Create an order

POST

https://api.t-dx.com/api/rest/v1/orders

POST

/api/rest/v1/orders

curl -X POST "https://api.t-dx.com/api/rest/v1/orders?dry=false&knowledgeOrExperience=false" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "clientOrderId": "9739d2bf-ddb3-4458-ab1f-98eb63279fb0",
  "subAccountId": "7376524e-6b6b-4137-9719-7e07a7709804",
  "type": "TYPE_MARKET",
  "side": "SIDE_BUY",
  "quantity": "0.05",
  "minQuantity": "0.001",
  "timeInForce": "TIME_IN_FORCE_DAY",
  "transactTime": "2024-01-15T09:30:00Z",
  "symbol": "BTC/CHF",
  "price": "14500.23"
}'

{
  "result": {
    "id": "2312bb39-a624-4785-aaf7-49b09034b560",
    "subAccountId": "7376524e-6b6b-4137-9719-7e07a7709804",
    "clientAccountId": "8aee564e-2eb1-4a57-b686-05476c2cfd93",
    "userId": "c43f7356-ad91-48bf-b647-96aa3ec59cf2",
    "pairId": "7a3fae7e-5a17-4931-821c-54b021f643da",
    "clientOrderId": "9739d2bf-ddb3-4458-ab1f-98eb63279fb0",
    "side": "SIDE_BUY",
    "quantity": "0.05",
    "minQuantity": "0.001",
    "executedQuantity": "0.045",
    "price": "14500.23",
    "status": "STATUS_PENDING",
    "type": "TYPE_MARKET",
    "symbol": "BTC/CHF",
    "timeInForce": "TIME_IN_FORCE_DAY",
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z",
    "reservedFunds": "2500.0",
    "clientCreationTime": "2024-01-15T09:30:00Z",
    "transactTime": "2024-01-15T09:30:00Z",
    "rejectionCause": "Market is closed",
    "reservedTransactionFee": "0.1",
    "reservedSwissStampTax": "0.1",
    "settleInstrumentId": "5321bef2-155d-40c7-aa63-5d18f5f6dc29",
    "averagePrice": "12.3"
  }
}

This endpoint is called to create an order by providing:

A unique order identifier generated by the client.
A price for a unit of the base instrument (e.g. 1 BTC for 24000 CHF)
A quantity and minimal quantity for the order.
A type (e.g. a limit order).
A side (e.g. sell).
A time in force (e.g. Good-til-cancel).
A symbol for the pair (e.g. BTC/CHF).

It returns the details of the order when successfully created, otherwise it returns an error message.

Authentication

AuthorizationBearer

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

Query parameters

drybooleanOptional

When true, it indicates that the order must not be eventually created but only as a dry-run.

knowledgeOrExperiencebooleanOptional

Optionally specify if the client has knowledge or experience about the type of instrument of the order

Request

This endpoint expects an object.

clientOrderIdstringRequiredformat: "^[0-9a-zA-ZÀ-ÿ-_@.+:]*$"

A unique identifier generated by the client that must be unique among all orders.

subAccountIdstringRequiredformat: "uuid"

The unique identifier of the sub-account the order will belong to.

typeenumRequired

Allowed values:

sideenumRequired

Allowed values:

quantitystringRequiredformat: "decimal"

Quantity of the order. It indicates the maximum quantity that can be filled by trades.

minQuantitystringRequiredformat: "decimal"

Minimal quantity of a fill.

timeInForceenumRequired

Allowed values:

transactTimedatetimeRequired

symbolstringRequired

The symbol of the pair the order is assigned to.

pricestringRequiredformat: "decimal"

Price of one unit of the base currency.

settleInstrumentIdstringOptionalformat: "uuid"

The unique identifier of the instrument that must be used to convert a trade from the quote currency.

complianceIdstringOptional

orderRestrictionsstringOptional

orderCapacitystringOptional

Response

A successful response.

resultobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

503

Service Unavailable Error