Get a Linktree profile

Try in Playground

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

GET/v1/linktreex-api-key

Headers

Get your API key

x-api-keystringrequiredheader

Your ScrapeAtlas customer key. Create one on /account/ and set SCRAPEATLAS_API_KEY.

Query parameters

urlstringrequiredquery

Required. A public HTTPS linktr.ee profile URL.

max 2048 chars · absolute HTTPS URL

Examplehttps://linktr.ee/example

Response fields

idinteger

Linktree's numeric account ID.

≥ 0

usernamestring

The username on the retrieved profile.

min 1 chars

displayNamestringnullable

Published display name from the profile title.

isVerifiedbooleannullable

Public verification flag.

profileBadgesstring[]nullable

Published profile badge labels.

profilePictureUrlstringnullable

Profile image URL, or null when unavailable.

descriptionstringnullable

Public bio, preserving line breaks; null when unavailable.

verticalsstring[]nullable

Public category metadata; null when unavailable.

linkPlatformsstring[]nullable

Linktree's platform labels, which may differ from its social icons.

timezonestringnullable

Timezone exposed by Linktree, or null when unavailable.

Ordered public links with id, type, title, url, optional parentId and presentation details. Pins appear first and repeated IDs appear once.

up to 500 items

links.idinteger

Always included.

≥ 0

links.typestring

Always included.

min 1 chars

links.titlestring

Always included.

links.urlstring

Always included.

links.parentIdintegeroptional

Optional.

≥ 0

Source position, thumbnailUrl, layout, preview title/description/imageUrl and embed option/videoIds.

links.details.positionintegernullable

Always included.

links.details.thumbnailUrlstringnullable

Always included.

links.details.layoutstringnullable

Always included.

links.details.preview.titlestringnullable

Always included.

links.details.preview.descriptionstringnullable

Always included.

links.details.preview.imageUrlstringnullable

Always included.

links.details.embed.optionstringnullable

Always included.

links.details.embed.videoIdsstring[]nullable

Always included.

Published social icons as type and url, including types beyond the convenience fields below.

socialLinks.typestring

Always included.

socialLinks.urlstring

Always included.

instagramstringoptional

Published Instagram social icon; omitted if absent.

tiktokstringoptional

Published TikTok social icon; omitted if absent.

spotifystringoptional

Published Spotify social icon; omitted if absent.

youtubestringoptional

Published YouTube social icon; omitted if absent.

soundcloudstringoptional

Published SoundCloud social icon; omitted if absent.

apple_musicstringoptional

Published Apple Music social icon; omitted if absent.

email_addressstringoptional

Published email icon, with mailto: and query parameters removed; omitted if absent.

linkedinstringoptional

Published LinkedIn social icon; omitted if absent.

discordstringoptional

Published Discord social icon; omitted if absent.

requestIdstring

Identifier for correlating a request with operational logs.

Upstream request count, decoded public-page source bytes read, and total duration.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable profile data is returned, including partial results.

statusenum

success or partial. Failures return failed or challenged with a failure object.

one of: success, partial

sourceUrlstring

Final canonical profile URL after allowed redirects.

absolute HTTPS URL

fetchedAtstring

UTC timestamp of retrieval.

complete applies to supported embedded public page fields. Inspect warnings for omitted or unavailable data.

coverage.sourcestring

Always included.

coverage.completeboolean

Always included.

coverage.warningsenum[]

Always included.

HTTP 200 returns the success variant. Check status: partial means usable data with warnings, and failed or challenged requests carry a failure object described in Errors & responses.

Error codes

HTTP	failure.code	Meaning
400	`invalid_request`	Invalid URL, missing URL, duplicates, or unsupported parameters.
401	`unauthorized`	Missing or invalid service API key.
403	`restricted_page`	The profile requires access or consent.
404	`not_found`	The profile is missing or inactive.
429	`upstream_rate_limited`	Linktree rate limited the request; no automatic retry.
502	`upstream_challenged`	The upstream rejected or challenged the request.
502	`unsupported_page`	Data is missing, malformed, or belongs to another profile.
502	`response_too_large` `unsafe_redirect` `request_limit` `upstream_error`	Retrieval could not safely complete.
503	`busy`	All worker slots are in use.
504	`timeout`	The request exceeded its deadline.

Code example

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

const response = await fetch(
  "https://api.scrapeatlas.com/v1/linktree?url=https%3A%2F%2Flinktr.ee%2Fexample",
  {
    headers: {
      "x-api-key": "YOUR_API_KEY"
    }
  }
);

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

type Result = {
  status: "success" | "partial" | "failed" | "challenged";
  requestId: string;
  [field: string]: unknown;
};

const response = await fetch(
  "https://api.scrapeatlas.com/v1/linktree?url=https%3A%2F%2Flinktr.ee%2Fexample",
  {
    headers: {
      "x-api-key": process.env.SCRAPEATLAS_API_KEY!
    }
  }
);

const data = (await response.json()) as Result;
if (data.status === "failed" || data.status === "challenged") {
  throw new Error(`Linktree request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/linktree",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://linktr.ee/example"
    },
    timeout=60,
)
data = response.json()
print(data["status"], data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.scrapeatlas.com/v1/linktree?url=https%3A%2F%2Flinktr.ee%2Fexample", nil)
	req.Header.Set("x-api-key", "YOUR_API_KEY")
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	var data map[string]interface{}
	json.NewDecoder(resp.Body).Decode(&data)
	fmt.Println(data["status"], data)
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        var client = HttpClient.newHttpClient();
        var request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.scrapeatlas.com/v1/linktree?url=https%3A%2F%2Flinktr.ee%2Fexample"))
            .GET()
            .header("x-api-key", "YOUR_API_KEY")
            .build();
        var response = client.send(request, HttpResponse.BodyHandlers.ofString());
        System.out.println(response.body());
    }
}

Use your sa_live_… customer key at https://api.scrapeatlas.com.

Responses

Successful result. Synthetic example validated against the runtime contract.

{
  "success": true,
  "status": "success",
  "requestId": "00000000-0000-4000-8000-000000000001",
  "id": 123,
  "username": "example",
  "profilePictureUrl": "https://example.test/avatar.png",
  "description": "Synthetic creator",
  "verticals": [
    "music"
  ],
  "linkPlatforms": [
    "Instagram"
  ],
  "timezone": "America/New_York",
  "links": [
    {
      "id": 1,
      "type": "CLASSIC",
      "title": "Website",
      "url": "https://example.test/",
      "details": {
        "position": 0,
        "thumbnailUrl": "https://example.test/image.png",
        "layout": "featured",
        "preview": {
          "title": "Example website",
          "description": "A public resource",
          "imageUrl": "https://example.test/preview.png"
        },
        "embed": null
      }
    },
    {
      "id": 2,
      "type": "PRODUCT",
      "title": "Merch",
      "url": ""
    }
  ],
  "socialLinks": [
    {
      "type": "INSTAGRAM",
      "url": "https://instagram.com/example"
    }
  ],
  "instagram": "https://instagram.com/example",
  "sourceUrl": "https://linktr.ee/example",
  "fetchedAt": "2026-09-10T00:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 18000,
    "durationMs": 350
  },
  "displayName": "Example Creator",
  "isVerified": true,
  "profileBadges": [
    "verified"
  ]
}

Invalid URL, missing URL, duplicates, or unsupported parameters.

{
  "requestId": "9d2f1c0a-6b1e-4c7d-9a8e-2f3b4c5d6e7f",
  "accounting": {
    "upstreamRequests": 0,
    "responseBytes": 0,
    "durationMs": 0
  },
  "success": false,
  "status": "failed",
  "failure": {
    "code": "invalid_request",
    "message": "Invalid request: missing, duplicate, unsupported or malformed parameters."
  }
}