Linktree Profile API

Returns every link on a public Linktree page, in page order, with its social icons, bio and contact email, from a username or link. Each link has its label, destination, type, thumbnail and group. The profile adds the page's ID, title, avatar, banner, verified badge, country, category and join date.

GET /v1/linktree/profile

Read the API reference

1 credit per request, $0.75–$1.97 per 1,000 requests
19 typed fields null when unknown
handle is all it needs, e.g. selenagomez
100 credits free when you sign up, no card, so you can build before you spend

Send one request. Get 19 fields back.

Copy the request in your language, or hand it to your agent. Sign up for an API key and your first 100 credits are free.

$ npm install socialtap

handle = selenagomez

Open in playground

GET /v1/linktree/profileTry in

const params = new URLSearchParams({
  handle: "SbuxIDOfficialStores",
});
const res = await fetch(`https://socialtap.dev/v1/linktree/profile?${params}`, {
  headers: { "x-api-key": process.env.SOCIALTAP_API_KEY ?? "" },
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.error.code}: ${body.error.message}`);
const { data, meta } = body;
console.log(data, meta.credits_charged);

import os

import requests

res = requests.get(
    "https://socialtap.dev/v1/linktree/profile",
    params={"handle": "SbuxIDOfficialStores"},
    headers={"x-api-key": os.environ["SOCIALTAP_API_KEY"]},
)
body = res.json()
if not res.ok:
    raise RuntimeError(f"{body['error']['code']}: {body['error']['message']}")
data, meta = body["data"], body["meta"]
print(data, meta["credits_charged"])

require "json"
require "net/http"

uri = URI("https://socialtap.dev/v1/linktree/profile")
uri.query = URI.encode_www_form('handle' => 'SbuxIDOfficialStores')
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = ENV.fetch("SOCIALTAP_API_KEY")
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == "https") { |http| http.request(req) }
body = JSON.parse(res.body)
raise "#{body["error"]["code"]}: #{body["error"]["message"]}" unless res.is_a?(Net::HTTPSuccess)
pp body["data"]
puts body["meta"]["credits_charged"]

<?php

$query = http_build_query([
    'handle' => 'SbuxIDOfficialStores',
]);
$ch = curl_init('https://socialtap.dev/v1/linktree/profile?' . $query);
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: ' . getenv('SOCIALTAP_API_KEY')],
]);
$body = json_decode(curl_exec($ch), true);
if (curl_getinfo($ch, CURLINFO_RESPONSE_CODE) >= 400) {
    throw new RuntimeException($body['error']['code'] . ': ' . $body['error']['message']);
}
print_r($body['data']);
echo $body['meta']['credits_charged'], PHP_EOL;

package main

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

func main() {
	q := url.Values{}
	q.Set("handle", "SbuxIDOfficialStores")
	req, err := http.NewRequest("GET", "https://socialtap.dev/v1/linktree/profile?"+q.Encode(), nil)
	if err != nil {
		log.Fatal(err)
	}
	req.Header.Set("x-api-key", os.Getenv("SOCIALTAP_API_KEY"))
	res, err := http.DefaultClient.Do(req)
	if err != nil {
		log.Fatal(err)
	}
	defer res.Body.Close()
	var body struct {
		Data  json.RawMessage `json:"data"`
		Meta  map[string]any  `json:"meta"`
		Error *struct {
			Code    string `json:"code"`
			Message string `json:"message"`
		} `json:"error"`
	}
	if err := json.NewDecoder(res.Body).Decode(&body); err != nil {
		log.Fatal(err)
	}
	if body.Error != nil {
		log.Fatalf("%s: %s", body.Error.Code, body.Error.Message)
	}
	fmt.Println(string(body.Data), body.Meta["credits_charged"])
}

curl 'https://socialtap.dev/v1/linktree/profile?handle=SbuxIDOfficialStores' \
  -H "x-api-key: $SOCIALTAP_API_KEY"

{
  "data": {
    "approximate_fields": [],
    "avatar_url": "https://ugc.production.linktr.ee/DQQCWwlZT7qHu3orFoIg_5DNrZjnwDtbJHpmu",
    "banner_url": null,
    "bio": null,
    "category": "restaurant",
    "country_code": "ID",
    "created_at": "2021-03-02T05:07:54Z",
    "display_name": "Starbucks Indonesia",
    "external_links": [
      {
        "title": "Find The Nearest Starbucks",
        "url": "https://www.starbucks.co.id/store-locator"
      },
      {
        "title": "Starbucks Delivers: GoFood Order",
        "url": "https://gofood.link/a/GN1xGkj"
      },
      {
        "title": "Download aplikasi Grab untuk transportasi dan pengantaran makanan | Grab ID",
        "url": "https://tinyurl.com/GrabStarbucksDelivery"
      }
    ],
    "id": "13053310",
    "is_private": false,
    "is_verified": false,
    "location": null,
    "metrics": {
      "follower_count": null,
      "following_count": null,
      "post_count": null,
      "total_like_count": null,
      "total_view_count": null
    },
    "platform": "linktree",
    "platform_specific": {
      "linktree": {
        "badges": [],
        "content_warning": null,
        "email": "customer.care@Starbucks.co.id",
        "is_sensitive": false,
        "link_platforms": [
          "Instagram"
        ],
        "links": [
          {
            "gates": [],
            "group_id": null,
            "id": "301194825",
            "position": 5,
            "thumbnail_url": null,
            "title": "Find The Nearest Starbucks",
            "type": "CLASSIC",
            "url": "https://www.starbucks.co.id/store-locator"
          },
          {
            "gates": [],
            "group_id": null,
            "id": "217384595",
            "position": 6,
            "thumbnail_url": null,
            "title": "Starbucks Delivers: GoFood Order",
            "type": "CLASSIC",
            "url": "https://gofood.link/a/GN1xGkj"
          },
          {
            "gates": [],
            "group_id": null,
            "id": "87194845",
            "position": 7,
            "thumbnail_url": "https://ugc.production.linktr.ee/4acb18e0-8e2e-44f1-b449-782478e9bbea_download-app-screen-ID.png",
            "title": "Download aplikasi Grab untuk transportasi dan pengantaran makanan | Grab ID",
            "type": "CLASSIC",
            "url": "https://tinyurl.com/GrabStarbucksDelivery"
          }
        ],
        "social_links": [
          {
            "platform": "instagram",
            "url": "https://www.instagram.com/starbucksindonesia/"
          },
          {
            "platform": "email_address",
            "url": "mailto:customer.care@Starbucks.co.id"
          }
        ],
        "timezone": "Asia/Jakarta",
        "updated_at": "2026-10-06T08:09:22Z",
        "verticals": [
          "brand",
          "creative",
          "ecommerce"
        ]
      }
    },
    "type": "unknown",
    "unknown_fields": [],
    "url": "https://linktr.ee/SbuxIDOfficialStores",
    "username": "SbuxIDOfficialStores"
  },
  "meta": {
    "request_id": "req_3f9c2a7d1e8b4c6a9f0e2d4b6a8c0e1f",
    "platform": "linktree",
    "source": "page",
    "is_cached": false,
    "credits_charged": 1,
    "latency_ms": 1285,
    "fetched_at": "2026-10-25T12:00:00Z",
    "input": {
      "kind": "profile",
      "id": "13053310",
      "url": "https://linktr.ee/SbuxIDOfficialStores"
    },
    "credits_remaining": 9999,
    "client_request_id": null,
    "warnings": []
  }
}

import { SocialTap } from "socialtap";

const client = new SocialTap(); // apiKey defaults to process.env.SOCIALTAP_API_KEY

const res = await client.linktree.profile.get({ handle: "SbuxIDOfficialStores" });
console.log(res.data);
console.log(res.credits.charged, res.meta.request_id);

import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;

public class Main {
    public static void main(String[] args) throws Exception {
        String query = "handle=" + encode("SbuxIDOfficialStores");
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://socialtap.dev/v1/linktree/profile?" + query))
            .header("x-api-key", System.getenv("SOCIALTAP_API_KEY"))
            .GET()
            .build();
        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());
        // An error is {"error": {"code", "message", ...}}; success is {data, meta}, meta.credits_charged its price.
        if (response.statusCode() >= 400) throw new RuntimeException(response.body());
        System.out.println(response.body());
    }

    static String encode(String value) {
        return URLEncoder.encode(value, StandardCharsets.UTF_8);
    }
}

using System.Text.Json;

using var http = new HttpClient();
http.DefaultRequestHeaders.Add("x-api-key", Environment.GetEnvironmentVariable("SOCIALTAP_API_KEY"));

var query = string.Join("&",
    "handle=" + Uri.EscapeDataString("SbuxIDOfficialStores"));
var res = await http.GetAsync("https://socialtap.dev/v1/linktree/profile?" + query);
using var body = JsonDocument.Parse(await res.Content.ReadAsStringAsync());
if (!res.IsSuccessStatusCode)
{
    var error = body.RootElement.GetProperty("error");
    throw new Exception($"{error.GetProperty("code")}: {error.GetProperty("message")}");
}
Console.WriteLine(body.RootElement.GetProperty("data"));
Console.WriteLine(body.RootElement.GetProperty("meta").GetProperty("credits_charged"));

// Cargo.toml: reqwest = { version = "0.12", features = ["blocking", "json"] }, serde_json = "1"
use std::env;

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let res = reqwest::blocking::Client::new()
        .get("https://socialtap.dev/v1/linktree/profile")
        .query(&[("handle", "SbuxIDOfficialStores")])
        .header("x-api-key", env::var("SOCIALTAP_API_KEY")?)
        .send()?;
    let ok = res.status().is_success();
    let body: serde_json::Value = res.json()?;
    if !ok {
        return Err(format!("{}: {}", body["error"]["code"], body["error"]["message"]).into());
    }
    println!("{} {}", body["data"], body["meta"]["credits_charged"]);
    Ok(())
}

200 OK · GET https://socialtap.dev/v1/linktree/profileLong arrays and strings are shortened here. Real responses are complete.Docs

One schema on 27 platforms.

The response reference lists every field, its type and when it is null. See the full schema.

Null means unknown
A field Linktree doesn't show is null, never zero or an empty string, so a real zero always means zero.
What it accepts
The Linktree page: a username with or without the @, or its link (linktr.ee/<username>, in any case, with or without a query).
Write one parser
Linktree, TikTok, Instagram and 24 more platforms answer in these fields, so the code that reads one reads them all.

platformstring: Platform ID (tiktok, youtube, …).
idstring: Platform-native account ID (string; YouTube UC…, Reddit t2_…).
usernamestring: Handle without the @; null when the account has none.
display_namestring: Display name, channel title or page name; null when empty or not exposed.
urlstring: Canonical profile URL.
typestring: Coarse account kind, as the platform labels it; unknown when it does not (TikTok labels organizations only). New values may be added; treat unknown values as unknown.
biostring: Profile bio, channel description or page about text; null when empty or not exposed.
avatar_urlstring: Profile picture URL (largest available). Platform CDN URLs can expire within hours.

What teams build with the Linktree Profile API.

List the links and accounts a creator shares
Monitor when a creator changes their links
Get a creator's contact email for outreach
See which brands and shops creators link to

Good to know before you build.

external_links lists each destination once: the page's links, then its social icons, which have no label. platform_specific.linktree.links keeps every block with its type, group and position, headers and groups included.
A link locked behind a passcode, password or NFT has its label and a null url.
A link behind a sensitive-content or age notice keeps its url, and gates names the notice. Linktree withholds the url of a few.
display_name is null while the page's title is still its default, the @username.
metrics and location are null: Linktree pages show no follower counts or location.
A page behind Linktree's Profile Lock returns is_private true, with its name and picture only.
A name no one has returns not_found. A page Linktree removed or hasn't verified yet returns private_or_unavailable.

1 credit per request. Failed requests are free.

Buy credits once and spend them on any endpoint, on any platform.

Plans and packs How this endpoint is priced How credits work

Source	Price per successful request	Per 1,000 requests
Public page `page`	1 credit	$0.75–$1.97

Cache hits are free.
Credits from packs and top-ups never expire.
A monthly plan's credits are spent first, and what is left of them ends at each renewal.
Prices exclude tax: sales tax is added at checkout where it applies.
Outside the US, plans and packs are sold to businesses: checkout asks for your VAT, GST or other business tax ID.

Questions about the Linktree Profile API.

Try it on an account you know.

Paste its handle or link in the playground, or copy the request into your code.

free credits

No credit card
Failed requests are free
Works on all 218 endpoints

Start for free Read the docs

Linktree Profile API. Send a handle or profile link.