Get an exchange quote
POST/api/v1/orders/exchange/quote
Retrieve a market price quote based on the provided request.
Request
Header Parameters
- application/json
Body
required
from objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
to objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
Settlement date for the exchange quote
Responses
- 201
- 400
- 401
- 403
- 404
- 405
- 415
- 429
- 500
Created
- application/json
- Schema
- Example (from schema)
Schema
Unique ID of the exchange quote
rate objectrequired
Rate of the exchange
Possible values: [BID
, OFFER
]
from objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
to objectrequired
The specific monetary value that is being converted from in the currency exchange
Possible values: Value must match regular expression [A-Z]{3}
The type of currency that the money is being exchanged from
Expiration date of the exchange quote
Settlement date of the exchange quote
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"rate": {
"price": 0,
"currencyPair": "string",
"type": "BID"
},
"from": {
"amount": 100,
"currency": "USD"
},
"to": {
"amount": 100,
"currency": "USD"
},
"expiresAt": "2023-12-31",
"settlementDate": "2023-12-31"
}
Bad Request
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unauthorized
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Forbidden
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Not Found
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Method Not Allowed
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Unsupported Media Type
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Too Many Requests
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
properties object
{
"type": "string",
"title": "string",
"status": 0,
"detail": "string",
"instance": "string",
"properties": {}
}