feat(v3.1.5): update version to 3.1.5, add affiliate and stable rewards API support

- Bumped version in package.json and package-lock.json to 3.1.5.
- Introduced new API endpoints for affiliate and stable rewards functionalities.
- Added request and response types for affiliate and stable rewards in the respective files.
- Updated RestClient to include methods for the new endpoints.

Author: JJ-Cro

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "okx-api",
-  "version": "3.1.4",
+  "version": "3.1.5",
   "description": "Complete Node.js SDK for OKX's REST APIs and WebSockets, with TypeScript & end-to-end tests",
   "scripts": {
     "test": "jest",
@@ -52,15 +52,13 @@
     "jest": "^29.7.0",
     "ts-jest": "^29.1.2",
     "ts-node": "^10.9.2",
-    "typescript": "^5.7.3"
-  },
-  "optionalDependencies": {
+    "typescript": "^5.7.3",
     "source-map-loader": "^4.0.0",
     "ts-loader": "^9.5.4",
     "webpack": "^5.74.0",
     "webpack-bundle-analyzer": "^4.6.1",
     "webpack-cli": "^4.10.0"
-  },
+  },  
   "keywords": [
     "okx",
     "okx api",

package.json

@@ -5,6 +5,7 @@ export * from './types/rest/client.js';
 export * from './types/rest/shared.js';
 // REST/request
 export * from './types/rest/request/account.js';
+export * from './types/rest/request/affiliate.js';
 export * from './types/rest/request/block-trading.js';
 export * from './types/rest/request/convert.js';
 export * from './types/rest/request/copy-trading.js';
@@ -17,10 +18,12 @@ export * from './types/rest/request/shared.js';
 export * from './types/rest/request/signal-bot.js';
 export * from './types/rest/request/simple-earn.js';
 export * from './types/rest/request/spread-trading.js';
+export * from './types/rest/request/stable-rewards.js';
 export * from './types/rest/request/subaccount.js';
 export * from './types/rest/request/trade.js';
 // REST/response
 export * from './types/rest/response/private-account.js';
+export * from './types/rest/response/private-affiliate.js';
 export * from './types/rest/response/private-block-trading.js';
 export * from './types/rest/response/private-copy-trading.js';
 export * from './types/rest/response/private-dual-investment.js';
@@ -29,6 +32,7 @@ export * from './types/rest/response/private-funding.js';
 export * from './types/rest/response/private-recurring-buy.js';
 export * from './types/rest/response/private-signal-bot.js';
 export * from './types/rest/response/private-spread-trading.js';
+export * from './types/rest/response/private-stable-rewards.js';
 export * from './types/rest/response/private-subaccount.js';
 export * from './types/rest/response/private-trade.js';
 export * from './types/rest/response/public-data.js';

src/index.ts

@@ -25,6 +25,14 @@ import {
   UpdateFixedLoanBorrowingOrderRequest,
   WithdrawalHistoryRequest,
 } from './types/rest/request/account.js';
+import {
+  GetAffiliateCoInviterLinkListRequest,
+  GetAffiliateInviteeListRequest,
+  GetAffiliateLinkListRequest,
+  GetAffiliatePerformanceSummaryRequest,
+  GetAffiliateSubAffiliateListRequest,
+  GetInviteeDetailRequest,
+} from './types/rest/request/affiliate.js';
 import {
   CancelBlockQuoteRequest,
   CancelBlockRFQRequest,
@@ -133,6 +141,14 @@ import {
   PlaceSpreadOrderRequest,
   UpdateSpreadOrderRequest,
 } from './types/rest/request/spread-trading.js';
+import {
+  GetStableRewardsApyHistoryRequest,
+  GetStableRewardsBalanceRequest,
+  GetStableRewardsProductInfoRequest,
+  GetStableRewardsSubscribeRedeemHistoryRequest,
+  RequestStableRewardsQuoteRequest,
+  SubmitStableRewardsTradeRequest,
+} from './types/rest/request/stable-rewards.js';
 import {
   GetManagedSubAccountTransferHistoryRequest,
   GetSubAccountMaxWithdrawalsRequest,
@@ -196,6 +212,14 @@ import {
   VIPLoanOrder,
   VIPLoanOrderDetail,
 } from './types/rest/response/private-account.js';
+import {
+  AffiliateCoInviterLinkListItem,
+  AffiliateInviteeListItem,
+  AffiliateLinkListItem,
+  AffiliatePerformanceSummary,
+  AffiliateSubAffiliateListItem,
+  InviteeDetail,
+} from './types/rest/response/private-affiliate.js';
 import {
   BlockCounterParty,
   BlockMakerInstrumentSettings,
@@ -291,6 +315,14 @@ import {
   SpreadTrade,
   UpdateSpreadOrderResponse,
 } from './types/rest/response/private-spread-trading.js';
+import {
+  StableRewardsApyHistoryItem,
+  StableRewardsBalance,
+  StableRewardsProductInfo,
+  StableRewardsQuote,
+  StableRewardsSubscribeRedeemHistoryItem,
+  StableRewardsTradeResult,
+} from './types/rest/response/private-stable-rewards.js';
 import {
   ManagedSubAccountTransfer,
   SubAccount,
@@ -2490,6 +2522,8 @@ export class RestClient extends BaseRestClient {
     ccy?: string;
     type?: `${ASSET_BILL_TYPE}`;
     clientId?: string;
+    /** Third-party custody type. Defaults to 1 (Copper) if not specified. */
+    thirdPartyType?: '1' | '2' | '5' | '6';
     after?: numberInString;
     before?: numberInString;
     limit?: numberInString;
@@ -3014,16 +3048,96 @@ export class RestClient extends BaseRestClient {
     return this.getPrivate('/api/v5/finance/sfp/dcd/order-history', params);
   }
 
+  /**
+   *
+   * Financial product — stable rewards endpoints
+   * @see https://www.okx.com/docs-v5/en/ (2026-04-24 release)
+   *
+   */
+
+  getStableRewardsProductInfo(
+    params: GetStableRewardsProductInfoRequest,
+  ): Promise<StableRewardsProductInfo[]> {
+    return this.getPrivate(
+      '/api/v5/finance/stable-rewards/product-info',
+      params,
+    );
+  }
+
+  requestStableRewardsQuote(
+    params: RequestStableRewardsQuoteRequest,
+  ): Promise<StableRewardsQuote[]> {
+    return this.postPrivate('/api/v5/finance/stable-rewards/quote', params);
+  }
+
+  submitStableRewardsTrade(
+    params: SubmitStableRewardsTradeRequest,
+  ): Promise<StableRewardsTradeResult[]> {
+    return this.postPrivate('/api/v5/finance/stable-rewards/trade', params);
+  }
+
+  getStableRewardsBalance(
+    params?: GetStableRewardsBalanceRequest,
+  ): Promise<StableRewardsBalance[]> {
+    return this.getPrivate('/api/v5/finance/stable-rewards/balance', params);
+  }
+
+  getStableRewardsApyHistory(
+    params: GetStableRewardsApyHistoryRequest,
+  ): Promise<StableRewardsApyHistoryItem[]> {
+    return this.get('/api/v5/finance/stable-rewards/apy-history', params);
+  }
+
+  getStableRewardsSubscribeRedeemHistory(
+    params: GetStableRewardsSubscribeRedeemHistoryRequest,
+  ): Promise<StableRewardsSubscribeRedeemHistoryItem[]> {
+    return this.getPrivate(
+      '/api/v5/finance/stable-rewards/subscribe-redeem-history',
+      params,
+    );
+  }
+
   /**
    *
    * Affiliate endpoints
+   * @see https://www.okx.com/docs-v5/en/ (2026-05-08 release)
    *
    */
 
-  getInviteeDetail(params: { uid: string }): Promise<any[]> {
+  getAffiliatePerformanceSummary(
+    params?: GetAffiliatePerformanceSummaryRequest,
+  ): Promise<AffiliatePerformanceSummary[]> {
+    return this.getPrivate('/api/v5/affiliate/performance/summary', params);
+  }
+
+  getInviteeDetail(params: GetInviteeDetailRequest): Promise<InviteeDetail[]> {
     return this.getPrivate('/api/v5/affiliate/invitee/detail', params);
   }
 
+  getAffiliateInviteeList(
+    params?: GetAffiliateInviteeListRequest,
+  ): Promise<AffiliateInviteeListItem[]> {
+    return this.getPrivate('/api/v5/affiliate/invitee/list', params);
+  }
+
+  getAffiliateLinkList(
+    params?: GetAffiliateLinkListRequest,
+  ): Promise<AffiliateLinkListItem[]> {
+    return this.getPrivate('/api/v5/affiliate/link/list', params);
+  }
+
+  getAffiliateCoInviterLinkList(
+    params?: GetAffiliateCoInviterLinkListRequest,
+  ): Promise<AffiliateCoInviterLinkListItem[]> {
+    return this.getPrivate('/api/v5/affiliate/co-inviter/list', params);
+  }
+
+  getAffiliateSubAffiliateList(
+    params?: GetAffiliateSubAffiliateListRequest,
+  ): Promise<AffiliateSubAffiliateListItem[]> {
+    return this.getPrivate('/api/v5/affiliate/sub-affiliate/list', params);
+  }
+
   getAffiliateRebateInfo(params: { apiKey: string }): Promise<any[]> {
     return this.getPrivate('/api/v5/users/partner/if-rebate', params);
   }

src/rest-client.ts

@@ -7,7 +7,7 @@ export interface RestClientOptions {
 
   /**
    * 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: 'prod' (default: 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
    */
@@ -21,7 +21,7 @@ export interface RestClientOptions {
   // Default: false. If true, we'll throw errors if any params are undefined
   strict_param_validation?: boolean;
 
-  // Optionally override API protocol + domain.
+  // Optionally override REST API base URL (e.g. 'https://www.okx.com' or 'https://openapi.okx.com').
   // Note: to use my.okx or app.okx or eea.okx or us.okx, use the "market" parameter
   // e.g 'https://eea.okx.com'
   baseUrl?: string;

src/types/rest/client.ts

@@ -0,0 +1,83 @@
+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;
+}

src/types/rest/request/affiliate.ts

@@ -0,0 +1,32 @@
+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;
+}

src/types/rest/request/stable-rewards.ts

@@ -242,6 +242,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';

src/types/rest/request/trade.ts

@@ -400,7 +400,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. */
@@ -424,7 +424,7 @@ export interface AccountInstrument {
   quoteCcy: string;
   tradeQuoteCcyList: string[]; // List of quote currencies available for trading, e.g. ["USD", "USDC"]
   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;
@@ -579,7 +579,7 @@ export interface SetTradingConfigResult {
 }
 
 export interface UnmatchedInfo {
-  type: string; // Unmatched information type: spot_mode, futures_mode, isolated_margin, isolated_contract, positions_options, isolated_pending_orders, pending_orders_options, trading_bot, repay_borrowings, loan, delta_risk, collateral_all
+  type: string; // Unmatched information type: spot_mode, futures_mode, isolated_margin, isolated_contract, positions_options, isolated_pending_orders, pending_orders_options, trading_bot, repay_borrowings, loan, delta_risk, collateral_all, risk_unit_type
   deltaLever?: string; // Delta leverage. Applicable when type is delta_risk
   ordList?: string[]; // Unmatched order list, order ID. Applicable when type is isolated_pending_orders/pending_orders_options
   posList?: string[]; // Unmatched position list, position ID. Applicable when type is isolated_margin/isolated_contract/positions_options