Link-in-Bio Lookup

Fetches a public link-in-bio page and returns its profile title, description and outbound links.

POST https://YOUR_API_HOST/v1/link-in-bio-lookup

Credits and caching

Success billing. 3 credits per resolved page (dead or empty pages are free). You are charged only when the lookup finds something; a not-found result is free.
Results are cached per account for 7 days. Repeating the same lookup in that window is free and returns cache_hit: true.
Invalid input, rate limits and errors are never charged.
Read the billing rules for the full picture.

Request

Send a JSON body with Authorization: Bearer <key>. The body can be up to 64 KB.

Field	Type	Required	Notes
`url`	string	yes	Up to 2048 characters.

Example request

Terminal

curl -X POST https://YOUR_API_HOST/v1/link-in-bio-lookup \
  -H "Authorization: Bearer $LOOKVALID_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://linktr.ee/linktree"}'

1const response = await fetch("https://YOUR_API_HOST/v1/link-in-bio-lookup", {
2  method: "POST",
3  headers: {
4    Authorization: `Bearer ${process.env.LOOKVALID_API_KEY}`,
5    "Content-Type": "application/json",
6  },
7  body: JSON.stringify({
8    "url": "https://linktr.ee/linktree"
9  }),
10});
11
12const result = await response.json();
13if (!response.ok) throw new Error(`${result.error.code}: ${result.error.fix}`);
14console.log(result.found, result.data, result.credits_charged);

1import os
2import requests
3
4response = requests.post(
5    "https://YOUR_API_HOST/v1/link-in-bio-lookup",
6    headers={"Authorization": f"Bearer {os.environ['LOOKVALID_API_KEY']}"},
7    json={
8        "url": "https://linktr.ee/linktree",
9    },
10    timeout=30,
11)
12result = response.json()
13if not response.ok:
14    raise RuntimeError(f"{result['error']['code']}: {result['error']['fix']}")
15print(result["found"], result["data"], result["credits_charged"])

Response

The status is 200 whether or not anything was found. Check found. Every response also carries the X-Request-Id, X-Credits-Charged, X-Credits-Remaining and X-RateLimit-* headers.

Envelope

Field	Type	Notes
`request_id`	string	-
`product`	"link-in-bio-lookup"	-
`found`	boolean	False means the lookup ran and found nothing; it is free.
`reason`	string or null	Why nothing was found; null when found.
`sources`	array of string	Where the data came from, including any attribution the licence requires.
`credits_charged`	integer	0 for a cache hit, a not-found result or an error.
`credits_remaining`	integer	-
`cache_hit`	boolean	True when the account already paid for this lookup within the cache window.
`cache`	object	-

The `data` object

Present when found is true, otherwise null.

Field	Type	Notes
`platform`	string	One of `linktree`, `beacons`, `biolink`, `lnkbio`, `stan`, `generic`.
`final_url`	string	-
`username`	string or null	-
`profile_name`	string or null	-
`description`	string or null	-
`links`	array of object	-
`links[].title`	string	-
`links[].url`	string	-
`social_icons`	array of object	-
`social_icons[].platform`	string	-
`social_icons[].handle`	string or null	-
`social_icons[].url`	string	-
`fetched_at`	string	-

Captured example (2026-10-18)

A real run of this lookup on 2026-10-18, using the request above, which is a public input. The envelope fields are left out.

1{
2  "product": "link-in-bio-lookup",
3  "found": true,
4  "data": {
5    "platform": "linktree",
6    "final_url": "https://linktr.ee/linktree",
7    "username": "linktree",
8    "profile_name": "Linktree",
9    "description": null,
10    "links": [
11      {
12        "title": "Linktree's Linktree",
13        "url": "https://linktr.ee/linktr.ee"
14      }
15    ],
16    "social_icons": [],
17    "fetched_at": "2026-10-18T02:06:03.810Z"
18  },
19  "sources": [
20    "https://linktr.ee"
21  ]
22}

Errors

400 invalid_input: The request input is invalid.
401 unauthorized: The API key is missing, malformed, revoked or unknown.
402 insufficient_credits: The account does not have enough credits for this lookup. Error code: insufficient_credits. During a trial whose allowance is used up the code is trial_allowance_exhausted: nothing is charged and the customer starts the plan from the billing page.
405 method_not_allowed: This endpoint does not accept that HTTP method.
413 payload_too_large: The request body is too large.
429 rate_limited: Too many requests for this API key.
500 internal_error: An unexpected error occurred.
503 provider_unavailable: The data source for this product is unavailable right now.