POST /v1/stream-token
Create a short-lived authenticated WebSocket stream token
| Availability | Private Preview |
|---|---|
| Method and path | POST /v1/stream-token |
| API version | 1.0.0-private-preview |
| Base URL | https://api.torq.finance |
| Authentication | SecretKey |
| Idempotency | Required header: Idempotency-Key. |
| Rate limits | Read x-ratelimit-* and x-request-id response headers. Do not hard-code a quota. |
Authentication requirements
SecretKey
Request examples
curl -X POST 'https://api.torq.finance/v1/stream-token' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer $TORQ_SECRET_KEY' \
-H 'Idempotency-Key: $TORQ_IDEMPOTENCY_KEY' \
-H 'Content-Type: application/json' \
--data '{}'This calls the docs preview and returns sample data shaped by the governed OpenAPI response. It never accepts credentials or changes protocol state.
Run the sample call to inspect a schema-shaped response without credentials or side effects.| Request body | StreamTokenRequest |
|---|
Parameters
| Name | In | Required | Type |
|---|---|---|---|
Idempotency-Key | header | Yes | string |
Request schema
StreamTokenRequest StreamTokenRequest
| Property | Type | Required | Description |
|---|---|---|---|
eventTypes | string[] | No | — |
cursor | string | null | No | — |
Inspect nested properties
eventTypes string[] · optional
items string
cursor string | null · optional
nullable
Responses
| Status | Meaning | Schema |
|---|---|---|
200 | Successful response | StreamToken |
400 | Invalid request | TorqApiError |
401 | Authentication required | TorqApiError |
403 | Insufficient scope or authority | TorqApiError |
409 | State or idempotency conflict | TorqApiError |
429 | Rate limit exceeded | TorqApiError |
500 | Internal failure | TorqApiError |
200 response schema
StreamToken StreamToken
| Property | Type | Required | Description |
|---|---|---|---|
token | string | Yes | — |
url | string (uri) | Yes | — |
expiresAt | string (date-time) | Yes | — |
Inspect nested properties
token string · required
minimum length: 1 · maximum length: 200
url string (uri) · required
expiresAt string (date-time) · required
400, 401, 403, 409, 429, 500 response schema
TorqApiError TorqApiError
| Property | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | — |
code | string | Yes | — |
message | string | Yes | — |
requestId | string | Yes | — |
retryable | boolean | Yes | — |
blockedReason | string | null | No | — |
docsUrl | string (uri) | No | — |
Inspect nested properties
ok boolean · required
code string · required
minimum length: 1 · maximum length: 200
message string · required
minimum length: 1 · maximum length: 200
requestId string · required
minimum length: 1 · maximum length: 200
retryable boolean · required
blockedReason string | null · optional
nullable
docsUrl string (uri) · optional
Related guides
- Authentication and scopes
- Errors, idempotency, and rate limits
- Canonical state and final completion
- SDK reference
For retry behavior and blocked-state handling, see Errors and rate limits.