Documentation

Build with TickAtlas. From first request to production.

Ordinary HTTP, API-key authentication and JSON responses. Start with one endpoint, then add economic events, 42 indicator series, screeners, historical data or streaming as your application grows.

X-API-Key header Consistent error objects Python, JavaScript, PHP, Go
docs · quickstart
01 · first request

Your first authenticated call

One header, one endpoint. The response shape below is the same one every endpoint returns.

GET /v1/indicator?symbol=EURUSD&indicator=RSI_14&timeframe=H1
X-API-Key: YOUR_API_KEY
Quickstart

From API key to useful data in three steps.

01

Create an account

Signup mints an API key and $2.50 of starting credit. No card required.

02

Send the header

Every request carries X-API-Key. There is no OAuth dance and no token refresh.

03

Read the envelope

Responses share one shape, so the parsing you write once works across the API.

/v1/indicator
curl -H "X-API-Key: YOUR_API_KEY" \
  "https://tickatlas.com/v1/indicator?symbol=EURUSD&indicator=RSI_14&timeframe=H1"
{
  "symbol": "EURUSD",
  "timeframe": "H1",
  "indicator": "RSI_14",
  "value": 58.4
}
SDKs

Use HTTP directly, or let the client library handle the plumbing.

Nothing in the API requires an SDK — it is plain REST. The official clients exist to wrap authentication, retries and pagination so you do not write them again.

Python pip install tickatlas Docs →
JavaScript npm install tickatlas Docs →
PHP composer require tickatlas/sdk Docs →
Go go get github.com/tickatlas/go Docs →
Production readiness

From 200 OK to production.

The six things that separate a working prototype from an integration that survives real traffic.

Throughput

Respect the rate limit

Limits are per-key and per-minute. A 429 carries the window so you can back off precisely.

Failure

Handle errors explicitly

Error objects are consistent across endpoints. Treat the code, not the message, as the contract.

Clients

Use an SDK or plain HTTP

The SDKs wrap auth and retries. Nothing in the API requires them.

Secrets

Keep keys server-side

A key in browser JavaScript is a public key. Proxy through your own backend instead.

Change

Watch the changelog

Breaking changes are versioned and announced there before they land.

Diagnosis

Check troubleshooting first

Most integration problems are one of a handful of documented causes.

Something not working?

Start with troubleshooting — most integration problems are one of a handful of documented causes. If it is not there, contact us with the request and the error body.

Platform status

Live availability for the API, the data pipeline and the Market Monitor.

Status is published on /status
Start building

Start with one request. Scale from there.

Create an account, send one authenticated GET, and add the rest of the platform as your application needs it.