Skip to main content
GET
List flagged traders

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.

Query Parameters

days
integer
default:7

Trading days of reports to include, 1 to 30

Required range: 1 <= x <= 30
state
enum<string>
default:new

Review state to list

Available options:
all,
new,
reviewed,
cleared
limit
integer
default:100

Most traders to return

Required range: 1 <= x <= 500
minLevel
enum<string>
default:low

Lowest finding level to include; findings stored before levels existed are always included

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

recent: most recently flagged first. stake: highest level first, then the most profit that could still be paid out

Available options:
recent,
stake

Response

Flagged traders

success
boolean
Example:

true

data
object