Skip to content

Fig Markets REST API (1.0)

Below are the available REST API endpoints for Fig Markets REST API

Languages
Servers
Test API

https://api.test.figmarkets.com/v1/

Production API

https://api.figmarkets.com/v1/

Operations

Request

Get a list of the exchange credentials set up on your account.

curl -i -X GET \
  https://api.test.figmarkets.com/v1/account/exchange-credentials

Responses

List of exchange credentials

Bodyapplication/jsonArray [
aliasstring(account.exchangeCredentialsAlias)

Custom alias/reference for exchange credentials

credentialsIdinteger(account.credentialsId)

Unique identifier for credentials

exchangestring(account.exchange)

Exchange name

exchangeIdinteger(account.exchangeId)

Exchange identifier

exchangeShortCodestring(account.exchangeShortCode)

Short code for the exchange

isExchangeDefaultboolean(account.isExchangeDefault)

Whether these are the default exchange credentials

]
Response
application/json
[ { "alias": "DBT-main", "credentialsId": 1, "exchange": "Deribit", "exchangeId": 17, "exchangeShortCode": "DBT", "isExchangeDefault": true } ]

/account/exchange-credentials/{id}

Request

Get a set of exchange credentials by ID.

The ID is the exchange credential's unique identifier.

You can find the ID in the response of the Get exchange credentials endpoint.

The response will include the decrypted exchange credentials.

Path
idintegerrequired

Exchange Credentials ID

curl -i -X GET \
  'https://api.test.figmarkets.com/v1/account/exchange-credentials/{id}'

Responses

Exchange credentials details

Bodyapplication/json
aliasstring(account.exchangeCredentialsAlias)

Custom alias/reference for exchange credentials

clientIdstring(account.clientId)

Client ID for exchange credentials

clientSecretstring(account.clientSecret)

Client secret for exchange credentials

credentialsIdinteger(account.credentialsId)

Unique identifier for credentials

exchangeIdinteger(account.exchangeId)

Exchange identifier

isExchangeDefaultboolean(account.isExchangeDefault)

Whether these are the default exchange credentials

Response
application/json
{ "alias": "DBT-main", "clientId": "zAtLC8iG", "clientSecret": "CEXYHBPchiNcDEYxaFl7gIhA90gfebnyJ5NEjVmUDiI", "credentialsId": 1, "exchangeId": 17, "isExchangeDefault": true }

Request

Get a list of the OTC counterparties set up on your account.

curl -i -X GET \
  https://api.test.figmarkets.com/v1/account/otc-counterparty

Responses

List of OTC counterparties

Bodyapplication/jsonArray [
idinteger(account.otcCounterpartyId)

Unique identifier for the OTC counterpartie

namestring(account.otcCounterpartyName)

Name of the OTC counterpartie

]
Response
application/json
[ { "id": 12345, "name": "Counterparty X" } ]
Operations
Operations
Operations