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. It works on the /api/partner/venues/{venueId} routes and, with trader:read or trader:trade, on the account, market and trading routes for the venue's own traders, each request naming its trader in x-trdrs-trader. A trdrs_sk_… key can't be used in its place. It never signs in, manages keys or reaches a trdrs user's accounts. Keep it on your server.

Path Parameters

venueId
string<uuid>
required

Query Parameters

month
string

The month, as YYYY-MM in UTC. Leave it out for the previous complete calendar month, the one being invoiced. The current month counts what has filled so far.

Pattern: ^\d{4}-\d{2}$

Response

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

month
string
required
frozen
boolean
required
invoiceState
string | null
required
currency
any
required
basis
enum<string>
required
Available options:
connect-traders,
exempt,
unattributable
reason
string
required

Why the month carries no count: internal_venue or missing_trade_dates. Only on an exempt or unattributable month.

activeTraders
integer | null
required
priceCentsPerActiveTrader
integer | null
required
amountCents
integer | null
required
traders
object[]
required