GET Platform Position

GET /positions/platform/:platform_code

const getPositionsForPlatform = (platformCode: string) => {
  const timestamp = Math.round(Date.now() / 1000)
  const payload = timestamp + 'GET' + '/positions/' + platformCode + '{}'
  const decodedSecret = Buffer.from(apiSecret, 'base64')
  const hmac = crypto.createHmac('sha256', decodedSecret)
  const signedPayload = hmac.update(payload).digest('base64')

  // SET HEADERS
  const headers = {
    'X-NDAX-API-KEY': 'public_key',
    'X-NDAX-SIGNED': signedPayload,
    'X-NDAX-TIMESTAMP': timestamp,
    'X-NDAX-PASSPHRASE': 'passphrase'
  }
  const options = {
    headers,
    body,
    json: true
  }

  return request.get(
    'https://api.ndax.in/positions/platform/' + platformCode,
    options
  )
}

Sample Response

{
  "message": [
    {
      "platform_code": "PLAT01",
      "participant_code": "CUST01",
      "asset": "BTC",
      "position_all_open_trades": "10.02",
      "position_all_accepted_trades_only": "10.02",
      "position_all_active_trades_only": "0"
    },
    {
      "platform_code": "PLAT01",
      "participant_code": "CUST01",
      "asset": "e₹",
      "position_all_open_trades": "-100200",
      "position_all_accepted_trades_only": "-100200",
      "position_all_active_trades_only": "0"
    },
    {
      "platform_code": "PLAT01",
      "participant_code": "CUST02",
      "asset": "USDT",
      "position_all_open_trades": "-110000",
      "position_all_accepted_trades_only": "0",
      "position_all_active_trades_only": "-110000"
    },
    {
      "platform_code": "PLAT01",
      "participant_code": "CUST02",
      "asset": "e₹",
      "position_all_open_trades": "109670",
      "position_accepted_trades_only": "0",
      "position_active_trades_only": "109670"
    }
  ]
}

Returns an array of all positions maintained at NDAX for the platform issuing the query. The response will include positions for all participants active on the platform. Response parameters listed below.

Query parameters include:

  • participant_code (optional) the participant_codes to filter the response by (e.g ?participant_code=PLAT01&participant_code=PLAT02)

Response:

ParameterDescriptionType

platform_code

The code of the platform for the position

string

participant_code

The code of the participant that holds the position

string

asset

The asset code for the for the position, e.g. e₹

string

position_all_open_trades

The net position of all open trades in the asset, i.e. trades with a trade_state of accepted or active

string

position_accepted_trades_only

The net position of all trades in the asset with a trade_state of accepted, i.e. trades where settlement has not yet been attempted

string

position_active_trades_only

The net position of all trades in the asset with a trade_state of active, i.e. trades where settlement has been attempted but was unsuccessful

string

Last updated