Changelog
Changelog
Keep track of changes and upgrades to the Rails API
[1.5.0] - 2025-05-29
Changed
- For both Create Order request and Cancel Order request, we have added a new Acknowledgment response in addition to the existing Confirmation response.
- The Acknowledgment response is sent immediately after the request is received, while the Confirmation response is sent after the order is successfully created or cancelled.
- This change allows for faster feedback on the request status, improving the user experience.
Security
-
Add a rate limit (
6000
requests per minute) for Create Order request and Cancel Order request.- This rate limit is shared across all markets and both endpoints.
- If the rate limit is exceeded, the request will be rejected with a
429 Too Many Requests
error.
-
Add a receive window constraint for Create Order request.
- The receive window is set to
1
second, meaning that the request will be rejected if it cannot be processed within this time frame. - You will receive a
400 Bad Request
error and an error messagereceive window exceeded, order rejected
.
- The receive window is set to
Deprecated
- We are phasing out the User Account WebSocket in favor of the User Account REST API.
[1.4.7] - 2025-05-22
Deprecated
- The Cancel Order By Price request is deprecated from Order Creation WebSocket and will be removed in the next release.
[1.4.6] - 2025-05-20
Added
- Add a new field
filledAt
to Get Completed Orders endpoint.
Deprecated
- The existing field
txCreated
from Get Completed Orders endpoint is deprecated and will be removed in the next release.
[1.4.5] - 2025-05-15
Fixed
- Fix cross order book issues for Order Book WebSocket.
Note
- Remove the
1%
balance cushion from market makers, which means the entire account balance can now be used for trading.
[1.4.4] - 2025-05-13
Security
- Add rate limit (20 requests per minute) for Authorization endpoint.
[1.4.3] - 2025-05-08
Changed
- Add new
filledQuantity
field to Order Filled Notifications. The existingquantity
field now represents the remaining quantity instead of the filled quantity. - Rename
createdAt
andupdatedAt
toorderCreatedAt
andorderFilledAt
respectively for Transaction Stream.
Note: Both changes above were breaking changes according to the Semantic Versioning rules, but they were not breaking changes in practice since the market makers were not using the API at the time of the change.
Fixed
- Fix empty body for Order Book WebSocket.
- Fix create, cancel, and fill messages not delivered in deterministic order for Order Creation WebSocket.
- Fix
updatedAt
timestamp not up to date from Cancel Order response.
[1.4.2] - 2025-05-03
Fixed
- Fix Order Book WebSocket
ping
message returning errors instead ofpong
.
[1.4.1] - 2025-05-02
Note
- Change unrealized PnL calculation to use index price instead of
(ask + bid) / 2
for Get Positions endpoint.
[1.4.0] - 2025-05-01
Added
- Add a new endpoint for Get Product Specifications.
Changed
- Raise Order Creation WebSocket connection limit from 2 to 4.
[1.3.0] - 2025-04-29
Added
- Add a new WebSocket Transaction Stream.
Changed
- Rename
refChainTxId
totxHash
in Get Withdrawals endpoint.
Note: This was a breaking change according to the Semantic Versioning rules, but it was not a breaking change in practice since the market makers were not using the API at the time of the change.
[1.2.1] - 2025-04-22
Changed
- Drop minimum two decimal places constraint for
price
andquantity
in Create Order request.
Fixed
- Fix Get Completed Orders endpoint having partially filled orders returned as completely filled.
[1.2.0] - 2025-04-15
Added
- Add a new User Account WebSocket.
Fixed
- Fix Get Supported Market endpoint to return only supported markets, not all markets.
Removed
- Remove per market option from Get Completed Orders endpoint.
[1.1.0] - 2025-04-8
Added
- Add post-only option to Create Order request.
Fixed
- Fix
maxSlippage
validation for Create Order request.
[1.0.1] - 2025-04-8
Added
- Add authorization token caching to all Get Account REST endpoints.