Get a Lnk.Bio page

Try in Playground

Accepts one HTTPS lnk.bio page URL. Tracking parameters and fragments are removed; duplicate parameters and cache_max_age are rejected.

GET/v1/linkbiox-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 lnk.bio page URL.

max 2048 chars

Examplehttps://lnk.bio/example

Response fields

handlestring

The username printed on the page, exactly as published (it may start with @).

min 1 chars

idstring

Lnk.Bio's account ID as a string. It can be negative.

instagramstringnullable

Instagram icon destination, or null when the page has no Instagram icon.

emailstringnullable

Email icon address without mailto:, or null when absent or not an address.

tiktokstringnullable

TikTok icon destination, or null.

youtubestringnullable

YouTube social icon destination, or null. Music-service YouTube icons are listed in socialLinks only.

twitterstringnullable

X icon destination, or null. Legacy Twitter icons are listed in socialLinks only.

whatsappstringnullable

WhatsApp contact icon destination, or null.

websitestringnullable

Website contact icon destination, or null.

facebookstringnullable

Facebook icon destination, or null.

Every anchor with visible text inside the public page container, in page order: url and text. Includes the profile handle link, link blocks, buttons, contact downloads and anchors inside bio text; icon-only anchors are excluded. Relative URLs are preserved. Cloudflare-obfuscated email anchors are restored to mailto: addresses.

up to 1000 items

links.urlstring

Always included.

links.textstring

Always included.

min 1 chars

namestringnullable

Display name, or null when the page shows none.

biostringnullable

Bio text with paragraphs separated by newlines, or null.

profilePictureUrlstringnullable

Profile picture URL, or null.

Every icon anchor as Lnk.Bio's network code and destination, including networks beyond the convenience fields.

up to 100 items

socialLinks.networkstring

Always included.

min 1 chars

socialLinks.urlstring

Always included.

min 1 chars

requestIdstring

Identifier for correlating a request with operational logs.

Upstream request count, decoded HTML bytes read, and total duration. Bytes exclude discarded error/redirect bodies and are not billing totals.

accounting.upstreamRequestsinteger

Always included.

≥ 0

accounting.responseBytesinteger

Always included.

≥ 0

accounting.durationMsnumber

Always included.

≥ 0

successboolean

True when usable page 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 page URL after allowed redirects.

absolute HTTPS URL

fetchedAtstring

UTC timestamp of retrieval.

complete applies to the supported public page fields. Inspect warnings for omitted or capped 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.
404	`not_found`	The page is missing, reserved, or blocked by Lnk.Bio.
429	`upstream_rate_limited`	Lnk.Bio rate limited the request; no automatic retry.
502	`upstream_challenged`	The upstream rejected or challenged the request.
502	`unsupported_page`	The page is not a profile page or its structure changed.
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/linkbio?url=https%3A%2F%2Flnk.bio%2Fexample" \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  "https://api.scrapeatlas.com/v1/linkbio?url=https%3A%2F%2Flnk.bio%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/linkbio?url=https%3A%2F%2Flnk.bio%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(`Lnk.Bio request failed: ${data.requestId}`);
}
console.log(data);

import requests

response = requests.get(
    "https://api.scrapeatlas.com/v1/linkbio",
    headers={"x-api-key": "YOUR_API_KEY"},
    params={
        "url": "https://lnk.bio/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/linkbio?url=https%3A%2F%2Flnk.bio%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/linkbio?url=https%3A%2F%2Flnk.bio%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",
  "handle": "example",
  "id": "-123456",
  "instagram": "https://www.instagram.com/example",
  "email": "hilo@example.test",
  "tiktok": null,
  "youtube": null,
  "twitter": "https://x.com/example",
  "whatsapp": null,
  "website": "https://example.test/",
  "facebook": null,
  "links": [
    {
      "url": "https://www.instagram.com/example",
      "text": "@example"
    },
    {
      "url": "https://example.test/shop",
      "text": "Shop"
    },
    {
      "url": "mailto:hilo@example.test",
      "text": "Email me"
    }
  ],
  "name": "Synthetic Creator",
  "bio": "Synthetic bio.",
  "profilePictureUrl": "https://cdn.example.test/profilepics/-123456_1.jpg",
  "socialLinks": [
    {
      "network": "SOCIAL_IG",
      "url": "https://www.instagram.com/example"
    },
    {
      "network": "SOCIAL_TWITTERX",
      "url": "https://x.com/example"
    },
    {
      "network": "CONTACT_EM",
      "url": "mailto:hilo@example.test"
    },
    {
      "network": "CONTACT_WE",
      "url": "https://example.test/"
    }
  ],
  "sourceUrl": "https://lnk.bio/example",
  "fetchedAt": "2026-09-11T00:00:00.000Z",
  "coverage": {
    "source": "public_page",
    "complete": true,
    "warnings": []
  },
  "accounting": {
    "upstreamRequests": 1,
    "responseBytes": 70000,
    "durationMs": 300
  }
}

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."
  }
}