Get export - Ticksupply API

Authorizations

X-Api-Key

string

header

required

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

Path Parameters

string

required

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

Pattern: ^exp_[a-f0-9]{32}$

Response

Export job details

string

required

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

Pattern: ^exp_[a-f0-9]{32}$

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

Output container format.

csv — gzip-compressed CSV with a header row (.csv.gz). Type information is lost; consumers parse strings.
parquet — columnar Parquet (.parquet). Preserves ClickHouse types (Decimal, DateTime64(9), Nullable, Array → LIST), supports per-column compression, and is read efficiently by pandas, Polars, DuckDB, Athena, and Spark.

Available options:

csv,

parquet

format_options

object

required

Server-resolved per-format options, echoed back with every default filled in. The shape matches format: empty object for csv, a populated ParquetFormatOptions for parquet. Pin these values in your client to keep future server default changes from affecting your pipeline.

Option 1
Option 2

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