Do not miss any Broker API Hub changes, ever again

Subscribe to the Broker API Hub changelog to be up to date on recent changes.

RSS
Broker API

Changelog

Last update:
broker-asyncapi API
1 structure change including:
1 Addition
Added 1
SUBSCRIBE /accounting
broker-openapi API
4 structure changes including:
4 Modifications
Modified 4
GET /events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • events property Modified
        • title, rules_primary, markets properties Modified
GET /events/{event_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • title property Modified
        • en, pt, id properties Modified
          • Properties are no longer required
      • rules_primary property Modified
        • en, pt, id properties Modified
          • Properties are no longer required
      • markets property Modified
        • title, yes_sub_title, no_sub_title properties Modified
GET /markets
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • title, yes_sub_title, no_sub_title properties Modified
GET /markets/{market_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • title property Modified
        • en, pt, id properties Modified
          • Properties are no longer required
      • yes_sub_title property Modified
        • en, pt, id properties Modified
          • Properties are no longer required
      • no_sub_title property Modified
        • en, pt, id properties Modified
          • Properties are no longer required
broker-asyncapi API
1 structure change including:
1 Modification
Modified 1
SUBSCRIBE /events
  • Message
  • Event/Market Lifecycle Update Frame message Modified
    • payload Modified
      • payload property Modified
        • EventCreatedPayload, MarketCreatedPayload alternatives Modified
broker-openapi API
4 structure changes including:
4 Modifications
Modified 4 Breaking
GET /events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • events property Modified
        • title, rules_primary, markets properties Modified
GET /events/{event_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • title property Modified
        • en, pt, id properties Modified
          • Properties are now required
            Breaking
      • rules_primary property Modified
        • en, pt, id properties Modified
          • Properties are now required
            Breaking
      • markets property Modified
        • title, yes_sub_title, no_sub_title properties Modified
GET /markets
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • title, yes_sub_title, no_sub_title properties Modified
GET /markets/{market_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • title property Modified
        • en, pt, id properties Modified
          • Properties are now required
            Breaking
      • yes_sub_title property Modified
        • en, pt, id properties Modified
          • Properties are now required
            Breaking
      • no_sub_title property Modified
        • en, pt, id properties Modified
          • Properties are now required
            Breaking
broker-asyncapi API
1 structure change including:
1 Modification
Modified 1
SUBSCRIBE /events
  • Message
  • Event/Market Lifecycle Update Frame message Modified
    • payload Modified
      • payload property Modified
        • EventSettledPayload alternative Modified
broker-openapi API
2 structure changes including:
2 Modifications
Modified 2
GET /events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • events property Modified
        • series property Added
GET /events/{event_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • series property Added
broker-asyncapi API
1 structure change including:
1 Modification
Modified 1
SUBSCRIBE /events
  • Message
  • Event/Market Lifecycle Update Frame message Modified
    • payload Modified
      • payload property Modified
        • EventCreatedPayload alternative Modified
broker-openapi API
2 structure changes including:
2 Modifications
Modified 2
GET /events
  • Response
  • 200 response Modified
    • application/json content type Modified
      • events property Modified
        • settlement_sources property Modified
GET /events/{event_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • settlement_sources property Modified
        • underlying property Added
broker-asyncapi API
1 structure change including:
1 Modification
Modified 1
SUBSCRIBE /events
  • Message
  • Event/Market Lifecycle Update Frame message Modified
    • payload Modified
      • payload property Modified
        • EventCreatedPayload alternative Modified
broker-asyncapi API
1 structure change including:
1 Modification
Modified 1
SUBSCRIBE /orders
  • Message
  • Order Update Frame message Modified
    • payload Modified
      • payload property Modified
        • filled_fee property Added
broker-openapi API
2 structure changes including:
2 Modifications
Modified 2
GET /trading/accounts/{account_id}/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • filled_fee property Added
GET /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • filled_fee property Added
broker-openapi API
3 structure changes including:
3 Modifications
Modified 3 Breaking
DELETE /trading/accounts/{account_id}/orders
  • Response
  • 201 response Modified
    • application/json content type Modified
      • property Modified
        • CommandAck property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 properties Added
  • 202 response Modified
    • application/json content type Modified
      • property Modified
        • CommandAck property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 properties Added
PATCH /trading/accounts/{account_id}/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • property Modified
        • CommandAck property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 properties Added
  • 202 response Modified
    • application/json content type Modified
      • property Modified
        • CommandAck property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 properties Added
POST /trading/accounts/{account_id}/orders
  • Response
  • 201 response Modified
    • application/json content type Modified
      • property Modified
        • CommandAck property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 properties Added
  • 202 response Modified
    • application/json content type Modified
      • property Modified
        • CommandAck property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • object-1, object-2 properties Added
broker-openapi API
3 structure changes including:
3 Modifications
Modified 3 Breaking
DELETE /trading/accounts/{account_id}/orders
  • Response
  • 201 response Modified
    • application/json content type Modified
      • market_id, broker_id, account_id, side, type, tif, token, price, qty, volume, filled_qty, filled_volume, status, status_reason, last_update_wall_time_ns, last_update_engine_seq, last_cmd_id_hex properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 202 response Modified
    • application/json content type Modified
      • market_id, broker_id, account_id, side, type, tif, token, price, qty, volume, filled_qty, filled_volume, status, status_reason, last_update_wall_time_ns, last_update_engine_seq, last_cmd_id_hex properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
PATCH /trading/accounts/{account_id}/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • market_id, broker_id, account_id, side, type, tif, token, price, qty, volume, filled_qty, filled_volume, status, status_reason, last_update_wall_time_ns, last_update_engine_seq, last_cmd_id_hex properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 202 response Modified
    • application/json content type Modified
      • market_id, broker_id, account_id, side, type, tif, token, price, qty, volume, filled_qty, filled_volume, status, status_reason, last_update_wall_time_ns, last_update_engine_seq, last_cmd_id_hex properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
POST /trading/accounts/{account_id}/orders
  • Response
  • 201 response Modified
    • application/json content type Modified
      • market_id, broker_id, account_id, side, type, tif, token, price, qty, volume, filled_qty, filled_volume, status, status_reason, last_update_wall_time_ns, last_update_engine_seq, last_cmd_id_hex properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
  • 202 response Modified
    • application/json content type Modified
      • market_id, broker_id, account_id, side, type, tif, token, price, qty, volume, filled_qty, filled_volume, status, status_reason, last_update_wall_time_ns, last_update_engine_seq, last_cmd_id_hex properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
broker-openapi API
1 structure change including:
1 Modification
Modified 1
POST /trading/accounts/{account_id}/orders
  • Body
  • application/json content type Modified
    • qty property Modified
      • Property is no longer required
broker-openapi API
5 structure changes including:
5 Modifications
Modified 5
DELETE /trading/accounts/{account_id}/orders
  • Response
  • 201 response Modified
    • application/json content type Modified
      • token property Added
  • 202 response Modified
    • application/json content type Modified
      • token property Added
GET /trading/accounts/{account_id}/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • token property Added
GET /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • token property Added
PATCH /trading/accounts/{account_id}/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • token property Added
  • 202 response Modified
    • application/json content type Modified
      • token property Added
POST /trading/accounts/{account_id}/orders
  • Response
  • 201 response Modified
    • application/json content type Modified
      • token property Added
  • 202 response Modified
    • application/json content type Modified
      • token property Added
broker-asyncapi API
1 structure change including:
1 Modification
Modified 1
SUBSCRIBE /orders
  • Message
  • Order Update Frame message Modified
    • payload Modified
      • payload property Modified
        • token property Added
broker-openapi API
5 structure changes including:
5 Modifications
Modified 5
DELETE /trading/accounts/{account_id}/orders
  • Response
  • 201 response Modified
    • application/json content type Modified
      • status_reason property Added
  • 202 response Modified
    • application/json content type Modified
      • status_reason property Added
GET /trading/accounts/{account_id}/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • status_reason property Added
GET /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status_reason property Added
PATCH /trading/accounts/{account_id}/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status_reason property Added
  • 202 response Modified
    • application/json content type Modified
      • status_reason property Added
POST /trading/accounts/{account_id}/orders
  • Response
  • 201 response Modified
    • application/json content type Modified
      • status_reason property Added
  • 202 response Modified
    • application/json content type Modified
      • status_reason property Added
broker-asyncapi API
1 structure change including:
1 Modification
Modified 1
SUBSCRIBE /orders
  • Message
  • Order Update Frame message Modified
    • payload Modified
      • payload property Modified
        • status_reason property Added
broker-openapi API
13 structure changes including:
1 Breaking change
1 Addition
11 Modifications
1 Removal
Modified 11 Breaking
DELETE /trading/accounts/{account_id}/orders
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /events
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /events/{event_id}
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /markets
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /markets/{market_id}
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /trading/accounts/{account_id}/orders
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /trading/accounts/{account_id}/orders/{order_id}
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /trading/accounts/{account_id}/payouts
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
GET /trading/accounts/{account_id}/positions
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
PATCH /trading/accounts/{account_id}/orders
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
POST /trading/accounts/{account_id}/orders
  • Authentication
  • Hmac auth authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Api key auth authentication method Added
Removed 1 Breaking
Hmac authauthentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
Api key authauthentication method
broker-openapi API
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
PATCH /trading/accounts/{account_id}/orders/{order_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
PATCH /trading/accounts/{account_id}/orders