Getting Started
Authentication
All endpoints other than /v1/health require an API key on every request. You create your own keys from your platform profile — there is nothing to apply for. A freshly minted key can only introspect itself (/v1/me, /v1/me/keys) until an administrator opens data endpoints on your account.
Presenting the key
Transmit the key solely in the Authorization header as a Bearer token. Do not place the key in a query string.
Header
Authorization: Bearer sxk_live_4f9c…
What a key can call
One list decides everything: the endpoint allow-list carried on the key. There are no scopes and no permission tiers. Endpoint access is deny-by-default — customers do not receive the full surface by minting a key. A key you create for yourself starts with the self-service endpoints only — /v1/health, /v1/me and /v1/me/keys. The catalogue, signals, portfolio, performance, benchmarks and analytics routes documented here are opened by an administrator, on your account ceiling or on the key itself. The three administrative endpoints are excluded and are effective only on a platform administrator's key. Calling an endpoint that is not on your key's list returns 403 endpoint_not_allowed, naming the registry id in error.details; /v1/me lists the ids in force under callable_endpoints.
Your account carries a ceiling that every key is clamped to. When the console mints a key with every selectable endpoint ticked — or with endpoint_allow omitted / { "mode": "all" } — the key receives that ceiling as-is. A meta-only ceiling stays meta-only; a wide ceiling (mode all, or a full customer list) is what lets a granted account mint keys that can call the data routes. Mode all never invents administrative routes for a non-admin account.
Two further per-key settings sit alongside it. An alpha allow-list may restrict a key to named alphas. By default a new account may only read testing alphas — collection ids starting with Test_ — once catalogue access itself is granted; production alphas need an administrator grant. A raw-book flag admits the unsmoothed signal fields and raw_ books; it is off by default. An administrator can narrow or widen any of these on a given key.
| Catalogue | /v1/alphas (slim list), /v1/alphas/{alpha} (description), source download. |
| Signals | Weekly rebalances, cross-sections and score panels. |
| Portfolio | Daily books: ledger, positions, P&L, trades and equity curves. |
| Performance | Performance metrics: /metrics, and cross-alpha analytics. |
| Administration | Operator-only routes; never on a self-service key. |
Confirming a key
Example
curl -H "Authorization: Bearer sxk_live_4f9c…" \ "https://api.simicx.com/v1/me"
/v1/mereturns the calling key's identity, the endpoints it may call, its rate limits and current usage. The full secret is shown once at issuance; thereafter only a display prefix is available via /v1/me/keys.