LINKTREE API

One profile.
A whole world of links.

Turn a public Linktree page into structured profile data, published links, and social accounts. Ready for your application, without maintaining a page parser.

Explore the endpoint API reference

Live private service

WHAT’S ON THE MAP

The data you need.
The details that matter.

View full coverage

The person behind the links

Retrieve public usernames, bios, profile images, and available category metadata.

Published links, in order

Keep link titles, destinations, types, and group relationships together.

Connected social accounts

Extract published social icons, including Instagram, TikTok, YouTube, and more.

YOUR FIRST REQUEST

Get to the
good data.

Start with a local worker and a service key. The examples use the current Linktree contract.

GET/v1/linktree

Get a Linktree profile

Accepts one HTTPS linktr.ee profile URL. Tracking parameters and fragments are removed. Custom domains, duplicate parameters, and cache_max_age are unsupported.

Request and response fields

QUICKSTART / LOCAL EXAMPLES

# Local worker · use your own service key
export BASE_URL="http://localhost:3007"

curl --get "$BASE_URL/v1/linktree" \
  -H "x-api-key: $LINKTREE_API_KEY" \
  --data-urlencode "url=https://linktr.ee/example"

const baseUrl = "http://localhost:3007";
const url = new URL('/v1/linktree', baseUrl);
url.searchParams.set("url", "https://linktr.ee/example");

const response = await fetch(url, {
  method: 'GET',
  headers: {
    'x-api-key': process.env.LINKTREE_API_KEY
  }
});

const data = await response.json();
console.log(data);

GET/v1/linktreeJSON response

Examples target local workers. Use the origin and credentials supplied for your service.

TAKE IT SOMEWHERE USEFUL

Made for what
you’re making.

Enrich creator profiles

Bring public bios, images, and linked social accounts into your creator database.

Discover destinations

Find a creator’s published website, storefront, music, and other destinations.

Build link directories

Organize the links published on public profiles into your own discovery experience.

BEFORE YOU BUILD

A few useful
answers.

Read the full reference

What does the Linktree API return?

Public profile metadata, ordered link records, group relationships, and published social icons. Missing values and omitted fields are identified in the response.

Does it retrieve follower counts or analytics?

No. It retrieves the supported data embedded in the public Linktree page. Private analytics, follower counts, destination pages, and media feeds are outside this endpoint’s coverage.

Can I use it today?

Use the local worker or an operator-provided private origin with a dedicated service key. There is no public signup or customer key portal yet.

Is this an official Linktree API?

No. ScrapeAtlas is independent and is not affiliated with Linktree. This endpoint retrieves supported publicly available data.

One profile.A whole world of links.

The data you need.The details that matter.