Skip to main content
GET
/
rest
/
firm-position-limits
/
{firm_uuid}
Get Firm Position Limits
curl --request GET \
  --url https://api.exchange.fairx.net/rest/firm-position-limits/{firm_uuid} \
  --header 'CB-ACCESS-KEY: <api-key>'
[
  {
    "firm_uuid": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
    "long_limit": 1000000,
    "short_limit": 500000,
    "weekend_margin_multiplier": 2,
    "source": "OVERRIDE",
    "timestamp": "2025-08-06T12:13:34Z"
  }
]

Authorizations

​
CB-ACCESS-KEY
string
header
required

The key string of the API key for the request

Path Parameters

​
firm_uuid
string
required

The UUID of the firm to get position limits for

Example:

"f81d4fae-7dec-11d0-a765-00a0c91e6bf6"

Response

Successfully retrieved firm position limits

​
firm_uuid
string
Example:

"f81d4fae-7dec-11d0-a765-00a0c91e6bf6"

​
long_limit
integer<int32>
Example:

1000000

​
short_limit
integer<int32>
Example:

500000

​
weekend_margin_multiplier
number<double>
Example:

2

​
source
enum<string>
Available options:
OVERRIDE,
CLEARING_HOUSE,
FCM
​
timestamp
string
Example:

"2025-08-06T12:13:34Z"