Skip to main content
GET
curl

Authorizations

API-Key
string
header
required

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

API-Sign
string
header
required

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

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Query Parameters

page_token
string

Opaque token returned as next_page_token in the previous response. Omit to request the first page.

Required string length: 1 - 256
page_size
integer<int32>
default:20

Maximum number of results to return. Ignored when page_token is present.

Required range: 1 <= x <= 25
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).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
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).

Pattern: ^[0-9]{4}-[0-9]{2}-[0-9]{2}$
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 and the reserved unspecified value return a 400 response.

Maximum array length: 10

The category of a settlement report.

Available options:
swaps,
price_trigger_swaps,
earn_rewards

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.

Maximum array length: 100
next_page_token
string

Opaque token for retrieving the next page. Absent when there are no more results.

Required string length: 1 - 256