Upcoming breaking changes in next major release

[tiagosiebler]

The following potentially breaking-changes are queued to be included with the next major release:

• Default REST API base URL will change from https://www.okx.com to https://openapi.okx.com
  • Announced formally in OKX API docs on 20th May 2026: https://www.okx.com/docs-v5/log_en/#2026-05-20
  • Docs state that the existing default global domain "will continue to work and will not be deprecated".
  • Docs also state that "We recommend updating your API client configuration to use https://openapi.okx.com as the REST API base URL".
  • To prevent any unexpected impact:
    • We are introducing a way to switch to the new domain: set market: 'OPENAPI_GLOBAL' in the REST client options, as per the readme.
    • We will keep the existing default domain unchanged until the next major release.
    • In the next major release, we will set the new openapi subdomain as the base REST url by default.

This post may be edited from time to time, for any other major changes coming with the next major release.