# Linktree API

> Linktree data toolkit via ScraperSocial — resolve a Linktree page to the links and profile details it publishes.

- Skill: `nikhonit/linktree-api` (Agent Skill, multi-file: 4 files)
- Install (CLI): `npx get-skill add nikhonit/linktree-api`
- Raw SKILL.md: https://api.skillmd.com/api/skills/nikhonit/linktree-api/raw
- Safety review: pending
- Works with: Claude Code, Claude.ai, OpenAI Codex
- Category: Integrations & APIs
- License: MIT-0
- Author: nikhonit (https://skillmd.com/u/nikhonit)
- Updated: 2026-11-18
- Page: https://skillmd.com/skills/nikhonit/linktree-api

---


# Linktree API skill

Read public Linktree pages as clean JSON. This Linktree API skill has a single endpoint: give it a handle and it returns every link and profile detail that page publishes, for 1 credit. It is the standard first step in creator research — a Linktree usually enumerates every other platform an account is on.

This skill wraps **1 live Linktree endpoint** from the [ScraperSocial](https://scrapersocial.com) API. Public data only, returned as clean JSON.

## When to use this skill

- You are mapping a creator's presence and want all the channels they link to.
- You are resolving a link-in-bio into real destination URLs.
- A user pastes a Linktree handle and asks what is on it.

### Do not use this skill when

- **The page is a Linkme.** Use the `linkme-api` skill instead.
- **You need click analytics.** Those belong to the page owner; Linktree's own dashboard has them.

## Setup

```bash
export SCRAPERSOCIAL_KEY=sk_live_...   # https://scrapersocial.com/app/keys
```

Signing up at [scrapersocial.com/signup](https://scrapersocial.com/signup) includes 100 free credits, no card required.

## Permissions and scope

These scripts do exactly three things and nothing else: read one environment variable (`SCRAPERSOCIAL_KEY`), send HTTPS requests to `https://api.scrapersocial.com` (the host is a constant in the code, not configurable), and print JSON. They run as `node scripts/<name>.js` with no other shell use, no file writes and no persistence. `call_endpoint.js` accepts only the 1 documented `/v1/linktree/` paths in the table below and refuses anything else before a request is made.

## Scripts

| Script | What it does | Input | Credits |
|---|---|---|---|
| `get_page.js` | Get Linktree page. | handle | 1 credit |
| `call_endpoint.js` | Call any `/v1/linktree/` endpoint directly | path + params | varies |

Every script also accepts `--limit`, `--cursor`, `--fields`, `--format` and `--fresh`. `--limit` is clamped to 50: above that the API returns an async job instead of data.

## Example

```bash
node skills/linktree-api/scripts/get_page.js <linktree-handle>
```

Every response uses the same envelope:

```json
{ "data": {}, "meta": { "count": 20, "next_cursor": "..." }, "request_id": "a18e4ef88ad4b00b" }
```

`meta` appears on paginated endpoints only. Keep `request_id` — support traces calls with it.

## Endpoints

| Endpoint | Input | Returns | Credits | Paginated |
|---|---|---|---|---|
| `/v1/linktree/page` | handle | page | 1 credit | no |

Costs shown per item for paginated endpoints, per call otherwise. Failed calls are not charged.

## FAQ

### What does the Linktree endpoint return?

`get_page.js` with the handle returns the page's links and profile details, for 1 credit.

### Why is this useful for creator research?

A Linktree usually lists every platform a creator is active on, so one 1-credit call often tells you which of the other 32 skills in this repo to use next.

### Is this an official Linktree API?

No. ScraperSocial is independent and not affiliated with Linktree. It returns publicly available page data only.

## Links

- [Linktree data on ScraperSocial](https://scrapersocial.com)
- [All 33 platform skills](https://github.com/nikhonit/social-media-api-skills)
- [OpenAPI spec](https://scrapersocial.com/openapi.json) · [llms.txt](https://scrapersocial.com/llms.txt)

## Disclaimer

ScraperSocial is an independent product and is not affiliated with, endorsed by, or sponsored by any platform named in this repository. All product names, logos and brands are property of their respective owners. These skills return only publicly available data.

