okx-api 3.1.4 → 3.1.6

package/dist/mjs/types/rest/request/account.d.ts

@@ -167,3 +167,31 @@ export interface BillsHistoryArchiveRequest {
     /** Comma-separated bill type ids, e.g. 1,2,3. If omitted, all types. */
     type?: string;
 }
+export interface MovePositionLegFrom {
+    posId: string;
+    side: 'buy' | 'sell';
+    sz: string;
+}
+export interface MovePositionLegTo {
+    tdMode?: 'cross' | 'isolated';
+    posSide?: PositionSide;
+    ccy?: string;
+}
+export interface MovePositionLeg {
+    from: MovePositionLegFrom;
+    to: MovePositionLegTo;
+}
+export interface MovePositionsRequest {
+    fromAcct: string;
+    toAcct: string;
+    legs: MovePositionLeg[];
+    clientId: string;
+}
+export interface GetMovePositionsHistoryRequest {
+    blockTdId?: string;
+    clientId?: string;
+    beginTs?: string;
+    endTs?: string;
+    limit?: string;
+    state?: 'filled' | 'pending';
+}

package/dist/mjs/types/rest/request/affiliate.d.ts

@@ -0,0 +1,52 @@
+export type AffiliatePeriodType = 'last_7d' | 'last_30d' | 'this_month' | 'last_month' | 'total' | 'today' | 'this_week' | 'custom';
+export type AffiliateCommissionCategory = 'SPOT' | 'DERIVATIVE' | 'BSC';
+export type AffiliateKycStatus = 'unverified' | 'verified';
+export type AffiliateLinkType = 'standard' | 'co_inviter';
+export type AffiliateLinkStatus = 'normal' | 'abnormal';
+export type AffiliateInviteeListOrderBy = 'cTime' | 'depAmt' | 'vol' | 'fee' | 'rebate';
+export type AffiliateSubAffiliateListOrderBy = 'cTime' | 'depAmt' | 'vol' | 'fee' | 'rebate';
+export type AffiliateOrderDir = 'asc' | 'desc';
+export interface GetAffiliatePerformanceSummaryRequest {
+    periodType?: AffiliatePeriodType;
+    /** Required when periodType=custom, together with end. Inclusive. */
+    begin?: string;
+    /** Required when periodType=custom, together with begin. Inclusive. */
+    end?: string;
+}
+export interface GetInviteeDetailRequest {
+    uid: string;
+}
+export interface GetAffiliateInviteeListRequest {
+    page?: string;
+    limit?: string;
+    periodType?: AffiliatePeriodType;
+    /** Required when periodType=custom, together with end. Inclusive. */
+    begin?: string;
+    /** Required when periodType=custom, together with begin. Inclusive. */
+    end?: string;
+    keyword?: string;
+    commissionCategory?: AffiliateCommissionCategory;
+    orderBy?: AffiliateInviteeListOrderBy;
+    orderDir?: AffiliateOrderDir;
+    kycStatus?: AffiliateKycStatus;
+    subAffiliateUid?: string;
+}
+export interface GetAffiliateLinkListRequest {
+    page?: string;
+    limit?: string;
+    linkType?: AffiliateLinkType;
+    linkStatus?: AffiliateLinkStatus;
+}
+export interface GetAffiliateCoInviterLinkListRequest {
+    page?: string;
+    limit?: string;
+    linkStatus?: AffiliateLinkStatus;
+}
+export interface GetAffiliateSubAffiliateListRequest {
+    page?: string;
+    limit?: string;
+    keyword?: string;
+    commissionCategory?: AffiliateCommissionCategory;
+    orderBy?: AffiliateSubAffiliateListOrderBy;
+    orderDir?: AffiliateOrderDir;
+}

package/dist/mjs/types/rest/request/affiliate.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=affiliate.js.map

package/dist/mjs/types/rest/request/affiliate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"affiliate.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/affiliate.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/request/public.d.ts

@@ -98,3 +98,12 @@ export interface GetEventContractMarketsRequest {
     before?: string;
     after?: string;
 }
+export interface GetInsuranceFundRequest {
+    instType?: string;
+    type?: 'liquidation_balance_deposit' | 'bankruptcy_loss' | 'platform_revenue' | 'adl';
+    instFamily?: string;
+    ccy?: string;
+    before?: string;
+    after?: string;
+    limit?: string;
+}

package/dist/mjs/types/rest/request/stable-rewards.d.ts

@@ -0,0 +1,27 @@
+export interface GetStableRewardsProductInfoRequest {
+    ccy: string;
+}
+export interface RequestStableRewardsQuoteRequest {
+    ccy: string;
+    settleCcy: string;
+    action: 'subscribe' | 'redeem';
+    amt: string;
+}
+export interface SubmitStableRewardsTradeRequest {
+    quoteId: string;
+}
+export interface GetStableRewardsBalanceRequest {
+    ccy?: string;
+}
+export interface GetStableRewardsApyHistoryRequest {
+    ccy: string;
+    days?: string;
+}
+export interface GetStableRewardsSubscribeRedeemHistoryRequest {
+    ccy: string;
+    type?: 'subscribe' | 'redeem';
+    status?: 'pending' | 'success' | 'failed';
+    after?: string;
+    before?: string;
+    limit?: string;
+}

package/dist/mjs/types/rest/request/stable-rewards.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=stable-rewards.js.map

package/dist/mjs/types/rest/request/stable-rewards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stable-rewards.js","sourceRoot":"","sources":["../../../../../src/types/rest/request/stable-rewards.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/request/trade.d.ts

@@ -213,6 +213,12 @@ export interface OrderRequest {
     reduceOnly?: boolean;
     /** A spot buy on BTC-USDT with "base_ccy" would mean the QTY (sz) is in USDT */
     tgtCcy?: 'base_ccy' | 'quote_ccy';
+    /**
+     * Maximum acceptable slippage for spot and spot margin market-side orders, where tgtCcy is the received currency (base_ccy for buy, quote_ccy for sell).
+     * Range: 0 to 0.05 (0% to 5%, inclusive). Up to 2 decimal places, e.g. 0.01 (1%) and 0.0123 (1.23%). Defaults to 0.00% if not specified.
+     * Only applicable to SPOT and SPOT margin market orders. Cannot be amended on an existing order.
+     */
+    slippagePct?: string;
     banAmend?: boolean;
     /** Price amendment type: "0" = do not allow amendment, "1" = allow amendment within price limit. Default is "0" */
     pxAmendType?: '0' | '1';

package/dist/mjs/types/rest/response/private-account.d.ts

@@ -267,6 +267,7 @@ export interface FeeGroup {
     taker: string;
     maker: string;
     groupId: string;
+    elpMaker?: string;
 }
 export interface AccountFeeRate {
     category: never;
@@ -362,7 +363,7 @@ export interface AccountInstrument {
     seriesId?: string;
     uly?: string;
     /**
-     * FUTURES label (deprecated — prefer `expTime`; may include this_five_years, next_five_years, …).
+     * FUTURES label (deprecated: prefer `expTime`; may include this_five_years, next_five_years, ...).
      */
     alias?: string;
     /** Deprecated; see `instCategory` on public `Instrument` where used. */
@@ -386,7 +387,7 @@ export interface AccountInstrument {
     quoteCcy: string;
     tradeQuoteCcyList: string[];
     settleCcy: string;
-    /** Instrument status: live, suspend, rebase (SWAP only), preopen, test */
+    /** Instrument status: live, suspend, rebase (SWAP only), post_only (SWAP only), preopen, test */
     state: string;
     stk: string;
     tickSz: string;
@@ -403,6 +404,8 @@ export interface AccountInstrument {
     posLmtAmt: string;
     posLmtPct: string;
     maxPlatOILmt: string;
+    /** Platform-wide maximum position value (coins) for this instrument. Applicable to SWAP/FUTURES. @see 2026-05-19 changelog */
+    maxPlatOICoinLmt?: string;
     /** Remaining long position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES. */
     longPosRemainingQuota?: string;
     /** Remaining short position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES. */
@@ -532,3 +535,36 @@ export interface UnmatchedInfo {
 export interface PrecheckSetDeltaNeutralResult {
     unmatchedInfoCheck: UnmatchedInfo[];
 }
+export interface MovePositionLegResultFrom {
+    posId: string;
+    instId: string;
+    px: string;
+    side: string;
+    sz: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface MovePositionLegResultTo {
+    instId: string;
+    px: string;
+    side: string;
+    sz: string;
+    tdMode: string;
+    posSide: string;
+    ccy: string;
+    sCode: string;
+    sMsg: string;
+}
+export interface MovePositionLegResult {
+    from: MovePositionLegResultFrom;
+    to: MovePositionLegResultTo;
+}
+export interface MovePositionsResult {
+    clientId: string;
+    blockTdId: string;
+    state: 'filled' | 'failed' | 'pending' | string;
+    ts: string;
+    fromAcct: string;
+    toAcct: string;
+    legs: MovePositionLegResult[];
+}

package/dist/mjs/types/rest/response/private-affiliate.d.ts

@@ -0,0 +1,106 @@
+import type { AffiliateCommissionCategory } from '../request/affiliate.js';
+export interface AffiliatePerformanceSummaryDetail {
+    commissionCategory: AffiliateCommissionCategory;
+    firstTraderCnt: string;
+    traderCnt: string;
+    vol: string;
+    commission: string;
+}
+export interface AffiliatePerformanceSummary {
+    uTime: string;
+    inviteeCnt: string;
+    depAmt: string;
+    details: AffiliatePerformanceSummaryDetail[];
+}
+export interface InviteeDetail {
+    inviteeLevel: string;
+    joinTime: string;
+    inviteeRebateRate: string;
+    totalCommission: string;
+    firstTradeTime: string;
+    level: string;
+    depAmt: string;
+    wdAmt: string;
+    volMonth: string;
+    totalVol: string;
+    accFee: string;
+    kycTime: string;
+    region: string;
+    affiliateCode: string;
+}
+export type AffiliateInviteeListKycStatus = 'unverified' | 'verified';
+export interface AffiliateInviteeListItem {
+    uid: string;
+    country: string;
+    joinTime: string;
+    firstTradeTime: string;
+    channelName: string;
+    rebateRate: string;
+    feeTierRank: string;
+    kycStatus: AffiliateInviteeListKycStatus;
+    kycTime: string;
+    depAmt: string;
+    totalVol: string;
+    totalFee: string;
+    totalCommission: string;
+    isCompliant: boolean;
+}
+export type AffiliateLinkListLinkType = 'standard' | 'co_inviter';
+export type AffiliateLinkListLinkStatus = 'normal' | 'abnormal';
+export interface AffiliateLinkListItem {
+    channelId: string;
+    channelName: string;
+    joinLink: string;
+    linkType: AffiliateLinkListLinkType;
+    inviterCommissionRate: string;
+    coInviterCommissionRate: string;
+    inviteeDiscountRate: string;
+    inviteeCnt: string;
+    traderCnt: string;
+    totalCommission: string;
+    commission24h: string;
+    cTime: string;
+    isDefault: boolean;
+    linkStatus: AffiliateLinkListLinkStatus;
+}
+export type AffiliateChannelAssessmentStatus = 'valid' | 'not_reach_trade' | 'not_reach_invite' | 'not_reach_both';
+export type AffiliateInviterChannelStatus = 'valid' | 'identity_invalid' | 'level_downgraded';
+export type AffiliateCoInviterChannelStatus = 'valid' | 'identity_invalid' | 'not_reach_assessment' | 'identity_invalid_and_not_reach_assessment';
+export interface AffiliateCoInviterLinkListItem {
+    channelId: string;
+    channelName: string;
+    joinLink: string;
+    inviterCommissionRate: string;
+    coInviterCommissionRate: string;
+    inviteeDiscountRate: string;
+    parUserName: string;
+    coUserName: string;
+    isCompliant: boolean;
+    note?: string;
+    isDefault: boolean;
+    totalCommission: string;
+    commission24h: string;
+    inviteeCnt: string;
+    traderCnt: string;
+    clickCnt: string;
+    totalFee: string;
+    cTime: string;
+    channelAssessmentStatus: AffiliateChannelAssessmentStatus;
+    inviterChannelStatus: AffiliateInviterChannelStatus;
+    coInviterChannelStatus: AffiliateCoInviterChannelStatus;
+    linkStatus: AffiliateLinkListLinkStatus;
+}
+export interface AffiliateSubAffiliateListItem {
+    subAffiliateUid: string;
+    country: string;
+    joinTime: string;
+    subAffiliateLevel: string;
+    commissionRate: string;
+    isCompliant: boolean;
+    inviteeCnt: string;
+    traderCnt: string;
+    depAmt: string;
+    totalVol: string;
+    totalFee: string;
+    totalCommission: string;
+}

package/dist/mjs/types/rest/response/private-affiliate.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=private-affiliate.js.map

package/dist/mjs/types/rest/response/private-affiliate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-affiliate.js","sourceRoot":"","sources":["../../../../../src/types/rest/response/private-affiliate.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/response/private-stable-rewards.d.ts

@@ -0,0 +1,57 @@
+export interface StableRewardsProductInfoDetail {
+    ccy: string;
+    settleCcy: string;
+    subFeeRate: string;
+    redemptFeeRate: string;
+    minSubAmt: string;
+    minRedeemAmt: string;
+    remainingSubQuota: string;
+    remainingRedemptQuota: string;
+    canRedeem: boolean;
+}
+export interface StableRewardsProductInfo {
+    details: StableRewardsProductInfoDetail[];
+    ts: string;
+}
+export interface StableRewardsQuote {
+    quoteId: string;
+    quoteAmt: string;
+    quoteCcy: string;
+    exchRate: string;
+    feeRate: string;
+    quoteTime: string;
+    ttlMs: string;
+}
+export interface StableRewardsTradeResult {
+    quoteId: string;
+    ordId: string;
+}
+export type StableRewardsBalanceState = 'earning' | 'pending';
+export interface StableRewardsBalanceDetail {
+    ccy: string;
+    amt: string;
+    totalEarnAccrual: string;
+    state: StableRewardsBalanceState;
+}
+export interface StableRewardsBalance {
+    details: StableRewardsBalanceDetail[];
+    ts: string;
+}
+export interface StableRewardsApyHistoryItem {
+    rate: string;
+    ts: string;
+}
+export type StableRewardsSubscribeRedeemType = 'subscribe' | 'redeem';
+export type StableRewardsSubscribeRedeemStatus = 'pending' | 'success' | 'failed';
+export interface StableRewardsSubscribeRedeemHistoryItem {
+    type: StableRewardsSubscribeRedeemType;
+    status: StableRewardsSubscribeRedeemStatus;
+    ccy: string;
+    settleCcy: string;
+    ccyAmt: string;
+    settleCcyAmt: string;
+    fee: string;
+    quoteId: string;
+    ordId: string;
+    ts: string;
+}

package/dist/mjs/types/rest/response/private-stable-rewards.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=private-stable-rewards.js.map

package/dist/mjs/types/rest/response/private-stable-rewards.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"private-stable-rewards.js","sourceRoot":"","sources":["../../../../../src/types/rest/response/private-stable-rewards.ts"],"names":[],"mappings":""}

package/dist/mjs/types/rest/response/private-trade.d.ts

@@ -25,12 +25,14 @@ export interface OrderResult {
     tag: string;
     ts: string;
     sCode: numberInString;
+    subCode?: string;
     sMsg: string;
 }
 export interface CancelledOrderResult {
     clOrdId: string;
     ordId: string;
     sCode: string;
+    subCode?: string;
     sMsg: string;
 }
 export interface AmendedOrder {
@@ -38,6 +40,7 @@ export interface AmendedOrder {
     ordId: string;
     reqId: string;
     sCode: string;
+    subCode?: string;
     sMsg: string;
 }
 export interface ClosedPositions {

package/dist/mjs/types/rest/response/public-data.d.ts

@@ -108,7 +108,7 @@ export interface Instrument {
      */
     alias: string;
     /**
-     * Instrument status: live, suspend, rebase (SWAP only), preopen, test, expired, settling (EVENTS), …
+     * Instrument status: live, suspend, rebase (SWAP only), post_only (SWAP only), preopen, test, expired, settling (EVENTS), …
      */
     state: string;
     openType?: string;
@@ -187,6 +187,26 @@ export interface PublicFundingRate {
     premium: string;
     ts: string;
 }
+export interface InsuranceFundDetail {
+    ccy?: string;
+    bal?: string;
+    amt?: string;
+    type?: string;
+    maxBal?: string;
+    maxBalTs?: string;
+    decRate?: string;
+    adlType?: string;
+    adlBal?: string;
+    adlRecBal?: string;
+    /** @deprecated Returns "" per 2026-06-09 changelog */
+    adlRate?: string;
+    /** @deprecated Returns "" per 2026-06-09 changelog */
+    adlRecRate?: string;
+}
+export interface InsuranceFund {
+    instType?: string;
+    details: InsuranceFundDetail[];
+}
 export interface FundingRateHistory {
     /** Perpetual (`SWAP`) or X-Perp (`FUTURES`). */
     instType: string;

package/dist/mjs/types/shared.d.ts

@@ -4,10 +4,11 @@ export interface APICredentials {
     apiPass: string;
 }
 /**
- * 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, 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' | 'GLOBAL' | 'EEA' | 'US';
+export type APIMarket = 'prod' | 'GLOBAL' | 'OPENAPI_GLOBAL' | 'EEA' | 'US';

package/dist/mjs/types/websockets/ws-api-request.d.ts

@@ -20,6 +20,12 @@ export interface WSAPIPlaceOrderRequestV5 {
     reduceOnly?: boolean;
     /** A spot buy on BTC-USDT with "base_ccy" would mean the QTY (sz) is in USDT */
     tgtCcy?: 'base_ccy' | 'quote_ccy';
+    /**
+     * Maximum acceptable slippage for spot and spot margin market-side orders, where tgtCcy is the received currency (base_ccy for buy, quote_ccy for sell).
+     * Range: 0 to 0.05 (0% to 5%, inclusive). Up to 2 decimal places, e.g. 0.01 (1%) and 0.0123 (1.23%). Defaults to 0.00% if not specified.
+     * Only applicable to SPOT and SPOT margin market orders. Cannot be amended on an existing order.
+     */
+    slippagePct?: string;
     banAmend?: boolean;
     tradeQuoteCcy?: string;
     stpMode?: 'cancel_maker' | 'cancel_taker' | 'cancel_both';

package/dist/mjs/types/websockets/ws-api-response.d.ts

@@ -4,6 +4,7 @@ export interface WSAPICancelOrderResultV5 {
     ordId: string;
     ts: numberInString;
     sCode: string;
+    subCode?: string;
     sMsg: string;
 }
 export interface WSAPISpreadPlaceOrderResultV5 {
@@ -11,6 +12,7 @@ export interface WSAPISpreadPlaceOrderResultV5 {
     ordId: string;
     tag: string;
     sCode: numberInString;
+    subCode?: string;
     sMsg: string;
 }
 export interface WSAPISpreadAmendOrderResultV5 {
@@ -18,12 +20,14 @@ export interface WSAPISpreadAmendOrderResultV5 {
     ordId: string;
     reqId: string;
     sCode: string;
+    subCode?: string;
     sMsg: string;
 }
 export interface WSAPISpreadCancelOrderResultV5 {
     clOrdId: string;
     ordId: string;
     sCode: string;
+    subCode?: string;
     sMsg: string;
 }
 /**

package/dist/mjs/types/websockets/ws-events.d.ts

@@ -6,9 +6,10 @@ export interface MessageEventLike {
 }
 export declare function isMessageEvent(msg: unknown): msg is MessageEventLike;
 export interface WsEvent {
-    event: 'error' | 'login' | 'subscribe' | 'unsubscribe' | 'channel-conn-count';
+    event: 'error' | 'login' | 'subscribe' | 'unsubscribe' | 'channel-conn-count' | 'notice';
     code?: string;
     msg?: string;
+    connId?: string;
     arg?: any;
     data?: any;
 }

package/dist/mjs/types/websockets/ws-general.d.ts

@@ -7,6 +7,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
      */

package/dist/mjs/types/websockets/ws-request.d.ts

@@ -6,7 +6,7 @@ export interface WsAuthRequestArg {
     sign: string;
 }
 export type WsTradeOp = 'order' | 'batch-orders' | 'cancel-order' | 'batch-cancel-orders' | 'amend-order' | 'batch-amend-order';
-export type WsPrivateChannel = 'account' | 'positions' | 'balance_and_position' | 'orders' | 'orders-algo' | 'algo-advance' | 'liquidation-warning' | 'account-greeks' | 'grid-orders-spot' | 'grid-orders-contract' | 'grid-orders-moon' | 'grid-positions' | 'grid-sub-orders';
+export type WsPrivateChannel = 'account' | 'positions' | 'balance_and_position' | 'orders' | 'orders-algo' | 'algo-advance' | 'liquidation-warning' | 'adl-warning' | 'account-greeks' | 'grid-orders-spot' | 'grid-orders-contract' | 'grid-orders-moon' | 'grid-positions' | 'grid-sub-orders';
 export type WsPublicKlineChannel = 'candle1Y' | 'candle6M' | 'candle3M' | 'candle1M' | 'candle1W' | 'candle1D' | 'candle2D' | 'candle3D' | 'candle5D' | 'candle12H' | 'candle6H' | 'candle4H' | 'candle2H' | 'candle1H' | 'candle30m' | 'candle15m' | 'candle5m' | 'candle3m' | 'candle1m' | 'candle1s' | 'candle1Yutc' | 'candle3Mutc' | 'candle1Mutc' | 'candle1Wutc' | 'candle1Dutc' | 'candle2Dutc' | 'candle3Dutc' | 'candle5Dutc' | 'candle12Hutc' | 'candle6Hutc';
 export type WsPublicMarkPriceKlineChannel = 'mark-price-candle1Y' | 'mark-price-candle6M' | 'mark-price-candle3M' | 'mark-price-candle1M' | 'mark-price-candle1W' | 'mark-price-candle1D' | 'mark-price-candle2D' | 'mark-price-candle3D' | 'mark-price-candle5D' | 'mark-price-candle12H' | 'mark-price-candle6H' | 'mark-price-candle4H' | 'mark-price-candle2H' | 'mark-price-candle1H' | 'mark-price-candle30m' | 'mark-price-candle15m' | 'mark-price-candle5m' | 'mark-price-candle3m' | 'mark-price-candle1m' | 'mark-price-candle1Yutc' | 'mark-price-candle3Mutc' | 'mark-price-candle1Mutc' | 'mark-price-candle1Wutc' | 'mark-price-candle1Dutc' | 'mark-price-candle2Dutc' | 'mark-price-candle3Dutc' | 'mark-price-candle5Dutc' | 'mark-price-candle12Hutc' | 'mark-price-candle6Hutc';
 export type WsPublicIndexKlineChannel = 'index-candle1Y' | 'index-candle6M' | 'index-candle3M' | 'index-candle1M' | 'index-candle1W' | 'index-candle1D' | 'index-candle2D' | 'index-candle3D' | 'index-candle5D' | 'index-candle12H' | 'index-candle6H' | 'index-candle4H index -candle2H' | 'index-candle1H' | 'index-candle30m' | 'index-candle15m' | 'index-candle5m' | 'index-candle3m' | 'index-candle1m' | 'index-candle1Yutc' | 'index-candle3Mutc' | 'index-candle1Mutc' | 'index-candle1Wutc' | 'index-candle1Dutc' | 'index-candle2Dutc' | 'index-candle3Dutc' | 'index-candle5Dutc' | 'index-candle12Hutc' | 'index-candle6Hutc';

package/dist/mjs/util/requestUtils.js

@@ -30,6 +30,9 @@ export function getRestBaseUrl(market, restClientOptions) {
         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
         case 'EEA': {
             return 'https://eea.okx.com';

package/dist/mjs/util/requestUtils.js.map

@@ -1 +1 @@
-{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../../src/util/requestUtils.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,eAAe,CAC7B,MAA0B,EAC1B,MAAc,EACd,iBAAiB,GAAG,KAAK;IAEzB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAI,MAAc,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;IAC3B,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,iDAAiD;IACjD,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AACvD,CAAC;AACD,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,CAAC;AAChC,MAAM,CAAC,MAAM,SAAS,GAAG,kBAAkB,CAAC;AAE5C,MAAM,UAAU,cAAc,CAC5B,MAAiB,EACjB,iBAAoC;IAEpC,IAAI,iBAAiB,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,QAAQ,MAAM,EAAE,CAAC;QACf,QAAQ;QACR,sGAAsG;QACtG,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,OAAO,qBAAqB,CAAC;QAC/B,CAAC;QACD,iGAAiG;QACjG,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,OAAO,qBAAqB,CAAC;QAC/B,CAAC;QACD,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,OAAO,oBAAoB,CAAC;QAC9B,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,QAAa;IACpC,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,CACL,QAAQ,CAAC,OAAO;QAChB,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM;QAC9B,QAAQ,CAAC,OAAO,KAAK,MAAM;QAC3B,QAAQ,CAAC,OAAO,KAAK,IAAI,CAC1B,CAAC;AACJ,CAAC"}
+{"version":3,"file":"requestUtils.js","sourceRoot":"","sources":["../../../src/util/requestUtils.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,eAAe,CAC7B,MAA0B,EAC1B,MAAc,EACd,iBAAiB,GAAG,KAAK;IAEzB,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;QACrB,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAED,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACpC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE;QACX,MAAM,KAAK,GAAI,MAAc,CAAC,GAAG,CAAC,CAAC;QACnC,IAAI,iBAAiB,KAAK,IAAI,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE,CAAC;YAC/D,MAAM,IAAI,KAAK,CACb,uDAAuD,CACxD,CAAC;QACJ,CAAC;QACD,OAAO,GAAG,GAAG,IAAI,KAAK,EAAE,CAAC;IAC3B,CAAC,CAAC;SACD,IAAI,CAAC,GAAG,CAAC,CAAC;IAEb,iDAAiD;IACjD,OAAO,WAAW,CAAC,CAAC,CAAC,GAAG,GAAG,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC;AACvD,CAAC;AACD,MAAM,CAAC,MAAM,UAAU,GAAG,KAAK,CAAC;AAChC,MAAM,CAAC,MAAM,SAAS,GAAG,kBAAkB,CAAC;AAE5C,MAAM,UAAU,cAAc,CAC5B,MAAiB,EACjB,iBAAoC;IAEpC,IAAI,iBAAiB,CAAC,OAAO,EAAE,CAAC;QAC9B,OAAO,iBAAiB,CAAC,OAAO,CAAC;IACnC,CAAC;IAED,QAAQ,MAAM,EAAE,CAAC;QACf,QAAQ;QACR,sGAAsG;QACtG,KAAK,QAAQ,CAAC;QACd,KAAK,MAAM,CAAC,CAAC,CAAC;YACZ,OAAO,qBAAqB,CAAC;QAC/B,CAAC;QACD,KAAK,gBAAgB,CAAC,CAAC,CAAC;YACtB,OAAO,yBAAyB,CAAC;QACnC,CAAC;QACD,iGAAiG;QACjG,KAAK,KAAK,CAAC,CAAC,CAAC;YACX,OAAO,qBAAqB,CAAC;QAC/B,CAAC;QACD,KAAK,IAAI,CAAC,CAAC,CAAC;YACV,OAAO,oBAAoB,CAAC;QAC9B,CAAC;IACH,CAAC;AACH,CAAC;AAED,MAAM,UAAU,QAAQ,CAAC,QAAa;IACpC,IAAI,QAAQ,CAAC,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,CACL,QAAQ,CAAC,OAAO;QAChB,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,MAAM;QAC9B,QAAQ,CAAC,OAAO,KAAK,MAAM;QAC3B,QAAQ,CAAC,OAAO,KAAK,IAAI,CAC1B,CAAC;AACJ,CAAC"}

package/dist/mjs/util/websocket-util.js

@@ -31,6 +31,20 @@ export const WS_BASE_URL_MAP = {
             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: {
@@ -327,7 +341,8 @@ export function getWsKeyForTopicChannel(market, channel, isPrivate) {
 export function getWsKeyForMarket(market, isPrivate, isBusinessChannel) {
     switch (market) {
         case 'prod':
-        case 'GLOBAL': {
+        case 'GLOBAL':
+        case 'OPENAPI_GLOBAL': {
             if (isBusinessChannel) {
                 return WS_KEY_MAP.prodBusiness;
             }
@@ -440,6 +455,7 @@ export function getMaxTopicsPerSubscribeEventForMarket(market) {
         case 'prod':
         case 'EEA':
         case 'GLOBAL':
+        case 'OPENAPI_GLOBAL':
         case 'US': {
             return null;
         }