API reference
Build with public social data.
Profiles, links, clips, and discussions. Choose a platform to explore its endpoints and make your first request.
Bluesky
Retrieve public Bluesky profiles, paginated user posts, and individual posts with nested replies.
Live private service · production acceptance passedKick
Retrieve a public Kick clip with media URLs, counts, timestamps, category, creator, and channel details.
Live private serviceKomi
Retrieve creator profiles, social accounts, and rich links from public Komi pages.
Live private serviceLinkme
Retrieve a public Linkme profile with grouped contact links, social links, and page settings.
Live private serviceLinktree
Retrieve a public profile and its published links in one request.
Live private servicePillar
Retrieve a public Pillar creator profile, social links, link click counts, and featured products.
Live private serviceSearch public pins, retrieve pin details, browse user boards, and read board pins.
Live private service · production acceptance passedDiscover public discussions and retrieve posts with bounded comments.
Live private service · intermittent proxy failuresTwitch
Retrieve Twitch profiles, video pages, weekly schedules and complete public clips.
Private · profile challengedMake your first request
Start the Linktree worker locally, then request a public profile using its dedicated service key. The profile URL below is a placeholder.
export BASE_URL="http://localhost:3007"
export API_KEY="your-service-key"
curl --get "$BASE_URL/v1/linktree" \
-H "x-api-key: $API_KEY" \
--data-urlencode "url=https://linktr.ee/example"Authentication
Each worker uses its own authentication header. Obtain the key and service origin from your operator. Send keys in headers and keep them on your server.
| Worker | Header | Configuration |
|---|---|---|
| Bluesky | x-api-key | BLUESKY_API_KEY |
| Kick | x-api-key | KICK_API_KEY |
| Komi | x-api-key | KOMI_API_KEY |
| Linkme | x-api-key | LINKME_API_KEY |
| Linktree | x-api-key | LINKTREE_API_KEY |
| Pillar | x-api-key | PILLAR_API_KEY |
| x-api-key | PINTEREST_API_KEY | |
| x-reddit-retrieval-secret | REDDIT_RETRIEVAL_SERVICE_SECRET | |
| Twitch | x-api-key | TWITCH_API_KEY |
These are service keys. Customer sign-up, quotas, credit billing, and a unified public API gateway are not available yet.
Understand the result
Success
The supported fields were retrieved. Coverage describes the public page, not every possible piece of account data.
Partial
Usable data is available, but a limit or missing field prevented complete coverage. Inspect warnings or failure details.
Failed or challenged
Retrieval could not complete. Use the explicit failure code to decide whether to retry.
Deployment status
See each platform for current private service availability. There is no public production domain yet; examples use localhost. The workers can deploy independently from this repository.