Skip to main content
GET
/
v1
/
subscriptions
List subscriptions
curl --request GET \
  --url https://api.ticksupply.com/v1/subscriptions \
  --header 'X-Api-Key: <api-key>'
{
  "items": [
    {
      "id": "sub_550e8400e29b41d4a716446655440000",
      "datastream_id": 123,
      "status": "active",
      "created_at": "2023-11-07T05:31:56Z",
      "datastream": {
        "datastream_id": 123,
        "exchange": "binance",
        "instrument": "BTCUSDT",
        "stream_type": "trade",
        "wire_format": "json"
      }
    }
  ],
  "total": 123,
  "limit": 123,
  "next_page_token": "<string>"
}

Authorizations

​
X-Api-Key
string
header
required

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

Query Parameters

​
limit
integer
default:50

Maximum number of items to return (1-100)

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

Cursor for pagination. Use next_page_token from previous response.

Response

Paginated list of subscriptions

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

Total number of subscriptions

​
limit
integer
required

Items per page

​
next_page_token
string | null

Token for next page (null if no more pages)