# Link-in-Bio Lookup (`linkinbio.lookup`)

Resolve a creator's link-in-bio page (Linktree, Komi, Pillar, Lnk.bio, Linkme) into its title, socials, contact email and every link.

Docs: https://primaryapi.com/docs/api-reference/linkinbio/lookup

- Endpoint: `POST https://api.primaryapi.com/v1/run/linkinbio.lookup`
- Category: Social · Platform: `linkinbio` · Kind: composite · Status: live
- Price: 1 credit per call; up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost.
- Billing unit: per successful call
- Reliability: routed to a healthy upstream and retried automatically when an attempt fails; live 30-day status: `GET https://api.primaryapi.com/v1/status/apis?sku=linkinbio.lookup`
- Execution: synchronous (answers 202 only if it outlives the wait window)

## Input

| Field | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
| `url` | string | yes |  | max 2048 chars; format: uri | URL of a link-in-bio page on Linktree, Komi, Pillar, Lnk.bio or Linkme, for example https://linktr.ee/linktree (the service is detected from the host). |

Unknown fields are rejected with `400 invalid_input`. The routing controls `preferLatencyUnderMs` and `maxCredits` may be sent in the same JSON body.

## Output

When `output.found` is `true`, `output.data` has this shape:

| Field | Type | Description |
|---|---|---|
| `service` | enum |  |
| `url` | string | The page that was read |
| `id` | string \| null |  |
| `username` | string \| null |  |
| `title` | string \| null |  |
| `description` | string \| null |  |
| `avatarUrl` | string \| null |  |
| `verticals` | string[] |  |
| `timezone` | string \| null |  |
| `email` | string \| null | Contact email published on the page (personal data: pass through, do not retain) |
| `instagram` | string \| null |  |
| `tiktok` | string \| null |  |
| `youtube` | string \| null |  |
| `x` | string \| null |  |
| `facebook` | string \| null |  |
| `linkedin` | string \| null |  |
| `spotify` | string \| null |  |
| `twitch` | string \| null |  |
| `soundcloud` | string \| null |  |
| `appleMusic` | string \| null |  |
| `applePodcast` | string \| null |  |
| `links` | object[] |  |
| `links[].id` | string \| null |  |
| `links[].type` | string \| null |  |
| `links[].title` | string \| null |  |
| `links[].url` | string \| null | Destination; null when the link sits behind a gate |
| `links[].locked` | boolean \| null | Link sits behind its own gate (age, passcode, sensitive content); null when unknown |
| `links[].thumbnailUrl` | string \| null |  |
| `linkCount` | integer |  |
| `locked` | boolean \| null | Whole page behind a password, age or sensitive-content gate: identity fields only, no links or socials; null when unknown |
| `verified` | boolean \| null | Service verification badge, when the source reports it |

When the thing you asked about does not exist (or a search matches nothing) the call still succeeds: `output.found` is `false`, `output.data` is `null` and `output.reason` says why (`not_found`, `private`, `no_results`, …). Misses are free unless the notes below say misses are billed.

## Example request

```bash
curl -sS -X POST "https://api.primaryapi.com/v1/run/linkinbio.lookup" \
  -H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://linktr.ee/linktree"}'
```

## Example response

_Values are placeholders that follow the output schema; `credits` is what this call would cost at the usual price._

```json
{
  "output": {
    "found": true,
    "data": {
      "service": "linktree",
      "url": "https://linktr.ee/linktree",
      "id": "string",
      "username": "string",
      "title": "string",
      "description": "string",
      "avatarUrl": "https://example.com",
      "verticals": [
        "string"
      ],
      "timezone": "string",
      "email": "string",
      "instagram": "string",
      "tiktok": "string",
      "youtube": "string",
      "x": "string",
      "facebook": "string",
      "linkedin": "string",
      "spotify": "string",
      "twitch": "string",
      "soundcloud": "string",
      "appleMusic": "string",
      "applePodcast": "string",
      "links": [
        {
          "id": "string",
          "type": "string",
          "title": "string",
          "url": "https://linktr.ee/linktree",
          "locked": true,
          "thumbnailUrl": "https://example.com"
        }
      ],
      "linkCount": 0,
      "locked": true,
      "verified": true
    }
  },
  "provider": "PrimaryAPI",
  "credits": 1,
  "items": 1,
  "requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z"
}
```

## Pricing and reliability

- Usual price: 1 credit per call
- Price ceiling: up to 3 credits if a call is retried elsewhere. A quote’s `maxCredits` is the most a given call can cost; the `maxCredits` routing control caps it per call
- Live 30-day status, success rate, uptime and latency: `GET https://api.primaryapi.com/v1/status/apis?sku=linkinbio.lookup`

## Errors to handle

`invalid_input`, `unauthorized`, `insufficient_balance`, `key_limit_reached`, `trial_cap_reached`, `forbidden`, `not_found`, `idempotency_conflict`, `rate_limited`, `all_sources_failed`, `service_unavailable`, `timeout`. See https://primaryapi.com/docs/errors.

## Notes

Linktree pages are read in-process from their public HTML (exercised live 2026-10-30). A page with no links and no socials is a free miss (empty_page). Pages are public, but scraping them may breach each service's terms: customers carry lawful-use responsibility. Contact emails are personal data: pass through only.

