API Reference

Wallets

API Overview

Health

Webhook Subscriptions

Configurations

Monitor Tokens

Developer Account

Faucet

Developer-Controlled Wallets

Wallet Sets

Wallets

Signing

Transactions

Token Lookup

Modular Wallets

Transfers

UserOps

Wallets

User-Controlled Wallets

Social/ Email Authentication

PIN Authentication

Users

Wallets

Transactions

Token Lookup

Signing

Compliance Engine

Address Screening

Get a trade

gethttps://api.circle.com/v1/exchange/stablefx/trades/{tradeId}

Reference
Playground

Returns a trade specified by the ID path parameter

Path parameters

tradeId

uuid

Required

The ID of the trade.

Query parameters

type

string

Required

The type of trader.

Response

200

Response Body

object

string

System-generated unique identifier of the resource.

contractTradeId

string

The contract trade identifier (numeric string)

status

string

Allowed valuespendingcompletedconfirmedpending_settlementtaker_fundedmaker_fundedbreachingbreached

rate

number

Exchange rate for the quote

from

object

Currency and amount details for a foreign exchange transaction

Show 2 properties

currency

string

Required

Currency code

Allowed valuesUSDCEURC

amount

string

Amount of currency, formatted as a string with up to six decimal places.

object

Currency and amount details for a foreign exchange transaction

Show 2 properties

currency

string

Required

Currency code

Allowed valuesUSDCEURC

amount

string

Amount of currency, formatted as a string with up to six decimal places.

createDate

string

Date and time when the resource was created

updateDate

string

Date and time when the resource was last updated

quoteId

string

System-generated unique identifier of the resource.

settlementTransactionHash

string

The transaction hash for the final settlement transaction

contractTransactions

object

Collection of contract functions associated with a trade

Show 3 properties

recordTrade

object

A blockchain transaction associated with a trade

Show 3 properties

status

string

The status of the transaction

Allowed valuespendingsuccessfailed

txHash

string

The transaction hash on the blockchain

errorDetails

string

Error details if the transaction failed

takerDeliver

object

A blockchain transaction associated with a trade

Show 3 properties

status

string

The status of the transaction

Allowed valuespendingsuccessfailed

txHash

string

The transaction hash on the blockchain

errorDetails

string

Error details if the transaction failed

makerDeliver

object

A blockchain transaction associated with a trade

Show 3 properties

status

string

The status of the transaction

Allowed valuespendingsuccessfailed

txHash

string

The transaction hash on the blockchain

errorDetails

string

Error details if the transaction failed

RequestChoose a language

ResponseChoose an example

1{
2  "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
3  "contractTradeId": "24",
4  "status": "pending",
5  "rate": 0.915,
6  "from": {
7    "currency": "USDC",
8    "amount": ""
9  },
10  "to": {
11    "currency": "USDC",
12    "amount": ""
13  },
14  "createDate": "2023-01-01T12:04:05Z",
15  "updateDate": "2023-01-01T12:04:05Z",
16  "quoteId": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
17  "settlementTransactionHash": "0x5ba96ea26172dde9a83b151d1a73f163bafe883f691b80e404b271b00eb86a0a",
18  "contractTransactions": {
19    "recordTrade": {
20      "status": "success",
21      "txHash": "0x522a01ed8750423ab213a3d4618f231e0984874509521e98977f017b452cd455",
22      "errorDetails": ""
23    },
24    "takerDeliver": {
25      "status": "success",
26      "txHash": "0x522a01ed8750423ab213a3d4618f231e0984874509521e98977f017b452cd455",
27      "errorDetails": ""
28    },
29    "makerDeliver": {
30      "status": "success",
31      "txHash": "0x522a01ed8750423ab213a3d4618f231e0984874509521e98977f017b452cd455",
32      "errorDetails": ""
33    }
34  }
35}

Did this page help you?

Developer Terms Service Terms Privacy Policy Acceptable Use Your Privacy Choices

Cookie Policy