Skip to main content
GET
/
v1
/
exchange
/
stablefx
/
trades
/
{tradeId}
Get a trade
curl --request GET \
  --url https://api-sandbox.circle.com/v1/exchange/stablefx/trades/{tradeId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "contractTradeId": "24",
  "status": "pending",
  "rate": 0.915,
  "from": {
    "currency": "USDC",
    "amount": "<string>"
  },
  "to": {
    "currency": "USDC",
    "amount": "<string>"
  },
  "createDate": "2023-01-01T12:04:05Z",
  "updateDate": "2023-01-01T12:04:05Z",
  "quoteId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
  "settlementTransactionHash": "0x5ba96ea26172dde9a83b151d1a73f163bafe883f691b80e404b271b00eb86a0a",
  "contractTransactions": {
    "recordTrade": {
      "status": "success",
      "txHash": "0x522a01ed8750423ab213a3d4618f231e0984874509521e98977f017b452cd455",
      "errorDetails": "<string>"
    },
    "takerDeliver": {
      "status": "success",
      "txHash": "0x522a01ed8750423ab213a3d4618f231e0984874509521e98977f017b452cd455",
      "errorDetails": "<string>"
    },
    "makerDeliver": {
      "status": "success",
      "txHash": "0x522a01ed8750423ab213a3d4618f231e0984874509521e98977f017b452cd455",
      "errorDetails": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Circle's API Keys are formatted in the following structure "PREFIX:ID:SECRET". All three parts are requred to make a successful request.

Path Parameters

​
tradeId
string<uuid>
required

The ID of the trade.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

Query Parameters

​
type
enum<string>
required

The type of trader.

Available options:
maker,
taker

Response

200 - application/json

Trade retrieved successfully

Detailed trade information including contract transactions

​
id
string<uuid>

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
contractTradeId
string

The contract trade identifier (numeric string)

Example:

"24"

​
status
enum<string>
Available options:
pending,
completed,
confirmed,
pending_settlement,
taker_funded,
maker_funded,
breaching,
breached
​
rate
number

Exchange rate for the quote

Example:

0.915

​
from
object

Currency and amount details for a foreign exchange transaction

​
to
object

Currency and amount details for a foreign exchange transaction

​
createDate
string<date-time>

Date and time when the resource was created

Example:

"2023-01-01T12:04:05Z"

​
updateDate
string<date-time>

Date and time when the resource was last updated

Example:

"2023-01-01T12:04:05Z"

​
quoteId
string<uuid>

System-generated unique identifier of the resource.

Example:

"c4d1da72-111e-4d52-bdbf-2e74a2d803d5"

​
settlementTransactionHash
string

The transaction hash for the final settlement transaction

Example:

"0x5ba96ea26172dde9a83b151d1a73f163bafe883f691b80e404b271b00eb86a0a"

​
contractTransactions
object

Collection of contract functions associated with a trade