API Endpoint Cheat Sheet

Explanations of all the fields returned from our API endpoints.

Announcement
Below are the definitions for the Announcement model fields. https://www.bitmex.com/api/explorer/#/Announcement Returned from: /announcement /announc...
Tue, 29 Sep, 2020 at 7:29 PM
API Key
Below are the field definitions for the API Key endpoint. https://www.bitmex.com/api/explorer/#/APIKey Returned from: /apiKey [   { "id&quo...
Thu, 15 Oct, 2020 at 9:17 PM
Chat
Below are the field definitions for the Chat endpoints. https://www.bitmex.com/api/explorer/#/Chat Returned from: /chat [   { "id": 0...
Thu, 15 Oct, 2020 at 9:09 PM
Execution
Below are the field definitions for the Execution endpoints. https://www.bitmex.com/api/explorer/#/Execution Returned from: /execution /execution/tradeH...
Tue, 29 Sep, 2020 at 7:36 PM
Funding
Below are the field definitions for the Funding endpoint. https://www.bitmex.com/api/explorer/#/Funding Returned from: /funding [   { "time...
Thu, 15 Oct, 2020 at 9:37 PM
Liquidation
Below are the field definitions for the Liquidation endpoint. Returned from: /liquidation [   { "orderID": "string",// Unique...
Tue, 29 Sep, 2020 at 10:14 PM
Global Notification
Below are the field definitions for the Global Notification endpoint. https://www.bitmex.com/api/explorer/#/GlobalNotification Returned from: /globalN...
Thu, 15 Oct, 2020 at 9:15 PM