LINKTREE API

Linktree page

Retrieve linktree page from Linktree with a single API request.

GET/api/data/v1/linktree
1credit base costZero-credit cache supported

Request parameters

Up to 1 credit

URL to Linktree page

If we have a response in the cache that is this many days old or newer, return the cached response (0 credits, with "cached": true and a "cached_at" timestamp). Otherwise, scrape a live result (1 credit). [See the Caching page for details.]

Try in the console

Live requests use your prepaid balance. Cached responses cost zero where supported.

curl --request GET \
  --url 'https://fetchgoblin.com/api/data/v1/linktree?url=https%3A%2F%2Flinktr.ee%2Fmiguelangeles' \
  --header 'x-api-key: YOUR_FETCHGOBLIN_API_KEY'

Response

Example
{
  "success": true,
  "id": 15278008,
  "username": "miguelangeles",
  "profilePictureUrl": "https://ugc.production.linktr.ee/d3141538-f586-4f3f-bc9a-a82fbebab798_DEATHRATTLE-slowed-COVER.jpeg",
  "description": "☆☆☆☆ IRL ANGEL ☆☆☆☆\nψ EMBRACE CHAOS ψ",
  "verticals": [
    "music"
  ],
  "linkPlatforms": [
    "Instagram"
  ],
  "timezone": "America/New_York",
  "links": [
    {
      "id": 463416775,
      "type": "SPOTIFY_ALBUM",
      "title": "new project \"BEFORE THE SUN RISES & WINTERR ENDS\"",
      "url": "https://open.spotify.com/album/0pgrg7phBbnwGJ2HBEl9EG?si=Zub7J4I3RySAaM9WVX3Okg"
    }
  ],
  "instagram": "https://instagram.com/miguelangeles",
  "tiktok": "https://tiktok.com/@irlangel",
  "spotify": "https://open.spotify.com/artist/14xRX3JR8H4RWh8R7V3fvZ?si=EgRxWIPiRcaEHtSnqk5PAQ",
  "youtube": "https://www.youtube.com/watch?v=xiFUzOJaiC4",
  "soundcloud": "https://soundcloud.com/miguelangeles",
  "apple_music": "https://music.apple.com/ca/artist/miguel-angeles/1209423162",
  "email_address": "[email protected]",
  "credits_charged": 1,
  "credits_remaining": 1000,
  "request_id": "00000000-0000-4000-8000-000000000000"
}
Example data from the API specification. Run a request to retrieve current data.

Response shape

This schema describes the documented data shape. Some platform fields may be absent or null. The response also includes your FetchGoblin request ID and current credit balance.

View JSON Schema +
{
  "type": "object",
  "properties": {
    "success": {
      "type": "boolean"
    },
    "id": {
      "type": "integer"
    },
    "username": {
      "type": "string"
    },
    "profilePictureUrl": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "verticals": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "linkPlatforms": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "timezone": {
      "type": "string"
    },
    "links": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "integer"
          },
          "type": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "url": {
            "type": "string"
          }
        }
      }
    },
    "instagram": {
      "type": "string"
    },
    "tiktok": {
      "type": "string"
    },
    "spotify": {
      "type": "string"
    },
    "youtube": {
      "type": "string"
    },
    "soundcloud": {
      "type": "string"
    },
    "apple_music": {
      "type": "string"
    },
    "email_address": {
      "type": "string"
    },
    "credits_charged": {
      "type": "integer",
      "minimum": 0,
      "description": "FetchGoblin credits charged for this request."
    },
    "credits_remaining": {
      "type": "integer",
      "description": "Your FetchGoblin credit balance after this request."
    },
    "request_id": {
      "type": "string",
      "format": "uuid",
      "description": "FetchGoblin request identifier."
    }
  }
}