Skip to main content
GET
/
v1
/
export-schemas
/
{id}
Get export schema
curl --request GET \
  --url https://api.ticksupply.com/v1/export-schemas/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "id": "sch_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4",
  "name": "normalized_trades",
  "stream_type": "trade",
  "created_at": "2023-11-07T05:31:56Z",
  "columns": [
    {
      "id": "<string>",
      "schema_id": "<string>",
      "position": 1,
      "output_column": "price",
      "meta": {
        "value": "collection_timestamp_ns",
        "format": "ns"
      },
      "data": {}
    }
  ],
  "unfold": {}
}

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 schema ID

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

Response

Export schema with columns

Export schema with its column definitions

​
id
string
required

Export schema ID

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

"sch_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4"

​
name
string
required

Schema name

Example:

"normalized_trades"

​
stream_type
string
required

Stream type this schema applies to

Example:

"trade"

​
created_at
string<date-time>
required

Creation timestamp

​
columns
object[]
required
​
unfold
object

Per-exchange unfold rules. When an exchange packs multiple events into one JSON array, unfold expands each element into its own row. Keys are exchange codes, values specify the JSON path to the array.

Last modified on April 5, 2026