Position

GET /position

Retrieve your position. Requires a valid API key sent with the x-api-key header.

Query parameters

  • pair string Required

    Market for position (e.g. USD_BTCCALL_PERP)

Responses

  • 200

    OK

    Hide response attributes Show response attributes object
    • code integer

      Response code

    • msg string

      Diagnostic message

    • result object

      Request result

      Hide result attributes Show result attributes
  • 503

    Error

    Hide response attributes Show response attributes object
GET /position
curl \
 -X GET https://api.everstrike.io/position?pair=string \
 -H "x-api-key: $API_KEY"
Response examples (200)
{
  "code": 200,
  "msg": "string",
  "result": {
    "size": 1,
    "free": 1,
    "locked": 0,
    "realized": 0,
    "funding": 0,
    "fees": 0,
    "stats": {
      "size": 1,
      "notional": 0.14,
      "margin": 1,
      "pnl": 0,
      "upnl": 0,
      "rpnl": 0,
      "equity": 1,
      "roe": 0,
      "mark": 2.1,
      "avg_entry": 3.4,
      "leverage": 2.82,
      "lp": 3.7,
      "bankrupt": 3.78,
      "direction": "BUY"
    }
  }
}
Response examples (503)
{
  "code": 503,
  "msg": "Invalid request",
  "result": {}
}