Skip to main content
GET
/
rest
/
v2
/
positions
/
{firm_uuid}
V2 - Get Firm Position
curl --request GET \
  --url https://api.exchange.fairx.net/rest/v2/positions/{firm_uuid} \
  --header 'CB-ACCESS-KEY: <api-key>'
{
  "Acme Trading": {
    "firm_uuid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "long_daily_position_limit": "5000000",
    "short_daily_position_limit": "5000000",
    "long_real_position_limit": "5000000",
    "short_real_position_limit": "5000000",
    "positions": {
      "BIPZ30": {
        "symbol": "BIPZ30",
        "long_initial_margin": "100",
        "short_initial_margin": "100",
        "short_working_position": 0.5,
        "long_working_position": 1,
        "short_filled_daily_position": 0,
        "long_filled_daily_position": 0,
        "short_filled_real_position": 0,
        "long_filled_real_position": 0,
        "total_futures_long_daily_dollar_amount": 0,
        "total_futures_short_daily_dollar_amount": 0,
        "total_futures_long_real_dollar_amount": 0,
        "total_futures_short_real_dollar_amount": 0
      }
    },
    "product_positions": {
      "BIP": {
        "product_code": "BIP",
        "trading_disabled": false,
        "trading24x7_disabled": false,
        "long_daily_contribution": 100,
        "short_daily_contribution": 50,
        "long_real_contribution": 100,
        "short_real_contribution": 50,
        "long_daily_position_limit": "5000000",
        "short_daily_position_limit": "5000000",
        "long_real_position_limit": "5000000",
        "short_real_position_limit": "5000000"
      }
    },
    "long_daily_contribution": 100,
    "short_daily_contribution": 50,
    "long_real_contribution": 100,
    "short_real_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