Skip to main content
POST
cURL
Queue an export of a trader’s full dataset as JSON, NDJSON, or CSV. Use it when an offline job needs more data than one response carries.

Read the job

  • format is json (default), ndjson, or csv. json is the full envelope. ndjson is the envelope on line 1, then one trade per line. csv is flat trade rows only.
  • address accepts a 0x... wallet address, a username, or a trd_-prefixed trader ID. A bare integer id is not accepted.
  • status is queued, running, ready, or failed. format echoes the request.
  • total_trades, processed_trades, file_size, and error are null until the worker sets them.
  • 202 means a new job was queued. 200 means an in-flight or ready job for the same trader and format was reused.
  • Quotas are a per-user daily cap and a per-address hourly cap, keyed on the API key owner. An extra key does not widen the quota.

Run the export flow

  1. Store job_id from the response.
  2. Poll Get Trader Export Status until status is ready or failed.
  3. On ready, call Download Trader Export.
  4. On 429, read Retry-After and submit again after that many seconds. The cap did not queue a job.
Get Trader Export Snapshot shows coverage and row estimates before you submit.

Authorizations

Authorization
string
header
required

API key authentication. Send your key in the Authorization header as Bearer oxi_sk_live_.... Live keys require an active Pro subscription and return live data.

Path Parameters

address
string
required

Trader wallet address (0x...), known trader username-style lookup, or trd_-prefixed trader ID emitted by this API.

Query Parameters

format
enum<string>
default:json

Output serialization. json = full envelope document (default); ndjson = full envelope as line 1 then one trade object per line; csv = flat trades rows only.

Available options:
json,
ndjson,
csv

Response

An in-flight or ready job for this trader+format already exists and was reused

object
string
required
Allowed value: "trader_export_job"
data
object
required
meta
object
required