Skip to main content
GET
/
v1
/
exports
/
{id}
Get export
curl --request GET \
  --url https://api.ticksupply.com/v1/exports/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "exp_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4",
  "datastream_id": 123,
  "start_time": 1704067200000000000,
  "end_time": 1704153600000000000,
  "format": "csv",
  "status": "queued",
  "created_at": "2023-11-07T05:31:56Z",
  "reason": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
X-Api-Key
string
header
required

Your API key. Get one from the dashboard at https://app.ticksupply.com/api-keys

Path Parameters

​
id
string
required

Export job ID (prefixed format, e.g., exp_xxx)

Response

Export job details

​
id
string
required

Prefixed export job ID (e.g., exp_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4)

Example:

"exp_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4"

​
datastream_id
integer<int64>
required

Datastream ID being exported

Example:

123

​
start_time
integer<int64>
required

Start of data range (nanoseconds since Unix epoch)

Example:

1704067200000000000

​
end_time
integer<int64>
required

End of data range (nanoseconds since Unix epoch)

Example:

1704153600000000000

​
format
enum<string>
required

Export file format

Available options:
csv
Example:

"csv"

​
status
enum<string>
required

Export job status

Available options:
queued,
running,
succeeded,
failed,
canceled
​
created_at
string<date-time>
required

Creation timestamp

​
reason
string | null

Failure reason (only present when status is "failed")

​
started_at
string<date-time> | null

When processing started

​
finished_at
string<date-time> | null

When processing finished