Skip to main content
POST
cURL
Call this when you queued an export you no longer want. The response is the same job resource Trader export status returns, so compare status to see what the cancel did.

Parameters

An OAuth access token needs the export scope on this route. An API key needs nothing extra.

What the cancel does

The answer is always 200 with the job. What the job reads depends on where it was when the cancel arrived. The worker checks for a cancel every 5 seconds while it reads the data and between upload parts, and once more at the last point before the file is published. A storage request already in flight finishes first, and each one is bounded at 120 seconds, so a running job reads cancelled within a few minutes at most. If the worker itself stops first, the job reads cancelled after its 30-minute lease lapses, at the next hourly cleanup.

Key response fields

Quota

Cancelling does not give quota back. The submit already counted against the 20 exports per account in 24 hours and the 5 per wallet in an hour, and that count stays for its full window, the same as a failed export’s. A later submit for the same wallet and format queues a new job. It never reuses a job you asked to cancel.

Example

The TypeScript SDK wraps it as client.cancelTraderExport(address, jobId) from @0xinsider/sdk 0.11.0. The SDK retries it on a network error or a 5xx, because a repeat is safe.

What it does not do

  • Delete a ready file. Once the file is being published, the job is returned unchanged and finishes normally.
  • Return quota. The submit’s count stays for its full window.
  • Take an Idempotency-Key. A repeat is safe without one, because the second cancel returns the state the first one reached.
  • Cancel a job belonging to another account, or a job submitted for a different wallet. Both answer 404, the same as the status route.
  • Notify you by webhook unless you subscribe. An endpoint subscribed to export_job_cancelled gets one delivery when the job reaches cancelled.

Authorizations

Authorization
string
header
required

Legacy default or named integration API key, or OAuth 2.1 access token, in the Authorization header as Bearer oxi_sk_live_... or Bearer oxi_at_.... Default keys retain full access; integration keys are limited to their approved read, webhooks, export and usage scopes and expire within 90 days. All credentials share the owner's account limits. Data calls require an active Pro subscription and return live data. A 401 carries WWW-Authenticate: Bearer resource_metadata="https://api.0xinsider.com/.well-known/oauth-protected-resource" (RFC 6750 section 3, RFC 9728).

Headers

X-Query-Validation
enum<string>

Opt into strict query-name validation. The default is compatible: unknown names are ignored and reported in X-Query-Ignored. With strict, an unknown name returns 400 bad_request with error.reason unknown_query_parameter before the handler runs, including when its percent escape is incomplete.

Available options:
strict

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

job_id
integer<int64>
required

Export job id returned by the submit route.

Response

The job after the cancel: cancelled, cancel_requested, or unchanged when a cancel can no longer reach it.

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