# Linktree API guide



## Choose a Linktree operation



Start with the object your task needs. The groups below use the current catalogue; open an endpoint to check accepted identifiers, filters, price and availability before retrieving.



### Other operations



- [Linktree page](https://www.monocrawl.com/docs/endpoints/linktree/page) — Creator identity and every outbound link on a public Linktree page.



## Check fields and collection limits



Use the endpoint’s declared parameters and returned continuation. Filters from another platform do not automatically apply here. Preserve source identifiers, URLs and warnings; a successful page does not establish complete history. Published response schemas identify whether they come from a reviewed shaper or observed response shapes.



Agents can use `get_endpoint` for the current contract and `get_docs` with topic `platforms/linktree` to read this page. The [coverage guide](https://www.monocrawl.com/docs/data-availability) explains nulls and partial results, and the [production guide](https://www.monocrawl.com/docs/production-checklist) covers budgets and recovery.



## Endpoint reference

## linktree/page

`GET /v1/linktree/page`

Creator identity and every outbound link on a public Linktree page.

*Linktree page*

| Parameter | Required | Description |
| --- | --- | --- |
| `url` | yes | Full Linktree URL or the bare handle — e.g. `https://linktr.ee/linktree` |
| `dry_run` | no | Read a zero-credit estimate without fetching sources, running AI, or reserving credits. Cache status is a snapshot, not a guarantee at execution. Accepted values: 1, 0, true, false. Case, spaces, hyphens and underscores are interchangeable. — e.g. `1` |

### Useful optional inputs

- `dry_run`: Read a free estimate before fetching sources or scheduling paid work. Zero credits; cache status and availability are snapshots rather than guarantees.

**Cost:** 1 credit at list price per successful uncached response; variable-cost operations may quote or settle a different charge. Confirmed uncharged or refunded failures report zero. Pending reconciliation can report credits_used:null; retain request_id and the original idempotency key.

```bash
curl "https://www.monocrawl.com/v1/linktree/page?url=https%3A%2F%2Flinktr.ee%2Flinktree" \
  -H "x-api-key: mn_your_key_here"
```

### Response data

Illustrative abbreviated data; documented core fields are optional and may be null. Additional source fields are allowed.

```json
{
  "_warnings": [],
  "avatar": "https://example.com/example",
  "bio": "example",
  "extraction": "example",
  "handle": "example",
  "is_locked": false,
  "link_count": 0,
  "links": [
    {
      "position": 0,
      "thumbnail": "example",
      "title": "example",
      "type": "example",
      "url": "https://example.com/example"
    }
  ],
  "name": "example",
  "platform": "example",
  "social_links": [
    {
      "platform": "example",
      "url": "https://example.com/example"
    }
  ],
  "status": 0,
  "url": "https://example.com/example",
  "verified": false
}
```

[Field reference](https://www.monocrawl.com/docs/endpoints/linktree/page#response) · [JSON Schema for response.data](https://www.monocrawl.com/schemas/linktree/page.json)

