Sign in
latestOpenAPI 3.1.02026-08-1051108155.9 KB

6e6f8dad92bf

Order

Submits a dry-mode to simulate an order submission

post/v1/order/dry-run

Request body

Example request

{
  "data": {
    "clientOrderId": "16e2da4d-58ab-4453-bdb4-8e4a865c12c1",
    "expiresAt": 1712623600,
    "onchainId": 1,
    "quantity": "5.5",
    "sender": "0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045",
    "stopPrice": "4200.5",
    "subaccount": "0x7072696d61727900000000000000000000000000000000000000000000000000"
  }
}

Response

code'AccountSuspended' | 'CausesImmediateLiquidation' | 'DuplicateSameSideOco' | 'ExchangeSuspended' | 'ImmediateMatchPostOnly' | 'InsufficientBalance' | 'LiquidationError' | 'MarketOrderReachedMaxSlippage' | 'MaxQuantityExceeded' | 'OcoFilled' | 'Ok' | 'OpenValueCapExceeded' | 'OrderIncreasesPosition' | 'RiskLimitExceeded' | 'SignerRevoked' | 'TriggerCanceledError' | 'UnfilledFillOrKill' | 'UnfilledImmediateOrCancel' | 'UnfilledMarketOrder' | 'MakerCanceledByTaker' | 'CloseOrder' required

Code indicating the result of the submission

marginAvailablestring decimal required

Margin available excluding this order in USD expressed as a decimal (precision: 9)

marginRequiredstring decimal required

Margin required for order in USD expressed as a decimal (precision: 9)

riskAvailablestring decimal required

Risk available for the product in USD expressed as a decimal (precision: 9)

riskUsedstring decimal required

Risk used including position and open orders in USD expressed as a decimal (precision: 9)

totalUsedMarginstring decimal required

Total used margin including this order in USD expressed as a decimal (precision: 9)

Example response

{
  "marginAvailable": "5000.75",
  "marginRequired": "1000.5",
  "riskAvailable": "100000000",
  "riskUsed": "3000.25",
  "totalUsedMargin": "3000.25"
}