Skip to main content
POST
Wallet free signup retired

Headers

0xArchive-Version
enum<string>

Selects the 2026-10 response contract. Send 2026-10-01; any dated version on or after it selects the same shapes. Without the header every response keeps its existing shape. With it:

  • The data quality routes, /v1/status/coverage and /v1/symbols answer the standard {success, data, meta} envelope.
  • Record times that are integer milliseconds by default become RFC 3339 UTC strings with millisecond precision, and the integer moves to a *_ms field: L4 resting-order timestamp (timestamp_ms), CVD buckets, HIP-3 oracle reads, Lighter and Lighter on Robinhood Chain liquidations and liquidation volume. Levels and trigger-levels snapshot_ts become RFC 3339 with snapshot_ts_ms.
  • Error bodies carry the contract error_code names: invalid_parameter instead of invalid_query_params and invalid_path_params, historical_depth_exceeded instead of history_window_exceeded, and historical_range_exceeded instead of request_range_exceeded; a malformed cursor that fails to parse answers 400 invalid_cursor instead of invalid_query_params. With 0xArchive-Version: 2026-10-01, malformed cursors on trades, liquidations, L2 and L4 diffs, order history, TP/SL and order-flow routes answer 400 invalid_cursor. Without the header, the first six route families treat a malformed cursor as no cursor and return the first page; order flow answers 400 invalid_query_params. Malformed trade time inputs answer 400 invalid_time_range with the header and 400 invalid_query_params without it.

The response echoes the selected version in its own 0xArchive-Version header.

Available options:
2026-10-01
Example:

"2026-10-01"

Response

410 - application/json

Wallet-only Free signup is retired.

Body of every non-2xx JSON response. code repeats the HTTP status, error_code is the stable machine-readable code (see ErrorCode), error is a human-readable message, and request_id identifies the request for support. Validation failures add param and, where the accepted set is fixed, valid_values. A 404 for a datatype the venue does not offer (unsupported_for_venue) adds venue, datatype and available_on; any other unknown path answers 404 route_not_found.

success
enum<boolean>
required

Always false on an error.

Available options:
false
code
integer
required

HTTP status code.

Example:

400

error_code
enum<string>
required

Stable, machine-readable error code. Branch on this value, not on the error text.

Contract codes

WebSocket only (sent in {"type":"error"} messages, never by REST)

Route-specific codes

Legacy names. Requests without 0xArchive-Version: 2026-10-01 keep the four names that predate the contract; with the header they receive the contract names instead.

Treat any value not listed here as a generic error of the HTTP status.

Available options:
invalid_parameter,
invalid_symbol,
invalid_interval,
invalid_cursor,
invalid_time_range,
range_before_coverage,
historical_range_exceeded,
historical_depth_exceeded,
unsupported_for_venue,
route_not_found,
not_found,
unauthorized,
forbidden,
insufficient_credits,
rate_limited,
conflict,
upstream_unavailable,
internal_error,
endpoint_unsupported,
slow_consumer,
positions_unavailable,
reconstruction_unavailable,
snapshot_advanced,
pagination_unavailable,
api_key_limit_reached,
wallet_requires_plan,
wallet_account_required,
wallet_free_signup_retired,
account_disabled,
oauth_not_permitted,
insufficient_scope,
invalid_query_params,
invalid_path_params,
history_window_exceeded,
request_range_exceeded
Example:

"invalid_parameter"

error
string
required

Human-readable message. Wording can change; do not parse it.

request_id
string<uuid>
required

Unique request ID for support.

param
string

The parameter that failed validation, when one did.

Example:

"side"

valid_values
string[]

Accepted values of param, when the set is fixed.

Example:
venue
string

unsupported_for_venue only: the venue the request asked.

Example:

"spot"

datatype
string

unsupported_for_venue and plan refusals (forbidden): the datatype the request asked for, as GET /v1/capabilities names it.

Example:

"order_flow"

available_on
object[]

unsupported_for_venue only: the venues and routes that serve the datatype.

credits_used
integer<int64>

insufficient_credits only: credits used this period.

credits_limit
integer<int64>

insufficient_credits only: the period's credit allowance.

max_concurrent
integer

rate_limited concurrency refusals only: simultaneous queries the plan allows.

suggestion
object

Present when the symbol exists on another venue: where to request it instead.

required_plans
string[]

Plan refusals (forbidden) only: the plans that include the datatype.

Example:
upgrade_url
string<uri>

Plan refusals (forbidden) only: where to change plan.

Example:

"https://0xarchive.io/pricing"