Docs
View as Markdown

Onekey documentation

Onekey is one API for public data from many platforms. You send one kind of request with one key, and you always get back the same JSON shape, whichever platform answered. Pricing is a flat, published number of credits per endpoint, and failed calls are refunded.

Right now there are 1,995 endpoints across 294 platforms (1,292 verified against the live source). The list grows all the time; the platform catalog is always current.

How it works#

  1. 1

    Get a key

    Sign up and copy your key. 1,000 free credits, no card.

    ok_live_a1b2…
  2. 2

    Make a call

    Same request shape for every platform.

    GET /v1/github/profile
  3. 3

    Get unified JSON

    One shape back, with the cost inside.

    { success, data, metadata }

Where to go next#

  • New here? Do the Quickstart. It takes about a minute.
  • Wondering what things cost? Read Credits & pricing.
  • Something failed? See Errors, and check the free status endpoint before you retry.
  • Paging through a list, or retrying safely? See Pagination and Idempotency.
  • Have a link rather than an endpoint in mind? Paste it into URL lookup.
  • Many calls at once? Send them as one batch, or run one query across platforms with multi-platform search, and stream the answers as they arrive.
  • Want a ready-made engagement rate or language? Read about the computed block.
  • Looking for a platform? Browse the platform catalog.
  • Want one query planned across platforms? See universal search. For a brand, a creator or a topic in one answer, see the reports.
  • Want to be told when data changes? Save the call as a monitor and get a signed webhook instead of polling.
  • Building with an AI agent? Start at AI agents: every page here is also available as Markdown. Connect the hosted MCP server, or follow an integration guide for n8n, LangChain, the Vercel AI SDK or Claude Code.

The shape of every call#

shell
GET https://api.onekey.dev/v1/{platform}/{endpoint}?{params}
x-api-key: YOUR_API_KEY

To switch platforms you change two words in the path. The rest of your code stays the same.

More routes build on the same endpoints and answer in the same shape:

RouteWhat it does
GET /v1/lookup?url=Resolves a public URL to its endpoint and serves it. See URL lookup.
POST /v1/batchUp to 100 endpoint calls in one request, one row each. See Batch.
GET /v1/search/multi, GET /v1/creator/cardOne query or handle across several platforms, side by side. See Multi-platform search.
Any of the three with Accept: text/event-streamRows as they arrive. See Streaming.
GET /v1/search/universalOne query planned across platforms and rank-fused. See Universal search.
GET /v1/reports/{kind}A brand, a creator or a topic in one answer. See Reports.
POST /v1/monitorsA saved call re-run on a schedule, with a signed webhook when the data changes. See Monitors.