Skip to main content
POST
/
v1
/
subscriptions
Python (ticksupply library)
# pip install ticksupply
from ticksupply import Client

client = Client(api_key="<api-key>")
sub = client.subscriptions.create(datastream_id=123)
print(sub)
{
  "id": "sub_550e8400e29b41d4a716446655440000",
  "datastream": {
    "datastream_id": 123,
    "exchange": "binance",
    "instrument": "BTCUSDT",
    "stream_type": "trades",
    "wire_format": "json"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "spans": [
    {
      "id": "spn_0194a1b2c3d4e5f6a7b8c9d0e1f2a3b4",
      "started_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
X-Api-Key
string
header
required

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

Headers

​
Idempotency-Key
string<uuid>

Unique key for idempotent requests. If you retry a request with the same key, you'll receive the original response without the operation being performed again.

Must be a valid UUID (any version — v4 recommended for uniqueness), up to 128 characters.

Maximum string length: 128

Body

application/json
​
datastream_id
integer<int64>
required

Datastream ID to subscribe to

Response

Subscription created successfully

​
id
string
required

Prefixed subscription ID (e.g., sub_550e8400e29b41d4a716446655440000)

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

"sub_550e8400e29b41d4a716446655440000"

​
status
enum<string>
required

Current subscription status

Available options:
active,
paused,
deleted
​
datastream
object
required

Simplified datastream information for catalog queries

​
created_at
string<date-time>
required

When the subscription was created

​
spans
object[]
required

Active and historical collection spans for the subscription. Always empty on the create response — call GET /v1/subscriptions/{id}/spans to retrieve the initial active span.

Last modified on April 17, 2026