Introduction

The Crypto Facilities platform provides a number of Application Programming Interfaces (APIs) through HTTP and Websockets (WS).

The HTTP API provides secure access to your Crypto Facilities account to perform actions such as:

• request current or historical price information
• check your account balance and PnL
• your margin parameters and estimated liquidation thresholds
• place or cancel orders (individually or in batch)
• see your open orders
• open positions or trade history
• request a digital asset withdrawal

These "endpoints" are explained in the HTTP API section.

The WebSocket API provides real-time data channels to the Crypto Facilities platform which eliminates the need to periodically send requests for frequently changing information. The WebSocket API section explains how to create "subscriptions" to these data channels.

Some of the endpoints allow performing sensitive tasks, such as initiating a digital asset withdrawal. To access these endpoints securely, the API uses encryption techniques developed by the National Security Agency. This section describes how to encrypt your communication with the API when accessing these endpoints.

The API can be implemented using any programming language you like (e.g. C, C++, Java or PHP), as long as it is capable of managing HTTP requests. We strongly suggest you look at the code examples listed in sample implementations.

Conventions and definitions

Server Time

The server time is in Coordinated Universal Time (UTC).

Unique Identifiers

Unique Identifier Example

c18f0c17-9971-40e6-8e5b-10df05d422f0

The system constructs unique identifiers according to the Universally Unique Identifier standard.

Dates and Times

Dates and Times Examples

2016-02-26T12:09:38.830Z

2016-02-26T12:09:38Z

The API requires dates and time arguments in the ISO8601 datetime format and returns all dates and times in the same format. The syntax of this format is <yyyy>-<mm>-<dd>T<HH>:<MM>:<SS>.<sss>Z where <yyyy> is the year, <mm> is the month, <dd> is the day, <HH> is the hour, <MM> is the minute, <SS> is the second and <sss> is the millisecond. When provided as an argument, <sss> is optional. Z denotes that the datetime is in UTC.

Symbols

The system identifies cash accounts, margin accounts, futures contracts and indices through ticker symbols. Please refer to the platform documentation for details on the ticker symbol syntax. The following shows some sample ticker symbols.

Order of Arguments

Example

When calling the tickers endpoint, the structure for rr_xbtusd will not contain the keys suspended, lastSize, vol24h, bid, bidSize, ask, askSize and markPrice. This is because rr_xbtusd is an index such that these keys do not apply.

{
  "symbol": "rr_xbtusd",
  "last": 4225,
  "lastTime": "2016-02-25T11:05:21.000Z",
  "open24h": 4179,
  "high24h": 4264,
  "low24h": 4177
}

When calling endpoints with required arguments, all arguments must be provided in the order they are listed (see section HTTP API resources).

Generate API keys

Your api_key (Public key) example:

rRra59qKQs3y1egAgSaG0RJlBcbq97wTUXSxXxPdhRZdv7z9ijZRWgrf

Your api_secret (Private key) example:

rttp4AzwRfYEdQ7R7X8Z/04Y4TZPa97pqCypi3xXxAqftygftnI6H9yGV+OcUOOJeFtZkr8mVwbAndU3Kz4Q+eG

In order to use the API, you need to generate a pair of unique API keys:

Limits

Up to 50 keys can be created with distinct nonces.

API Testing Environment

To allow clients to test their API implementation, we have API functionality in our futures demo environment publicly available that is completely separate from the production environment and does not require existing account credentials.

In order to get started, just navigate to:

https://conformance.cryptofacilities.com

Click the Sign Up button and an e-mail and password combination will be generated for you by the platform.

Review the Demo Environment Terms & Conditions and Kraken Privacy Policy before accepting.

Note the credentials so that you may re-use them if desired.

Once these steps are completed, select 'Complete Sign-Up' to create your Demo account

Once you have signed up, you can generate API keys for the purpose of testing.

The WebSocket and HTTP API code on this environment is identical to the live production code in terms of the feeds/endpoints and the response structure.

You may also use the Github repository which has libraries coded for multiple common programming languages.

The only difference between the demo API behaviour and that of the live production environment is that the base URL is not cryptofacilities.com but instead conformance.cryptofacilities.com.

Examples

Example: subscribe to WebSocket ticker feeds by sending:

{
  "event": "subscribe",
  "feed": "ticker",
  "product_ids": [
    "PI_XBTUSD",
    "FI_ETHUSD_210625"
  ]
}

On the demo, for the WebSocket API you would subscribe to:

wss://conformance.cryptofacilities.com/ws/v1

All the feeds are identical to those documented above.

For a similar exercise via the HTTP API you would request:

https://conformance.cryptofacilities.com/derivatives/api/v3/tickers

Please note that when you have successfully tested in the demo environment, the base URL in the live production platform environment works with

cryptofacilities.com

API URLs

To access the HTTP API's endpoints, HTTP calls need to be sent to endpoints under:

• https://www.cryptofacilities.com/derivatives/api/v3/
• https://www.cryptofacilities.com/api/history/v2/
• https://www.cryptofacilities.com/api/charts/v1/

To subscribe to a WebSocket feed, establish a WebSocket connection to:

wss://www.cryptofacilities.com/ws/v1

Note: The direct access URLs for IP whitelisting are different, see IP whitelisting below.

Crypto Facilities IP whitelisting for direct access

API/programmatic traders can connect directly to the exchange server to improve latency and performance by whitelisting up to 15 IP addresses.

The servers to connect through whitelisted addresses are as follows:

• https://api.cryptofacilities.com
• wss://api.cryptofacilities.com

Crypto Facilities reserves the right to remove any IP addresses from the whitelist at any time and for any reason.

HTTP API

HTTP API Introduction

Authentication

Authentication example

Inclusion of HTTP headers in Java where apiKey, nonce, and authent are determined as described in this section. For full working examples in different programming languages, see Sample Implementations.

String url = "https://www.cryptofacilities.com/derivatives/api/v3/sendorder";

URL obj = new URL(url);
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
...
con.setRequestProperty("APIKey", apiKey);
con.setRequestProperty("Nonce", nonce);
con.setRequestProperty("Authent", authent);

Calls to endpoints requiring authentication must include the following HTTP headers: APIKey and Authent. A third header, Nonce, may also be included (this is optional).

Some HTTP endpoints allow performing sensitive operations such as placing orders or requesting a digital asset withdrawal. These private endpoints can therefore be called only through encrypted requests, and an authentication string (Authent) must be included in each such request. Authent is computed from the following inputs:

PostData

postData is a & concatenation in the form <argument>=<value> and is specific to each HTTP endpoint.

Example: To operate the endpoint orderbook you choose the argument symbol with value fi_xbtusd_180615. postData is then given by symbol=fi_xbtusd_180615.

Update: Authentication Flow for v3 endpoints: As of 20th February 2024, to align with best practices and ensure a higher security standard, we are updating the authentication flow for /derivatives/* endpoints. (details below)

PostData Generation Changes: - Before release: Users were required to hash query string parameters before url-encoding for Authent generation, e.g., greeting=hello world. - After release: The authentication process will now require hashing the full, url-encoded URI component as it appears in the request, e.g., greeting=hello%20world. This update is particularly relevant for the batchorder endpoint, which accepts a JSON body in its query parameters.

Backward Compatibility and Future Plans: For the time being, this change is backward compatible. The API will accept both Authent generation methods described above. However, we aim to phase out the old method (hashing decoded query string parameters) in the future to maintain the highest security standards. We will provide ample notice ahead of this change and strongly encourage all users to transition to the new method as soon as possible to ensure seamless service continuity.

Nonce

Nonce is a continuously incrementing integer parameter. A good nonce is your system time in milliseconds (in string format). Our system tolerates nonces that are out of order for a brief period of time. Nonce is not required.

Example: 1415957147987

Many authentication issues are related with incorrect Nonce. A new pair of api keys will automatically reset the nonce and resolve these issues.

Endpoint Path

endpointPath This is the URL extension of the endpoint.

If an endpointPath starts with "/derivatives" it should not be included when Authent is being computed.

Example: /api/v3/orderbook

API Secret

The api_secret is obtained as described under generate-api-keys.

Example: rttp4AzwRfYEdQ7R7X8Z/04Y4TZPa97pqCypi3xXxAqftygftnI6H9yGV+OcUOOJeFtZkr8mVwbAndU3Kz4Q+eG

Authent

Based on these inputs, Authent needs to be computed as follows:

1. Concatenate postData + Nonce + endpointPath
2. Hash the result of step 1 with the SHA-256 algorithm
3. Base64-decode your api_secret
4. Use the result of step 3 to hash the result of the step 2 with the HMAC-SHA-512 algorithm
5. Base64-encode the result of step 4

Request Limits

Example

The following shows the return of call of the sendorder endpoint where the API limit has been exceeded.

{
  "result": "error",
  "serverTime": "2016-02-25T09:45:53.818Z",
  "error": "apiLimitExceeded"
}

Request limits are determined from cost associated with each API call and rate limiting budgets depend on which path the endpoint uses. Public endpoints do not have a cost and therefore do not count against any rate limiting budget. For /derivatives endpoints, clients can spend up to 500 every 10 seconds.

The below table displays the cost associated with each API call for /derivatives endpoints:

On the Batch Order endpoint, the cost is 9 + size of the batch of the requests. For example, a batch of 10 order requests, (send, edit, and or cancel) sent through the Batch Order endpoint would cost 19.

If the API limit is exceeded, the API will return error equal to apiLimitExceeded.

For /history endpoints, clients have a pool of up to 100 tokens that continually replenishes at a rate of 100 every 10 minutes.

The below table displays the cost associated with each API call for /history endpoints. The accountlog rate limit cost varies on the optional 'count' parameter (default count is 500):

Calls and Returns

Calls

Calls to endpoints that do not change the state of the server should be submitted with request type GET and with request parameters submitted in the URL. Calls to endpoints that do change the state of the server should be submitted with request type POST or PUT and with request parameters submitted in the request body.

Returns

Example response of a successful call to the sendorder endpoint.

{
  "result": "success",
  "serverTime": "2016-02-25T09:45:53.818Z",
  "sendStatus": {
    "receivedTime": "2016-02-25T09:45:53.601Z",
    "status": "placed",
    "order_id": "c18f0c17-9971-40e6-8e5b10df05d422f0"
  }
}

The API's returns are in JSON format. If the call was successful, the return includes the requested information or feedback on the requested action.

If a call was successful, the result key in the root structure will have the value success.

Example response of a successful call to the sendorder endpoint where the desired operation was not performed.

{
   "result":"success",
   "serverTime":"2016-02-25T09:45:53.818Z",
   "sendStatus":{
      "receivedTime":"2016-02-25T09:45:53.601Z",
      "status":"insufficientAvailableFunds"
   }
}

Note that if a call comes back with result equal to success, this merely means that the request has been received and assessed successfully. It does not necessarily mean that the desired operation has been performed. Details on the operation's status are returned in a status key, where applicable.

Trading (v3) API

Public API for Mars including primary trade endpoints.

Account Information

Get wallets

GET
https://www.cryptofacilities.com/derivatives/api/v3/accounts

This endpoint returns key information relating to all your accounts which may either be cash accounts or margin accounts. This includes digital asset balances, instrument balances, margin requirements, margin trigger estimates and auxiliary information such as available funds, PnL of open positions and portfolio value.

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Response - application/json

Example response: success
GET /accounts
code 200
application/json

{
  "accounts": {
    "cash": {
      "balances": {
        "xbt": 141.31756797,
        "xrp": 52465.1254
      },
      "type": "cashAccount"
    },
    "fi_xbtusd": {
      "auxiliary": {
        "af": 100.73891563,
        "pnl": 12.42134766,
        "pv": 153.73891563
      },
      "balances": {
        "FI_XBTUSD_171215": 50000,
        "FI_XBTUSD_180615": -15000,
        "xbt": 141.31756797,
        "xrp": 0
      },
      "currency": "xbt",
      "marginRequirements": {
        "im": 52.8,
        "lt": 39.6,
        "mm": 23.76,
        "tt": 15.84
      },
      "triggerEstimates": {
        "im": 3110,
        "lt": 2890,
        "mm": 3000,
        "tt": 2830
      },
      "type": "marginAccount"
    },
    "flex": {
      "availableMargin": 34122.66,
      "balanceValue": 34995.52,
      "collateralValue": 34122.66,
      "currencies": {
        "EUR": {
          "available": 4540.5837374453,
          "collateral": 4886.906656949836,
          "quantity": 4540.5837374453,
          "value": 4999.137289089901
        },
        "USD": {
          "available": 5000,
          "collateral": 5000,
          "quantity": 5000,
          "value": 5000
        },
        "XBT": {
          "available": 0.1185308247,
          "collateral": 4886.49976674881,
          "quantity": 0.1185308247,
          "value": 4998.721054420551
        }
      },
      "initialMargin": 0,
      "initialMarginWithOrders": 0,
      "maintenanceMargin": 0,
      "marginEquity": 34122.66,
      "pnl": 0,
      "portfolioValue": 34995.52,
      "totalUnrealized": 0,
      "totalUnrealizedAsMargin": 0,
      "type": "multiCollateralMarginAccount",
      "unrealizedFunding": 0
    }
  },
  "result": "success",
  "serverTime": "2016-02-25T09:45:53.818Z"
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "accounts": {
    "cash": {
      "balances": {
        "<field>": 0.0
      },
      "type": "cashAccount"
    }
  },
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Account

Account example
(Some parts of this example are auto-generated)

{
  "cash": {
    "balances": {
      "<field>": 0.0
    },
    "type": "cashAccount"
  }
}

Information for all margin and cash accounts

Type: Object

Object fields:

CashAccount

CashAccount example
(Some parts of this example are auto-generated)

{
  "balances": {
    "<field>": 0.0
  },
  "type": "cashAccount"
}

Type: Object

Object fields:

CashAccountBalances

CashAccountBalances example
(Some parts of this example are auto-generated)

{
  "<field>": 0.0
}

Type: Object

Object fields:

MarginAccount

MarginAccount example
(Some parts of this example are auto-generated)

{
  "auxiliary": {
    "af": 0.0,
    "funding": 0.0,
    "pnl": 0.0,
    "pv": 0.0,
    "usd": 0.0
  },
  "balances": {
    "<field>": 0.0
  },
  "currency": "string",
  "marginRequirements": {
    "im": 0.0,
    "lt": 0.0,
    "mm": 0.0,
    "tt": 0.0
  },
  "triggerEstimates": {
    "im": 0.0,
    "lt": 0.0,
    "mm": 0.0,
    "tt": 0.0
  },
  "type": "marginAccount"
}

Type: Object

Object fields:

Auxiliary

Auxiliary example
(Some parts of this example are auto-generated)

{
  "af": 0.0,
  "funding": 0.0,
  "pnl": 0.0,
  "pv": 0.0,
  "usd": 0.0
}

Type: Object

Object fields:

MarginAccountBalances

MarginAccountBalances example
(Some parts of this example are auto-generated)

{
  "<field>": 0.0
}

Type: Object

Object fields:

MarginRequirements

MarginRequirements example
(Some parts of this example are auto-generated)

{
  "im": 0.0,
  "lt": 0.0,
  "mm": 0.0,
  "tt": 0.0
}

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

Get open positions

GET
https://www.cryptofacilities.com/derivatives/api/v3/openpositions

This endpoint returns the size and average entry price of all open positions in Futures contracts. This includes Futures contracts that have matured but have not yet been settled.

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Response - application/json

Example response: failure
GET /openpositions
code 200
application/json

{
  "error": "apiLimitExceeded",
  "result": "error",
  "serverTime": "2016-02-25T09:45:53.818Z"
}

Example response: success
GET /openpositions
code 200
application/json

{
  "openPositions": [
    {
      "fillTime": "2020-07-22T14:39:12.376Z",
      "price": 9392.749993345933,
      "side": "short",
      "size": 10000,
      "symbol": "PI_XBTUSD",
      "unrealizedFunding": 0.00001045432180096817
    },
    {
      "fillTime": "2020-07-22T14:39:12.376Z",
      "price": 9399.749966754434,
      "side": "long",
      "size": 20000,
      "symbol": "FI_XBTUSD_201225"
    },
    {
      "fillTime": "2022-04-20T19:15:25.438Z",
      "maxFixedLeverage": 5,
      "pnlCurrency": "BTC",
      "price": 570,
      "side": "long",
      "size": 1,
      "symbol": "PF_DEFIUSD",
      "unrealizedFunding": -0.0073428045972263895
    }
  ],
  "result": "success",
  "serverTime": "2020-07-22T14:39:12.376Z"
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "openPositions": [
    {
      "fillTime": "string",
      "price": 0.0,
      "side": "long",
      "size": 0.0,
      "symbol": "string",
      "unrealizedFunding": 0.0
    }
  ],
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

OpenPositionJson

OpenPositionJson example
(Some parts of this example are auto-generated)

{
  "fillTime": "string",
  "price": 0.0,
  "side": "long",
  "size": 0.0,
  "symbol": "string",
  "unrealizedFunding": 0.0
}

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

Get position percentile of unwind queue

GET
https://www.cryptofacilities.com/derivatives/api/v3/unwindqueue

This endpoint returns the percentile of the open position in case of unwinding.

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Response - application/json

Example response: success
GET /unwindqueue
code 200
application/json

{
  "queue": [
    {
      "percentile": 100,
      "symbol": "PF_GMTUSD"
    },
    {
      "percentile": 20,
      "symbol": "FI_ETHUSD_220624"
    },
    {
      "percentile": 80,
      "symbol": "PF_UNIUSD"
    }
  ],
  "result": "success",
  "serverTime": "2022-06-13T18:01:18.695Z"
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "queue": [
    {
      "percentile": 0.0,
      "symbol": "string"
    }
  ],
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

UnwindQueueJson

UnwindQueueJson example
(Some parts of this example are auto-generated)

{
  "percentile": 0.0,
  "symbol": "string"
}

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

Assignment Program

Adds an assignment program preference

POST
https://www.cryptofacilities.com/derivatives/api/v3/assignmentprogram/add

This endpoint adds an assignment program preference

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Parameters

Response - application/json

Example response
(Some parts of this example are auto-generated)
POST /assignmentprogram/add
code 200
application/json

{
  "id": 0.0,
  "participant": {
    "acceptLong": true,
    "acceptShort": true,
    "contract": "PF_BTCUSD",
    "contractType": "flex",
    "enabled": true,
    "maxPosition": 10,
    "maxSize": 10,
    "timeFrame": "weekdays"
  }
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "id": 0.0,
  "participant": {
    "acceptLong": true,
    "acceptShort": true,
    "contract": "PF_BTCUSD",
    "contractType": "flex",
    "enabled": true,
    "maxPosition": 10,
    "maxSize": 10,
    "timeFrame": "weekdays"
  },
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

AssignmentParticipantJson

AssignmentParticipantJson example

{
  "acceptLong": true,
  "acceptShort": true,
  "contract": "PF_BTCUSD",
  "contractType": "flex",
  "enabled": true,
  "maxPosition": 10,
  "maxSize": 10,
  "timeFrame": "weekdays"
}

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

Lists current assignment programs

GET
https://www.cryptofacilities.com/derivatives/api/v3/assignmentprogram/current

This endpoint returns information on currently active assignment programs

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Response - application/json

Example response
(Some parts of this example are auto-generated)
GET /assignmentprogram/current
code 200
application/json

{
  "participants": [
    {
      "id": 0.0,
      "participant": {
        "acceptLong": true,
        "acceptShort": true,
        "contract": "PF_BTCUSD",
        "contractType": "flex",
        "enabled": true,
        "maxPosition": 10,
        "maxSize": 10,
        "timeFrame": "weekdays"
      }
    }
  ]
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "participants": [
    {
      "id": 0.0,
      "participant": {
        "acceptLong": true,
        "acceptShort": true,
        "contract": "PF_BTCUSD",
        "contractType": "flex",
        "enabled": true,
        "maxPosition": 10,
        "maxSize": 10,
        "timeFrame": "weekdays"
      }
    }
  ],
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

AssignmentParticipantDetails

AssignmentParticipantDetails example
(Some parts of this example are auto-generated)

{
  "id": 0.0,
  "participant": {
    "acceptLong": true,
    "acceptShort": true,
    "contract": "PF_BTCUSD",
    "contractType": "flex",
    "enabled": true,
    "maxPosition": 10,
    "maxSize": 10,
    "timeFrame": "weekdays"
  }
}

Type: Object

Object fields:

AssignmentParticipantJson

AssignmentParticipantJson example

{
  "acceptLong": true,
  "acceptShort": true,
  "contract": "PF_BTCUSD",
  "contractType": "flex",
  "enabled": true,
  "maxPosition": 10,
  "maxSize": 10,
  "timeFrame": "weekdays"
}

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

deletes an assignment program preference

POST
https://www.cryptofacilities.com/derivatives/api/v3/assignmentprogram/delete

This endpoint deletes an assignment program preference

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Parameters

Response - application/json

Example response
(Some parts of this example are auto-generated)
POST /assignmentprogram/delete
code 200
application/json

{
  "id": 0.0,
  "participant": {
    "acceptLong": true,
    "acceptShort": true,
    "contract": "PF_BTCUSD",
    "contractType": "flex",
    "enabled": true,
    "maxPosition": 10,
    "maxSize": 10,
    "timeFrame": "weekdays"
  }
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "id": 0.0,
  "participant": {
    "acceptLong": true,
    "acceptShort": true,
    "contract": "PF_BTCUSD",
    "contractType": "flex",
    "enabled": true,
    "maxPosition": 10,
    "maxSize": 10,
    "timeFrame": "weekdays"
  },
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

AssignmentParticipantJson

AssignmentParticipantJson example

{
  "acceptLong": true,
  "acceptShort": true,
  "contract": "PF_BTCUSD",
  "contractType": "flex",
  "enabled": true,
  "maxPosition": 10,
  "maxSize": 10,
  "timeFrame": "weekdays"
}

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

Lists all changes in assignment program preferences

GET
https://www.cryptofacilities.com/derivatives/api/v3/assignmentprogram/history

This endpoint returns information on assignment program preferences

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Response - application/json

Example response
(Some parts of this example are auto-generated)
GET /assignmentprogram/history
code 200
application/json

{
  "participants": [
    {
      "deleted": false,
      "participant": {
        "acceptLong": true,
        "acceptShort": true,
        "contract": "PF_BTCUSD",
        "contractType": "flex",
        "enabled": true,
        "maxPosition": 10,
        "maxSize": 10,
        "timeFrame": "weekdays"
      }
    }
  ]
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "participants": [
    {
      "deleted": false,
      "participant": {
        "acceptLong": true,
        "acceptShort": true,
        "contract": "PF_BTCUSD",
        "contractType": "flex",
        "enabled": true,
        "maxPosition": 10,
        "maxSize": 10,
        "timeFrame": "weekdays"
      }
    }
  ],
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

AssignmentParticipantHistoryJson

AssignmentParticipantHistoryJson example
(Some parts of this example are auto-generated)

{
  "deleted": false,
  "participant": {
    "acceptLong": true,
    "acceptShort": true,
    "contract": "PF_BTCUSD",
    "contractType": "flex",
    "enabled": true,
    "maxPosition": 10,
    "maxSize": 10,
    "timeFrame": "weekdays"
  }
}

Type: Object

Object fields:

AssignmentParticipantJson

AssignmentParticipantJson example

{
  "acceptLong": true,
  "acceptShort": true,
  "contract": "PF_BTCUSD",
  "contractType": "flex",
  "enabled": true,
  "maxPosition": 10,
  "maxSize": 10,
  "timeFrame": "weekdays"
}

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

Fee Schedules

Get fee schedules

GET
https://www.cryptofacilities.com/derivatives/api/v3/feeschedules

This endpoint lists all fee schedules.

Authentication is not required.

Response - application/json

Example response: success
GET /feeschedules
code 200
application/json

{
  "feeSchedules": [
    {
      "name": "PGTMainFees",
      "tiers": [
        {
          "makerFee": 0.02,
          "takerFee": 0.05,
          "usdVolume": 0
        },
        {
          "makerFee": 0.015,
          "takerFee": 0.04,
          "usdVolume": 100000
        },
        {
          "makerFee": 0.0125,
          "takerFee": 0.03,
          "usdVolume": 1000000
        },
        {
          "makerFee": 0.01,
          "takerFee": 0.025,
          "usdVolume": 5000000
        },
        {
          "makerFee": 0.0075,
          "takerFee": 0.02,
          "usdVolume": 10000000
        },
        {
          "makerFee": 0.005,
          "takerFee": 0.015,
          "usdVolume": 20000000
        },
        {
          "makerFee": 0.0025,
          "takerFee": 0.0125,
          "usdVolume": 50000000
        },
        {
          "makerFee": 0,
          "takerFee": 0.01,
          "usdVolume": 100000000
        }
      ],
      "uid": "7fc4d7c0-464f-4029-a9bb-55856d0c5247"
    },
    {
      "name": "mainfees",
      "tiers": [
        {
          "makerFee": 0.02,
          "takerFee": 0.05,
          "usdVolume": 0
        },
        {
          "makerFee": 0.015,
          "takerFee": 0.04,
          "usdVolume": 100000
        },
        {
          "makerFee": 0.0125,
          "takerFee": 0.03,
          "usdVolume": 1000000
        },
        {
          "makerFee": 0.01,
          "takerFee": 0.025,
          "usdVolume": 5000000
        },
        {
          "makerFee": 0.0075,
          "takerFee": 0.02,
          "usdVolume": 10000000
        },
        {
          "makerFee": 0.005,
          "takerFee": 0.015,
          "usdVolume": 20000000
        },
        {
          "makerFee": 0.0025,
          "takerFee": 0.0125,
          "usdVolume": 50000000
        },
        {
          "makerFee": 0,
          "takerFee": 0.01,
          "usdVolume": 100000000
        }
      ],
      "uid": "d46c2190-81e3-4370-a333-424f24387829"
    }
  ],
  "result": "success",
  "serverTime": "2022-03-31T20:38:53.677Z"
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "feeSchedules": [
    {
      "name": "PGTMainFees",
      "tiers": [
        {
          "makerFee": 0.02,
          "takerFee": 0.05,
          "usdVolume": 0
        },
        {
          "makerFee": 0.015,
          "takerFee": 0.04,
          "usdVolume": 100000
        },
        {
          "makerFee": 0.0125,
          "takerFee": 0.03,
          "usdVolume": 1000000
        },
        {
          "makerFee": 0.01,
          "takerFee": 0.025,
          "usdVolume": 5000000
        },
        {
          "makerFee": 0.0075,
          "takerFee": 0.02,
          "usdVolume": 10000000
        },
        {
          "makerFee": 0.005,
          "takerFee": 0.015,
          "usdVolume": 20000000
        },
        {
          "makerFee": 0.0025,
          "takerFee": 0.0125,
          "usdVolume": 50000000
        },
        {
          "makerFee": 0,
          "takerFee": 0.01,
          "usdVolume": 100000000
        }
      ],
      "uid": "7fc4d7c0-464f-4029-a9bb-55856d0c5247"
    }
  ],
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

FeeSchedule

FeeSchedule example

{
  "name": "PGTMainFees",
  "tiers": [
    {
      "makerFee": 0.02,
      "takerFee": 0.05,
      "usdVolume": 0
    },
    {
      "makerFee": 0.015,
      "takerFee": 0.04,
      "usdVolume": 100000
    },
    {
      "makerFee": 0.0125,
      "takerFee": 0.03,
      "usdVolume": 1000000
    },
    {
      "makerFee": 0.01,
      "takerFee": 0.025,
      "usdVolume": 5000000
    },
    {
      "makerFee": 0.0075,
      "takerFee": 0.02,
      "usdVolume": 10000000
    },
    {
      "makerFee": 0.005,
      "takerFee": 0.015,
      "usdVolume": 20000000
    },
    {
      "makerFee": 0.0025,
      "takerFee": 0.0125,
      "usdVolume": 50000000
    },
    {
      "makerFee": 0,
      "takerFee": 0.01,
      "usdVolume": 100000000
    }
  ],
  "uid": "7fc4d7c0-464f-4029-a9bb-55856d0c5247"
}

Type: Object

Object fields:

FeeTier

FeeTier example
(Some parts of this example are auto-generated)

{
  "makerFee": 0.015,
  "takerFee": 0.04,
  "usdVolume": 100000
}

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

Get fee schedule volumes

GET
https://www.cryptofacilities.com/derivatives/api/v3/feeschedules/volumes

Returns your fee schedule volumes for each fee schedule.

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Response - application/json

Example response: success
GET /feeschedules/volumes
code 200
application/json

{
  "result": "success",
  "serverTime": "2016-02-25T09:45:53.818Z",
  "volumesByFeeSchedule": {
    "eef90775-995b-4596-9257-0917f6134766": 53823
  }
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z",
  "volumesByFeeSchedule": {
    "7fc4d7c0-464f-4029-a9bb-55856d0c5247": 10,
    "d46c2190-81e3-4370-a333-424f24387829": 10
  }
}

Type: Object

Object fields:

FeeScheduleVolumes

FeeScheduleVolumes example

{
  "7fc4d7c0-464f-4029-a9bb-55856d0c5247": 10,
  "d46c2190-81e3-4370-a333-424f24387829": 10
}

The 30-day volume for your account.

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

General

Get notifications

GET
https://www.cryptofacilities.com/derivatives/api/v3/notifications

This endpoint provides the platform's notifications.

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Response - application/json

Example response: failure
GET /notifications
code 200
application/json

{
  "error": "apiLimitExceeded",
  "result": "error",
  "serverTime": "2016-02-25T09:45:53.818Z"
}

Example response: success
GET /notifications
code 200
application/json

{
  "notifications": [
    {
      "note": "We've launched a new Telegram group.",
      "priority": "low",
      "type": "general"
    },
    {
      "effectiveTime": "2018-06-29T15:00:00Z",
      "note": "Week contracts with maturity 29/Jun/2018 expire and settle.",
      "priority": "medium",
      "type": "settlement"
    }
  ],
  "result": "success",
  "serverTime": "2018-06-29T15:22:05.187Z"
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "notifications": [
    {
      "effectiveTime": "string",
      "expectedDowntimeMinutes": 0,
      "note": "string",
      "priority": "low",
      "type": "new_feature"
    }
  ],
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

NotificationJson

NotificationJson example
(Some parts of this example are auto-generated)

{
  "effectiveTime": "string",
  "expectedDowntimeMinutes": 0,
  "note": "string",
  "priority": "low",
  "type": "new_feature"
}

Type: Object

Object fields:

ErrorResponse

ErrorResponse example
(Some parts of this example are auto-generated)

{
  "error": "accountInactive",
  "errors": [
    "accountInactive"
  ],
  "result": "error",
  "serverTime": "2020-08-27T17:03:33.196Z"
}

Type: Object

Object fields:

Error

Error example

"accountInactive"

Error description.

• accountInactive: The Futures account the request refers to is inactive
• apiLimitExceeded: The API limit for the calling IP address has been exceeded
• authenticationError: The request could not be authenticated
• insufficientFunds: The amount requested for transfer is below the amount of funds available
• invalidAccount: The Futures account the transfer request refers to is invalid
• invalidAmount: The amount the transfer request refers to is invalid
• invalidArgument: One or more arguments provided are invalid
• invalidUnit: The unit the transfer request refers to is invalid
• Json Parse Error: The request failed to pass valid JSON as an argument
• marketUnavailable: The market is currently unavailable
• nonceBelowThreshold: The provided nonce is below the threshold
• nonceDuplicate: The provided nonce is a duplicate as it has been used in a previous request
• notFound: The requested information could not be found
• requiredArgumentMissing: One or more required arguments are missing
• Server Error: There was an error processing the request
• Unavailable: The endpoint being called is unavailable
• unknownError: An unknown error has occurred

Type: String

Must be one of: "accountInactive", "apiLimitExceeded", "authenticationError", "insufficientFunds", "invalidAccount", "invalidAmount", "invalidArgument", "invalidUnit", "Json Parse Error", "marketUnavailable", "nonceBelowThreshold", "nonceDuplicate", "notFound", "requiredArgumentMissing", "Server Error", "Unavailable", "unknownError"

Historical Data

Get your fills

GET
https://www.cryptofacilities.com/derivatives/api/v3/fills

This endpoint returns information on your filled orders for all futures contracts.

Authentication

• Authent header (Authentication string)

• APIKey header (General API key with at least read-only access)

Parameters

Response - application/json

Example response: success
GET /fills
code 200
application/json

{
  "fills": [
    {
      "fillTime": "2020-07-22T13:37:27.077Z",
      "fillType": "maker",
      "fill_id": "3d57ed09-fbd6-44f1-8e8b-b10e551c5e73",
      "order_id": "693af756-055e-47ef-99d5-bcf4c456ebc5",
      "price": 9400,
      "side": "buy",
      "size": 5490,
      "symbol": "PI_XBTUSD"
    },
    {
      "fillTime": "2020-07-21T12:41:52.790Z",
      "fillType": "taker",
      "fill_id": "56b86ada-73b0-454d-a95a-e29e3e85b349",
      "order_id": "3f513c4c-683d-44ab-a73b-d296abbea201",
      "price": 9456,
      "side": "buy",
      "size": 5000,
      "symbol": "PI_XBTUSD"
    }
  ],
  "result": "success",
  "serverTime": "2020-07-22T13:44:24.311Z"
}

This is one of:

• Success Response

• ErrorResponse

Schemas

Success Response

Success Response example
(Some parts of this example are auto-generated)

{
  "fills": [
    {
      "fillTime": "2021-11-18T02:39:41.826Z",
      "fillType": "maker",
      "fill_id": "98e3deeb-0385-4b25-b15e-7e8453512cb2",
      "order_id": "06b9d509-965c-4788-b317-0e5ca11d56fb",
      "price": 47000,
      "side": "buy",
      "size": 10,
      "symbol": "PI_XBTUSD"
    }
  ],
  "result": "success",
  "serverTime": "2020-08-27T17:03:33.196Z"
}