API
REST API Reference
The REST API exposes the datasets behind the terminal plus your own journal. Base URL: https://www.analytics-fx.com/api/v1.
Authentication
Every request needs an API key in the Authorization header as a bearer token. Create and manage keys at /dashboard/api. The raw key is shown once at creation; store it securely.
Authorization: Bearer afx_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxRequests without a valid key return 401.
Usage and credits
Anyone can test the API for free with a small monthly allowance. An active Analytics plan includes 2000 credits every month. Beyond that, requests draw from your prepaid credit balance, and different endpoints cost different amounts.
When the allowance and balance are exhausted, requests return 429 with reset headers. Check usage at GET /api/v1/usage or on the dashboard.
Endpoints
Every endpoint returns the standard envelope and counts against your credits as shown. Lists are paginated where noted.
/api/v1/symbolsFree/api/v1/seasonality/{symbol}1 credit/api/v1/seasonality1 credit/api/v1/cot/{currency}1 credit/api/v1/cot1 credit/api/v1/journal/trades2 credits · owner-scoped/api/v1/journal/positions1 credit · owner-scoped/api/v1/journal/trades1 credit · owner-scoped/api/v1/journal/trades1 credit · owner-scoped/api/v1/journal/accounts5 credits · owner-scoped/api/v1/journal/trades/screenshot2 credits · owner-scoped/api/v1/usageFree · owner-scoped/api/v1/backtests2 credits · owner-scoped/api/v1/backtests/{id}/trades2 credits · owner-scoped/api/v1/backtests/{id}2 credits · owner-scoped/api/v1/backtests/{id}1 credit · owner-scoped/api/v1/forward/accounts2 credits · owner-scoped/api/v1/forward/accounts/{id}2 credits · owner-scoped/api/v1/forward/accounts/{id}/trades2 credits · owner-scoped/api/v1/forward/accounts/{id}/trades2 credits · owner-scoped/api/v1/forward/trades/{id}2 credits · owner-scoped/api/v1/forward/trades/{id}1 credit · owner-scoped/api/v1/forward/trades/{id}1 credit · owner-scoped/api/v1/gex/{symbol}2 credits/api/v1/zeta/{asset}1 credit/api/v1/ml/{currency}1 credit/api/v1/news1 credit/api/v1/screener/{symbol}2 credits/api/v1/montecarlo2 creditsFor machines
Machine-readable OpenAPI 3.1 spec: /api/v1/openapi.json. AI agents can also read /llms.txt.
Versioning and deprecation
Nothing is deprecated today. When an endpoint eventually is, it stays live for at least six months from the date it is marked deprecated to the date it is removed (sunset), so integrations have time to migrate. New response fields can be added to any endpoint at any time without a version bump; only removing or renaming a field, or changing its meaning, counts as breaking.
A deprecated endpoint's responses carry three headers: Deprecation (the date it was marked deprecated), Sunset (the date it stops responding), and, when a replacement exists, Link: </api/v1/...>; rel="successor-version" pointing at it. Watch for these headers rather than for breaking changes landing without notice.
Notes
Journal endpoints only ever return data owned by the key holder. Dataset responses are versioned under /api/v1 and are independent of the internal terminal routes, so they will not change underneath you without a version bump.