Release Notes¶
Use this page to track rollout guidance, payload support, and notable changes for the Nubra REST API.
Current UAT rollout
The current rollout is staged for migration validation.
Users mapped to the current environment track continue using the existing routes and payload behavior.
Users mapped to the latest UAT environment track should use the REST API V3 documentation when validating the newer V3 payload structure.
Production users continue on the existing REST API flow until they are explicitly moved to latest PROD, at which point they can begin using the V3 endpoints there as well.
When To Use This Page¶
Use this page when you need to:
- confirm whether a payload flow is available in the current rollout
- check whether a workflow changed between the current and V3 tracks
- verify whether a change applies only to UAT
- decide whether to stay on the current flow or validate the V3 flow in latest UAT
Majorly Updated Sections¶
If you are validating migration behavior on the current rollout, these are the main sections to review first:
- Authentication
- session and environment guidance for current versus latest mappings
- Place Order
- single-order payload examples and current trading flow
- Place Strategy Order
- strategy payload structure and migration-oriented examples
- Modify Order
- updated modify payload guidance
- Modify Strategy Order
- strategy modify payload behavior for V3 migration validation
- Get Order Margin
- refreshed margin request patterns for current validation flows
- Realtime Order Updates
- current websocket payload guidance
- REST API V3
- use this track when explicitly validating the newer V3 payload structure
Latest Version Summary¶
| Track | Status | Environment |
|---|---|---|
| main REST API pages | existing payload flow | current mappings and current production usage |
| REST API V3 pages | direct V3 payload validation | latest UAT now, latest PROD when migration is enabled |
Current Rollout Notes¶
UAT Support Update¶
Current behavior:
- many users can be mapped to UAT latest for migration validation
- users mapped to UAT current continue using the main REST API pages and existing routes
- users mapped to UAT latest should use REST API V3 to validate the newer payload structure
- this keeps the validation path explicit during migration instead of mixing current and V3 route usage on the same mapping
Production Note¶
Current behavior:
- production users mapped to the current environment track continue using the existing routes and payload behavior
- production users are not assumed to be on latest PROD by default
- once a user is moved to latest PROD, they can begin using the REST API V3 endpoints in production as part of migration
- rollout mapping between current and latest tracks is handled separately from the documentation track
Important Rules¶
Important Rules
- Match the documentation track to the payload structure you are validating.
- Use the main REST API pages for the existing payload flow.
- Use REST API V3 when your account is mapped to latest UAT or latest PROD for V3 validation.
- Do not assume main REST API pages and REST API V3 pages are interchangeable on the same environment mapping.
- Do not assume documentation track selection changes the user's current/latest environment mapping.