API Update: Introducing the ‚error‘ field to the Execution Endpoint schema
At BitMEX, we are committed to continually improving our platform and its infrastructure to support advanced trading capabilities for our users. As part of this ongoing effort, we are announcing an update to our REST and WebSocket APIs.
From 5 January 2025, a new field, error, will be added to the BitMEX Execution endpoint.
Effective Date and Time: 5 January 2025 at 06:00 – 09:00 UTC
What is changing?
A new field, error, will be added to the response of the Execution table (available via the /execution REST API endpoint and WebSocket API).
Please refer to a snippet example in the REST API or WebSocket API below:
/execution
{
„table“:“execution“,
„action“:“partial“,
„keys“:[],
„types“:{
„execID“:“guid“,
„orderID“:“guid“
…
„error“:“symbol“
}
Why are we making this change?
The addition of the error field is a necessary preparatory step for upcoming features.
This is an additive change, meaning it introduces a new field without removing any existing data. Most integrations should be unaffected.
If you have any questions about these upcoming changes, please contact Support.
To be the first to know about our new listings, product launches, giveaways and more, we invite you to join one of our online communities and connect with other traders. For the absolute latest, you can also follow us on Twitter, or read our blog and site announcements.
BitMEX Blog


















