Skip to main content
GET
/
v1
/
subscriptions
/
{id}
Get subscription
curl --request GET \
  --url https://api.ticksupply.com/v1/subscriptions/{id} \
  --header 'X-Api-Key: <api-key>'
{
  "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"
  }
}

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

Subscription ID (prefixed format, e.g., sub_xxx)

Response

Subscription details

​
id
string
required

Prefixed subscription ID (e.g., sub_550e8400e29b41d4a716446655440000)

Example:

"sub_550e8400e29b41d4a716446655440000"

​
datastream_id
integer<int64>
required

Datastream ID

​
status
enum<string>
required

Current subscription status

Available options:
active,
paused,
deleted
​
created_at
string<date-time>
required

Creation timestamp

​
datastream
object

Simplified datastream information for catalog queries