Skip to content
scrapeatlas.Dashboard

Link in bio

Linktree API

Retrieve profiles, product collections and a paginated creator directory.

3 endpointsx-api-key

Read public Linktree profiles with display names, verification, link previews and social icons. Explore shops and discover creators by category or subcategory.

API availability: Available

Base URL · local workerhttp://localhost:3007Public API: https://api.scrapeatlas.com.
Authenticationx-api-keyCustomer key from your account. See Authentication.

Endpoints

GET/v1/linktree

Get a Linktree profile

Retrieve a public Linktree profile with display name, verification, badges, ordered links, block previews and social icons.

Reference
GET/v1/linktree/shop

Get a Linktree shop

Retrieve published shop products and collections with prices, images, vendors and source collection totals.

Reference
GET/v1/linktree/directory

Browse the Linktree creator directory

Discover public Linktree profiles by category or subcategory with display names, verification, avatars and pagination.

Reference

Quick start

Create an API key on your account page, then call the public API. Values below are placeholders.

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

Coverage & limits

  • One profile per request; four concurrent requests per worker. Additional requests receive 503 busy.
  • 15-second deadline; at most three upstream requests including redirects, with one retry for a network failure (including interrupted bodies) or HTTP 5xx.
  • Maximum 2 MiB decoded HTML or JSON; at most 500 visited links and ten nested group levels.
  • Locked profiles return restricted_page. Gated links and their descendants are omitted with a partial result.
  • Outbound links are returned as data; destination pages and media are never fetched.
  • Fresh retrieval on every request.
  • Some public link records reference groups omitted from the page. These links retain parentId and produce partial coverage with unresolved_parent.
  • Shop retrieval visits at most 500 products and collections combined; collection previews retain source totals and explicit partial coverage.
  • Directory retrieval returns one source page with at most 100 profiles, 100 category choices and 100 subcategory choices; page bounds 1–100000.
  • Choose category or subcategory, not both. Source pagination is caller-driven.
Error codes
10
HTTPfailure.codeMeaning
400invalid_requestInvalid URL, missing URL, duplicates, or unsupported parameters.
401unauthorizedMissing or invalid service API key.
403restricted_pageThe profile requires access or consent.
404not_foundThe profile is missing or inactive.
429upstream_rate_limitedLinktree rate limited the request; no automatic retry.
502upstream_challengedThe upstream rejected or challenged the request.
502unsupported_pageData is missing, malformed, or belongs to another profile.
502response_too_large unsafe_redirect request_limit upstream_errorRetrieval could not safely complete.
503busyAll worker slots are in use.
504timeoutThe request exceeded its deadline.