Scrappa's GET /api/link-in-bio/linktree endpoint reads a public Linktree creator page and returns its profile, links, pinned links, and typed social links as structured JSON. Pass either handle or a full url.
Each link carries the platform type as observed live, and an unrecognised type is passed through rather than dropped, so no link is ever silently lost. Linktree answers a reserved handle with a redirect to its blocked page, which this endpoint does not follow, so that case comes back as a 422 UPSTREAM_REJECTED. A handle that answers 200 but carries no profile data returns an empty result instead. An existing profile with nothing configured answers with HTTP 200 and an empty result. That response is not billable, and its meta.reason explains which case applied.
Run this endpoint
Endpoint
Parameters
Start with the required fields, then add optional filters only when your use case needs them.
Runnable path
This endpoint has no required query parameters.
2 optional filters available.
string
Optional
Linktree username, for example linktree.
linktree
string
Optional
Full Linktree profile URL. Used when you do not have the bare username.
https://example.com/product
Request Examples
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://scrappa.co/api/link-in-bio/linktree?handle=linktree",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: YOUR_API_KEY_HERE"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
<?php
use Illuminate\Support\Facades\Http;
$response = Http::timeout(30)
->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
->get('https://scrappa.co/api/link-in-bio/linktree?handle=linktree');
if ($response->successful()) {
echo $response->body();
} else {
echo "Error: " . $response->status();
}
const options = {
method: 'GET',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE'
}
};
fetch('https://scrappa.co/api/link-in-bio/linktree?handle=linktree', options)
.then(response => {
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
return response.text();
})
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
const axios = require('axios');
const options = {
method: 'GET',
url: 'https://scrappa.co/api/link-in-bio/linktree?handle=linktree',
headers: {
x-api-key: 'YOUR_API_KEY_HERE',
}
};
try {
const response = await axios(options);
console.log(response.data);
} catch (error) {
console.error('Error:', error.message);
}
require 'net/http'
require 'uri'
uri = URI.parse("https://scrappa.co/api/link-in-bio/linktree?handle=linktree")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == 'https'
request = Net::HTTP::Get.new(uri.request_uri)
request['x-api-key'] = 'YOUR_API_KEY_HERE'
begin
response = http.request(request)
puts response.body
rescue => e
puts "Error: #{e.message}"
end
import http.client
import json
conn = http.client.HTTPSConnection("scrappa.co")
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
conn.request("GET", "/api/link-in-bio/linktree?handle=linktree", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
except Exception as e:
print(f"Error: {e}")
finally:
conn.close()
import requests
headers = {
'x-api-key': 'YOUR_API_KEY_HERE',
}
try:
response = requests.get('https://scrappa.co/api/link-in-bio/linktree?handle=linktree', headers=headers)
response.raise_for_status()
print(response.text)
except requests.exceptions.RequestException as e:
print(f"Error: {e}")
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.Response;
import java.io.IOException;
public class ApiExample {
public static void main(String[] args) {
OkHttpClient client = new OkHttpClient();
Request request = new Request.Builder()
.url("https://scrappa.co/api/link-in-bio/linktree?handle=linktree")
.addHeader("x-api-key", "YOUR_API_KEY_HERE")
.build();
try (Response response = client.newCall(request).execute()) {
if (response.isSuccessful()) {
System.out.println(response.body().string());
} else {
System.out.println("Error: " + response.code());
}
} catch (IOException e) {
System.out.println("Error: " + e.getMessage());
}
}
}
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
client := &http.Client{}
req, err := http.NewRequest("GET", "https://scrappa.co/api/link-in-bio/linktree?handle=linktree", nil)
if err != nil {
fmt.Println("Error creating request:", err)
return
}
req.Header.Set("x-api-key", "YOUR_API_KEY_HERE")
resp, err := client.Do(req)
if err != nil {
fmt.Println("Error making request:", err)
return
}
defer resp.Body.Close()
body, err := ioutil.ReadAll(resp.Body)
if err != nil {
fmt.Println("Error reading response:", err)
return
}
fmt.Println(string(body))
}
#!/bin/bash
curl -X GET \
-H "x-api-key: YOUR_API_KEY_HERE" \
"https://scrappa.co/api/link-in-bio/linktree?handle=linktree"
using System;
using System.Net.Http;
using System.Threading.Tasks;
class Program
{
static async Task Main()
{
using var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY_HERE");
try
{
var response = await client.SendAsync(new HttpRequestMessage(HttpMethod.Get, "https://scrappa.co/api/link-in-bio/linktree?handle=linktree"));
var content = await response.Content.ReadAsStringAsync();
Console.WriteLine(content);
}
catch (Exception ex)
{
Console.WriteLine($"Error: {ex.Message}");
}
}
}
import axios from 'axios';
async function run(): Promise<void> {
try {
const response = await axios({
method: 'GET',
url: 'https://scrappa.co/api/link-in-bio/linktree?handle=linktree',
headers: {
'x-api-key': 'YOUR_API_KEY_HERE',
},
});
console.log(response.data);
} catch (error) {
console.error('Error:', error);
}
}
void run();
use reqwest::Client;
#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
let client = Client::new();
let response = client
.get("https://scrappa.co/api/link-in-bio/linktree?handle=linktree")
.header("x-api-key", "YOUR_API_KEY_HERE")
.send()
.await?;
println!("{}", response.text().await?);
Ok(())
}
Response Schema
Example response fields are illustrative; inspect the JSON before integrating.
Example response fields
Scan these fields before integrating.
provider
handle
profile
links
pinned_links
socials
meta
Common links fields
id
url
title
type
{
"provider": "linktree",
"handle": "linktree",
"profile": {
"id": 123456789,
"username": "linktree",
"name": "Linktree",
"page_title": "Linktree",
"description": "The best link-in-bio tool.",
"timezone": "Europe/Berlin",
"avatar": "https://cdn.example.com/avatar.jpg",
"is_verified": true,
"badges": [],
"verticals": []
},
"links": [
{
"id": "1000001",
"url": "https://www.youtube.com/channel/UCkG8b0Yl8kG",
"title": "YouTube",
"type": "YOUTUBE_CHANNEL",
"thumbnail": null,
"is_pinned": false,
"is_hidden": false,
"order": 1
}
],
"pinned_links": [],
"socials": [
{
"type": "INSTAGRAM",
"url": "https://www.instagram.com/linktree",
"title": null
}
],
"meta": {
"duration_ms": 640,
"attempts": 1,
"billable": true
}
}
Errors
Handle these documented responses before retrying or showing customer-facing failures.
Profile Not Found
No public profile exists for this handle.
{
"meta": {
"billable": false,
"retryable": false
},
"error": {
"code": "NOT_FOUND",
"message": "The requested profile does not exist."
},
"success": false
}Upstream Unavailable
The profile could not be read from its source right now. Please retry.
{
"meta": {
"billable": false,
"retryable": true
},
"error": {
"code": "UPSTREAM_UNAVAILABLE",
"message": "This API is temporarily unavailable. Please retry."
},
"success": false
}Request Rejected Upstream
The source rejected this request, for example because the handle was not acceptable to it.
{
"meta": {
"billable": false,
"retryable": false
},
"error": {
"code": "UPSTREAM_REJECTED",
"message": "The upstream profile host rejected this request."
},
"success": false
}Profile Host Blocked the Request
The provider's bot protection refused this request after every available exit was tried. This is not a billing event; retry later.
{
"meta": {
"billable": false,
"retryable": true
},
"error": {
"code": "UPSTREAM_BLOCKED",
"message": "This API is temporarily unavailable. Please retry."
},
"success": false
}Invalid Handle or URL
The handle was not in a supported format, or the URL did not belong to this endpoint's provider.
{
"errors": {
"url": [
"This URL does not belong to this endpoint's provider."
]
},
"success": false
}Generate Code with AI
Copy a ready-made prompt with all the endpoint details, parameters, and example responses. Paste it into ChatGPT, Claude, or any AI assistant to instantly generate working code.
Try It Live
Test this endpoint in our interactive playground with real data.