Skip to main content
GET
/
orders
/
{orderId}
Get order
curl --request GET \
  --url https://api.sandbox1-dev.finhost.io/crypto-exchange/orders/{orderId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "profileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountIdFrom": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountIdTo": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "pair": "<string>",
  "volume": "<string>",
  "settings": {
    "type": "market",
    "desiredPrice": "<string>"
  },
  "state": {
    "status": "initiated"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "charge": {
    "percentage": 1,
    "contractId": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
orderId
string<uuid>
required

Order ID Order ID (uuid version 7)

Example:

"018e53c4-cd35-7863-be61-924932bfd862"

Query Parameters

​
companyId
string<uuid>

Company ID

Response

OK

​
id
string<uuid>
required

Order ID (uuid version 7)

Example:

"018e53c4-cd35-7863-be61-924932bfd862"

​
profileId
string<uuid>
required

Profile ID

​
accountIdFrom
string<uuid>
required

Account ID from which funds are taken

​
accountIdTo
string<uuid>
required

Account ID to which funds are sent

​
pair
string
required

Order pair

Pattern: ^[a-zA-Z0-9]{1,16}\/[a-zA-Z0-9]{1,16}$
Examples:

"USDT/EUR"

"BTC/EUR"

"1INCH/USDT"

​
side
enum<string>
required

Order side

Available options:
buy,
sell
​
volume
string
required

Order volume. If BUYING, the volume is in QUOTE currency. If SELLING, the volume is in BASE currency

Required string length: 1 - 36
Examples:

"42"

"4.2"

"4.20"

​
settings
object
required

Market order (executes immediately at the current market price)

​
state
object
required

Order initiated

​
createdAt
string<date-time>
required

Created date

​
updatedAt
string<date-time>
required

Updated date

​
charge
object

Charge info