Get started
Introduction
What peekin is, what the API can do, and what it deliberately cannot.
#What peekin is
peekin is a link page for creators whose paid page is somewhere Instagram, TikTok and the rest do not like. Your bio points at a peekin page; the peekin page points at your paid page; and the paid address is never printed anywhere a platform, a crawler or a person copying the source can read it. Every visitor gets the same page. We never show a robot a different one.
Around the page sit the tools that keep it working: an exposure scanner that grades any link page on nine checks, a profile picture check, a health check on every link, a leak check that reads your own Instagram export, analytics that count people rather than taps, an email box, and domains you can own.
#What the API does
The API gives your numbers, your pages with their real destinations, and the email addresses you have collected, to a script, a spreadsheet, a dashboard or an agent. With an edit key it can also make draft pages and change pages, links and poplinks. It cannot move money, and a key is read-only unless the account owner made it to edit.
| Endpoint | What it does |
|---|---|
GET /api/v1/stats | Arrivals, paid taps, 18+ passes and social taps per page, this window against the last, with countries and top links |
GET /api/v1/pages | Your pages and every link on them, including the paid destination |
GET /api/v1/pages/:page | One page in full: look, protection, capture, links and socials |
GET /api/v1/analytics | Views, taps and people per day, per page and per link |
GET /api/v1/subscribers | The email addresses collected on your pages, newest first |
GET /api/v1/poplinks, /domains, /slug-check | Your poplinks, your domains, and whether a page address is free |
POST /api/v1/scan | All nine scanner checks on any link page, not the three the public widget shows |
POST, PATCH, DELETE on pages, links, poplinks | Edit key only. See Editing over the API |
#Who it is for
- A creator who wants their numbers in a sheet next to their platform earnings.
- An agency running several pages who wants one report across all of them.
- A developer building a tool for creators who needs a clean read on a page.
- An AI agent asked to check a page, read the numbers, or explain the product. There is an MCP server with eighteen tools that read and, with an edit key, edit, a plain-text summary at /llms.txt, and every docs page is also served as Markdown.
#Where to go next
Quickstart gets a key and makes the first call in a couple of minutes. Authentication explains keys and limits. The guides cover the product itself, and the reference covers each endpoint field by field.