# Linktree Profile API Documentation

Retrieve the public profile of a Linktree creator: username, display name, bio, verified flags, profile image, and for each link the title, url, type, position, thumbnail, children and metadata. Social links include the platform type, url and position. A valid profile with zero links is a successful response.

- **Documentation:** [https://scrappa.co/docs/linktree-api/linktree_profile](https://scrappa.co/docs/linktree-api/linktree_profile)
- **API group:** Linktree API
- **Endpoint:** `GET https://scrappa.co/api/linktree/profile`

## 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 |
| --- | --- | --- | --- |
| `username` | string | Yes | Linktree username, e.g. linktree. Example: linktree. |

## Example request

```bash
#!/bin/bash

curl -X GET \
    -H "x-api-key: YOUR_API_KEY_HERE" \
    "https://scrappa.co/api/linktree/profile?username=linktree"
```

## Example response

```json
{
    "success": true,
    "data": {
        "username": "linktree",
        "page_title": "Linktree",
        "description": null,
        "verified": false,
        "profile_image": null,
        "is_profile_verified": false,
        "has_sensitive_content": false,
        "content_gating": null,
        "theme": {
            "key": "leaf",
            "mode": "light"
        },
        "links": [
            {
                "id": "589138106",
                "title": "Linktree's Linktree",
                "url": "https://linktr.ee/linktr.ee",
                "type": "CLASSIC",
                "position": 1,
                "thumbnail": "https://ugc.production.linktr.ee/b2f4b99c-linktr.ee.jpeg",
                "children": [],
                "meta_data": {
                    "title": "Welcome to our Linktree | Linktree",
                    "description": "A place to discover everything going on in the world of Linktree"
                }
            },
            {
                "id": "98304012",
                "title": "Homepage",
                "url": "https://linktr.ee/linktr.ee",
                "type": "CLASSIC",
                "position": 2,
                "thumbnail": null,
                "children": [],
                "meta_data": null
            }
        ],
        "pinned_links": [],
        "socials": []
    },
    "meta": {
        "endpoint_family": "profile_detail",
        "billable": true
    }
}
```

## Errors

| Status | Error | Description |
| --- | --- | --- |
| 404 | Profile Not Found | No public profile exists for this username. |
| 503 | Upstream Unavailable | The profile could not be read from its source right now. Please retry. |
| 503 | Parse Error | The Linktree response could not be parsed. Please retry. |

## 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)