Docs · Linktree page

Linktree page

A public Linktree page: its links, social accounts and bio.

1 credit per callFresh within 1 dayMCP tool: linkinbio_linktree

GEThttps://api.lurkapi.com/v1/linktree

When to use this

Use it to find where a creator sends their audience: their website, social accounts, email and campaign links. Pass a linktr.ee profile URL. You get the title, bio, picture, categories, links and social accounts, in the page's order.

Cards that don't link anywhere, such as a header or an embedded shop, have url: null. Locked cards keep their destination hidden. We read the page only and don't follow its links.

A missing page returns 404 not_found. A page behind a password or a sensitive-content warning returns 403 not_public. Results are cached for up to a day.

Example request

Copy one and replace YOUR_API_KEY with your API key (get one free). The code versions read the key from the LURKAPI_API_KEY environment variable instead.

curl "https://api.lurkapi.com/v1/linktree?url=https%3A%2F%2Flinktr.ee%2Fmiguelangeles" \
  -H "x-api-key: YOUR_API_KEY"

Paste it into a terminal, with your key in place of YOUR_API_KEY.

const params = new URLSearchParams({
  url: "https://linktr.ee/miguelangeles",
});
const res = await fetch(`https://api.lurkapi.com/v1/linktree?${params}`, {
  headers: { "x-api-key": process.env.LURKAPI_API_KEY },
});
const data = await res.json();
if (!data.success) throw new Error(`${data.code}: ${data.error}`);
console.log(data.links);

Node 18+. Save it as lurk.mjs and run node lurk.mjs. It reads your key from LURKAPI_API_KEY.

import os
import requests

res = requests.get(
    "https://api.lurkapi.com/v1/linktree",
    params={
        "url": "https://linktr.ee/miguelangeles",
    },
    headers={"x-api-key": os.environ["LURKAPI_API_KEY"]},
    timeout=60,
)
data = res.json()
if not data["success"]:
    raise RuntimeError(f"{data['code']}: {data['error']}")
print(data["links"])

Run pip install requests, save it as lurk.py and run python lurk.py. It reads your key from LURKAPI_API_KEY.

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
	"net/url"
	"os"
	"time"
)

func main() {
	params := url.Values{}
	params.Set("url", "https://linktr.ee/miguelangeles")
	req, _ := http.NewRequest("GET", "https://api.lurkapi.com/v1/linktree?"+params.Encode(), nil)
	req.Header.Set("x-api-key", os.Getenv("LURKAPI_API_KEY"))

	client := &http.Client{Timeout: 60 * time.Second}
	res, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var data map[string]any
	if err := json.NewDecoder(res.Body).Decode(&data); err != nil {
		panic(err)
	}
	if data["success"] != true {
		panic(fmt.Sprintf("%v: %v", data["code"], data["error"]))
	}
	out, _ := json.MarshalIndent(data["links"], "", "  ")
	fmt.Println(string(out))
}

Save it as main.go and run go run main.go. It reads your key from LURKAPI_API_KEY.

<?php
$params = http_build_query([
    'url' => 'https://linktr.ee/miguelangeles',
]);
$context = stream_context_create(['http' => [
    'header' => 'x-api-key: ' . getenv('LURKAPI_API_KEY'),
    'timeout' => 60,
    'ignore_errors' => true,
]]);
$body = file_get_contents('https://api.lurkapi.com/v1/linktree?' . $params, false, $context);
$data = json_decode($body, true);
if (!$data['success']) {
    throw new Exception("{$data['code']}: {$data['error']}");
}
print_r($data['links']);

Save it as lurk.php and run php lurk.php. It reads your key from LURKAPI_API_KEY.

require 'json'
require 'net/http'

uri = URI('https://api.lurkapi.com/v1/linktree')
uri.query = URI.encode_www_form(
  'url' => 'https://linktr.ee/miguelangeles',
)
req = Net::HTTP::Get.new(uri)
req['x-api-key'] = ENV.fetch('LURKAPI_API_KEY')
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 60) do |http|
  http.request(req)
end
data = JSON.parse(res.body)
raise "#{data['code']}: #{data['error']}" unless data['success']
puts JSON.pretty_generate(data['links'])

Save it as lurk.rb and run ruby lurk.rb. It reads your key from LURKAPI_API_KEY.

Parameters

Add them to the URL after a ?. Join several with &.

Parameter	Description
`url` stringrequired	The creator's Linktree profile URL, such as https://linktr.ee/linktree. Tracking parameters are ignored. Example `https://linktr.ee/miguelangeles`

Example response

A real response, captured from the live API. Lists are trimmed to a couple of items, and long text such as media links is cut short with ….

Show the example response (3 KB)

{
  "success": true,
  "credits_remaining": 999957,
  "credits_charged": 1,
  "id": 15278008,
  "username": "miguelangeles",
  "pageTitle": "MIGUEL ANGELES",
  "profilePictureUrl": "https://ugc.production.linktr.ee/d3141538-f586-4f3f-bc9a-a82fbebab798_DE…",
  "description": "☆☆☆☆ IRL ANGEL ☆☆☆☆\nψ EMBRACE CHAOS ψ",
  "verticals": [
    "music",
    "creative",
    "arts-entertainment"
  ],
  "linkPlatforms": [
    "TikTok",
    "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",
      "thumbnailUrl": "https://ugc.production.linktr.ee/8ed131c7-6d74-47fc-bceb-8be7f6bae4c8_ab…",
      "locked": false,
      "parentId": null
    },
    {
      "id": 460281204,
      "type": "SPOTIFY_SONG",
      "title": "stream \"NOVEMBERR\"",
      "url": "https://open.spotify.com/track/62HnBMEdZjeFCd2T8g37T8?si=7bd35dd0e9f24d65",
      "thumbnailUrl": "https://ugc.production.linktr.ee/3bd59146-cd44-4187-9601-4341b21070d2_ab…",
      "locked": false,
      "parentId": null
    }
  ],
  "socialLinks": [
    {
      "type": "INSTAGRAM",
      "url": "https://instagram.com/miguelangeles"
    },
    {
      "type": "SPOTIFY",
      "url": "https://open.spotify.com/artist/14xRX3JR8H4RWh8R7V3fvZ?si=EgRxWIPiRcaEHtSnqk5PAQ"
    },
    {
      "type": "SOUNDCLOUD",
      "url": "https://soundcloud.com/miguelangeles"
    },
    {
      "type": "YOUTUBE",
      "url": "https://www.youtube.com/watch?v=xiFUzOJaiC4"
    },
    {
      "type": "APPLE_MUSIC",
      "url": "https://music.apple.com/ca/artist/miguel-angeles/1209423162"
    },
    {
      "type": "TIKTOK",
      "url": "https://tiktok.com/@irlangel"
    },
    {
      "type": "EMAIL_ADDRESS",
      "url": "mailto:miguel@irlangel.com"
    }
  ],
  "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": "miguel@irlangel.com"
}

Response fields

Every field in a successful response, and what it means. A name with [] belongs to each item of a list: links[].id is the id of every item in links. null means there's no value.

Show all 29 fields

Field	Type	Description
success	true	Always true here; errors have `success: false`.
credits_remaining	number	Your balance after this call. On anonymous playground calls: free tries left today.
credits_charged	number	Credits this call cost; 0 on free endpoints. On anonymous playground calls: tries used (1).
id	integer	Linktree account id.
username	string	The profile's Linktree username.
pageTitle	string	Profile title; the username when no title is set.
profilePictureUrl	stringcan be null	Profile picture URL; null when no picture is set.
description	stringcan be null	Profile bio as plain text; null when none is set.
verticals	string[]	Creator categories selected on Linktree, such as music or internet-technology.
linkPlatforms	string[]	Social platforms Linktree lists for the profile, in its order.
timezone	stringcan be null	The account's timezone; null when the page doesn't give one.
links	object[]	Link cards in page order. Each GROUP card is followed by the cards inside it. Cards in hidden groups and embedded product details aren't included.
links[].id	integer	Link card id.
links[].type	string	Linktree card type, such as CLASSIC, HEADER or YOUTUBE_VIDEO.
links[].title	stringcan be null	Link card title; null if none is set.
links[].url	stringcan be null	Where the card links; null for locked cards and cards that don't link anywhere.
links[].thumbnailUrl	stringcan be null	Card thumbnail URL; null when none is set.
links[].locked	boolean	Whether the card is locked. A locked card's destination is hidden.
links[].parentId	integercan be null	Id of the GROUP card this card sits in; null for top-level cards.
socialLinks	object[]	The social links on the profile, in their displayed order.
socialLinks[].type	string	Linktree's social type, such as INSTAGRAM, TIKTOK or EMAIL_ADDRESS.
socialLinks[].url	string	The social destination or mailto URL listed on the profile.
instagram	stringcan be null	Instagram link; null if the profile doesn't list one.
tiktok	stringcan be null	TikTok link; null if the profile doesn't list one.
spotify	stringcan be null	Spotify link; null if the profile doesn't list one.
youtube	stringcan be null	YouTube link; null if the profile doesn't list one.
soundcloud	stringcan be null	SoundCloud link; null if the profile doesn't list one.
apple_music	stringcan be null	Apple Music link; null if the profile doesn't list one.
email_address	stringcan be null	Email address from the public EMAIL_ADDRESS social link, without mailto or query parameters; null when none is listed.

Cost and freshness

Each call costs 1 credit. Calls turned away before they reach the platform (invalid parameters, a key or balance problem, a rate limit) are free, and so are 5xx errors. A not_found is charged, since the platform was checked. How charging works.

Answers are cached for up to 1 day. A repeat call within that time can return the same data, and costs the same.

Errors

A failed call returns success: false, an error message, a code your program can check, and a docs link. These are the errors this endpoint can return. All error codes.

Status	Code	Meaning
401	`missing_api_key`	No API key was sent. Put it in the `x-api-key` header.
401	`invalid_api_key`	This key doesn't exist or was revoked.
402	`insufficient_credits`	Not enough credits for this call. Buy a pack, or wait for tomorrow's free top-up.
402	`over_max_credits`	This call would cost more than the `max_credits` you set. The error says what it needs; raise `max_credits` to allow it. Not charged.
403	`account_suspended`	This account is suspended. Email support@lurkapi.com. Not charged.
403	`not_public`	The platform shows this account or post only to people who are logged in. Try a public one. Charged, since the platform was checked.
404	`not_found`	What you asked for (a post, an ad, a subreddit) doesn't exist, or there's no endpoint at that path. Charged if the platform was checked.
405	`method_not_allowed`	Endpoints only take `GET`, with parameters in the URL.
429	`rate_limited`	Too many calls in a short time. Wait as many seconds as the `retry-after` header says, then retry.
500	`internal_error`	Something broke on our side. Retry. Not charged.
502	`upstream_error`	The platform didn't send a usable answer. Retry. Not charged.
503	`upstream_busy`	All our connections to the platform are busy. Retry in a few seconds. Not charged.
504	`upstream_timeout`	The platform took over 30 seconds to answer (90 for web pages). Retry. Not charged.

Use it in Claude

Connect LurkAPI to Claude and ask in plain English. This endpoint is the linkinbio_linktree tool. For example:

Ask Claude

Use LurkAPI's linkinbio_linktree tool with url "https://linktr.ee/miguelangeles", then summarize what you find.

Claude calls linkinbio_linktree with arguments like these, and each call costs 1 credit:

Tool arguments

{"url": "https://linktr.ee/miguelangeles"}

To save tokens, tool results leave out empty fields, keep one URL per image or video, and give transcripts as plain text unless you pass timestamps=true. A result over 45,000 characters comes in parts. Its _note gives the offset for the next part, and later parts are free for 15 minutes. Pass trim=false for the full response.

From the blog

All posts