Estimate order

post https://api.cvex.trade/v1/trading/estimate-order

The "Estimate Order" endpoint is designed to enable users to simulate the execution of an order without actually committing to the trade. By providing the same parameters that would be used in a real order creation, you can receive a detailed projection of the execution.

Response Codes

Code	Description
200	Success
422	Order was rejected
500	Unexpected errors or blockchain node malfunction

Cost

Each request to this endpoint costs 1 API credit

Body Params

contract

string

required

The symbol or numeric ID of the contract for which the order is being placed.

type

string

required

Defaults to market

Specifies the type of order, such as limit or market

limit_price

string

Defaults to 0

The limit price for the order, applicable only if the order type is limit.

time_in_force

string

required

Defaults to GTC

Defines how long the order remains valid before expiration. Options include "GTC" (Good Till Canceled), "IOC" (Immediate or Cancel), "FOK" (Fill or Kill), and "PO" (Post Only).

reduce_only

boolean

Defaults to false

A boolean flag indicating whether the order should only reduce a position, not increase it.

quantity_steps

string

Defaults to 0

The size of the order expressed in the smallest tradable increments, always an integer. Only one quantity parameter should be provided.

quantity_contracts

string

Defaults to 0

The size of the order in terms of contracts. Only one quantity parameter should be provided.

quantity_assets

string

Defaults to 0

The size of the order in units of the underlying asset. Only one quantity parameter should be provided.

premium_limit

float

Defaults to 100

The maximum premium in USDC that the client is willing to pay.

Response

Language

Credentials

Header


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://api.cvex.trade/v1/trading/estimate-order \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "type": "market",
8
  "time_in_force": "GTC"
9
}
10
'


xxxxxxxxxx
22
 
1
{
2
  "current_equity": "1413.015215",
3
  "current_leverage": "0",
4
  "current_maintenance_margin": "0",
5
  "current_margin_utilization": "0",
6
  "current_positions_net_value": "0",
7
  "current_total_net_value": "0",
8
  "estimated_liquidation_price": "3264.9605",
9
  "maker_tokens_amount": "0",
10
  "new_equity": "1412.90482",
11
  "new_leverage": "10.893565",
12
  "new_maintenance_margin": "2.997146",
13
  "new_margin_utilization": "0.212127",
14
  "new_positions_net_value": "32.649605",
15
  "new_total_net_value": "32.649605",
16
  "operational_fee": "0.02",
17
  "realized_profit": "0",
18
  "taker_base_amount": "32.74",
19
  "taker_tokens_amount": "0.01",
20
  "trading_fee": "0.000983",
21
  "error": ""
22
}

Response Codes

Cost

200200