Skip to main content
GET
List every risk match of a trading day

Authorizations

X-API-Key
string
header
required

Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.

Headers

If-None-Match
string

Optional. The ETag of the answer you already have. When the answer would be the same, the response is 304 without a body.

Path Parameters

tradingDay
string
required

Trading day (YYYY-MM-DD), named after the date its 17:00 to 17:00 Chicago session ends on

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

Query Parameters

kind
enum<string>
default:copy

copy and hedge trader pairs, overlap (the wider hedge rule), small groups, or each trader's match counts

Available options:
copy,
hedge,
overlap,
group,
trader
traderId
string

Only rows naming this trader (your trader record or the login)

Maximum string length: 64
minLevel
enum<string>
default:low

Only rows at this level or above that day

Available options:
low,
medium,
high
sort
enum<string>
default:tight

tight (tight matches; groups: days seen; traders: copy matches), weight, matches or recent

Available options:
tight,
weight,
matches,
recent
offset
integer
default:0

Rows to skip

Required range: 0 <= x <= 1000000
limit
integer
default:100

Rows to return, at most 500

Required range: 1 <= x <= 500

Response

One page of the day's matches

success
boolean
Example:

true

data
object