Skip to main content
GET
Payout queue — bulk payout eligibility

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

type
enum<string>
default:sim_funded

Account type to check. Payouts normally apply to sim_funded accounts only — evaluation/competition are supported for special cases.

Available options:
evaluation,
sim_funded,
competition
eligibleOnly
boolean
default:false

Return only accounts that are payout-eligible right now.

limit
integer
default:100

Accounts per page (eligibility is computed for each account on the page and may be up to 30 seconds old).

Required range: 1 <= x <= 200
offset
integer
default:0

Pagination offset.

Required range: x >= 0

Response

Payout queue computed

success
boolean
Example:

true

data
object
Example: