Get initial margin requirements
GET/initialmargin
Returns initial margin requirements based on given order parameters.
Request
Query Parameters
lmt
- a limit ordermkt
- an immediate-or-cancel order with 1% price protection
Possible values: [lmt
, mkt
]
The order type:
The symbol of the Futures.
Possible values: [buy
, sell
]
Responses
- 200
The maximum order size
- application/json
- Schema
Schema
- Success Response
- ErrorResponse
accountInactive
: The Futures account the request refers to is inactiveapiLimitExceeded
: The API limit for the calling IP address has been exceededauthenticationError
: The request could not be authenticatedinsufficientFunds
: The amount requested for transfer is below the amount of funds availableinvalidAccount
: The Futures account the transfer request refers to is invalidinvalidAmount
: The amount the transfer request refers to is invalidinvalidArgument
: One or more arguments provided are invalidinvalidUnit
: The unit the transfer request refers to is invalidJson Parse Error
: The request failed to pass valid JSON as an argumentmarketUnavailable
: The market is currently unavailablenonceBelowThreshold
: The provided nonce is below the thresholdnonceDuplicate
: The provided nonce is a duplicate as it has been used in a previous requestnotFound
: The requested information could not be foundrequiredArgumentMissing
: One or more required arguments are missingServer Error
: There was an error processing the requestUnavailable
: The endpoint being called is unavailableunknownError
: An unknown error has occurred
The initial margin requirement or null if there is no market
The estimated liquidation price after execution
The limit price of the order or null if the order type was mkt
and there is no market
Possible values: [MARKET_SUSPENDED
, MARKET_NOT_FOUND
, INVALID_PRICE
, INVALID_QUANTITY
, SMALL_ORDER_LIMIT_EXCEEDED
, INSUFFICIENT_MARGIN
, WOULD_CAUSE_LIQUIDATION
, CLIENT_ORDER_ID_IN_USE
, CLIENT_ORDER_ID_TOO_LONG
, MAX_POSITION_EXCEEDED
, PRICE_COLLAR
, PRICE_DISLOCATION
, EDIT_HAS_NO_EFFECT
, ORDER_FOR_CANCELLATION_NOT_FOUND
, ORDER_FOR_EDIT_NOT_FOUND
, ORDER_CANNOT_HAVE_TRIGGER_PRICE
, POST_WOULD_EXECUTE
, IOC_WOULD_NOT_EXECUTE
, WOULD_EXECUTE_SELF
, WOULD_NOT_REDUCE_POSITION
, REJECTED_AFTER_EXECUTION
, MARKET_IS_POST_ONLY
, ORDER_LIMIT_EXCEEDED
, FIXED_LEVERAGE_TOO_HIGH
, CANNOT_EDIT_TRIGGER_PRICE_OF_TRAILING_STOP
, CANNOT_EDIT_LIMIT_PRICE_OF_TRAILING_STOP
, TRAILING_STOP_ORDER_LIMIT_EXCEEDED
, TRAILING_STOP_PERCENT_DEVIATION_EXCEEDS_MAX_DECIMAL_PLACES
, TRAILING_STOP_QUOTE_DEVIATION_NOT_MULTIPLE_OF_TICK_SIZE
, TRAILING_STOP_MAX_DEVIATION_TOO_LARGE
, TRAILING_STOP_MAX_DEVIATION_TOO_SMALL
, INSUFFICIENT_HEADROOM_AROUND_CURRENT_PRICE_TO_EDIT_TRAILING_STOP
, NO_REFERENCE_PRICE_AVAILABLE_FOR_CALCULATING_TRAILING_STOP_TRIGGER_PRICE
, INSUFFICIENT_CLOSING_MARGIN
, LIMIT_PRICE_SET_AS_ABSOLUTE_AND_RELATIVE
, LIMIT_PRICE_OFFSET_VALUE_INVALID
, LIMIT_PRICE_OFFSET_UNIT_INVALID
, LIMIT_PRICE_OFFSET_MUST_HAVE_VALUE_AND_UNIT
, LIMIT_PRICE_OFFSET_QUOTE_CURRENCY_VALUE_MUST_BE_MULTIPLE_OF_TICK_SIZE
, LIMIT_PRICE_OFFSET_PERCENT_VALUE_TOO_MANY_DECIMAL_PLACES
, LIMIT_PRICE_OFFSET_TOO_HIGH
, LIMIT_PRICE_OFFSET_TOO_LOW
]
Possible values: [success
]
Server time in Coordinated Universal Time (UTC)
Possible values: [accountInactive
, apiLimitExceeded
, authenticationError
, insufficientFunds
, invalidAccount
, invalidAmount
, invalidArgument
, invalidUnit
, Json Parse Error
, marketUnavailable
, nonceBelowThreshold
, nonceDuplicate
, notFound
, requiredArgumentMissing
, Server Error
, Unavailable
, unknownError
]
Possible values: [accountInactive
, apiLimitExceeded
, authenticationError
, insufficientFunds
, invalidAccount
, invalidAmount
, invalidArgument
, invalidUnit
, Json Parse Error
, marketUnavailable
, nonceBelowThreshold
, nonceDuplicate
, notFound
, requiredArgumentMissing
, Server Error
, Unavailable
, unknownError
]
Error description.
Possible values: [error
]
Server time in Coordinated Universal Time (UTC)