List export schemas - Ticksupply API

GET

export-schemas

Python (ticksupply library)

# pip install ticksupply
from ticksupply import Client

client = Client(api_key="<api-key>")
for schema in client.export_schemas.list():
    print(schema)

// cargo add ticksupply
// cargo add tokio --features full
use ticksupply::Client;

#[tokio::main]
async fn main() -> ticksupply::Result<()> {
    let client = Client::with_api_key("<api-key>")?;
    for schema in client.export_schemas().list().await? {
        println!("{schema:#?}");
    }
    Ok(())
}

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.ticksupply.com/v1/export-schemas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ticksupply.com/v1/export-schemas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ticksupply.com/v1/export-schemas"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ticksupply.com/v1/export-schemas")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "sch_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4",
    "name": "normalized",
    "stream_category": "trade",
    "is_built_in": false,
    "created_at": "2023-11-07T05:31:56Z",
    "version": 1,
    "has_draft": false
  }
]

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "request_timeout",
    "message": "Request exceeded 10s deadline"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after 30 seconds."
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}

Authorizations

X-Api-Key

string

header

required

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

Response

List of export schemas

string

required

Export schema ID

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

Example:

"sch_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4"

name

string

required

Schema name

Example:

"normalized"

stream_category

enum<string>

required

Stream category this schema applies to

Available options:

trade,

orderbook,

book_update,

quote,

kline,

ticker,

liquidation

Example:

"trade"

is_built_in

boolean

required

true for schemas provided by Ticksupply (e.g., normalized, book_5, book_20). Built-ins are read-only and cannot be deleted. false for schemas you created.

Example:

false

created_at

string<date-time>

required

Creation timestamp

version

integer

required

Latest published version number. 0 if no version has been published yet.

Example:

1

has_draft

boolean

required

Whether an unpublished draft version exists for this schema.

Example:

false

Last modified on April 5, 2026

Python (ticksupply library)

# pip install ticksupply
from ticksupply import Client

client = Client(api_key="<api-key>")
for schema in client.export_schemas.list():
    print(schema)

// cargo add ticksupply
// cargo add tokio --features full
use ticksupply::Client;

#[tokio::main]
async fn main() -> ticksupply::Result<()> {
    let client = Client::with_api_key("<api-key>")?;
    for schema in client.export_schemas().list().await? {
        println!("{schema:#?}");
    }
    Ok(())
}

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.ticksupply.com/v1/export-schemas', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ticksupply.com/v1/export-schemas",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ticksupply.com/v1/export-schemas"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ticksupply.com/v1/export-schemas")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

[
  {
    "id": "sch_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4",
    "name": "normalized",
    "stream_category": "trade",
    "is_built_in": false,
    "created_at": "2023-11-07T05:31:56Z",
    "version": 1,
    "has_draft": false
  }
]

{
  "error": {
    "code": "unauthenticated",
    "message": "Invalid or missing API key"
  }
}

{
  "error": {
    "code": "request_timeout",
    "message": "Request exceeded 10s deadline"
  }
}

{
  "error": {
    "code": "rate_limited",
    "message": "Rate limit exceeded. Retry after 30 seconds."
  }
}

{
  "error": {
    "code": "internal",
    "message": "An internal error occurred"
  }
}