Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

The Venue key (trdrs_vk_sandbox_… or trdrs_vk_production_…), in preview. It belongs to one venue in one environment and carries the scopes it was created with. The venue's verified owner creates it while signed in, and it works only on the /api/partner/venues/{venueId} routes. A trdrs_sk_… key can't be used in its place. It never lets you act as a trader, sign in or manage keys. Keep it on your server.

Path Parameters

venueId
string<uuid>
required

Query Parameters

historyWindow
integer
default:1440

How many minutes of history to return, from 60 to 10,080. The default is 1,440, one day.

Required range: 60 <= x <= 10080
historyInterval
enum<integer>
default:5

Minutes between history points: 1, 5, 15 or 60. The default is 5. The window divided by the interval can't exceed 1,000 points.

Available options:
1,
5,
15,
60

Response

Success. The response is sent with Cache-Control: no-store, so don't cache it.

risk
object
required