Getting started

Authentication

All requests are authenticated with a bearer token sent in the Authorization header. The API does not use OAuth, sessions, or per-request signing.

Header format

Authorization: Bearer YOUR_KEY

Requests without this header return 401 Unauthorized. Invalid keys return 401 with { "error": { "code": "unauthorized" } } in the response body. See errors for the full envelope.

Quickstart

Confirm a key is active by requesting any tracked ticker.

curl https://api.tickerbot.io/v1/tickers/AAPL \
  -H "Authorization: Bearer YOUR_KEY"

A 200 indicates the key is valid. 401 indicates the key is missing or invalid; 403 indicates the key is valid but the requested capability is not included in the key's plan.

Issuing keys

Keys are issued from the dashboard at tickerbot.io/api. The first key is shown after checkout; additional keys — for staging, CI, or per-environment isolation — are created from the dashboard.

Keys are independent. Usage counts, rate limits, and webhook ownership are scoped to the issuing key, not the account. Rotating a key does not transfer ownership of resources created by the previous key.

Plans

Reads
$99/mo
Every read endpoint, no commitments.
Best for Prototyping, batch analytics, polling-driven apps, backtesting against recent history.
Read + Write + Realtime
$299/mo
Reads plus webhook delivery.
Best for Production trading bots, alert apps, Discord scanner bots — anything that needs push updates instead of polling.
FeatureReadsRead + Write + Realtime
Daily request cap100,0001,000,000
Burst rate10 req/sec10 req/sec
Historical depth30 days1 year
GET /tickers/{ticker} and bulkYesYes
GET /signals/{ticker}/{signal}YesYes
GET/POST /scanYesYes
POST/GET/DELETE /webhooksYes
Crypto coverage (top 100 by mcap)YesYes
US equities coverage (~12,000 tickers)YesYes

Handling keys

  • Keys are credentials. Do not commit them to source control, embed them in mobile applications, or include them in browser bundles.
  • Use separate keys for staging and production environments.
  • Revoke exposed keys from the dashboard. Revocation takes effect immediately.