Link-in-Bio Lookup
Every link and the profile info behind a Linktree, Komi, Pillar, Lnk.bio or Linkme page.
curl -X POST https://api.1lookup.dev/v1/link-in-bio-lookup \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://linktr.ee/northwindcoffee"}'{
"success": true,
"data": {
"url": "https://linktr.ee/northwindcoffee",
"provider": "linktree",
"profile": {
"username": "northwindcoffee",
"display_name": "Northwind Coffee Roasters",
"bio": "Small-batch roasters in Portland, OR.",
"image_url": "https://cdn.example.com/link-in-bio/northwindcoffee.jpg"
},
"links": [
{
"title": "Shop the fall lineup",
"url": "https://northwind.example/shop"
},
{
"title": "Wholesale inquiries",
"url": "https://northwind.example/wholesale"
},
{
"title": "Join the newsletter",
"url": "https://northwind.example/newsletter"
}
]
},
"meta": {
"credits_used": 3,
"credits_remaining": 999,
"cached": false,
"request_id": "req_8f3a2c1e9b7d"
}
}Authorization
Authorizationstring<bearer>requiredYour API key as a Bearer token. Live keys start with 1lk_live_. Test keys start with 1lk_test_ and return this endpoint's sample response without spending credits. See authentication.
Body
Send the fields as a JSON object with Content-Type: application/json.
urlstring<uri>requiredLink-in-bio URL. Example: https://linktr.ee/northwindcoffee
freshbooleanSkip the 7-day cache and run a new lookup. Charged as a normal lookup.
referencestringYour own identifier, echoed back in meta and shown in lookup history.
Response
A 200 response carries the result in data and the cost of the call in meta. These are the fields most integrations read.
successbooleantrue when the lookup ran.
data.providerstringWhich link-in-bio service hosts the page.
data.profile.display_namestringThe name shown at the top of the page.
data.profile.biostringThe short description on the page, when the owner wrote one.
data.profile.image_urlstringURL of the avatar or logo used on the page.
data.links[].titlevalueThe label the owner gave the link.
data.links[].urlvalueThe destination the link points to.
meta.credits_usednumberCredits charged for this call.
meta.credits_remainingnumberYour balance after the call.
meta.cachedbooleantrue when the result came from the 7-day cache.
meta.request_idstringQuote this when you contact support.
Errors
A failed request returns success: false with an error object, and is never charged. The full list is on the errors page.
| HTTP | Code | Meaning |
|---|---|---|
| 401 | unauthorized | The key is missing, malformed or revoked. |
| 402 | insufficient_credits | Your credits are used up and pay as you go is off or at its limit. |
| 422 | invalid_input | A field is missing or malformed. The field property names it. |
| 429 | rate_limited | Too many requests for this key. Wait for the Retry-After interval. |
| 500 | internal_error | Something failed on our side. Safe to retry. |
| 503 | source_unavailable | An upstream source did not answer in time. Safe to retry. |
Billing
3 credits. Charged when the lookup runs and returns a result. Errors are never charged, and repeating the same input within 7 days is served from cache at no charge.
Product overview and use cases