Skip to main content
GET
/
rest
/
positions
/
{firm_uuid}
Get Firm Position
curl --request GET \
  --url https://api.exchange.fairx.net/rest/positions/{firm_uuid} \
  --header 'CB-ACCESS-KEY: <api-key>'
{
  "Acme Trading": {
    "firm_name": "Acme Trading",
    "long_contribution": 100,
    "positions": {
      "BIPZ30": {
        "short_working_position": 0,
        "long_working_position": 0,
        "short_filled_position": 0,
        "symbol": "BIPZ30",
        "long_filled_position": 0,
        "total_futures_long_dollar_amount": 0,
        "total_futures_short_dollar_amount": 0,
        "initial_margin": "100"
      }
    },
    "position_limit": "5000000",
    "short_contribution": 50
  }
}

Authorizations

​
CB-ACCESS-KEY
string
header
required

The key string of the API key for the request

Path Parameters

​
firm_uuid
string
required

The firm's UUID

Example:

"e80d6a4e-af9f-4fcb-a819-3d22c7017279"

Query Parameters

​
expired_filter
enum<string>

Filter positions by expiration status

Available options:
NONE,
TWO_WEEKS,
TRADE_WEEK,
NON_EXPIRED,
IS_ACTIVE

Response

200 - application/json

Successfully retrieved positions

​
{key}
object