Order

Submits a dry-mode to simulate an order submission

Changed on
post/v1/order/dry-run

Request

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"
}

Changes

    • warning

      added the new QuantityBelowMinimum enum value to the ///////// response property for the response status

    • warning

      added the new QuantityBelowMinimum enum value to the //// response property for the response status

    • info

      added the non-success response with the status

    • breaking

      the ///// request property type changed from number to integer

    • breaking

      the ///// request property format changed from no format to uint64

    • breaking

      the ///// request property type changed from number to integer

    • breaking

      the ///// request property type changed from string to no type

    • breaking

      the ///// request property format changed from no format to uint32

    • breaking

      the ///// request property type changed from number to integer

    • breaking

      the ///// request property type changed from integer to no type

    • breaking

      the ///// request property type changed from number to integer

    • breaking

      the ///// request property type changed from number to integer

    • breaking

      the ///// request property format changed from no format to uint64

    • breaking

      the ///// request property type changed from number to integer

    • breaking

      the ///// request property type changed from string to no type

    • breaking

      the ///// request property format changed from no format to uint32

    • breaking

      the ///// request property type changed from number to integer

    • breaking

      the ///// request property type changed from integer to no type

    • breaking

      the ///// request property type changed from number to integer

    • breaking

      the response's property type changed from string to no type for status

    • breaking

      the ///// response's property type changed from string to no type for status

    • breaking

      the response's property type changed from string to no type for status

    • warning

      the ///// request property's maxLength was set to 36

    • warning

      the ///// request property's maxLength was set to 36

    • warning

      the ///// request property's min was set to 0.00

    • warning

      the ///// request property's min was set to 0.00

    • info

      the request property default value GTD was removed

    • info

      added subschema #1 to the ///// request property oneOf list

    • info

      added subschema #1 to the ///// request property oneOf list

    • info

      added subschema #1 to the ///// request property oneOf list

    • info

      added subschema #1 to the ///// request property oneOf list

    • info

      added to the response property allOf list for the response status

    • info

      added to the ///// response property allOf list for the response status

    • info

      added to the response property allOf list for the response status

    • info

      the response's property default value Bad Request was removed for the status

    • info

      the response's property default value Forbidden was removed for the status

    • info

      the response's property default value Not Found was removed for the status

    • info

      the response's property default value Too Many Requests was removed for the status

    • info

      the response's property default value Unauthorized was removed for the status

    • info

      the response's property default value 400 was removed for the status

    • info

      the response's property default value 401 was removed for the status

    • info

      the response's property default value 403 was removed for the status

    • info

      the response's property default value 404 was removed for the status

    • info

      the response's property default value 429 was removed for the status

    • info

      removed the AccountSuspended enum value from the response property for the response status

    • info

      removed the AccountSuspended enum value from the ///// response property for the response status

    • info

      removed the AccountSuspended enum value from the response property for the response status

    • info

      removed the CausesImmediateLiquidation enum value from the response property for the response status

    • info

      removed the DuplicateClientOrderId enum value from the ///// response property for the response status

    • info

      removed the DuplicateClientOrderId enum value from the response property for the response status

    • info

      removed the DuplicateSameSideOco enum value from the response property for the response status

    • info

      removed the ExchangeSuspended enum value from the ///// response property for the response status

    • info

      removed the ExchangeSuspended enum value from the response property for the response status

    • info

      removed the ImmediateMatchPostOnly enum value from the response property for the response status

    • info

      removed the InstrumentOpenValueCapExceeded enum value from the ///// response property for the response status

    • info

      removed the InstrumentOpenValueCapExceeded enum value from the response property for the response status

    • info

      removed the InsufficientBalance enum value from the response property for the response status

    • info

      removed the InsufficientBalance enum value from the ///// response property for the response status

    • info

      removed the InsufficientBalance enum value from the response property for the response status

    • info

      removed the InsuranceFundCannotOpenPositions enum value from the ///// response property for the response status

    • info

      removed the InsuranceFundCannotOpenPositions enum value from the response property for the response status

    • info

      removed the InvalidBinaryData enum value from the ///// response property for the response status

    • info

      removed the InvalidBinaryData enum value from the response property for the response status

    • info

      removed the InvalidExpireTime enum value from the ///// response property for the response status

    • info

      removed the InvalidExpireTime enum value from the response property for the response status

    • info

      removed the InvalidGroupContingencyType enum value from the ///// response property for the response status

    • info

      removed the InvalidGroupContingencyType enum value from the response property for the response status

    • info

      removed the InvalidNonceForSigner enum value from the ///// response property for the response status

    • info

      removed the InvalidNonceForSigner enum value from the response property for the response status

    • info

      removed the InvalidSigner enum value from the ///// response property for the response status

    • info

      removed the InvalidSigner enum value from the response property for the response status

    • info

      removed the InvalidSignerAddress enum value from the ///// response property for the response status

    • info

      removed the InvalidSignerAddress enum value from the response property for the response status

    • info

      removed the InvalidTimeInForce enum value from the ///// response property for the response status

    • info

      removed the InvalidTimeInForce enum value from the response property for the response status

    • info

      removed the LiquidationError enum value from the response property for the response status

    • info

      removed the LiquidationError enum value from the ///// response property for the response status

    • info

      removed the LiquidationError enum value from the response property for the response status

    • info

      removed the MarginAccountBalanceZero enum value from the ///// response property for the response status

    • info

      removed the MarginAccountBalanceZero enum value from the response property for the response status

    • info

      removed the MarketOrderReachedMaxSlippage enum value from the response property for the response status

    • info

      removed the NonceAlreadyUsed enum value from the ///// response property for the response status

    • info

      removed the NonceAlreadyUsed enum value from the response property for the response status

    • info

      removed the OcoFilled enum value from the response property for the response status

    • info

      removed the Ok enum value from the response property for the response status

    • info

      removed the OpenValueCapExceeded enum value from the response property for the response status

    • info

      removed the OrderIncreasesPosition enum value from the response property for the response status

    • info

      removed the OrderWithZeroQuantity enum value from the ///// response property for the response status

    • info

      removed the OrderWithZeroQuantity enum value from the response property for the response status

    • info

      removed the PriceAboveMaximum enum value from the ///// response property for the response status

    • info

      removed the PriceAboveMaximum enum value from the response property for the response status

    • info

      removed the PriceBelowMinimum enum value from the ///// response property for the response status

    • info

      removed the PriceBelowMinimum enum value from the response property for the response status

    • info

      removed the QuantityAboveMaximum enum value from the ///// response property for the response status

    • info

      removed the QuantityAboveMaximum enum value from the response property for the response status

    • info

      removed the QuantityNotMultipleOfLotSize enum value from the ///// response property for the response status

    • info

      removed the QuantityNotMultipleOfLotSize enum value from the response property for the response status

    • info

      removed the RiskLimitExceeded enum value from the response property for the response status

    • info

      removed the RiskLimitExceeded enum value from the ///// response property for the response status

    • info

      removed the RiskLimitExceeded enum value from the response property for the response status

    • info

      removed the SignerRevoked enum value from the response property for the response status

    • info

      removed the TooManyOpenOrders enum value from the ///// response property for the response status

    • info

      removed the TooManyOpenOrders enum value from the response property for the response status

    • info

      removed the TooManyPositions enum value from the ///// response property for the response status

    • info

      removed the TooManyPositions enum value from the response property for the response status

    • info

      removed the TooManyStopOrders enum value from the ///// response property for the response status

    • info

      removed the TooManyStopOrders enum value from the response property for the response status

    • info

      removed the TriggerCanceledError enum value from the response property for the response status

    • info

      removed the UnfilledFillOrKill enum value from the response property for the response status

    • info

      removed the UnfilledImmediateOrCancel enum value from the response property for the response status

    • info

      removed the UnfilledMarketOrder enum value from the response property for the response status

    • info

      response property message list-of-types was narrowed by removing types array from media type application/json of response 400