Documentation

One key, one schema, every platform

Everything is a GET with your key in a header, and every response comes back in the same envelope. When a call would take longer than a request should, hand it to a job instead — that path has no timeout at all.

Endpoints

173

Platforms

Cacheable

173

hits cost 0

Spec version

0.1.0

Your first call

Put your key in the x-api-key header. There is no OAuth dance, no token exchange, and no separate sandbox host — a free key hits the same endpoints as a paid one.

request

curl "${API}/v1/youtube/channel?handle=@mkbhd" \
  -H "x-api-key: ${KEY}"

The response separates the data from the accounting. data is the unified object, meta tells you what the call cost, how long it took, and whether it came from cache.

response

{
  "success": true,
  "data": {
    "platform": "youtube",
    "id": "UCBJycsmduvYEL83R_U4JriQ",
    "handle": "mkbhd",
    "displayName": "Marques Brownlee",
    "followerCount": 20100000,
    "postCount": 1742,
    "verified": true
  },
  "meta": {
    "platform": "youtube",
    "endpoint": "youtube.channel",
    "creditsCharged": 1,
    "cached": false,
    "cacheAgeSeconds": null,
    "durationMs": 412,
    "requestId": "req_01JB8Z..."
  }
}

What you should read next

Quickstart

Key, first call, first webhook — in that order.

API reference

Every endpoint with its credit cost, generated from the spec.

Playground

Fire a real request with your own key and read the headers.

Unified schema

Creator, Post, Comment, Transcript, Ad — field by field.

Jobs & webhooks

Batching, async work, and subscribing to change.

Errors & billing

The full taxonomy and exactly what each code costs.

Platforms live on this deployment

Coverage grows by adding endpoint definitions, and the docs, the spec, the billing and the routing all follow from those definitions. What you see here is what the server actually serves right now.

The billing contract

These hold on every endpoint, on every plan, including the free one. They are numbered clauses in the specification rather than positioning, and the settlement rules spell out exactly when each applies.

You are never charged for a failed request.

You are never charged for an empty result.

Cache hits cost 0 credits.

An invalid API key is an auth error, not a billing error.

Every endpoint's price is machine-readable.

A balance can never go negative.

Per-tenant cache isolation is standard.

Hard daily spend caps.