DEderibit
Account Management
Private

Changed on

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

Request

  • Base URL
    https://test.deribit.com/api/v2
  • URL
    https://test.deribit.com/api/v2/private/get_position
  • Auth
    none declared

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",
    "user_id": 57874
  }
}

Changes

  • 82518876f388Revision changes
    • breaking

      the response's property type changed from integer to object for status

    • breaking

      removed the required property from the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

  • f6085bbfcb9aRevision changes
    • breaking

      the ///// response's property type changed from integer to number for status