API Reference

Get all FX trades

gethttps://api-sandbox.circle.com/v1/exchange/trades

Reference
Playground

Returns all cross-currency trades. You can include an optional settlementId query parameter to filter the trades to only a specific settlement.

Query parameters

settlementId

uuid

Queries items with the specified settlement id. Matches any settlement id if unspecified.

Response

200GetFxTradesResponse

Response Body

object

data

array of objects

Show 8 properties

string

Unique system generated identifier for the entity.

from

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Allowed valuesUSDCEURCMXNBRL

object

Show 2 properties

amount

string

Required

Magnitude of the amount, in units of the currency, with a ..

currency

string

Required

Allowed valuesUSDCEURCMXNBRL

status

string

Status of the trade.

Allowed valuespendingconfirmedfailedcompletepending_settlement

createDate

string

ISO-8601 UTC date/time format.

updateDate

string

ISO-8601 UTC date/time format.

quoteId

string

Unique system generated identifier for the entity.

settlementId

string

Unique system generated identifier for the entity.

401NotAuthorized

404NotFound

RequestChoose a language

ResponseChoose an example

1{
2  "data": [
3    {
4      "id": "b8627ae8-732b-4d25-b947-1df8f4007a29",
5      "from": {
6        "amount": "3.14",
7        "currency": "USDC"
8      },
9      "to": {
10        "amount": "3.14",
11        "currency": "USDC"
12      },
13      "status": "pending",
14      "createDate": "2020-04-10T02:13:30.000Z",
15      "updateDate": "2020-04-10T02:13:30.000Z",
16      "quoteId": "b8627ae8-732b-4d25-b947-1df8f4007a29",
17      "settlementId": "b8627ae8-732b-4d25-b947-1df8f4007a29"
18    }
19  ]
20}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy