okx-api 3.2.0 → 3.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +22 -22
- package/dist/cjs/index.d.ts +4 -0
- package/dist/cjs/index.js +4 -0
- package/dist/cjs/index.js.map +1 -1
- package/dist/cjs/rest-client.d.ts +31 -1
- package/dist/cjs/rest-client.js +34 -0
- package/dist/cjs/rest-client.js.map +1 -1
- package/dist/cjs/types/rest/request/affiliate.d.ts +11 -0
- package/dist/cjs/types/rest/request/glp.d.ts +7 -0
- package/dist/cjs/types/rest/request/glp.js +3 -0
- package/dist/cjs/types/rest/request/glp.js.map +1 -0
- package/dist/cjs/types/rest/request/okusd.d.ts +10 -0
- package/dist/cjs/types/rest/request/okusd.js +3 -0
- package/dist/cjs/types/rest/request/okusd.js.map +1 -0
- package/dist/cjs/types/rest/request/public.d.ts +1 -0
- package/dist/cjs/types/rest/request/trade.d.ts +36 -5
- package/dist/cjs/types/rest/response/private-account.d.ts +7 -2
- package/dist/cjs/types/rest/response/private-affiliate.d.ts +2 -0
- package/dist/cjs/types/rest/response/private-glp.d.ts +48 -0
- package/dist/cjs/types/rest/response/private-glp.js +3 -0
- package/dist/cjs/types/rest/response/private-glp.js.map +1 -0
- package/dist/cjs/types/rest/response/private-okusd.d.ts +37 -0
- package/dist/cjs/types/rest/response/private-okusd.js +3 -0
- package/dist/cjs/types/rest/response/private-okusd.js.map +1 -0
- package/dist/cjs/types/rest/response/private-trade.d.ts +27 -0
- package/dist/cjs/types/rest/response/public-data.d.ts +23 -1
- package/dist/cjs/types/rest/shared.d.ts +3 -1
- package/dist/cjs/types/websockets/ws-api-request.d.ts +16 -2
- package/dist/cjs/types/websockets/ws-general.d.ts +1 -1
- package/dist/cjs/types/websockets/ws-request.d.ts +5 -1
- package/dist/mjs/index.d.ts +4 -0
- package/dist/mjs/index.js +4 -0
- package/dist/mjs/index.js.map +1 -1
- package/dist/mjs/rest-client.d.ts +31 -1
- package/dist/mjs/rest-client.js +34 -0
- package/dist/mjs/rest-client.js.map +1 -1
- package/dist/mjs/types/rest/request/affiliate.d.ts +11 -0
- package/dist/mjs/types/rest/request/glp.d.ts +7 -0
- package/dist/mjs/types/rest/request/glp.js +2 -0
- package/dist/mjs/types/rest/request/glp.js.map +1 -0
- package/dist/mjs/types/rest/request/okusd.d.ts +10 -0
- package/dist/mjs/types/rest/request/okusd.js +2 -0
- package/dist/mjs/types/rest/request/okusd.js.map +1 -0
- package/dist/mjs/types/rest/request/public.d.ts +1 -0
- package/dist/mjs/types/rest/request/trade.d.ts +36 -5
- package/dist/mjs/types/rest/response/private-account.d.ts +7 -2
- package/dist/mjs/types/rest/response/private-affiliate.d.ts +2 -0
- package/dist/mjs/types/rest/response/private-glp.d.ts +48 -0
- package/dist/mjs/types/rest/response/private-glp.js +2 -0
- package/dist/mjs/types/rest/response/private-glp.js.map +1 -0
- package/dist/mjs/types/rest/response/private-okusd.d.ts +37 -0
- package/dist/mjs/types/rest/response/private-okusd.js +2 -0
- package/dist/mjs/types/rest/response/private-okusd.js.map +1 -0
- package/dist/mjs/types/rest/response/private-trade.d.ts +27 -0
- package/dist/mjs/types/rest/response/public-data.d.ts +23 -1
- package/dist/mjs/types/rest/shared.d.ts +3 -1
- package/dist/mjs/types/websockets/ws-api-request.d.ts +16 -2
- package/dist/mjs/types/websockets/ws-general.d.ts +1 -1
- package/dist/mjs/types/websockets/ws-request.d.ts +5 -1
- package/llms.txt +10427 -8090
- package/package.json +6 -7
|
@@ -65,6 +65,16 @@ export interface AttachAlgoOrdRequest {
|
|
|
65
65
|
/** Trailing: activation; omit = activate immediately. */
|
|
66
66
|
activePx?: string;
|
|
67
67
|
}
|
|
68
|
+
export interface AdvChaseParams {
|
|
69
|
+
chaseType?: string;
|
|
70
|
+
chaseVal?: string;
|
|
71
|
+
maxChaseType?: string;
|
|
72
|
+
maxChaseVal?: string;
|
|
73
|
+
}
|
|
74
|
+
export interface AdvChaseAmendParams {
|
|
75
|
+
newChaseVal?: string;
|
|
76
|
+
newMaxChaseVal?: string;
|
|
77
|
+
}
|
|
68
78
|
export interface AlgoOrderRequest {
|
|
69
79
|
instId: string;
|
|
70
80
|
tdMode: TradeMode;
|
|
@@ -102,7 +112,9 @@ export interface AlgoOrderRequest {
|
|
|
102
112
|
timeInterval?: string;
|
|
103
113
|
quickMgnType?: string;
|
|
104
114
|
closeFraction?: numberInString;
|
|
105
|
-
advanceOrdType?: 'fok' | 'ioc' | '';
|
|
115
|
+
advanceOrdType?: 'fok' | 'ioc' | 'chase' | '';
|
|
116
|
+
/** Required when advanceOrdType is `chase` (FUTURES/SWAP trigger). */
|
|
117
|
+
advChaseParams?: AdvChaseParams[];
|
|
106
118
|
attachAlgoOrds?: AttachAlgoOrdRequest[];
|
|
107
119
|
}
|
|
108
120
|
export interface AmendOrderRequest {
|
|
@@ -113,8 +125,17 @@ export interface AmendOrderRequest {
|
|
|
113
125
|
reqId?: string;
|
|
114
126
|
newSz?: string;
|
|
115
127
|
newPx?: string;
|
|
116
|
-
/**
|
|
128
|
+
/**
|
|
129
|
+
* EVENTS: `"1"` for non-`post_only` amends when applicable.
|
|
130
|
+
* Ignored since 2026-07-24 (event-contract speed bump removed).
|
|
131
|
+
*/
|
|
117
132
|
speedBump?: string;
|
|
133
|
+
/** RPI taker access. Not inherited on amend - omit = false. Alias: isElpTakerAccess until 2026-10-31. */
|
|
134
|
+
rpiTakerAccess?: boolean;
|
|
135
|
+
/** @deprecated Use `rpiTakerAccess`. Alias until 2026-10-31. */
|
|
136
|
+
isElpTakerAccess?: boolean;
|
|
137
|
+
/** RPI maker spacing: auto-round price when true. Only for ordType rpi. */
|
|
138
|
+
rpiPxRound?: boolean;
|
|
118
139
|
/**
|
|
119
140
|
* Amend attached trailing stop (or related attach algo) — only one of newCallbackRatio / newCallbackSpread per item (2026-04-13).
|
|
120
141
|
*/
|
|
@@ -138,9 +159,11 @@ export interface AmendAlgoOrderRequest {
|
|
|
138
159
|
newSlOrdPx?: string;
|
|
139
160
|
newTpTriggerPxType?: 'last' | 'index' | 'mark';
|
|
140
161
|
newSlTriggerPxType?: 'last' | 'index' | 'mark';
|
|
141
|
-
newTriggerPx
|
|
142
|
-
newOrdPx
|
|
162
|
+
newTriggerPx?: string;
|
|
163
|
+
newOrdPx?: string;
|
|
143
164
|
newTriggerPxType?: 'last' | 'index' | 'mark';
|
|
165
|
+
/** Amend chase values on a pending trigger+chase order (pre-trigger). */
|
|
166
|
+
advChaseParams?: AdvChaseAmendParams[];
|
|
144
167
|
attachAlgoOrds?: AlgoTriggerOrder[];
|
|
145
168
|
}
|
|
146
169
|
export interface CancelAlgoOrderRequest {
|
|
@@ -226,10 +249,18 @@ export interface OrderRequest {
|
|
|
226
249
|
tradeQuoteCcy?: string;
|
|
227
250
|
/** Self trade prevention mode: cancel_maker, cancel_taker, cancel_both. Default is cancel_maker */
|
|
228
251
|
stpMode?: 'cancel_maker' | 'cancel_taker' | 'cancel_both';
|
|
229
|
-
/**
|
|
252
|
+
/**
|
|
253
|
+
* RPI taker access for limit/market/fok/ioc. Default false. Speedbump when true.
|
|
254
|
+
* Alias `isElpTakerAccess` accepted until 2026-10-31.
|
|
255
|
+
*/
|
|
256
|
+
rpiTakerAccess?: boolean;
|
|
257
|
+
/** @deprecated Use `rpiTakerAccess`. Alias until 2026-10-31. */
|
|
230
258
|
isElpTakerAccess?: boolean;
|
|
259
|
+
/** RPI maker spacing: auto-round price when true. Only for ordType rpi. */
|
|
260
|
+
rpiPxRound?: boolean;
|
|
231
261
|
/**
|
|
232
262
|
* EVENTS: set to `"1"` for non-`post_only` orders. Error 54086 if missing when required.
|
|
263
|
+
* Ignored since 2026-07-24 (event-contract speed bump removed).
|
|
233
264
|
*/
|
|
234
265
|
speedBump?: string;
|
|
235
266
|
/** EVENTS: `yes` or `no`. */
|
|
@@ -267,7 +267,10 @@ export interface FeeGroup {
|
|
|
267
267
|
taker: string;
|
|
268
268
|
maker: string;
|
|
269
269
|
groupId: string;
|
|
270
|
+
/** @deprecated Use `rpiMaker`. Alias until 2026-10-31. */
|
|
270
271
|
elpMaker?: string;
|
|
272
|
+
/** RPI maker effective fee rate. "" if RPI not applicable. */
|
|
273
|
+
rpiMaker?: string;
|
|
271
274
|
}
|
|
272
275
|
export interface AccountFeeRate {
|
|
273
276
|
category: never;
|
|
@@ -391,7 +394,7 @@ export interface AccountInstrument {
|
|
|
391
394
|
state: string;
|
|
392
395
|
stk: string;
|
|
393
396
|
tickSz: string;
|
|
394
|
-
/** Trading rule types: normal, pre_market, rebase_contract */
|
|
397
|
+
/** Trading rule types: normal, pre_market (incl. Pre-market X-Perp FUTURES), rebase_contract, xperp */
|
|
395
398
|
ruleType: string;
|
|
396
399
|
auctionEndTime: string;
|
|
397
400
|
futureSettlement: boolean;
|
|
@@ -411,8 +414,10 @@ export interface AccountInstrument {
|
|
|
411
414
|
/** Remaining short position value (USD) the user is permitted to open. Applicable to SWAP/FUTURES. */
|
|
412
415
|
shortPosRemainingQuota?: string;
|
|
413
416
|
groupId?: string;
|
|
414
|
-
/**
|
|
417
|
+
/** @deprecated Use `rpi`. Alias until 2026-10-31. */
|
|
415
418
|
elp?: string;
|
|
419
|
+
/** RPI maker permission. "0" = not enabled, "1" = enabled but no permission, "2" = enabled with permission */
|
|
420
|
+
rpi?: string;
|
|
416
421
|
upcChg?: InstrumentUpcomingParamChange[];
|
|
417
422
|
}
|
|
418
423
|
export interface QuickMarginBorrowRepayResult {
|
|
@@ -27,6 +27,8 @@ export interface InviteeDetail {
|
|
|
27
27
|
kycTime: string;
|
|
28
28
|
region: string;
|
|
29
29
|
affiliateCode: string;
|
|
30
|
+
/** Trading volume in selected periodType window (USDT). Only when periodType supplied. */
|
|
31
|
+
volPeriod?: string;
|
|
30
32
|
}
|
|
31
33
|
export type AffiliateInviteeListKycStatus = 'unverified' | 'verified';
|
|
32
34
|
export interface AffiliateInviteeListItem {
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
export interface GlpMakerTaker {
|
|
2
|
+
maker: string;
|
|
3
|
+
taker: string;
|
|
4
|
+
}
|
|
5
|
+
export interface GlpVolumeBuckets {
|
|
6
|
+
typeA: GlpMakerTaker | null;
|
|
7
|
+
typeBTotal: GlpMakerTaker | null;
|
|
8
|
+
tradfiX2: GlpMakerTaker | null;
|
|
9
|
+
total: GlpMakerTaker;
|
|
10
|
+
}
|
|
11
|
+
export interface GlpShareBuckets {
|
|
12
|
+
typeA: GlpMakerTaker | null;
|
|
13
|
+
typeBAdj: GlpMakerTaker | null;
|
|
14
|
+
total: GlpMakerTaker;
|
|
15
|
+
}
|
|
16
|
+
export interface GlpDailyMetrics {
|
|
17
|
+
volume: GlpVolumeBuckets;
|
|
18
|
+
share: GlpShareBuckets;
|
|
19
|
+
}
|
|
20
|
+
export interface GlpMtdMetrics extends GlpDailyMetrics {
|
|
21
|
+
mtdStatus: string;
|
|
22
|
+
qualifyingShare: GlpMakerTaker;
|
|
23
|
+
}
|
|
24
|
+
export interface GlpProgramPerformance {
|
|
25
|
+
program: string;
|
|
26
|
+
marketMakerBusinessId: string;
|
|
27
|
+
enrollmentStatus: string;
|
|
28
|
+
marketMakerLevelId: string;
|
|
29
|
+
enrolledTierDisplay: string;
|
|
30
|
+
qualifyingPool: string;
|
|
31
|
+
qualifyingRows: string[];
|
|
32
|
+
daily: GlpDailyMetrics;
|
|
33
|
+
mtd: GlpMtdMetrics;
|
|
34
|
+
}
|
|
35
|
+
export interface GlpTodayPerformance {
|
|
36
|
+
dataReady: boolean;
|
|
37
|
+
dataDate: string;
|
|
38
|
+
account: {
|
|
39
|
+
masterAccountId: string;
|
|
40
|
+
combinedAccountIds: string[];
|
|
41
|
+
};
|
|
42
|
+
programs: GlpProgramPerformance[];
|
|
43
|
+
}
|
|
44
|
+
export interface GlpHistoricalPerformanceItem {
|
|
45
|
+
date: string;
|
|
46
|
+
volume: GlpVolumeBuckets;
|
|
47
|
+
share: GlpShareBuckets;
|
|
48
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"private-glp.js","sourceRoot":"","sources":["../../../../../src/types/rest/response/private-glp.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
export interface OkusdLimitBucket {
|
|
2
|
+
personalDailyLimit: string;
|
|
3
|
+
personalUsedAmt: string;
|
|
4
|
+
platformDailyLimit: string;
|
|
5
|
+
platformUsedAmt: string;
|
|
6
|
+
feeRate?: string;
|
|
7
|
+
}
|
|
8
|
+
export interface OkusdSubLimit extends OkusdLimitBucket {
|
|
9
|
+
maxSubAmt: string;
|
|
10
|
+
}
|
|
11
|
+
export interface OkusdLimits {
|
|
12
|
+
subLimit: OkusdSubLimit;
|
|
13
|
+
fastRedeemLimit: OkusdLimitBucket;
|
|
14
|
+
stdRedeemLimit: OkusdLimitBucket;
|
|
15
|
+
ts: string;
|
|
16
|
+
}
|
|
17
|
+
export interface OkusdSubscribeResult {
|
|
18
|
+
ordId: string;
|
|
19
|
+
clOrdId: string;
|
|
20
|
+
ccy: string;
|
|
21
|
+
amt: string;
|
|
22
|
+
okusdAmt: string;
|
|
23
|
+
state: string;
|
|
24
|
+
ts: string;
|
|
25
|
+
}
|
|
26
|
+
export interface OkusdRedeemResult {
|
|
27
|
+
ordId: string;
|
|
28
|
+
clOrdId: string;
|
|
29
|
+
ccy: string;
|
|
30
|
+
amt: string;
|
|
31
|
+
fee: string;
|
|
32
|
+
usdtAmt: string;
|
|
33
|
+
redeemType: string;
|
|
34
|
+
state: string;
|
|
35
|
+
estSettlementTime: string;
|
|
36
|
+
ts: string;
|
|
37
|
+
}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"private-okusd.js","sourceRoot":"","sources":["../../../../../src/types/rest/response/private-okusd.ts"],"names":[],"mappings":""}
|
|
@@ -266,6 +266,17 @@ export interface AlgoOrderDetailsResult {
|
|
|
266
266
|
chaseVal?: string;
|
|
267
267
|
maxChaseType?: string;
|
|
268
268
|
maxChaseVal?: string;
|
|
269
|
+
/** Sub-order type for trigger orders: fok, ioc, chase, or empty. */
|
|
270
|
+
advanceOrdType?: string;
|
|
271
|
+
/** Chase params when advanceOrdType is chase. */
|
|
272
|
+
advChaseParams?: {
|
|
273
|
+
chaseType?: string;
|
|
274
|
+
chaseVal?: string;
|
|
275
|
+
maxChaseType?: string;
|
|
276
|
+
maxChaseVal?: string;
|
|
277
|
+
}[];
|
|
278
|
+
/** algoId(s) of algo order(s) spawned when trigger fires (chase). Empty before trigger. */
|
|
279
|
+
subAlgoIdList?: string[];
|
|
269
280
|
}
|
|
270
281
|
export interface AlgoOrderListItem {
|
|
271
282
|
activePx: string;
|
|
@@ -320,6 +331,14 @@ export interface AlgoOrderListItem {
|
|
|
320
331
|
chaseVal?: string;
|
|
321
332
|
maxChaseType?: string;
|
|
322
333
|
maxChaseVal?: string;
|
|
334
|
+
advanceOrdType?: string;
|
|
335
|
+
advChaseParams?: {
|
|
336
|
+
chaseType?: string;
|
|
337
|
+
chaseVal?: string;
|
|
338
|
+
maxChaseType?: string;
|
|
339
|
+
maxChaseVal?: string;
|
|
340
|
+
}[];
|
|
341
|
+
subAlgoIdList?: string[];
|
|
323
342
|
}
|
|
324
343
|
export interface HistoricAlgoOrder {
|
|
325
344
|
activePx: string;
|
|
@@ -374,6 +393,14 @@ export interface HistoricAlgoOrder {
|
|
|
374
393
|
chaseVal?: string;
|
|
375
394
|
maxChaseType?: string;
|
|
376
395
|
maxChaseVal?: string;
|
|
396
|
+
advanceOrdType?: string;
|
|
397
|
+
advChaseParams?: {
|
|
398
|
+
chaseType?: string;
|
|
399
|
+
chaseVal?: string;
|
|
400
|
+
maxChaseType?: string;
|
|
401
|
+
maxChaseVal?: string;
|
|
402
|
+
}[];
|
|
403
|
+
subAlgoIdList?: string[];
|
|
377
404
|
}
|
|
378
405
|
export interface CancelAllAfterResponse {
|
|
379
406
|
triggerTime: string;
|
|
@@ -36,6 +36,14 @@ export interface OrderBook {
|
|
|
36
36
|
bids: OrderBookLevel[];
|
|
37
37
|
ts: string;
|
|
38
38
|
}
|
|
39
|
+
/** RPI consolidated book level: [price, totalQty, nonRpiQty, count] */
|
|
40
|
+
type OrderBookRpiLevel = [string, string, string, string];
|
|
41
|
+
export interface OrderBookRpi {
|
|
42
|
+
asks: OrderBookRpiLevel[];
|
|
43
|
+
bids: OrderBookRpiLevel[];
|
|
44
|
+
ts: string;
|
|
45
|
+
seqId: number;
|
|
46
|
+
}
|
|
39
47
|
type timestamp = string;
|
|
40
48
|
type openPrice = string;
|
|
41
49
|
type highPrice = string;
|
|
@@ -121,7 +129,7 @@ export interface Instrument {
|
|
|
121
129
|
maxTriggerSz: string;
|
|
122
130
|
maxStopSz: string;
|
|
123
131
|
/**
|
|
124
|
-
* e.g. `normal`, `pre_market
|
|
132
|
+
* e.g. `normal`, `pre_market` (incl. Pre-market X-Perp FUTURES), `rebase_contract`, `xperp` (after Pre-market X-Perp converts).
|
|
125
133
|
*/
|
|
126
134
|
ruleType: string;
|
|
127
135
|
auctionEndTime: string;
|
|
@@ -139,6 +147,10 @@ export interface Instrument {
|
|
|
139
147
|
shortPosRemainingQuota?: string;
|
|
140
148
|
maxPlatOILmt?: string;
|
|
141
149
|
groupId?: string;
|
|
150
|
+
/** Minimum spacing between RPI bid and RPI ask, in organic price levels. Default 4; 0 for Event Contracts. */
|
|
151
|
+
rpiMinLevel?: string;
|
|
152
|
+
/** Minimum distance from opposite-side organic best price for RPI spacing, in bps. */
|
|
153
|
+
rpiMinPxBand?: string;
|
|
142
154
|
upcChg?: InstrumentUpcomingParamChange[];
|
|
143
155
|
}
|
|
144
156
|
export interface EconomicCalendarData {
|
|
@@ -381,7 +393,17 @@ export interface EventContractMarket {
|
|
|
381
393
|
fixTime: string;
|
|
382
394
|
outcome: string;
|
|
383
395
|
floorStrike: string;
|
|
396
|
+
/** Max expiration value for YES on `between` method. "INF" = no upper bound. "" for non-between. */
|
|
397
|
+
capStrike?: string;
|
|
398
|
+
/** Hit direction when method is `hit`: up | dn | "". */
|
|
399
|
+
hitDir?: string;
|
|
384
400
|
settleValue: string;
|
|
385
401
|
disputed: boolean;
|
|
386
402
|
}
|
|
403
|
+
export interface MmInstrumentType {
|
|
404
|
+
instId: string;
|
|
405
|
+
instType: string;
|
|
406
|
+
/** A | B-Crypto | B-TradFi */
|
|
407
|
+
pairType: string;
|
|
408
|
+
}
|
|
387
409
|
export {};
|
|
@@ -12,7 +12,9 @@ export type GridAlgoSubOrderType = 'live' | 'filled';
|
|
|
12
12
|
export type InstrumentType = 'SPOT' | 'MARGIN' | 'SWAP' | 'FUTURES' | 'OPTION' | 'EVENTS';
|
|
13
13
|
export type MarginMode = 'cross' | 'isolated';
|
|
14
14
|
export type OrderSide = 'buy' | 'sell';
|
|
15
|
-
export type OrderType = 'market' | 'limit' | 'post_only' | 'fok' | 'ioc' | 'optimal_limit_ioc' | 'mmp' | 'mmp_and_post_only' | 'elp'
|
|
15
|
+
export type OrderType = 'market' | 'limit' | 'post_only' | 'fok' | 'ioc' | 'optimal_limit_ioc' | 'mmp' | 'mmp_and_post_only' | 'elp'
|
|
16
|
+
/** RPI maker (replaces `elp`; ELP alias accepted until 2026-10-31) */
|
|
17
|
+
| 'rpi';
|
|
16
18
|
export type OrderState = 'canceled' | 'live' | 'partially_filled' | 'filled' | 'mmp_canceled';
|
|
17
19
|
export type PositionSide = 'net' | 'long' | 'short';
|
|
18
20
|
export type PriceTriggerType = 'last' | 'index' | 'mark';
|
|
@@ -29,9 +29,16 @@ export interface WSAPIPlaceOrderRequestV5 {
|
|
|
29
29
|
banAmend?: boolean;
|
|
30
30
|
tradeQuoteCcy?: string;
|
|
31
31
|
stpMode?: 'cancel_maker' | 'cancel_taker' | 'cancel_both';
|
|
32
|
-
/**
|
|
32
|
+
/**
|
|
33
|
+
* RPI taker access for limit/market/fok/ioc. Default false.
|
|
34
|
+
* Alias `isElpTakerAccess` accepted until 2026-10-31.
|
|
35
|
+
*/
|
|
36
|
+
rpiTakerAccess?: boolean;
|
|
37
|
+
/** @deprecated Use `rpiTakerAccess`. Alias until 2026-10-31. */
|
|
33
38
|
isElpTakerAccess?: boolean;
|
|
34
|
-
/**
|
|
39
|
+
/** RPI maker spacing: auto-round price when true. Only for ordType rpi. */
|
|
40
|
+
rpiPxRound?: boolean;
|
|
41
|
+
/** EVENTS: `"1"` for non-`post_only` orders when required (error 54086 if missing). Ignored since 2026-07-24. */
|
|
35
42
|
speedBump?: string;
|
|
36
43
|
/** EVENTS: `yes` or `no`. */
|
|
37
44
|
outcome?: string;
|
|
@@ -53,7 +60,14 @@ export interface WSAPIAmendOrderRequestV5 {
|
|
|
53
60
|
newPx?: string;
|
|
54
61
|
newPxUsd?: string;
|
|
55
62
|
newPxVol?: string;
|
|
63
|
+
/** Ignored since 2026-07-24 (event-contract speed bump removed). */
|
|
56
64
|
speedBump?: string;
|
|
65
|
+
/** RPI taker access. Not inherited on amend - omit = false. */
|
|
66
|
+
rpiTakerAccess?: boolean;
|
|
67
|
+
/** @deprecated Use `rpiTakerAccess`. Alias until 2026-10-31. */
|
|
68
|
+
isElpTakerAccess?: boolean;
|
|
69
|
+
/** RPI maker spacing: auto-round price when true. Only for ordType rpi. */
|
|
70
|
+
rpiPxRound?: boolean;
|
|
57
71
|
attachAlgoOrds?: AmendAttachedTrailingStop[];
|
|
58
72
|
}
|
|
59
73
|
export interface WSAPIMassCancelOrdersRequestV5 {
|
|
@@ -27,7 +27,7 @@ export interface WSClientConfigurableOptions {
|
|
|
27
27
|
wsOptions?: {
|
|
28
28
|
protocols?: string[];
|
|
29
29
|
agent?: any;
|
|
30
|
-
} & Partial<WebSocket.ClientOptions | ClientRequestArgs
|
|
30
|
+
} & (Omit<Partial<WebSocket.ClientOptions>, 'agent'> | Omit<Partial<ClientRequestArgs>, 'agent'>);
|
|
31
31
|
wsUrl?: string;
|
|
32
32
|
/**
|
|
33
33
|
* Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method
|
|
@@ -10,7 +10,11 @@ export type WsPrivateChannel = 'account' | 'positions' | 'balance_and_position'
|
|
|
10
10
|
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';
|
|
11
11
|
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';
|
|
12
12
|
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';
|
|
13
|
-
export type WsPublicOrderBooksChannel = 'books' | 'books5' | 'bbo-tbt' | 'books-l2-tbt' | 'books50-l2-tpt'
|
|
13
|
+
export type WsPublicOrderBooksChannel = 'books' | 'books5' | 'bbo-tbt' | 'books-l2-tbt' | 'books50-l2-tpt'
|
|
14
|
+
/** @deprecated Use `books-rpi`. ELP-only book; retired after 2026-10-31. */
|
|
15
|
+
| 'books-elp'
|
|
16
|
+
/** Consolidated organic + RPI depth (replaces books-elp). */
|
|
17
|
+
| 'books-rpi';
|
|
14
18
|
export type WsPublicChannel = 'instruments' | 'tickers' | 'open-interest' | WsPublicKlineChannel | WsPublicMarkPriceKlineChannel | WsPublicIndexKlineChannel | 'trades' | 'estimated-price' | 'mark-price' | 'price-limit' | WsPublicOrderBooksChannel | 'opt-summary' | 'funding-rate' | 'index-tickers' | 'status' | 'liquidation-orders' | 'event-contract-markets';
|
|
15
19
|
export type WsBusinessPrivateChannel = 'orders-algo' | 'algo-advance' | 'deposit-info' | 'withdrawal-info' | 'grid-orders-spot' | 'grid-orders-contract' | 'grid-orders-moon' | 'grid-positions' | 'grid-sub-orders' | 'algo-recurring-buy';
|
|
16
20
|
export type WsBusinessPublicChannel = WsPublicKlineChannel | WsPublicMarkPriceKlineChannel | WsPublicIndexKlineChannel;
|
package/dist/mjs/index.d.ts
CHANGED
|
@@ -9,7 +9,9 @@ export * from './types/rest/request/convert.js';
|
|
|
9
9
|
export * from './types/rest/request/copy-trading.js';
|
|
10
10
|
export * from './types/rest/request/dual-investment.js';
|
|
11
11
|
export * from './types/rest/request/funding.js';
|
|
12
|
+
export * from './types/rest/request/glp.js';
|
|
12
13
|
export * from './types/rest/request/grid-trading.js';
|
|
14
|
+
export * from './types/rest/request/okusd.js';
|
|
13
15
|
export * from './types/rest/request/public.js';
|
|
14
16
|
export * from './types/rest/request/recurring-buy.js';
|
|
15
17
|
export * from './types/rest/request/shared.js';
|
|
@@ -26,6 +28,8 @@ export * from './types/rest/response/private-copy-trading.js';
|
|
|
26
28
|
export * from './types/rest/response/private-dual-investment.js';
|
|
27
29
|
export * from './types/rest/response/private-flexible-loan.js';
|
|
28
30
|
export * from './types/rest/response/private-funding.js';
|
|
31
|
+
export * from './types/rest/response/private-glp.js';
|
|
32
|
+
export * from './types/rest/response/private-okusd.js';
|
|
29
33
|
export * from './types/rest/response/private-recurring-buy.js';
|
|
30
34
|
export * from './types/rest/response/private-signal-bot.js';
|
|
31
35
|
export * from './types/rest/response/private-spread-trading.js';
|
package/dist/mjs/index.js
CHANGED
|
@@ -11,7 +11,9 @@ export * from './types/rest/request/convert.js';
|
|
|
11
11
|
export * from './types/rest/request/copy-trading.js';
|
|
12
12
|
export * from './types/rest/request/dual-investment.js';
|
|
13
13
|
export * from './types/rest/request/funding.js';
|
|
14
|
+
export * from './types/rest/request/glp.js';
|
|
14
15
|
export * from './types/rest/request/grid-trading.js';
|
|
16
|
+
export * from './types/rest/request/okusd.js';
|
|
15
17
|
export * from './types/rest/request/public.js';
|
|
16
18
|
export * from './types/rest/request/recurring-buy.js';
|
|
17
19
|
export * from './types/rest/request/shared.js';
|
|
@@ -29,6 +31,8 @@ export * from './types/rest/response/private-copy-trading.js';
|
|
|
29
31
|
export * from './types/rest/response/private-dual-investment.js';
|
|
30
32
|
export * from './types/rest/response/private-flexible-loan.js';
|
|
31
33
|
export * from './types/rest/response/private-funding.js';
|
|
34
|
+
export * from './types/rest/response/private-glp.js';
|
|
35
|
+
export * from './types/rest/response/private-okusd.js';
|
|
32
36
|
export * from './types/rest/response/private-recurring-buy.js';
|
|
33
37
|
export * from './types/rest/response/private-signal-bot.js';
|
|
34
38
|
export * from './types/rest/response/private-spread-trading.js';
|
package/dist/mjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,uBAAuB;AACvB,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,eAAe;AACf,cAAc,iCAAiC,CAAC;AAChD,cAAc,mCAAmC,CAAC;AAClD,cAAc,uCAAuC,CAAC;AACtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,yCAAyC,CAAC;AACxD,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uCAAuC,CAAC;AACtD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wCAAwC,CAAC;AACvD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,+BAA+B,CAAC;AAC9C,gBAAgB;AAChB,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,kDAAkD,CAAC;AACjE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,0CAA0C,CAAC;AACzD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAChE,cAAc,iDAAiD,CAAC;AAChE,cAAc,6CAA6C,CAAC;AAC5D,cAAc,wCAAwC,CAAC;AACvD,cAAc,sCAAsC,CAAC;AACrD,EAAE;AACF,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,uBAAuB;AACvB,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,eAAe;AACf,cAAc,iCAAiC,CAAC;AAChD,cAAc,mCAAmC,CAAC;AAClD,cAAc,uCAAuC,CAAC;AACtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,yCAAyC,CAAC;AACxD,cAAc,iCAAiC,CAAC;AAChD,cAAc,6BAA6B,CAAC;AAC5C,cAAc,sCAAsC,CAAC;AACrD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,gCAAgC,CAAC;AAC/C,cAAc,uCAAuC,CAAC;AACtD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,oCAAoC,CAAC;AACnD,cAAc,qCAAqC,CAAC;AACpD,cAAc,wCAAwC,CAAC;AACvD,cAAc,wCAAwC,CAAC;AACvD,cAAc,oCAAoC,CAAC;AACnD,cAAc,+BAA+B,CAAC;AAC9C,gBAAgB;AAChB,cAAc,0CAA0C,CAAC;AACzD,cAAc,4CAA4C,CAAC;AAC3D,cAAc,gDAAgD,CAAC;AAC/D,cAAc,+CAA+C,CAAC;AAC9D,cAAc,kDAAkD,CAAC;AACjE,cAAc,gDAAgD,CAAC;AAC/D,cAAc,0CAA0C,CAAC;AACzD,cAAc,sCAAsC,CAAC;AACrD,cAAc,wCAAwC,CAAC;AACvD,cAAc,gDAAgD,CAAC;AAC/D,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAChE,cAAc,iDAAiD,CAAC;AAChE,cAAc,6CAA6C,CAAC;AAC5D,cAAc,wCAAwC,CAAC;AACvD,cAAc,sCAAsC,CAAC;AACrD,EAAE;AACF,cAAc,mBAAmB,CAAC;AAClC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,sCAAsC,CAAC;AACrD,cAAc,uCAAuC,CAAC;AACtD,cAAc,iCAAiC,CAAC;AAChD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kCAAkC,CAAC;AACjD,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,0BAA0B,CAAC;AACzC,cAAc,mBAAmB,CAAC;AAClC,cAAc,2BAA2B,CAAC;AAC1C,cAAc,uBAAuB,CAAC;AACtC,cAAc,8BAA8B,CAAC"}
|
|
@@ -6,7 +6,9 @@ import { ConvertQuoteEstimateRequest, ConvertTradeRequest } from './types/rest/r
|
|
|
6
6
|
import { CloseSubpositionRequest, CopySettingsRequest, GetCopyTradersRequest, GetCTBatchLeverageInfoRequest, GetCTHistoryLeadTradersRequest, GetCTProfitDetailsRequest, GetCurrentSubpositionsRequest, GetLeadTraderPositionsRequest, GetLeadTraderRanksRequest, GetLeadTraderStatsRequest, GetPrivateLeadTraderRanksRequest, GetSubpositionsHistoryRequest, PlaceCTAlgoOrderRequest, SetCTBatchLeverageRequest } from './types/rest/request/copy-trading.js';
|
|
7
7
|
import { GetDcdOrderHistoryRequest, GetDcdOrderStatusRequest, GetDcdProductsRequest, RequestDcdQuoteRequest, RequestDcdRedeemQuoteRequest, SubmitDcdRedeemRequest, SubmitDcdTradeRequest } from './types/rest/request/dual-investment.js';
|
|
8
8
|
import { FundingRateRequest, FundsTransferRequest, GetDepositHistoryRequest, GetDepositWithdrawStatusRequest, GetFundingRateRequest, WithdrawRequest } from './types/rest/request/funding.js';
|
|
9
|
+
import { GetGlpHistoricalPerformanceRequest } from './types/rest/request/glp.js';
|
|
9
10
|
import { CloseContractGridPositionRequest, GetGridAlgoOrdersRequest, GetRSIBackTestingRequest, GridAlgoOrderRequest, GridAlgoOrderType, MaxGridQuantityRequest, StopGridAlgoOrderRequest } from './types/rest/request/grid-trading.js';
|
|
11
|
+
import { RedeemOkusdRequest, SubscribeOkusdRequest } from './types/rest/request/okusd.js';
|
|
10
12
|
import { CandleRequest, EconomicCalendarRequest, GetContractOpenInterestHistoryRequest, GetContractTakerVolumeRequest, GetEventContractEventsRequest, GetEventContractMarketsRequest, GetEventContractSeriesRequest, GetHistoricalMarketDataRequest, GetInsuranceFundRequest, GetOptionTradesRequest, GetPremiumHistoryRequest, GetTopTradersContractLongShortRatioRequest, UnitConvertRequest } from './types/rest/request/public.js';
|
|
11
13
|
import { AmendRecurringBuyOrderRequest, GetRecurringBuyOrderListRequest, PlaceRecurringBuyOrderRequest } from './types/rest/request/recurring-buy.js';
|
|
12
14
|
import { PaginatedSymbolRequest } from './types/rest/request/shared.js';
|
|
@@ -23,13 +25,15 @@ import { CurrentSubposition, GetAccountConfigurationResult, GetCopySettingsResul
|
|
|
23
25
|
import { DcdCurrencyPair, DcdOrderHistoryItem, DcdOrderStatus, DcdProduct, DcdQuote, DcdRedeemQuote, DcdRedeemResult, DcdTradeResult } from './types/rest/response/private-dual-investment.js';
|
|
24
26
|
import { AccruedInterestItem, AccruedInterestRequest, AdjustCollateralRequest, CollateralAssetsResponse, GetFlexibleLoanCollateralAssetsRequest, GetLoanInfoRequest, LoanHistoryItem, LoanHistoryRequest, LoanInfo, MaxLoanRequest, MaxLoanResponse } from './types/rest/response/private-flexible-loan.js';
|
|
25
27
|
import { AccountAssetValuation, AssetBillDetails, DepositHistory, FundingBalance, FundingCurrency, FundTransferResult, FundTransferState, NonTradableAsset, WithdrawResponse } from './types/rest/response/private-funding.js';
|
|
28
|
+
import { GlpHistoricalPerformanceItem, GlpTodayPerformance } from './types/rest/response/private-glp.js';
|
|
29
|
+
import { OkusdLimits, OkusdRedeemResult, OkusdSubscribeResult } from './types/rest/response/private-okusd.js';
|
|
26
30
|
import { RecurringBuyOrder, RecurringBuyOrderResult, RecurringBuySubOrder } from './types/rest/response/private-recurring-buy.js';
|
|
27
31
|
import { CancelSignalBotsResult, CreateSignalBotResult, CreateSignalResult, GetSignalsResult } from './types/rest/response/private-signal-bot.js';
|
|
28
32
|
import { CancelSpreadOrderResponse, PlaceSpreadOrderResponse, PublicSpreadTrade, SpreadCandle, SpreadDetails, SpreadOrder, SpreadOrderBook, SpreadTicker, SpreadTrade, UpdateSpreadOrderResponse } from './types/rest/response/private-spread-trading.js';
|
|
29
33
|
import { StableRewardsApyHistoryItem, StableRewardsBalance, StableRewardsProductInfo, StableRewardsQuote, StableRewardsSubscribeRedeemHistoryItem, StableRewardsTradeResult } from './types/rest/response/private-stable-rewards.js';
|
|
30
34
|
import { ManagedSubAccountTransfer, SubAccount, SubAccountAPIReset, SubAccountBalances, SubAccountMaxWithdrawal, SubAccountTransferResult } from './types/rest/response/private-subaccount.js';
|
|
31
35
|
import { AlgoOrderDetailsResult, AlgoOrderListItem, AlgoOrderResult, AmendAlgoOrderResult, AmendedOrder, CancelAllAfterResponse, CancelledOrderResult, ClosedPositions, HistoricAlgoOrder, HistoricOrder, OrderDetails, OrderFill, OrderListItem, OrderResult } from './types/rest/response/private-trade.js';
|
|
32
|
-
import { Announcement, Candle, CandleNoVolume, EconomicCalendarData, EstimatedDeliveryExercisePrice, EthStakingProductInfo, EventContractEvent, EventContractMarket, EventContractSeries, FundingRateHistory, IndexTicker, Instrument, InsuranceFund, InterestRateAndLoanQuota, MarketDataHistoryResult, OptionTrade, OptionTrades, OrderBook, PublicBorrowHistoryRecord, PublicFundingRate, SolStakingProductInfo, SystemTime, Ticker, Trade, UnitConvertData } from './types/rest/response/public-data.js';
|
|
36
|
+
import { Announcement, Candle, CandleNoVolume, EconomicCalendarData, EstimatedDeliveryExercisePrice, EthStakingProductInfo, EventContractEvent, EventContractMarket, EventContractSeries, FundingRateHistory, IndexTicker, Instrument, InsuranceFund, InterestRateAndLoanQuota, MarketDataHistoryResult, MmInstrumentType, OptionTrade, OptionTrades, OrderBook, OrderBookRpi, PublicBorrowHistoryRecord, PublicFundingRate, SolStakingProductInfo, SystemTime, Ticker, Trade, UnitConvertData } from './types/rest/response/public-data.js';
|
|
33
37
|
import { AccountLevel, APIResponse, ContractGridDirection, GridAlgoSubOrderType, InstrumentType, MarginMode, numberInString, Pagination, PositionSide, PosMode, TimestampObject } from './types/rest/shared.js';
|
|
34
38
|
import BaseRestClient from './util/BaseRestClient.js';
|
|
35
39
|
export declare class RestClient extends BaseRestClient {
|
|
@@ -679,6 +683,10 @@ export declare class RestClient extends BaseRestClient {
|
|
|
679
683
|
instId: string;
|
|
680
684
|
sz?: numberInString;
|
|
681
685
|
}): Promise<OrderBook[]>;
|
|
686
|
+
getRpiOrderBook(params: {
|
|
687
|
+
instId: string;
|
|
688
|
+
sz?: numberInString;
|
|
689
|
+
}): Promise<OrderBookRpi[]>;
|
|
682
690
|
getFullOrderBook(params: {
|
|
683
691
|
instId: string;
|
|
684
692
|
sz?: string;
|
|
@@ -831,6 +839,10 @@ export declare class RestClient extends BaseRestClient {
|
|
|
831
839
|
getVIPInterestRateAndLoanQuota(params: any): Promise<any[]>;
|
|
832
840
|
getUnderlying(params: any): Promise<any[]>;
|
|
833
841
|
getInsuranceFund(params?: GetInsuranceFundRequest): Promise<InsuranceFund[]>;
|
|
842
|
+
getMmInstrumentTypes(params?: {
|
|
843
|
+
instType?: 'SPOT' | 'SWAP';
|
|
844
|
+
instId?: string;
|
|
845
|
+
}): Promise<MmInstrumentType[]>;
|
|
834
846
|
getUnitConvert(params: UnitConvertRequest): Promise<UnitConvertData[]>;
|
|
835
847
|
getOptionTickBands(params: {
|
|
836
848
|
instType: string;
|
|
@@ -1205,11 +1217,29 @@ export declare class RestClient extends BaseRestClient {
|
|
|
1205
1217
|
*
|
|
1206
1218
|
*/
|
|
1207
1219
|
getStableRewardsProductInfo(params: GetStableRewardsProductInfoRequest): Promise<StableRewardsProductInfo[]>;
|
|
1220
|
+
/** @deprecated Decommissioned 2026-07-14. Use order book trading APIs. */
|
|
1208
1221
|
requestStableRewardsQuote(params: RequestStableRewardsQuoteRequest): Promise<StableRewardsQuote[]>;
|
|
1222
|
+
/** @deprecated Decommissioned 2026-07-14. Use order book trading APIs. */
|
|
1209
1223
|
submitStableRewardsTrade(params: SubmitStableRewardsTradeRequest): Promise<StableRewardsTradeResult[]>;
|
|
1210
1224
|
getStableRewardsBalance(params?: GetStableRewardsBalanceRequest): Promise<StableRewardsBalance[]>;
|
|
1211
1225
|
getStableRewardsApyHistory(params: GetStableRewardsApyHistoryRequest): Promise<StableRewardsApyHistoryItem[]>;
|
|
1226
|
+
/** @deprecated Decommissioned 2026-07-14. Use order book trading APIs. */
|
|
1212
1227
|
getStableRewardsSubscribeRedeemHistory(params: GetStableRewardsSubscribeRedeemHistoryRequest): Promise<StableRewardsSubscribeRedeemHistoryItem[]>;
|
|
1228
|
+
/**
|
|
1229
|
+
*
|
|
1230
|
+
* Financial product — OKUSD endpoints
|
|
1231
|
+
*
|
|
1232
|
+
*/
|
|
1233
|
+
getOkusdLimits(): Promise<OkusdLimits[]>;
|
|
1234
|
+
subscribeOkusd(params: SubscribeOkusdRequest): Promise<OkusdSubscribeResult[]>;
|
|
1235
|
+
redeemOkusd(params: RedeemOkusdRequest): Promise<OkusdRedeemResult[]>;
|
|
1236
|
+
/**
|
|
1237
|
+
*
|
|
1238
|
+
* GLP performance endpoints (market makers)
|
|
1239
|
+
*
|
|
1240
|
+
*/
|
|
1241
|
+
getGlpTodayPerformance(): Promise<GlpTodayPerformance[]>;
|
|
1242
|
+
getGlpHistoricalPerformance(params: GetGlpHistoricalPerformanceRequest): Promise<GlpHistoricalPerformanceItem[]>;
|
|
1213
1243
|
/**
|
|
1214
1244
|
*
|
|
1215
1245
|
* Affiliate endpoints
|
package/dist/mjs/rest-client.js
CHANGED
|
@@ -720,6 +720,9 @@ export class RestClient extends BaseRestClient {
|
|
|
720
720
|
getOrderBook(params) {
|
|
721
721
|
return this.get('/api/v5/market/books', params);
|
|
722
722
|
}
|
|
723
|
+
getRpiOrderBook(params) {
|
|
724
|
+
return this.get('/api/v5/market/books-rpi', params);
|
|
725
|
+
}
|
|
723
726
|
getFullOrderBook(params) {
|
|
724
727
|
return this.get('/api/v5/market/books-full', params);
|
|
725
728
|
}
|
|
@@ -952,6 +955,9 @@ export class RestClient extends BaseRestClient {
|
|
|
952
955
|
getInsuranceFund(params) {
|
|
953
956
|
return this.get('/api/v5/public/insurance-fund', params);
|
|
954
957
|
}
|
|
958
|
+
getMmInstrumentTypes(params) {
|
|
959
|
+
return this.get('/api/v5/public/mm-instrument-types', params);
|
|
960
|
+
}
|
|
955
961
|
getUnitConvert(params) {
|
|
956
962
|
return this.get('/api/v5/public/convert-contract-coin', params);
|
|
957
963
|
}
|
|
@@ -1344,9 +1350,11 @@ export class RestClient extends BaseRestClient {
|
|
|
1344
1350
|
getStableRewardsProductInfo(params) {
|
|
1345
1351
|
return this.getPrivate('/api/v5/finance/stable-rewards/product-info', params);
|
|
1346
1352
|
}
|
|
1353
|
+
/** @deprecated Decommissioned 2026-07-14. Use order book trading APIs. */
|
|
1347
1354
|
requestStableRewardsQuote(params) {
|
|
1348
1355
|
return this.postPrivate('/api/v5/finance/stable-rewards/quote', params);
|
|
1349
1356
|
}
|
|
1357
|
+
/** @deprecated Decommissioned 2026-07-14. Use order book trading APIs. */
|
|
1350
1358
|
submitStableRewardsTrade(params) {
|
|
1351
1359
|
return this.postPrivate('/api/v5/finance/stable-rewards/trade', params);
|
|
1352
1360
|
}
|
|
@@ -1356,9 +1364,35 @@ export class RestClient extends BaseRestClient {
|
|
|
1356
1364
|
getStableRewardsApyHistory(params) {
|
|
1357
1365
|
return this.get('/api/v5/finance/stable-rewards/apy-history', params);
|
|
1358
1366
|
}
|
|
1367
|
+
/** @deprecated Decommissioned 2026-07-14. Use order book trading APIs. */
|
|
1359
1368
|
getStableRewardsSubscribeRedeemHistory(params) {
|
|
1360
1369
|
return this.getPrivate('/api/v5/finance/stable-rewards/subscribe-redeem-history', params);
|
|
1361
1370
|
}
|
|
1371
|
+
/**
|
|
1372
|
+
*
|
|
1373
|
+
* Financial product — OKUSD endpoints
|
|
1374
|
+
*
|
|
1375
|
+
*/
|
|
1376
|
+
getOkusdLimits() {
|
|
1377
|
+
return this.getPrivate('/api/v5/finance/okusd/limits');
|
|
1378
|
+
}
|
|
1379
|
+
subscribeOkusd(params) {
|
|
1380
|
+
return this.postPrivate('/api/v5/finance/okusd/subscribe', params);
|
|
1381
|
+
}
|
|
1382
|
+
redeemOkusd(params) {
|
|
1383
|
+
return this.postPrivate('/api/v5/finance/okusd/redeem', params);
|
|
1384
|
+
}
|
|
1385
|
+
/**
|
|
1386
|
+
*
|
|
1387
|
+
* GLP performance endpoints (market makers)
|
|
1388
|
+
*
|
|
1389
|
+
*/
|
|
1390
|
+
getGlpTodayPerformance() {
|
|
1391
|
+
return this.getPrivate('/api/v5/users/glp/today-performance');
|
|
1392
|
+
}
|
|
1393
|
+
getGlpHistoricalPerformance(params) {
|
|
1394
|
+
return this.getPrivate('/api/v5/users/glp/historical-performance', params);
|
|
1395
|
+
}
|
|
1362
1396
|
/**
|
|
1363
1397
|
*
|
|
1364
1398
|
* Affiliate endpoints
|