Skip to main content
Version: mainnet (v0.71)

Estimate margin​

Estimate the margin that would be required for submitting this order

Query Parameters
    marketId string required

    Market ID for the order.

    partyId string required

    Party ID of the order.

    side string

    Possible values: [SIDE_UNSPECIFIED, SIDE_BUY, SIDE_SELL]

    Default value: SIDE_UNSPECIFIED

    Order side - indicator for Seller or Buyer side.

    • SIDE_UNSPECIFIED: Default value, always invalid
    • SIDE_BUY: Buy order
    • SIDE_SELL: Sell order
    type string

    Possible values: [TYPE_UNSPECIFIED, TYPE_LIMIT, TYPE_MARKET, TYPE_NETWORK]

    Default value: TYPE_UNSPECIFIED

    Type of the order.

    • TYPE_UNSPECIFIED: Default value, always invalid
    • TYPE_LIMIT: Used for Limit orders
    • TYPE_MARKET: Used for Market orders
    • TYPE_NETWORK: Used for orders where the initiating party is the network (with distressed parties)
    size uint64 required

    Size of order.

    price string required

    Price of the asset.

Responses

A successful response.

Schema
    marginLevels object

    Summary of the estimated margins for this order if it were to trade now.

    asset string
    collateralReleaseLevel string
    initialMargin string
    maintenanceMargin string
    marketId string
    partyId string
    searchLevel string
    timestamp int64
Loading...