Submit an Order to Buy or Sell Crypto

post https://apex-crypto/api/v2/orders

Client systems use this endpoint to submit new order instructions to buy or sell crypto on behalf of an investor.

The order processes asynchronously. The system allows duplicate submissions; however, order details must NOT change in subsequent requests. Orders are uniquely tracked for idempotency by the submitting system providing the clientOrderId field.

Clients can provide the amounts to purchase or sell crypto in two different ways:

Notional - Using the notional field, an investor may place an order for crypto given a USD amount to purchase. For example, an investor can buy $100 of BTCUSD at market price by entering 100 in the notional field.
Absolute - Using the quantity field, an investor may place an order for an exact amount of crypto. For example, an investor can sell 0.05 BTC for USD by entering 0.05 in the quantity field.

Body Params

Submits a new order to fill given the terms provided by the investor

account

string

required

Investor account identifier

bpsCommission

integer

Clients use this parameter to add commission (in basis points) to the investor's executed trade cost

bpsMarkup

integer

Clients use this parameter to add markup (in basis points) to the investor's ordered asset price

clientOrderId

string

required

length ≤ 64

Client-specified unique identifier used to track, manage, and retrieve details about the order once it's submitted.

expireTime

date-time | null

Time the order expires for GTD orders

fixedCommission

string

Clients use this parameter to add fixed commission (in USD) to the investor's executed trade cost

fixedMarkup

string

Clients use this parameter to add fixed markup (in USD) to the investor's ordered asset price

notional

string

Order size in approximate monetary units; mutually exclusive with quantity

price

string

All float fields must accommodate up to fifteen significant digits

quantity

string

Order size in number of product units; mutually exclusive with notional

side

string

required

BUY - Buy crypto assets
SELL - Sell crypto assets

stopPrice

string

The stop price for stop limit order.

symbol

string

required

The symbol representing a crypto asset on the platform

timeInForce

string

required

IOC - Fill immediately and cancel any amount that can't be filled
DAY - Fill order until the end of the current trading day
GTC - Fill order until canceled or after 90 days
GTD - Fill order until the good-till date

type

string

required

MARKET - Fill the order using current MARKET price
LIMIT - Fill the order matching the price constraints provided

Responses

Response body

object

averagePrice

string

The price of the order averaged across all filled quantities for the order

cancels

array of objects

cancels

object

rejectReason

string

request

object

required

A request to stop attempting to serve an order; a clientOrderId is identified alongside this request object in order to target a specific order to cancel

transactTime

date-time

createdAt

date-time

The time the order was submitted on the Apex Crypto platform

cumulativeQuantity

string

The total amount of quantity filled for an order; if subsequent orders are filled, this value may increase commensurately

executions

array of objects

The results of the order's attempt(s) to execute

executions

object

commission

string

In order to ensure that any configured minimum trade fee is met by any trading scenario, the first execution fill is charged the minimum fee. The Apex Crypto system maintains a running total of any bps commission charges as other fills are executed for that order. Once the minimum fee has been satisfied by the bps commission charges for all of the fills on the order, the bps commission charges apply to any subsequent fills.

executedAt

date-time

required

Time the execution was completed

string

required

A unique identifier for the execution report

netMoney

string

required

price

string

required

The price at which the execution filled

quantity

string

required

The amount that was filled in this execution

side

string

required

BUY - Buy crypto assets
SELL - Sell crypto assets

BUY SELL

symbol

string

required

The symbol filled

tradeDate

date

Trading date the execution was completed on

string

required

Unique clientOrderId that represents this order

leavesQuantity

string

In the case that your order is not yet or cannot be fully filled, this amount indicates the order's open quantity remaining

rejectReason

string

Provided when an order is rejected in the course of attempting to serve the request

request

object

required

account

string

required

Investor account identifier

bpsCommission

integer

Clients use this parameter to add commission (in basis points) to the investor's executed trade cost

bpsMarkup

integer

Clients use this parameter to add markup (in basis points) to the investor's ordered asset price

clientOrderId

string

required

length ≤ 64

Client-specified unique identifier used to track, manage, and retrieve details about the order once it's submitted.

expireTime

date-time | null

Time the order expires for GTD orders

fixedCommission

string

Clients use this parameter to add fixed commission (in USD) to the investor's executed trade cost

fixedMarkup

string

Clients use this parameter to add fixed markup (in USD) to the investor's ordered asset price

notional

string

Order size in approximate monetary units; mutually exclusive with quantity

price

string

All float fields must accommodate up to fifteen significant digits

quantity

string

Order size in number of product units; mutually exclusive with notional

side

string

required

BUY - Buy crypto assets
SELL - Sell crypto assets

BUY SELL

stopPrice

string

The stop price for stop limit order.

symbol

string

required

The symbol representing a crypto asset on the platform

timeInForce

string

required

IOC DAY GTC GTD

type

string

required

MARKET - Fill the order using current MARKET price
LIMIT - Fill the order matching the price constraints provided

LIMIT MARKET STOP_LIMIT

status

string

IN_PROGRESS COMPLETE

working

boolean

Defaults to false

True if the order is actively being worked

Response body

object

averagePrice

string

The price of the order averaged across all filled quantities for the order

cancels

array of objects

cancels

object

rejectReason

string

request

object

required

A request to stop attempting to serve an order; a clientOrderId is identified alongside this request object in order to target a specific order to cancel

transactTime

date-time

createdAt

date-time

The time the order was submitted on the Apex Crypto platform

cumulativeQuantity

string

The total amount of quantity filled for an order; if subsequent orders are filled, this value may increase commensurately

executions

array of objects

The results of the order's attempt(s) to execute

executions

object

commission

string

executedAt

date-time

required

Time the execution was completed

string

required

A unique identifier for the execution report

netMoney

string

required

price

string

required

The price at which the execution filled

quantity

string

required

The amount that was filled in this execution

side

string

required

BUY - Buy crypto assets
SELL - Sell crypto assets

BUY SELL

symbol

string

required

The symbol filled

tradeDate

date

Trading date the execution was completed on

string

required

Unique clientOrderId that represents this order

leavesQuantity

string

In the case that your order is not yet or cannot be fully filled, this amount indicates the order's open quantity remaining

rejectReason

string

Provided when an order is rejected in the course of attempting to serve the request

request

object

required

account

string

required

Investor account identifier

bpsCommission

integer

Clients use this parameter to add commission (in basis points) to the investor's executed trade cost

bpsMarkup

integer

Clients use this parameter to add markup (in basis points) to the investor's ordered asset price

clientOrderId

string

required

length ≤ 64

Client-specified unique identifier used to track, manage, and retrieve details about the order once it's submitted.

expireTime

date-time | null

Time the order expires for GTD orders

fixedCommission

string

Clients use this parameter to add fixed commission (in USD) to the investor's executed trade cost

fixedMarkup

string

Clients use this parameter to add fixed markup (in USD) to the investor's ordered asset price

notional

string

Order size in approximate monetary units; mutually exclusive with quantity

price

string

All float fields must accommodate up to fifteen significant digits

quantity

string

Order size in number of product units; mutually exclusive with notional

side

string

required

BUY - Buy crypto assets
SELL - Sell crypto assets

BUY SELL

stopPrice

string

The stop price for stop limit order.

symbol

string

required

The symbol representing a crypto asset on the platform

timeInForce

string

required

IOC DAY GTC GTD

type

string

required

MARKET - Fill the order using current MARKET price
LIMIT - Fill the order matching the price constraints provided

LIMIT MARKET STOP_LIMIT

status

string

IN_PROGRESS COMPLETE

working

boolean

Defaults to false

True if the order is actively being worked

Language

Credentials

Header


xxxxxxxxxx
11
1
curl --request POST \
2
     --url https://apex-crypto/api/v2/orders \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "side": "BUY",
8
  "timeInForce": "IOC",
9
  "type": "LIMIT"
10
}
11
'

Choose an example:

application/json

200This response returns when the order already exists.

201This response returns the newly created order.

400This response returns when the request to submit the order was submitted improperly.

500This response returns if the system encounters an unexpected error while handling this request.

defaultThis response returns if the system encounters an unexpected error while handling this request.