Skip to main content
GET
Python (ticksupply library)

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)

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

Response

Subscription details

id
string
required

Prefixed subscription ID (e.g., sub_550e8400e29b41d4a716446655440000)

Pattern: ^sub_[a-f0-9]{32}$
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

Last modified on February 6, 2026