API Reference

Search Liquidity Conversions

post
http://localhost:8080/v1/fx/liquidity/conversions/search

Searches conversions on one liquidity account. Only the target account is required; every other filter narrows the result. Paging and sorting travel as query parameters, and default to the newest 25 by creation time. Requires multi-currency wallets to be enabled.

Query Params
int32
≥ 1
Defaults to 1

Page to return, starting at 1.

int32
1 to 25
Defaults to 25

Page size, 1-25. Currency Cloud will not serve more than 25.

string
enum
Defaults to CREATED_AT

The field to order by.

Allowed:
string
enum
Defaults to DESC

The direction to order in.

Allowed:
Body Params

Filters for a liquidity conversion search. Only the target account is required; paging and sorting travel as query parameters.

number

Smallest bought amount to return, inclusive.

number

Largest bought amount to return, inclusive.

string

ISO 4217 code of the currency bought. Omit to search every currency.

string

The two currencies concatenated, as Currency Cloud names a pair. An alternative to giving the buy and sell currencies separately.

string
enum

Which of a conversion's dates a search's date range applies to

Allowed:
date-time

Start of the range, inclusive, in UTC. Omit both to search the whole account. Filtering on CONVERSION_DATE ignores the time, which Currency Cloud holds as a date.

uuid

The idempotency key you supplied when creating the conversion. This is the only identifier from the create response that Currency Cloud can search on.

number

Smallest sold amount to return, inclusive.

number

Largest sold amount to return, inclusive.

string

ISO 4217 code of the currency sold. Omit to search every currency.

string
length between 0 and 255

Currency Cloud's own human-readable reference for the conversion.

string

Currency Cloud's state for the conversion, matched exactly. Passed through verbatim, so new values may become searchable without a change here.

string
enum
required

The account whose conversions are sought. Possible values:

  • CLIENT_HOUSE: your own House Account, held in your Currency Cloud tenant
  • TREASURY_RECON_SUB: your reconciliation sub-account, held by Shaype
Allowed:
date-time

End of the range, inclusive, in UTC. Omit both to search the whole account.

Responses

Updated 3 days ago

Did this page help you?
Language
LoadingLoading…
Response
Choose an example:
application/json

Updated 3 days ago

Did this page help you?