Skip to main content
GET
/
rest
/
firms
Get All Firms
curl --request GET \
  --url https://api.exchange.fairx.net/rest/firms \
  --header 'CB-ACCESS-KEY: <api-key>'
[
  {
    "firm_uuid": "123e4567-e89b-12d3-a456-426614174000",
    "fcm_uuid": "abcdef12-3456-7890-abcd-ef1234567890",
    "name": "Acme Trading",
    "code": "ABC",
    "firm_role": "TRADING_FIRM",
    "max_order_size": 200,
    "self_match_prevention_mode": "CANCEL_AGGRESSING",
    "is24_by7_trading_disabled": false
  }
]

Authorizations

​
CB-ACCESS-KEY
string
header
required

The key string of the API key for the request

Response

Successfully retrieved firms

​
firm_uuid
string
Example:

"123e4567-e89b-12d3-a456-426614174000"

​
fcm_uuid
string
Example:

"abcdef12-3456-7890-abcd-ef1234567890"

​
name
string
Example:

"Acme Trading"

​
code
string
Example:

"ABC"

​
firm_role
enum<string>
Available options:
FCM,
TRADING_FIRM
Example:

"TRADING_FIRM"

​
max_order_size
integer<int32>
Example:

200

​
self_match_prevention_mode
enum<string>
Available options:
CANCEL_AGGRESSING,
CANCEL_RESTING,
CANCEL_BOTH
​
is24_by7_trading_disabled
boolean
Example:

false