Skip to content
Scrappa Get API key
Linktree API 1 credit/request

Linktree Batch Profiles API Documentation

GET https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019

Retrieve up to 10 public Linktree profiles in one call. Pass a comma-separated list of usernames. Each username costs one upstream request. Only found profiles are returned and billed; unknown usernames are omitted from the results.

Linktree Batch Profiles API Documentation 1 credit/request

Endpoint

Request preview
GET
https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019
Auth header
x-api-key
Cost
1 credit/request
usernames = linktree,spotify,vannise2019
Response preview
200 OK
{
    "success": true,
    "data": [
        {
            "username": "linktree",
            "page_title": "Linktree",
            "description": null,
            "verified": false,
            "profile_image": null,
            "is_profile_verified": false,
            "has_sensitive_content": false,
            "content_gating": null,
            "theme": {
                "key": "leaf",
...

Parameters

Start with the required fields, then add optional filters only when your use case needs them.

Runnable path

1 required parameter needed before sending a request.

usernames string Required

Comma-separated Linktree usernames, up to 10. Example: linktree,spotify,vannise2019.

Example value linktree,spotify,vannise2019

Request Examples

PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019",
    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
<?php

use Illuminate\Support\Facades\Http;

$response = Http::timeout(30)
    ->withHeaders(['x-api-key' => 'YOUR_API_KEY_HERE'])
    ->get('https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019');

if ($response->successful()) {
    echo $response->body();
} else {
    echo "Error: " . $response->status();
}
JavaScript
const options = {
    method: 'GET',
    headers: {
        'x-api-key': 'YOUR_API_KEY_HERE'
    }
};

fetch('https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019', 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));
JavaScript
const axios = require('axios');

const options = {
    method: 'GET',
    url: 'https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019',
    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);
}
Ruby
require 'net/http'
require 'uri'

uri = URI.parse("https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019")
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
Python
import http.client
import json

conn = http.client.HTTPSConnection("scrappa.co")

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    conn.request("GET", "/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019", headers=headers)
    res = conn.getresponse()
    data = res.read()
    print(data.decode("utf-8"))
except Exception as e:
    print(f"Error: {e}")
finally:
    conn.close()
Python
import requests

headers = {
    'x-api-key': 'YOUR_API_KEY_HERE',
}

try:
    response = requests.get('https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019', headers=headers)
    response.raise_for_status()
    print(response.text)
except requests.exceptions.RequestException as e:
    print(f"Error: {e}")
Java
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/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019")
        .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());
        }
    }
}
Go
package main

import (
    "fmt"
    "net/http"
    "io/ioutil"
)

func main() {
    client := &http.Client{}
    req, err := http.NewRequest("GET", "https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019", 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))
}
Terminal
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019"
C#
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/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019"));
            var content = await response.Content.ReadAsStringAsync();
            Console.WriteLine(content);
        }
        catch (Exception ex)
        {
            Console.WriteLine($"Error: {ex.Message}");
        }
    }
}
TypeScript
import axios from 'axios';

async function run(): Promise<void> {
    try {
        const response = await axios({
            method: 'GET',
            url: 'https://scrappa.co/api/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019',
            headers: {
        'x-api-key': 'YOUR_API_KEY_HERE',
            },
        });

        console.log(response.data);
    } catch (error) {
        console.error('Error:', error);
    }
}

void run();
RUST
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/linktree/profiles?usernames=linktree%2Cspotify%2Cvannise2019")
        .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.

success data meta

Common data fields

username page_title description verified
JSON Response
200 OK
{
    "success": true,
    "data": [
        {
            "username": "linktree",
            "page_title": "Linktree",
            "description": null,
            "verified": false,
            "profile_image": null,
            "is_profile_verified": false,
            "has_sensitive_content": false,
            "content_gating": null,
            "theme": {
                "key": "leaf",
                "mode": "light"
            },
            "links": [
                {
                    "id": "589138106",
                    "title": "Linktree's Linktree",
                    "url": "https://linktr.ee/linktr.ee",
                    "type": "CLASSIC",
                    "position": 1,
                    "thumbnail": "https://ugc.production.linktr.ee/b2f4b99c-linktr.ee.jpeg",
                    "children": [],
                    "meta_data": {
                        "title": "Welcome to our Linktree | Linktree",
                        "description": "A place to discover everything going on in the world of Linktree"
                    }
                }
            ],
            "pinned_links": [],
            "socials": []
        },
        {
            "username": "spotify",
            "page_title": "Spotify",
            "description": null,
            "verified": true,
            "profile_image": null,
            "is_profile_verified": true,
            "has_sensitive_content": false,
            "content_gating": null,
            "theme": {
                "key": "leaf",
                "mode": "light"
            },
            "links": [
                {
                    "id": "61298474",
                    "title": "Spotify's Linktree",
                    "url": "https://open.spotify.com/",
                    "type": "CLASSIC",
                    "position": 1,
                    "thumbnail": null,
                    "children": [],
                    "meta_data": null
                }
            ],
            "pinned_links": [],
            "socials": []
        },
        {
            "username": "vannise2019",
            "page_title": "Vannise",
            "description": null,
            "verified": false,
            "profile_image": null,
            "is_profile_verified": false,
            "has_sensitive_content": false,
            "content_gating": null,
            "theme": {
                "key": "leaf",
                "mode": "light"
            },
            "links": [],
            "pinned_links": [],
            "socials": [
                {
                    "type": "instagram",
                    "url": "https://instagram.com/vannise2019",
                    "position": 1
                }
            ]
        }
    ],
    "meta": {
        "endpoint_family": "profile_detail",
        "billable": true
    }
}

Errors

Handle these documented responses before retrying or showing customer-facing failures.

503

Upstream Unavailable

The profiles could not be read from their source right now. Please retry.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "profile_detail"
    },
    "error": {
        "code": "UPSTREAM_UNAVAILABLE",
        "message": "This API is temporarily unavailable. Please retry."
    },
    "success": false
}
503

Parse Error

The Linktree response could not be parsed. Please retry.

{
    "meta": {
        "billable": false,
        "retryable": true,
        "endpoint_family": "profile_detail"
    },
    "error": {
        "code": "PARSE_ERROR",
        "message": "The Linktree response could not be parsed."
    },
    "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.