Skip to main content
GET
/
v1
/
datastreams
List datastreams
curl --request GET \
  --url https://api.ticksupply.com/v1/datastreams \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "datastream_id": 123,
      "exchange": "binance",
      "instrument": "BTCUSDT",
      "stream_type": "trade",
      "wire_format": "json"
    },
    {
      "datastream_id": 124,
      "exchange": "binance",
      "instrument": "BTCUSDT",
      "stream_type": "depth",
      "wire_format": "json"
    }
  ],
  "total": 2,
  "limit": 100,
  "next_page_token": null
}

Authorizations

​
X-Api-Key
string
header
required

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

Query Parameters

​
exchange
string

Filter by exchange code

​
instrument
string

Filter by instrument symbol

​
stream_type
string

Filter by stream type

​
wire_format
string

Filter by wire format

​
limit
integer
default:100

Maximum number of results (1-1000)

Required range: 1 <= x <= 1000
​
page_token
string

Cursor for pagination. Use next_page_token from previous response.

Response

Paginated list of datastreams

​
items
object[]
required
​
total
integer<int64>
required

Total number of datastreams matching filters

​
limit
integer
required

Items per page

​
next_page_token
string | null

Token for next page (null if no more pages)