Estimate position

GET 
/api/v2/estimate/position

Estimate the margin that would be required for maintaining the specified position, collateral increase needed to open the specified position and the liquidation price estimate. Margin estimates are scaled to asset decimal places. Liquidation price estimates are scaled to asset decimal places by default, unless an argument to scale to market decimal places is specified in the request.

Request

Query Parameters

marketId stringrequired

Market ID to estimate position for.

openVolume int64required

Open volume. This field is a signed integer scaled to the market's position decimal places. A negative number denotes a short position.

averageEntryPrice stringrequired

Average entry price corresponding to the open volume. The price is an unsigned integer. For example 123456 is a correctly formatted price of 1.23456 assuming market configured to 5 decimal places.

marginAccountBalance stringrequired

Margin account balance. Needs to be provided scaled to asset decimal places.

generalAccountBalance stringrequired

General account balance. Needs to be provided scaled to asset decimal places.

orderMarginAccountBalance stringrequired

Order margin account balance. Needs to be provided scaled to asset decimal places.

marginMode string
Possible values: [MARGIN_MODE_UNSPECIFIED, MARGIN_MODE_CROSS_MARGIN, MARGIN_MODE_ISOLATED_MARGIN]
Default value: MARGIN_MODE_UNSPECIFIED
Margin mode for the party, cross margin or isolated margin.
• MARGIN_MODE_UNSPECIFIED: Never valid.
• MARGIN_MODE_CROSS_MARGIN: Cross margin mode - margin is dynamically acquired and released as a position is marked to market
• MARGIN_MODE_ISOLATED_MARGIN: Isolated margin mode - margin for any newly opened position volume is transferred to the margin account when the trade is executed
marginFactor string

Margin factor to be used along with isolated margin mode.

includeRequiredPositionMarginInAvailableCollateral boolean

Whether the estimated position margin increase should be included in available collateral for liquidation price calculation in isolated margin mode.

scaleLiquidationPriceToMarketDecimals boolean

Whether the liquidation price estimates should be scaled to market decimal places or by asset decimal places. If not set, asset decimal places are used.

Responses

200

A successful response.

application/json

Schema

Schema

collateralIncreaseEstimate object
Estimated margin account balance increase.
bestCase Estimate assuming no slippage
worstCase Estimate assuming slippage cap is applied
liquidation object

Liquidation price range estimate for the specified position. Only populated if available collateral was specified in the request.

bestCase object

Liquidation price estimate assuming no slippage.

includingBuyOrders string

Liquidation price assuming buy orders start getting filled.

includingSellOrders string

Liquidation price assuming sell orders start getting filled.

openVolumeOnly string

Liquidation price for current open volume ignoring any active orders.

worstCase object

Liquidation price estimate assuming slippage cap is applied.

includingBuyOrders string

Liquidation price assuming buy orders start getting filled.

includingSellOrders string

Liquidation price assuming sell orders start getting filled.

openVolumeOnly string

Liquidation price for current open volume ignoring any active orders.

margin object

Margin level range estimate for the specified position.

bestCase object

Margin level estimate assuming no slippage.

asset string

Asset ID for which the margin levels apply.

collateralReleaseLevel string

Collateral release level value. This field is an unsigned integer scaled to the asset's decimal places.

initialMargin string

Initial margin value. This field is an unsigned integer scaled to the asset's decimal places.

maintenanceMargin string

Maintenance margin value. This field is an unsigned integer scaled to the asset's decimal places.

marginFactor string

Margin factor, relevant only for isolated margin, 0 otherwise.

marginMode - MARGIN_MODE_UNSPECIFIED: Never valid. - MARGIN_MODE_CROSS_MARGIN: Cross margin mode - margin is dynamically acquired and released as a position is marked to market - MARGIN_MODE_ISOLATED_MARGIN: Isolated margin mode - margin for any newly opened position volume is transferred to the margin account when the trade is executed

Possible values: [MARGIN_MODE_UNSPECIFIED, MARGIN_MODE_CROSS_MARGIN, MARGIN_MODE_ISOLATED_MARGIN]

Default value: MARGIN_MODE_UNSPECIFIED

Margin mode for the party, cross margin or isolated margin.

marketId string

Market ID for which the margin levels apply.

orderMargin string

Margin required to cover orders in isolated margin mode.

partyId string

Party ID for whom the margin levels apply.

searchLevel string

Margin search level value. This field is an unsigned integer scaled to the asset's decimal places.

timestamp int64

Timestamp in Unix nanoseconds for when the ledger entry was created.

worstCase object

Margin level estimate assuming slippage cap is applied.

asset string

Asset ID for which the margin levels apply.

collateralReleaseLevel string

Collateral release level value. This field is an unsigned integer scaled to the asset's decimal places.

initialMargin string

Initial margin value. This field is an unsigned integer scaled to the asset's decimal places.

maintenanceMargin string

Maintenance margin value. This field is an unsigned integer scaled to the asset's decimal places.

marginFactor string

Margin factor, relevant only for isolated margin, 0 otherwise.

marginMode - MARGIN_MODE_UNSPECIFIED: Never valid. - MARGIN_MODE_CROSS_MARGIN: Cross margin mode - margin is dynamically acquired and released as a position is marked to market - MARGIN_MODE_ISOLATED_MARGIN: Isolated margin mode - margin for any newly opened position volume is transferred to the margin account when the trade is executed

Possible values: [MARGIN_MODE_UNSPECIFIED, MARGIN_MODE_CROSS_MARGIN, MARGIN_MODE_ISOLATED_MARGIN]

Default value: MARGIN_MODE_UNSPECIFIED

Margin mode for the party, cross margin or isolated margin.

marketId string

Market ID for which the margin levels apply.

orderMargin string

Margin required to cover orders in isolated margin mode.

partyId string

Party ID for whom the margin levels apply.

searchLevel string

Margin search level value. This field is an unsigned integer scaled to the asset's decimal places.

timestamp int64

Timestamp in Unix nanoseconds for when the ledger entry was created.

Example (from schema)

{
  "collateralIncreaseEstimate": {
    "bestCase": "string",
    "worstCase": "string"
  },
  "liquidation": {
    "bestCase": {
      "includingBuyOrders": "string",
      "includingSellOrders": "string",
      "openVolumeOnly": "string"
    },
    "worstCase": {
      "includingBuyOrders": "string",
      "includingSellOrders": "string",
      "openVolumeOnly": "string"
    }
  },
  "margin": {
    "bestCase": {
      "asset": "string",
      "collateralReleaseLevel": "string",
      "initialMargin": "string",
      "maintenanceMargin": "string",
      "marginFactor": "string",
      "marginMode": "MARGIN_MODE_UNSPECIFIED",
      "marketId": "string",
      "orderMargin": "string",
      "partyId": "string",
      "searchLevel": "string",
      "timestamp": "string"
    },
    "worstCase": {
      "asset": "string",
      "collateralReleaseLevel": "string",
      "initialMargin": "string",
      "maintenanceMargin": "string",
      "marginFactor": "string",
      "marginMode": "MARGIN_MODE_UNSPECIFIED",
      "marketId": "string",
      "orderMargin": "string",
      "partyId": "string",
      "searchLevel": "string",
      "timestamp": "string"
    }
  }
}

500

An internal server error

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]
message string

Example (from schema)

{
  "code": 0,
  "details": [
    {
      "@type": "string"
    }
  ],
  "message": "string"
}

Loading...