# Linkme Link-in-Bio API Documentation

Scrappa's `GET /api/link-in-bio/linkme` endpoint reads a public Linkme profile and returns its profile details, typed social links, and outgoing link tiles as structured JSON. Pass either `handle` or a full `url`.

Social platforms are derived from each link's host, because the page itself does not label them. **Known shape difference:** Linkme's link tiles carry a title but no per-link typed icon. That field is returned as `null` and is not a gap in this endpoint — the per-link typed icon data only exists behind an authenticated surface, which this API never calls. An existing profile with nothing configured answers with HTTP 200 and an empty result. That response is not billable, and its `meta.reason` explains which case applied.

- **Documentation:** [https://scrappa.co/docs/link-in-bio-api/link_in_bio_linkme](https://scrappa.co/docs/link-in-bio-api/link_in_bio_linkme)
- **API group:** Link-in-Bio API
- **Endpoint:** `GET https://scrappa.co/api/link-in-bio/linkme`

## Authentication

Send your Scrappa API key in the `X-API-KEY` request header. Paid endpoints also support accountless x402 payments when called without an API key.

## Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `handle` | string | No | Linkme username, for example linkme. |
| `url` | string | No | Full Linkme profile URL. Used when you do not have the bare username. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/link-in-bio/linkme?handle=linkme"
```

## Example response

```json
{
    "provider": "linkme",
    "handle": "linkme",
    "profile": {
        "handle": "linkme",
        "name": "@linkme",
        "description": "One link for everything.",
        "url": "https://link.me/linkme",
        "image": "https://cdn.example.com/avatar.webp",
        "created_at": "2021-05-11T17:44:18.000Z",
        "updated_at": "2026-09-01T22:15:14.000Z"
    },
    "socials": [
        {
            "platform": "instagram",
            "url": "https://www.instagram.com/LinkMe"
        },
        {
            "platform": "tiktok",
            "url": "https://www.tiktok.com/@joinlinkme"
        }
    ],
    "links": [
        {
            "url": "https://youtu.be/gxNwMAHxAXQ",
            "title": "Road to a $1B Company Ep. 3",
            "icon": null
        }
    ],
    "meta": {
        "duration_ms": 910,
        "attempts": 1,
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Profile Not Found | No public profile exists for this handle. |
| 503 | Upstream Unavailable | The profile could not be read from its source right now. Please retry. |
| 422 | Request Rejected Upstream | The source rejected this request, for example because the handle was not acceptable to it. |
| 503 | Profile Host Blocked the Request | The provider's bot protection refused this request after every available exit was tried. This is not a billing event; retry later. |
| 422 | Invalid Handle or URL | The handle was not in a supported format, or the URL did not belong to this endpoint's provider. |

## More Scrappa resources

- [API documentation](https://scrappa.co/docs)
- [Full LLM-readable API reference](https://scrappa.co/llms-full.txt)
- [OpenAPI specification](https://scrappa.co/docs/api.json)
- [Pricing](https://scrappa.co/pricing)