What to use for each task
How each one signs in
- REST API, SDKs, Agent skill: an API key in
OXARCHIVE_API_KEY. REST sends it as X-API-Key.
- WebSocket: the same key, sent as
Authorization: Bearer when the socket opens.
- CLI: the same key, in
OXA_API_KEY.
- MCP server: OAuth through your client’s built-in flow, with no 0xArchive API key. The authorization server is
https://auth.0xarchive.io, and market data needs the mcp:market.read scope.
- Webhook Alerts: the dashboard, the REST routes with an API key, or the MCP server over OAuth.
- Bulk Exports: your dashboard account, in the browser.
Keep API keys in the environment or a secret store, never in browser code or prompts.
When a call fails
401 on an API-key interface: check that the key is set in the variable that interface reads, and that it is active.- OAuth failure on the MCP server: repeat the client’s OAuth flow. Do not add an API key to the MCP URL.
403: check the window against your plan’s history, then the exact endpoint and key.404: check the namespace and symbol in Venue coverage.429: read the error_code. Retry rate_limited within a bounded budget, after its retry_after seconds when it has one; stop on insufficient_credits. When you reach a limit has the full rule.
Moving a working request from one interface to another? Keep the same symbol, window, and depth, and compare the new result with the old one.
Next step
Copy a working request for the interface you picked from Examples, which has REST, WebSocket, and agent examples and links to the SDK and CLI examples.Last modified on October 6, 2026
