Submits a dry-mode to simulate an order submission
Changed onRequest
- Base URLhttps://api.ethereal.trade
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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
Example response
{
"marginAvailable": "5000.75",
"marginRequired": "1000.5",
"riskAvailable": "100000000",
"riskUsed": "3000.25",
"totalUsedMargin": "3000.25"
}Changes
- warning
added the new
QuantityBelowMinimumenum value to the/////////response property for the response status - warning
added the new
QuantityBelowMinimumenum value to the////response property for the response status - info
added the non-success response with the status
- warning
- breaking
the
/////request property type changed fromnumbertointeger - breaking
the
/////request property format changed from no format touint64 - breaking
the
/////request property type changed fromnumbertointeger - breaking
the
/////request property type changed fromstringto no type - breaking
the
/////request property format changed from no format touint32 - breaking
the
/////request property type changed fromnumbertointeger - breaking
the
/////request property type changed fromintegerto no type - breaking
the
/////request property type changed fromnumbertointeger - breaking
the
/////request property type changed fromnumbertointeger - breaking
the
/////request property format changed from no format touint64 - breaking
the
/////request property type changed fromnumbertointeger - breaking
the
/////request property type changed fromstringto no type - breaking
the
/////request property format changed from no format touint32 - breaking
the
/////request property type changed fromnumbertointeger - breaking
the
/////request property type changed fromintegerto no type - breaking
the
/////request property type changed fromnumbertointeger - breaking
the
response's property type changed fromstringto no type for status - breaking
the
/////response's property type changed fromstringto no type for status - breaking
the
response's property type changed fromstringto no type for status - warning
the
/////request property's maxLength was set to36 - warning
the
/////request property's maxLength was set to36 - warning
the
/////request property's min was set to0.00 - warning
the
/////request property's min was set to0.00 - info
the
request property default valueGTDwas removed - info
added
subschema #1to the/////request propertyoneOflist - info
added
subschema #1to the/////request propertyoneOflist - info
added
subschema #1to the/////request propertyoneOflist - info
added
subschema #1to the/////request propertyoneOflist - info
added to the
response propertyallOflist for the response status - info
added to the
/////response propertyallOflist for the response status - info
added to the
response propertyallOflist for the response status - info
the
response's property default valueBad Requestwas removed for the status - info
the
response's property default valueForbiddenwas removed for the status - info
the
response's property default valueNot Foundwas removed for the status - info
the
response's property default valueToo Many Requestswas removed for the status - info
the
response's property default valueUnauthorizedwas removed for the status - info
the
response's property default value400was removed for the status - info
the
response's property default value401was removed for the status - info
the
response's property default value403was removed for the status - info
the
response's property default value404was removed for the status - info
the
response's property default value429was removed for the status - info
removed the
AccountSuspendedenum value from theresponse property for the response status - info
removed the
AccountSuspendedenum value from the/////response property for the response status - info
removed the
AccountSuspendedenum value from theresponse property for the response status - info
removed the
CausesImmediateLiquidationenum value from theresponse property for the response status - info
removed the
DuplicateClientOrderIdenum value from the/////response property for the response status - info
removed the
DuplicateClientOrderIdenum value from theresponse property for the response status - info
removed the
DuplicateSameSideOcoenum value from theresponse property for the response status - info
removed the
ExchangeSuspendedenum value from the/////response property for the response status - info
removed the
ExchangeSuspendedenum value from theresponse property for the response status - info
removed the
ImmediateMatchPostOnlyenum value from theresponse property for the response status - info
removed the
InstrumentOpenValueCapExceededenum value from the/////response property for the response status - info
removed the
InstrumentOpenValueCapExceededenum value from theresponse property for the response status - info
removed the
InsufficientBalanceenum value from theresponse property for the response status - info
removed the
InsufficientBalanceenum value from the/////response property for the response status - info
removed the
InsufficientBalanceenum value from theresponse property for the response status - info
removed the
InsuranceFundCannotOpenPositionsenum value from the/////response property for the response status - info
removed the
InsuranceFundCannotOpenPositionsenum value from theresponse property for the response status - info
removed the
InvalidBinaryDataenum value from the/////response property for the response status - info
removed the
InvalidBinaryDataenum value from theresponse property for the response status - info
removed the
InvalidExpireTimeenum value from the/////response property for the response status - info
removed the
InvalidExpireTimeenum value from theresponse property for the response status - info
removed the
InvalidGroupContingencyTypeenum value from the/////response property for the response status - info
removed the
InvalidGroupContingencyTypeenum value from theresponse property for the response status - info
removed the
InvalidNonceForSignerenum value from the/////response property for the response status - info
removed the
InvalidNonceForSignerenum value from theresponse property for the response status - info
removed the
InvalidSignerenum value from the/////response property for the response status - info
removed the
InvalidSignerenum value from theresponse property for the response status - info
removed the
InvalidSignerAddressenum value from the/////response property for the response status - info
removed the
InvalidSignerAddressenum value from theresponse property for the response status - info
removed the
InvalidTimeInForceenum value from the/////response property for the response status - info
removed the
InvalidTimeInForceenum value from theresponse property for the response status - info
removed the
LiquidationErrorenum value from theresponse property for the response status - info
removed the
LiquidationErrorenum value from the/////response property for the response status - info
removed the
LiquidationErrorenum value from theresponse property for the response status - info
removed the
MarginAccountBalanceZeroenum value from the/////response property for the response status - info
removed the
MarginAccountBalanceZeroenum value from theresponse property for the response status - info
removed the
MarketOrderReachedMaxSlippageenum value from theresponse property for the response status - info
removed the
NonceAlreadyUsedenum value from the/////response property for the response status - info
removed the
NonceAlreadyUsedenum value from theresponse property for the response status - info
removed the
OcoFilledenum value from theresponse property for the response status - info
removed the
Okenum value from theresponse property for the response status - info
removed the
OpenValueCapExceededenum value from theresponse property for the response status - info
removed the
OrderIncreasesPositionenum value from theresponse property for the response status - info
removed the
OrderWithZeroQuantityenum value from the/////response property for the response status - info
removed the
OrderWithZeroQuantityenum value from theresponse property for the response status - info
removed the
PriceAboveMaximumenum value from the/////response property for the response status - info
removed the
PriceAboveMaximumenum value from theresponse property for the response status - info
removed the
PriceBelowMinimumenum value from the/////response property for the response status - info
removed the
PriceBelowMinimumenum value from theresponse property for the response status - info
removed the
QuantityAboveMaximumenum value from the/////response property for the response status - info
removed the
QuantityAboveMaximumenum value from theresponse property for the response status - info
removed the
QuantityNotMultipleOfLotSizeenum value from the/////response property for the response status - info
removed the
QuantityNotMultipleOfLotSizeenum value from theresponse property for the response status - info
removed the
RiskLimitExceededenum value from theresponse property for the response status - info
removed the
RiskLimitExceededenum value from the/////response property for the response status - info
removed the
RiskLimitExceededenum value from theresponse property for the response status - info
removed the
SignerRevokedenum value from theresponse property for the response status - info
removed the
TooManyOpenOrdersenum value from the/////response property for the response status - info
removed the
TooManyOpenOrdersenum value from theresponse property for the response status - info
removed the
TooManyPositionsenum value from the/////response property for the response status - info
removed the
TooManyPositionsenum value from theresponse property for the response status - info
removed the
TooManyStopOrdersenum value from the/////response property for the response status - info
removed the
TooManyStopOrdersenum value from theresponse property for the response status - info
removed the
TriggerCanceledErrorenum value from theresponse property for the response status - info
removed the
UnfilledFillOrKillenum value from theresponse property for the response status - info
removed the
UnfilledImmediateOrCancelenum value from theresponse property for the response status - info
removed the
UnfilledMarketOrderenum value from theresponse property for the response status - info
response property
messagelist-of-types was narrowed by removing typesarrayfrom media typeapplication/jsonof response400
- breaking