Skip to content
Social

Link-in-Bio Lookup

Every link and the profile info behind a Linktree, Komi, Pillar, Lnk.bio or Linkme page.

POST/v1/link-in-bio-lookup
3 creditsBulk supportedNewLinktree, Komi, Pillar, Lnk.bio and Linkme
Request
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"}'
Response
{
  "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>required

Your 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>required

Link-in-bio URL. Example: https://linktr.ee/northwindcoffee

freshboolean

Skip the 7-day cache and run a new lookup. Charged as a normal lookup.

referencestring

Your 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.

successboolean

true when the lookup ran.

data.providerstring

Which link-in-bio service hosts the page.

data.profile.display_namestring

The name shown at the top of the page.

data.profile.biostring

The short description on the page, when the owner wrote one.

data.profile.image_urlstring

URL of the avatar or logo used on the page.

data.links[].titlevalue

The label the owner gave the link.

data.links[].urlvalue

The destination the link points to.

meta.credits_usednumber

Credits charged for this call.

meta.credits_remainingnumber

Your balance after the call.

meta.cachedboolean

true when the result came from the 7-day cache.

meta.request_idstring

Quote 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.

HTTPCodeMeaning
401unauthorizedThe key is missing, malformed or revoked.
402insufficient_creditsYour credits are used up and pay as you go is off or at its limit.
422invalid_inputA field is missing or malformed. The field property names it.
429rate_limitedToo many requests for this key. Wait for the Retry-After interval.
500internal_errorSomething failed on our side. Safe to retry.
503source_unavailableAn 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