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

estimatePosition

Return a margin range for the specified position and liquidation price range if available collateral is supplied

estimatePosition(
marketId: ID!
openVolume: String!
orders: [OrderInfo!]
collateralAvailable: String
): PositionEstimate

Arguments

estimatePosition.marketId ● ID! non-null scalar

ID of the market to place the order on

estimatePosition.openVolume ● String! non-null scalar

Open volume - negative for short position (int64)

estimatePosition.orders ● [OrderInfo!] list input

Open and/or hypothetical orders

estimatePosition.collateralAvailable ● String scalar

Optional argument specifying collateral available for the position, if provided then response will contain the liquidation price estimate

Type

PositionEstimate object

Response for the estimate of the margin level and, if available, collateral was provided in the request, liqudation price for the specified position