Get open positions

GET 
/openpositions

This endpoint returns the size and average entry price of all open positions in Futures contracts. This includes Futures contracts that have matured but have not yet been settled.

Responses

200

application/json

Schema

Schema

oneOf

Success Response

openPositions object[]

A list containing structures with information on open positions.

The list is sorted descending by fillTime.

Array [

symbol string

The symbol of the Futures.

side string

Possible values: [long, short]

The direction of the position.

size double

The size of the position.

price double

The average price at which the position was entered into.

fillTime string

The date and time the position was entered into (Deprecated field, fills endpoint for fill time is recommended).

unrealizedFunding double

Unrealised funding on the position.

pnlCurrency stringnull

Possible values: [USD, EUR, GBP, USDC, USDT, BTC, ETH]

Selected pnl currency for the position (default: USD)

maxFixedLeverage double

Max leverage selected for isolated position.

greeks object

The current Greeks, if this is an option position

iv doublerequired

delta doublerequired

gamma doublerequired

vega doublerequired

theta doublerequired

rho doublerequired

]

result stringrequired

Possible values: [success]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

ErrorResponse

errors Error (string)[]

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

error Error (string)

Possible values: [accountInactive, apiLimitExceeded, authenticationError, insufficientFunds, invalidAccount, invalidAmount, invalidArgument, invalidUnit, Json Parse Error, marketUnavailable, nonceBelowThreshold, nonceDuplicate, notFound, requiredArgumentMissing, Server Error, Unavailable, unknownError]

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

result stringrequired

Possible values: [error]

serverTime date-timerequired

Server time in Coordinated Universal Time (UTC)

success

{
  "result": "success",
  "openPositions": [
    {
      "side": "short",
      "symbol": "PI_XBTUSD",
      "price": 9392.749993345933,
      "fillTime": "2020-07-22T14:39:12.376Z",
      "size": 10000,
      "unrealizedFunding": 0.00001045432180096817
    },
    {
      "side": "long",
      "symbol": "FI_XBTUSD_201225",
      "price": 9399.749966754434,
      "fillTime": "2020-07-22T14:39:12.376Z",
      "size": 20000
    },
    {
      "side": "long",
      "symbol": "PF_DEFIUSD",
      "price": 570,
      "fillTime": "2022-04-20T19:15:25.438Z",
      "size": 1,
      "unrealizedFunding": -0.0073428045972263895,
      "pnlCurrency": "BTC",
      "maxFixedLeverage": 5
    }
  ],
  "serverTime": "2020-07-22T14:39:12.376Z"
}

failure

{
  "result": "error",
  "serverTime": "2016-02-25T09:45:53.818Z",
  "error": "apiLimitExceeded"
}

Loading...