# Linktree on Onekey

> 2 endpoints for Linktree (1 stable, 1 beta), 1 credit each. Category: Social networks. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.
Access: 1 of 2 endpoints are marked "needs a pack" or "may need a pack": free-grant credits reach only the open fetch path; a verified email and a purchased pack unlock the rest.

Page: https://onekey.dev/platforms/linktree
Reference (Markdown): https://onekey.dev/docs/api/linktree.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 2 mapped Linktree endpoints return each:

- `author.avatarUrl` (URL): 2
- `author.bio` (string): 2
- `author.displayName` (string): 2
- `author.url` (URL): 1
- `author.username` (string): 1
- `author.verified` (boolean): 1
- plus 2 platform-specific fields under `ext.`

## Endpoints

### linktree.page

Linktree page preview (name, description, avatar).
- Price: 1 credit per fresh call. Status: beta. Access: may need a pack. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/linktree/page?handle=linktree` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `handle` (string, required): Linktree handle (the path after linktr.ee/)
- Fields returned: `author.displayName`, `author.bio`, `author.avatarUrl`, `author.url`
- Reference: https://onekey.dev/docs/api/linktree/page.md

### linktree.page_links

Linktree page with its full link list, social links and profile details.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/linktree/page_links?handle=linktree` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `handle` (string, required): Linktree handle (the path after linktr.ee/)
- Fields returned: `author.username`, `author.displayName`, `author.bio`, `author.avatarUrl`, `author.verified`, `ext.links`, `ext.socialLinks`
- Reference: https://onekey.dev/docs/api/linktree/page_links.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/linktree/page_links?handle=linktree" \
  -H "x-api-key: YOUR_API_KEY"
```