Skip to main content
POST
Submit product feedback
Optional authentication. Submit anonymously, or send a valid API key or browser session to associate feedback with your account. A supplied invalid credential is rejected. See feedback.
Operation schema
Open the generated operation schema for machine-readable request and response details.

Authorizations

​
X-API-Key
string
header
required

API key for authentication. Get yours at https://0xarchive.io/dashboard

Headers

​
Idempotency-Key
string

Optional key with 8-128 visible ASCII characters (0x21-0x7e). Reuse it only for an identical retry; a different request with the same key returns 409.

Required string length: 8 - 128
Pattern: ^[!-~]{8,128}$
​
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"

Body

application/json

A product feedback request. Anonymous submissions are allowed. Account identity is derived only from a validated credential, never from request fields. Optional structured context fields are flat on the request and share a 2,048-byte serialized limit.

​
type
enum<string>
required

Feedback type. Security reports use type=other with category=security.

Available options:
bug,
feature,
question,
other
​
message
string
required

Required nonblank message, limited to 5,000 UTF-8 bytes. Include any free-text reproduction details in this field; there is no separate free-text context property.

Required string length: 1 - 5000
​
category
enum<string>
default:support

Optional feedback category. Defaults to support.

Available options:
support,
security
​
email
string<email>

Optional contact email for anonymous submissions. If a credential authenticates the request, this field is ignored and the account email is used; this field never establishes account identity.

Maximum string length: 254
​
surface
string

Optional surface identifier (maximum 64 UTF-8 bytes).

​
route
string

Optional route identifier (maximum 512 UTF-8 bytes).

​
venue
string

Optional venue identifier (maximum 64 UTF-8 bytes).

​
market_family
string

Optional market-family identifier (maximum 64 UTF-8 bytes).

​
symbol
string

Optional symbol identifier (maximum 128 UTF-8 bytes).

​
data_type
string

Optional data-type identifier (maximum 64 UTF-8 bytes).

​
start
integer<int64>

Optional start timestamp in Unix milliseconds. When both start and end are supplied, start must not exceed end.

Required range: 0 <= x <= 253402300799999
​
end
integer<int64>

Optional end timestamp in Unix milliseconds. When both start and end are supplied, start must not exceed end.

Required range: 0 <= x <= 253402300799999
​
request_id
string

Optional request identifier (maximum 128 UTF-8 bytes).

​
error_code
string

Optional error-code identifier (maximum 128 UTF-8 bytes).

Response

HTTP 202: feedback accepted with a receipt identifier.

Receipt returned when feedback has been accepted. The standard response envelope, plus the legacy message field.

​
success
enum<boolean>
required
Available options:
true
Example:

true

​
data
object
required
​
meta
object
required

Response metadata. Every 2xx JSON response carries meta.request_id; list payloads add count; cursor-paged routes add has_more and, when another page follows, next_cursor; per-symbol routes add symbol and venue. Fields that do not apply to a route are omitted.

​
message
string
required

Human-readable acknowledgement kept from the earlier response. It does not promise a reply.

Example:

"Thank you for your feedback!"

Last modified on October 31, 2026