Skip to main content
GET
SDK

SDK Example

Authorizations

x-api-key
string
header
required

API Key for authentication

Query Parameters

sort
enum<string>
default:realized

Field to rank by.

Available options:
realized,
volume,
days,
ending_total
direction
enum<string>
default:desc

Sort direction.

Available options:
asc,
desc
limit
integer
default:100

Number of results per page.

cursor
string

Opaque pagination cursor returned from the previous page's pagination.nextCursor.

period
enum<string>
default:30d

Time period shorthand. Ignored if start/end are provided.

Available options:
1d,
7d,
14d,
30d,
90d,
all
start
string<date>

Start date (YYYY-MM-DD). Overrides period.

end
string<date>

End date (YYYY-MM-DD). Overrides period.

Response

Successful response.

traders
object[]
pagination
object

Cursor-based pagination metadata.