Gets a list of OTC deals.

get

https://api-otc-sandbox.vertofx.com/deals

Retrieves a paginated list of OTC deals. This endpoint supports filtering and sorting of deals based on various criteria.

Query Params

includeArchived

boolean

If true, includes archived deals in the results. By default, archived deals are excluded.

sellCurrency

string

enum

Filters deals by the currency being sold.

buyCurrency

string

enum

Filters deals by the currency being bought.

referenceId

string

Filters deals by a specific reference ID.

status

string

enum

Filters deals by their current status.

Allowed:

inwardStartDate

date-time

Filters deals by the inward settlement time, starting from this date and time.

inwardEndDate

date-time

Filters deals by the inward settlement time, ending at this date and time.

outwardStartDate

date-time

Filters deals by the outward settlement time, starting from this date and time.

outwardEndDate

date-time

Filters deals by the outward settlement time, ending at this date and time.

createdStartDate

date-time

Filters deals by their creation date, starting from this date and time.

createdEndDate

date-time

Filters deals by their creation date, ending at this date and time.

limit

int32

required

The maximum number of items to return in a single response. Used for pagination.

skip

int32

required

The number of items to skip before starting to return the results. Used for pagination.

orderBy

string

enum

Defaults to createdDateDesc

Specifies the order in which to return the deals, either by ascending or descending creation date.

Allowed:

baseCurrency

string

enum

Specifies the currency to get equivalent amount in the specified currency.

minimumAmount

number

Filters deals by a minimum amount.

maximumAmount

number

Filters deals by a maximum amount.

Responses

200Resultant paginated list of deals.

400Unacceptable request. Indicates that the request was malformed or invalid.

500A server-side error occurred. Indicates an unexpected error on the server.