Skip to main content

Get initial margin requirements

GET 

/initialmargin

Returns initial margin requirements based on given order parameters.

Request

Query Parameters

    orderType stringrequired

    Possible values: [lmt, mkt]

    The order type:

    • lmt - a limit order
    • mkt - an immediate-or-cancel order with 1% price protection
    symbol stringrequired

    The symbol of the Futures.

    side stringrequired

    Possible values: [buy, sell]

    size numberrequired
    limitPrice number

Responses

The maximum order size

Schema
    oneOf
    initialMargin number

    The initial margin requirement or null if there is no market

    estimatedLiquidationThreshold number

    The estimated liquidation price after execution

    price number

    The limit price of the order or null if the order type was mkt and there is no market

    error OrderError (string)

    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]

    result stringrequired

    Possible values: [success]

    serverTime date-timerequired

    Server time in Coordinated Universal Time (UTC)

Loading...