# peekin docs

https://peekin.bio/docs

## Get started

- [Introduction](https://peekin.bio/docs/introduction.md): What peekin is, what the API can do, and what it deliberately cannot.
- [Quickstart](https://peekin.bio/docs/quickstart.md): A key, a first call, and your numbers in a terminal in under five minutes.
- [Authentication](https://peekin.bio/docs/authentication.md): Bearer keys, what they can reach, how to revoke one, and the limits on each.

## Guides

- [Pages and links](https://peekin.bio/docs/pages-and-links.md): How a page is built, what a paid link actually does, and where the picker puts everything.
- [The exposure scanner](https://peekin.bio/docs/the-scanner.md): Nine checks, one score, and what each one costs you if it fails.
- [Analytics](https://peekin.bio/docs/analytics.md): People, not taps. What each number means and where it comes from.
- [Campaigns and tracking links](https://peekin.bio/docs/campaign-tracking.md): Which post made money: one address per post, your own OnlyFans or Fansly tracking link behind it.
- [Email capture](https://peekin.bio/docs/email-capture.md): A box on your page, a list in your account, and who is responsible for it.
- [Custom domains](https://peekin.bio/docs/custom-domains.md): Your page goes live on a shared address, included. Your own domain is the upgrade: bring one free, or buy one here by the year.
- [Team seats](https://peekin.bio/docs/team-seats.md): Teammates with their own login and a role, on Pro and Agency.
- [Error handling](https://peekin.bio/docs/error-handling.md): What an error looks like, every status you can get, and how to retry without making it worse.

## API reference

- [GET /api/v1/stats](https://peekin.bio/docs/api-stats.md): Your numbers per page, this window against the last.
- [GET /api/v1/pages](https://peekin.bio/docs/api-pages.md): Your pages and every link on them, destinations included.
- [GET /api/v1/subscribers](https://peekin.bio/docs/api-subscribers.md): Read the email addresses collected on your pages over the API: one page or all, with the country and date each was added.
- [Editing over the API](https://peekin.bio/docs/api-write.md): Create and change pages, links and poplinks over the API with an edit key, and what needs an explicit confirm.
- [MCP server](https://peekin.bio/docs/mcp.md): Eighteen tools for an agent: read with any key, edit with an edit key.
- [POST /api/v1/scan](https://peekin.bio/docs/api-scan.md): Run all nine exposure checks on any link page from your own code, and read the score and each result.