Go Back ↗
API Reference

List settlements

get
https://example.com/v1/settlements

List settled movements the vendor has reported.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Return only settlements where this account appears on either side.

string

Return only settlements denominated in this asset code.

string
enum

Return only settlements of this classification.

Allowed:
string

Return only settlements produced by this transfer.

date-time

Return only settlements recorded at or after this instant.

date-time

Return only settlements recorded before this instant.

integer
0 to 4294967295

Zero-based page number to return.

integer
0 to 4294967295

Maximum number of settlements to return in the page.

string

Ordering to apply, formatted as field:asc or field:desc.

Responses

Updated about 9 hours ago

Did this page help you?
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 9 hours ago

Did this page help you?