Skip to main content
GET
curl

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

Query Parameters

start_date
string<date>

The inclusive start date for filtering settlement reports. Use in combination with end_date to specify a date range. Use RFC 3339 full-date format (YYYY-MM-DD).

end_date
string<date>

The inclusive end date for filtering settlement reports. Use in combination with start_date to specify a date range. Use RFC 3339 full-date format (YYYY-MM-DD).

report_type
enum<string>[]

Filters the returned reports by one or more report types. If omitted, all report types are included. Repeat the query parameter to request multiple types, for example report_type=price_trigger_swaps&report_type=swaps. Unknown values return a 400 response.

Available options:
earn_rewards,
price_trigger_swaps,
swaps
page_size
integer<int32>
default:20

Maximum number of results to return on a single page. Defaults to 20, maximum 100.

Required range: 1 <= x <= 25
page_token
string

Opaque cursor returned by a previous response's next_page_token. Omit to start from the beginning.

Required string length: 1 - 256

Response

Successful response containing a list of settlement reports and pagination details.

data
object[]
required

An array of settlement report objects that match the specified filter criteria.

next_page_token
string

Opaque cursor for the next page of results. Absent when there are no more pages.

Required string length: 1 - 512