feat: add support for OPENAPI_GLOBAL market

- Updated WebsocketClient to handle OPENAPI_GLOBAL market.
- Enhanced documentation to include OPENAPI_GLOBAL in APIMarket and RestClientOptions.
- Added OPENAPI_GLOBAL base URL and WebSocket configurations.
- Ensured compatibility with existing GLOBAL market functionality.

Author: JJ-Cro

src/types/rest/client.ts

@@ -7,7 +7,8 @@ export interface RestClientOptions {
 
   /**
    * The API group this client should connect to:
-   * - market: 'prod' (default: OKX Global REST at https://openapi.okx.com)
+   * - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services
+   * - market: 'OPENAPI_GLOBAL' // OKX Global REST at https://openapi.okx.com
    * - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
    * - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
    */

src/types/shared.ts

@@ -5,16 +5,19 @@ export interface APICredentials {
 }
 
 /**
- * The API Market represents the OKX Domain that you have signed up for. At this time, there are 3 supported domain groups:
+ * The API Market represents the OKX Domain that you have signed up for. At this time, there are 4 supported domain groups:
  *
- * - GLOBAL, OKX Global (REST: openapi.okx.com; www.okx.com also works).
+ * - GLOBAL, otherwise known as "www.okx.com".
+ * - OPENAPI_GLOBAL, OKX Global REST at openapi.okx.com (same WS as GLOBAL).
  * - EEA, otherwise known as "my.okx.com".
  * - US, otherwise known as "app.okx.com".
  */
 export type APIMarket =
   | 'prod' // same as GLOBAL. Kept for some backwards compatibility
-  // OKX Global REST: https://openapi.okx.com (recommended). www.okx.com remains supported.
+  // also known as "www.okx.com" or OKX Global: https://www.okx.com/docs-v5/en/#overview-production-trading-services
   | 'GLOBAL'
+  // OKX Global REST at https://openapi.okx.com. WebSocket URLs unchanged (same as GLOBAL).
+  | 'OPENAPI_GLOBAL'
   // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
   | 'EEA'
   // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services

src/types/websockets/ws-general.ts

@@ -10,6 +10,7 @@ export interface WSClientConfigurableOptions {
   /**
    * The API group this client should connect to:
    * - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services
+   * - market: 'OPENAPI_GLOBAL' // OKX Global REST at https://openapi.okx.com (WS same as GLOBAL)
    * - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
    * - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services
    */

src/util/requestUtils.ts

@@ -44,9 +44,12 @@ export function getRestBaseUrl(
 
   switch (market) {
     default:
-    // "prod" defaults to OKX Global REST API: https://openapi.okx.com (www.okx.com remains supported)
+    // "prod" defaults to OKX Global: https://www.okx.com/docs-v5/en/#overview-production-trading-services
     case 'GLOBAL':
     case 'prod': {
+      return 'https://www.okx.com';
+    }
+    case 'OPENAPI_GLOBAL': {
       return 'https://openapi.okx.com';
     }
     // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services

src/util/websocket-util.ts

@@ -44,6 +44,20 @@ export const WS_BASE_URL_MAP: Record<
       business: 'wss://wspap.okx.com:8443/ws/v5/business?brokerId=9999',
     },
   },
+  // OKX Global REST at openapi.okx.com. WebSocket URLs unchanged (same as GLOBAL).
+  OPENAPI_GLOBAL: {
+    live: {
+      public: 'wss://ws.okx.com:8443/ws/v5/public',
+      private: 'wss://ws.okx.com:8443/ws/v5/private',
+      // Some channels require business suffix: https://www.okx.com/help/changes-to-v5-api-websocket-subscription-parameter-and-url
+      business: 'wss://ws.okx.com:8443/ws/v5/business',
+    },
+    demo: {
+      public: 'wss://wspap.okx.com:8443/ws/v5/public',
+      private: 'wss://wspap.okx.com:8443/ws/v5/private',
+      business: 'wss://wspap.okx.com:8443/ws/v5/business?brokerId=9999',
+    },
+  },
   // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services
   EEA: {
     live: {
@@ -367,7 +381,8 @@ export function getWsKeyForMarket(
 ): WsKey {
   switch (market) {
     case 'prod':
-    case 'GLOBAL': {
+    case 'GLOBAL':
+    case 'OPENAPI_GLOBAL': {
       if (isBusinessChannel) {
         return WS_KEY_MAP.prodBusiness;
       }
@@ -503,6 +518,7 @@ export function getMaxTopicsPerSubscribeEventForMarket(
     case 'prod':
     case 'EEA':
     case 'GLOBAL':
+    case 'OPENAPI_GLOBAL':
     case 'US': {
       return null;
     }

src/websocket-client.ts

@@ -253,7 +253,8 @@ export class WebsocketClient extends BaseWebsocketClient<
     switch (this.options.market) {
       case undefined:
       case 'prod':
-      case 'GLOBAL': {
+      case 'GLOBAL':
+      case 'OPENAPI_GLOBAL': {
         return isPrivateType
           ? WS_KEY_MAP.prodPrivate
           : isBusinessType