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 Modification
Modified 1
SUBSCRIBE /orders
  • Message
  • Order Reject Frame message Added
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
        • markets property Modified
GET /events/{event_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • expected_expiration_time property Modified
          • Property is now required
            Breaking
GET /markets
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • expected_expiration_time property Modified
          • Property is now required
            Breaking
GET /markets/{market_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • expected_expiration_time property Modified
        • Property is now required
          Breaking
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 properties Modified
          • Type went from string to object
            Breaking
        • markets property Modified
  • Query
  • lang query parameter Added
GET /events/{event_id}
  • Query
  • lang query parameter Modified
    • Type went from string to array[string]
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • title property Modified
        • Type went from string to object
          Breaking
        • en, pt, id properties Added
      • rules_primary property Modified
        • Type went from string to object
          Breaking
        • en, pt, id properties Added
      • markets property Modified
        • title property Modified
          • Type went from string to object
            Breaking
        • yes_sub_title, no_sub_title properties Modified
          • Type went from string | null to object
            Breaking
GET /markets
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • title property Modified
          • Type went from string to object
            Breaking
        • yes_sub_title, no_sub_title properties Modified
          • Type went from string | null to object
            Breaking
  • Query
  • lang query parameter Added
GET /markets/{market_id}
  • Query
  • lang query parameter Modified
    • Type went from string to array[string]
      Breaking
  • Response
  • 200 response Modified
    • application/json content type Modified
      • title property Modified
        • Type went from string to object
          Breaking
        • en, pt, id properties Added
      • yes_sub_title property Modified
        • Type went from string | null to object
          Breaking
        • en, pt, id properties Added
      • no_sub_title property Modified
        • Type went from string | null to object
          Breaking
        • en, pt, id properties Added
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
        • markets property Modified
        • rules_primary property Added
GET /events/{event_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • rules_primary property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
      • rules_primary property Added
GET /markets
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • rules_primary property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
GET /markets/{market_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • rules_primary property Removed
        • Removing a resource is always breaking unless it was deprecated before
          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
        • EventCreatedPayload, MarketCreatedPayload alternatives Modified
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
      • volume, filled_volume properties Added
  • 202 response Modified
    • application/json content type Modified
      • volume, filled_volume properties Added
GET /trading/accounts/{account_id}/orders
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • volume, filled_volume properties Added
GET /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • volume, filled_volume properties Added
PATCH /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 201 response Modified
    • application/json content type Modified
      • volume, filled_volume properties Added
  • 202 response Modified
    • application/json content type Modified
      • volume, filled_volume properties Added
POST /trading/accounts/{account_id}/orders
  • Body
  • application/json content type Modified
    • volume, token properties Added
  • Response
  • 201 response Modified
    • application/json content type Modified
      • volume, filled_volume properties Added
  • 202 response Modified
    • application/json content type Modified
      • volume, filled_volume properties Added
broker-openapi API
3 structure changes including:
3 Modifications
Modified 3
GET /trading/accounts/{account_id}/orders
  • Query
  • event_id query parameter Added
GET /trading/accounts/{account_id}/payouts
  • Query
  • event_id query parameter Added
GET /trading/accounts/{account_id}/positions
  • Query
  • event_id query parameter Added
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
        • markets property Modified
GET /events/{event_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • status_revision property Added
GET /markets
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • status_revision property Added
GET /markets/{market_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • status_revision 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
        • MarketCreatedPayload, MarketStatusChangedPayload, MarketSettledPayload, MarketVoidedPayload 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
        • markets property Modified
  • Query
  • min_close_ts query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
GET /events/{event_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • yes_sub_title, no_sub_title properties Modified
          • Type went from string to string | null
GET /markets
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • yes_sub_title, no_sub_title properties Modified
          • Type went from string to string | null
GET /markets/{market_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • yes_sub_title, no_sub_title properties Modified
        • Type went from string to string | null
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
        • MarketCreatedPayload alternative 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
        • markets property Modified
        • void_reason property Added
GET /events/{event_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • latest_expiration_time property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • market_index, lower_inclusive, upper_inclusive, expected_expiration_time properties Added
      • void_reason property Added
GET /markets
  • Response
  • 200 response Modified
    • application/json content type Modified
      • markets property Modified
        • latest_expiration_time property Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • market_index, lower_inclusive, upper_inclusive, expected_expiration_time properties Added
GET /markets/{market_id}
  • Response
  • 200 response Modified
    • application/json content type Modified
      • latest_expiration_time property Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • market_index, lower_inclusive, upper_inclusive, expected_expiration_time properties Added
broker-asyncapi API
1 structure change including:
1 Addition
Added 1
SUBSCRIBE /events
broker-openapi API
11 structure changes including:
5 Additions
6 Modifications
Modified 6
DELETE /trading/accounts/{account_id}/orders
  • Response
  • 404 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 409 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 422 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 503 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
GET /trading/accounts/{account_id}/orders
  • Response
  • 400 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 503 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
GET /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 404 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 503 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
GET /trading/accounts/{account_id}/positions
  • Response
  • 400 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 503 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
PATCH /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 404 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 409 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 422 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 503 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
POST /trading/accounts/{account_id}/orders
  • Response
  • 409 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 422 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 429 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
  • 503 response Modified
    • application/json content type Modified
      • Type is now object
      • Error property Added
Added 5
GET /events
GET /events/{event_id}
GET /markets
GET /markets/{market_id}
GET /trading/accounts/{account_id}/payouts
broker-openapi API
4 structure changes including:
4 Additions
Added 4
GET /events
GET /events/{event_id}
GET /markets
GET /markets/{market_id}
broker-openapi API
6 structure changes including:
6 Modifications
Modified 6 Breaking
DELETE /trading/accounts/{account_id}/orders
  • Response
  • 404 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 409 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 422 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 503 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
GET /trading/accounts/{account_id}/orders
  • Response
  • 400 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 503 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
GET /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 404 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 503 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
GET /trading/accounts/{account_id}/positions
  • Response
  • 400 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 503 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • Query
  • status query parameter Added
PATCH /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 404 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 409 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 422 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 503 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
POST /trading/accounts/{account_id}/orders
  • Response
  • 409 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 422 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 429 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
  • 503 response Modified
    • application/json content type Modified
      • Type is no longer object
        Breaking
      • Error property Removed
broker-asyncapi API
1 structure change including:
1 Addition
Added 1
SUBSCRIBE /payouts
broker-openapi API
2 structure changes including:
1 Breaking change
1 Addition
1 Removal
Removed 1 Breaking
DELETE /trading/accounts/{account_id}/orders/{order_id}
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
DELETE /trading/accounts/{account_id}/orders
broker-openapi API
8 structure changes including:
1 Breaking change
1 Addition
6 Modifications
1 Removal
Modified 6 Breaking
DELETE /trading/accounts/{account_id}/orders/{order_id}
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Hmac auth authentication method Added
  • Header
  • PRE-ACCESS-KEY, PRE-ACCESS-SIGNATURE, PRE-ACCESS-TIMESTAMP headers Added
GET /trading/accounts/{account_id}/orders
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Hmac auth authentication method Added
  • Header
  • PRE-ACCESS-KEY, PRE-ACCESS-SIGNATURE, PRE-ACCESS-TIMESTAMP headers Added
GET /trading/accounts/{account_id}/orders/{order_id}
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Hmac auth authentication method Added
  • Header
  • PRE-ACCESS-KEY, PRE-ACCESS-SIGNATURE, PRE-ACCESS-TIMESTAMP headers Added
GET /trading/accounts/{account_id}/positions
  • Response
  • 200 response Modified
    • application/json content type Modified
      • items property Modified
        • asset, total, available, reserved properties Removed
          • Removing a resource is always breaking unless it was deprecated before
            Breaking
        • market_id, qty, realized_pnl, fees_paid, last_update_engine_seq properties Added
  • Query
  • asset query parameter Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • market_id query parameter Added
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Hmac auth authentication method Added
  • Header
  • PRE-ACCESS-KEY, PRE-ACCESS-SIGNATURE, PRE-ACCESS-TIMESTAMP headers Added
PATCH /trading/accounts/{account_id}/orders/{order_id}
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Hmac auth authentication method Added
  • Header
  • PRE-ACCESS-KEY, PRE-ACCESS-SIGNATURE, PRE-ACCESS-TIMESTAMP headers Added
POST /trading/accounts/{account_id}/orders
  • Authentication
  • Oauth2 authentication method Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • Hmac auth authentication method Added
  • Header
  • PRE-ACCESS-KEY, PRE-ACCESS-SIGNATURE, PRE-ACCESS-TIMESTAMP headers Added
Removed 1 Breaking
Oauth2authentication method
  • Removing a resource is always breaking unless it was deprecated before
    Breaking
Added 1
Hmac authauthentication method
broker-openapi API
2 structure changes including:
2 Modifications
Modified 2 Breaking
DELETE /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201 response Added
PATCH /trading/accounts/{account_id}/orders/{order_id}
  • Response
  • 200 response Removed
    • Removing a resource is always breaking unless it was deprecated before
      Breaking
  • 201 response Added