Skip to main content
GET
Get daily payout activity

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.

Query Parameters

startDate
string

Only include payouts executed from this date onwards

endDate
string

Only include payouts executed up to this date

type
enum<string>

Only include payouts from accounts of this type

Available options:
evaluation,
sim_funded,
competition

Response

Daily payout amount and count

success
boolean
Example:

true

data
object