Start a candle export as a background job; poll GET /v1/candles/export/{exportId}

Same request fields as the GET, in the JSON body (or the query). Answers 202 { exportId, status: "queued", estimatedSeconds }, or 200 { status: "done", url, ... } at once when the window is closed and already built. The same request from the same account while one is in flight (or within a few minutes after it finished) returns that export (deduplicated: true) and is not counted by the per account limit, which counts requests that start new work.

post/v1/candles/export

Request

  • Base URL: https://app.texttoquant.com/api
  • URL: https://app.texttoquant.com/api/v1/candles/export
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

symbolstring required
timeframestring required
startstring date required
endstring date required
format'csv' | 'jsonl'

Response

done: the closed window was already built; the link is in the answer

successtrue required
dataobject required

Changes

No recorded changes to this operation across all 1 revision of this API.