Sign in

v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Account Management
Private

Retrieves the open position for a specific instrument. Returns detailed position information including size, average entry price, mark price, unrealized P&L, initial margin, maintenance margin, and other position-related metrics.

If no position exists for the specified instrument, the response will indicate a zero position.

Scope: trade:read

Try in API console

get/private/get_position

Query parameters

instrument_namestring required

Unique instrument identifier

Example:BTC-PERPETUAL

Instrument name

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "instrument_name": "BTC-PERPETUAL"
  }
}