Sign in

v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB
Settlements

Settlement: Index

Retrieves a paginated list of settlements from most-recent to least-recent. Pagination can be configured with page and per_page parameters.

get/settlements

Query parameters

start_timestring date-time

Query for records created after this time.

end_timestring date-time

Query for records created before this time.

per_pageinteger

How many objects per page.

pageinteger

Page number to query for.

Response

200 response

resourcestring required

Resource type name for this list, always "list".

start_timestring date-time required

Start of the time range for records in this response.

end_timestring date-time required

End of the time range for records in this response.

totalinteger required

Total number of records matching the query.

pageinteger required

Current page number.

per_pageinteger required

Number of results per page.

last_pageinteger required

Last available page number.

Example response

{
  "data": [
    {
      "currency": "JPY",
      "fx_currency": "JPY"
    }
  ]
}