@0xmonaco/types 1.0.25 → 1.0.26-develop.aeb6d5b
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/dist/faucet/index.d.ts +55 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.js +1 -0
- package/dist/margin-accounts/index.d.ts +4 -2
- package/dist/market/index.d.ts +42 -3
- package/dist/portfolio/index.d.ts +7 -0
- package/dist/positions/index.d.ts +25 -0
- package/dist/profile/index.d.ts +38 -1
- package/dist/pulse/index.d.ts +61 -0
- package/dist/pulse/index.js +9 -0
- package/dist/sdk/index.d.ts +11 -0
- package/dist/trading/index.d.ts +3 -1
- package/dist/trading/orders.d.ts +4 -0
- package/dist/trading/responses.d.ts +32 -2
- package/dist/validation/margin-accounts.d.ts +12 -12
- package/dist/validation/margin-accounts.js +26 -4
- package/dist/validation/positions.d.ts +3 -0
- package/dist/validation/positions.js +14 -0
- package/dist/validation/profile.d.ts +3 -2
- package/dist/validation/profile.js +1 -0
- package/dist/validation/trading.d.ts +1 -0
- package/dist/validation/trading.js +26 -28
- package/dist/websocket/events/orders-events.d.ts +3 -1
- package/dist/wire/operations.d.ts +1 -1
- package/dist/wire/operations.js +3 -0
- package/dist/wire/schema.d.ts +603 -21
- package/package.json +2 -2
package/dist/wire/schema.d.ts
CHANGED
|
@@ -734,6 +734,32 @@ export interface paths {
|
|
|
734
734
|
patch?: never;
|
|
735
735
|
trace?: never;
|
|
736
736
|
};
|
|
737
|
+
"/api/v1/faucet/info": {
|
|
738
|
+
parameters: {
|
|
739
|
+
query?: never;
|
|
740
|
+
header?: never;
|
|
741
|
+
path?: never;
|
|
742
|
+
cookie?: never;
|
|
743
|
+
};
|
|
744
|
+
/**
|
|
745
|
+
* Get faucet quota and recent requests
|
|
746
|
+
* @description Get faucet quota and recent requests.
|
|
747
|
+
*
|
|
748
|
+
* Returns the authenticated wallet's remaining faucet requests in the
|
|
749
|
+
* rolling 24h window, when the next request becomes available, and the
|
|
750
|
+
* 5 most recent faucet requests. Quota is wallet-scoped: it aggregates
|
|
751
|
+
* across all user rows sharing the wallet address, matching mint
|
|
752
|
+
* enforcement.
|
|
753
|
+
*/
|
|
754
|
+
get: operations["get_faucet_info"];
|
|
755
|
+
put?: never;
|
|
756
|
+
post?: never;
|
|
757
|
+
delete?: never;
|
|
758
|
+
options?: never;
|
|
759
|
+
head?: never;
|
|
760
|
+
patch?: never;
|
|
761
|
+
trace?: never;
|
|
762
|
+
};
|
|
737
763
|
"/api/v1/faucet/mint": {
|
|
738
764
|
parameters: {
|
|
739
765
|
query?: never;
|
|
@@ -1026,6 +1052,26 @@ export interface paths {
|
|
|
1026
1052
|
patch?: never;
|
|
1027
1053
|
trace?: never;
|
|
1028
1054
|
};
|
|
1055
|
+
"/api/v1/market/funding/history": {
|
|
1056
|
+
parameters: {
|
|
1057
|
+
query?: never;
|
|
1058
|
+
header?: never;
|
|
1059
|
+
path?: never;
|
|
1060
|
+
cookie?: never;
|
|
1061
|
+
};
|
|
1062
|
+
/**
|
|
1063
|
+
* @description Historical funding settlements across all perp markets in one call, so
|
|
1064
|
+
* clients don't have to fan out one request per trading pair.
|
|
1065
|
+
*/
|
|
1066
|
+
get: operations["list_all_funding_history"];
|
|
1067
|
+
put?: never;
|
|
1068
|
+
post?: never;
|
|
1069
|
+
delete?: never;
|
|
1070
|
+
options?: never;
|
|
1071
|
+
head?: never;
|
|
1072
|
+
patch?: never;
|
|
1073
|
+
trace?: never;
|
|
1074
|
+
};
|
|
1029
1075
|
"/api/v1/market/pairs": {
|
|
1030
1076
|
parameters: {
|
|
1031
1077
|
query?: never;
|
|
@@ -1828,6 +1874,33 @@ export interface paths {
|
|
|
1828
1874
|
patch?: never;
|
|
1829
1875
|
trace?: never;
|
|
1830
1876
|
};
|
|
1877
|
+
"/api/v1/pulse": {
|
|
1878
|
+
parameters: {
|
|
1879
|
+
query?: never;
|
|
1880
|
+
header?: never;
|
|
1881
|
+
path?: never;
|
|
1882
|
+
cookie?: never;
|
|
1883
|
+
};
|
|
1884
|
+
/**
|
|
1885
|
+
* Get the market pulse news feed
|
|
1886
|
+
* @description Get the market pulse news feed.
|
|
1887
|
+
*
|
|
1888
|
+
* Returns the latest cached snapshot of AI-synthesized, per-asset news
|
|
1889
|
+
* headlines with sentiment tags, refreshed hourly from the upstream
|
|
1890
|
+
* pipeline by a background poller. The request path never calls the
|
|
1891
|
+
* upstream. Public endpoint — no authentication required. Responses carry
|
|
1892
|
+
* an ETag (the snapshot's generatedAt); clients may send If-None-Match to
|
|
1893
|
+
* receive 304 when unchanged.
|
|
1894
|
+
*/
|
|
1895
|
+
get: operations["get_pulse"];
|
|
1896
|
+
put?: never;
|
|
1897
|
+
post?: never;
|
|
1898
|
+
delete?: never;
|
|
1899
|
+
options?: never;
|
|
1900
|
+
head?: never;
|
|
1901
|
+
patch?: never;
|
|
1902
|
+
trace?: never;
|
|
1903
|
+
};
|
|
1831
1904
|
"/api/v1/trades/by-id/{tradeId}": {
|
|
1832
1905
|
parameters: {
|
|
1833
1906
|
query?: never;
|
|
@@ -2280,8 +2353,13 @@ export interface components {
|
|
|
2280
2353
|
updatedAt?: string | null;
|
|
2281
2354
|
};
|
|
2282
2355
|
AttachPositionTpSlRequest: {
|
|
2283
|
-
|
|
2356
|
+
/**
|
|
2357
|
+
* @description One-cancels-the-other. Defaults to false. When true, both take_profit and
|
|
2358
|
+
* stop_loss are required and the sibling is cancelled after either triggers.
|
|
2359
|
+
*/
|
|
2360
|
+
oco?: boolean | null;
|
|
2284
2361
|
takeProfit?: components["schemas"]["TpSlLeg"];
|
|
2362
|
+
stopLoss?: components["schemas"]["TpSlLeg"];
|
|
2285
2363
|
};
|
|
2286
2364
|
AttachPositionTpSlResponse: {
|
|
2287
2365
|
positionId?: string | null;
|
|
@@ -2477,7 +2555,7 @@ export interface components {
|
|
|
2477
2555
|
*/
|
|
2478
2556
|
expirationDate?: string | null;
|
|
2479
2557
|
/**
|
|
2480
|
-
* @description Time in force: GTC, IOC, or FOK
|
|
2558
|
+
* @description Time in force: GTC, IOC, or FOK. LIMIT orders only; rejected on MARKET orders.
|
|
2481
2559
|
* @example GTC
|
|
2482
2560
|
*/
|
|
2483
2561
|
timeInForce?: string | null;
|
|
@@ -2499,13 +2577,14 @@ export interface components {
|
|
|
2499
2577
|
*/
|
|
2500
2578
|
riskBucketCollateral?: string | null;
|
|
2501
2579
|
/**
|
|
2502
|
-
* @
|
|
2580
|
+
* @deprecated
|
|
2581
|
+
* @description DEPRECATED compatibility field. Order side is authoritative. When supplied, BUY requires LONG and SELL requires SHORT; NONE is rejected.
|
|
2503
2582
|
* @example LONG
|
|
2504
2583
|
* @enum {string|null}
|
|
2505
2584
|
*/
|
|
2506
|
-
positionSide?: "LONG" | "SHORT" |
|
|
2585
|
+
positionSide?: "LONG" | "SHORT" | null;
|
|
2507
2586
|
/**
|
|
2508
|
-
* @description Leverage multiplier as decimal string for margin orders
|
|
2587
|
+
* @description Leverage multiplier as a decimal string. Required for normal margin orders; optional and ignored for reduce-only orders.
|
|
2509
2588
|
* @example 5
|
|
2510
2589
|
*/
|
|
2511
2590
|
leverage?: string | null;
|
|
@@ -2925,7 +3004,7 @@ export interface components {
|
|
|
2925
3004
|
*/
|
|
2926
3005
|
expirationDate?: string | null;
|
|
2927
3006
|
/**
|
|
2928
|
-
* @description Time in force: GTC, IOC, or FOK
|
|
3007
|
+
* @description Time in force: GTC, IOC, or FOK. LIMIT orders only; rejected on MARKET orders.
|
|
2929
3008
|
* @example GTC
|
|
2930
3009
|
*/
|
|
2931
3010
|
timeInForce?: string | null;
|
|
@@ -2947,13 +3026,14 @@ export interface components {
|
|
|
2947
3026
|
*/
|
|
2948
3027
|
riskBucketCollateral?: string | null;
|
|
2949
3028
|
/**
|
|
2950
|
-
* @
|
|
3029
|
+
* @deprecated
|
|
3030
|
+
* @description DEPRECATED compatibility field. Order side is authoritative. When supplied, BUY requires LONG and SELL requires SHORT; NONE is rejected.
|
|
2951
3031
|
* @example LONG
|
|
2952
3032
|
* @enum {string|null}
|
|
2953
3033
|
*/
|
|
2954
|
-
positionSide?: "LONG" | "SHORT" |
|
|
3034
|
+
positionSide?: "LONG" | "SHORT" | null;
|
|
2955
3035
|
/**
|
|
2956
|
-
* @description Leverage multiplier as decimal string for margin orders
|
|
3036
|
+
* @description Leverage multiplier as a decimal string. Required for normal margin orders; optional and ignored for reduce-only orders.
|
|
2957
3037
|
* @example 5
|
|
2958
3038
|
*/
|
|
2959
3039
|
leverage?: string | null;
|
|
@@ -3123,6 +3203,36 @@ export interface components {
|
|
|
3123
3203
|
*/
|
|
3124
3204
|
error?: string | null;
|
|
3125
3205
|
};
|
|
3206
|
+
/** @description One token minted by a past faucet request. */
|
|
3207
|
+
FaucetMintRecord: {
|
|
3208
|
+
/**
|
|
3209
|
+
* Format: uuid
|
|
3210
|
+
* @description Asset UUID
|
|
3211
|
+
*/
|
|
3212
|
+
assetId?: string | null;
|
|
3213
|
+
/**
|
|
3214
|
+
* @description Token symbol
|
|
3215
|
+
* @example USDC
|
|
3216
|
+
*/
|
|
3217
|
+
symbol?: string | null;
|
|
3218
|
+
/**
|
|
3219
|
+
* @description Amount minted in token units
|
|
3220
|
+
* @example 1000
|
|
3221
|
+
*/
|
|
3222
|
+
amount?: string | null;
|
|
3223
|
+
/** @description On-chain transaction hash; absent when the transaction was submitted but never confirmed */
|
|
3224
|
+
txHash?: string | null;
|
|
3225
|
+
};
|
|
3226
|
+
/**
|
|
3227
|
+
* @description Past faucet mints grouped by clock minute for display. A group can span
|
|
3228
|
+
* several endpoint calls made in the same minute; the daily quota counts
|
|
3229
|
+
* each call individually.
|
|
3230
|
+
*/
|
|
3231
|
+
FaucetRequestRecord: {
|
|
3232
|
+
/** @description Timestamp (ISO 8601) of the request, truncated to the minute (display grouping; the daily quota counts every call) */
|
|
3233
|
+
requestedAt?: string | null;
|
|
3234
|
+
minted?: components["schemas"]["FaucetMintRecord"][] | null;
|
|
3235
|
+
};
|
|
3126
3236
|
FeeTierScheduleRow: {
|
|
3127
3237
|
/**
|
|
3128
3238
|
* Format: int32
|
|
@@ -3207,19 +3317,48 @@ export interface components {
|
|
|
3207
3317
|
*/
|
|
3208
3318
|
createdAt?: string | null;
|
|
3209
3319
|
};
|
|
3320
|
+
/**
|
|
3321
|
+
* @description One settled funding window. Windows are fixed and epoch-aligned (hourly);
|
|
3322
|
+
* a boundary the engine was down for is skipped, never settled retroactively,
|
|
3323
|
+
* so consecutive records can legitimately be more than one interval apart.
|
|
3324
|
+
*/
|
|
3210
3325
|
FundingRecord: {
|
|
3211
3326
|
/** Format: uuid */
|
|
3212
3327
|
tradingPairId?: string | null;
|
|
3213
3328
|
epoch?: string | null;
|
|
3329
|
+
/**
|
|
3330
|
+
* @description Final settled rate for the window as a decimal-string fraction per
|
|
3331
|
+
* funding interval (e.g. "0.0001" = 0.01%). The ±max-rate cap is applied
|
|
3332
|
+
* once to the window average at settlement; this is the capped value that
|
|
3333
|
+
* payments used.
|
|
3334
|
+
*/
|
|
3214
3335
|
fundingRate?: string | null;
|
|
3336
|
+
/**
|
|
3337
|
+
* @description Quote currency charged per unit of base position for this window:
|
|
3338
|
+
* funding_rate x reference_price. Positive means longs paid shorts.
|
|
3339
|
+
*/
|
|
3215
3340
|
fundingDeltaPerUnit?: string | null;
|
|
3341
|
+
/**
|
|
3342
|
+
* @description Running sum of funding_delta_per_unit across all settled windows;
|
|
3343
|
+
* position payments settle against deltas of this value.
|
|
3344
|
+
*/
|
|
3216
3345
|
cumulativeFundingPerUnit?: string | null;
|
|
3346
|
+
/**
|
|
3347
|
+
* @description Mark price at the window boundary — the payment basis for every
|
|
3348
|
+
* position settled in this window.
|
|
3349
|
+
*/
|
|
3217
3350
|
referencePrice?: string | null;
|
|
3218
3351
|
/** Format: uint32 */
|
|
3219
3352
|
sampleCount?: number | null;
|
|
3220
3353
|
windowStartedAt?: string | null;
|
|
3221
3354
|
windowClosedAt?: string | null;
|
|
3222
3355
|
settledAt?: string | null;
|
|
3356
|
+
/**
|
|
3357
|
+
* @description True when the window held fewer than the minimum accepted samples and
|
|
3358
|
+
* settled at the carried last settled rate (zero if no rate was ever
|
|
3359
|
+
* settled) instead of a freshly computed average.
|
|
3360
|
+
*/
|
|
3361
|
+
carried?: boolean | null;
|
|
3223
3362
|
};
|
|
3224
3363
|
GetAppStatsResponse: {
|
|
3225
3364
|
/**
|
|
@@ -3372,14 +3511,55 @@ export interface components {
|
|
|
3372
3511
|
*/
|
|
3373
3512
|
clientId?: string | null;
|
|
3374
3513
|
};
|
|
3514
|
+
GetFaucetInfoResponse: {
|
|
3515
|
+
/**
|
|
3516
|
+
* Format: uint32
|
|
3517
|
+
* @description Remaining faucet requests in the rolling 24h window
|
|
3518
|
+
* @example 2
|
|
3519
|
+
*/
|
|
3520
|
+
remainingRequests24h?: number | null;
|
|
3521
|
+
/**
|
|
3522
|
+
* Format: uint32
|
|
3523
|
+
* @description Maximum faucet requests per rolling 24h window
|
|
3524
|
+
* @example 3
|
|
3525
|
+
*/
|
|
3526
|
+
dailyLimit?: number | null;
|
|
3527
|
+
/** @description Timestamp (ISO 8601) safe to retry at or after: when the wallet's next faucet slot frees under the current daily limit, with a small safety margin. When remaining_requests_24h is 0 this is when the next mint becomes possible. Absent when no requests are in the rolling 24h window or when the daily limit is 0. Not a calendar-day reset. */
|
|
3528
|
+
nextAvailableAt?: string | null;
|
|
3529
|
+
/**
|
|
3530
|
+
* @description Up to 5 most recent faucet request groups, newest first, regardless of
|
|
3531
|
+
* the 24h window.
|
|
3532
|
+
*/
|
|
3533
|
+
recentRequests?: components["schemas"]["FaucetRequestRecord"][] | null;
|
|
3534
|
+
};
|
|
3375
3535
|
GetFundingStateResponse: {
|
|
3376
3536
|
/** Format: uuid */
|
|
3377
3537
|
tradingPairId?: string | null;
|
|
3538
|
+
/**
|
|
3539
|
+
* @description Most recently SETTLED funding rate as a decimal-string fraction per funding interval; "0" when nothing has settled yet
|
|
3540
|
+
* @example 0.0001
|
|
3541
|
+
*/
|
|
3378
3542
|
currentFundingRate?: string | null;
|
|
3543
|
+
/**
|
|
3544
|
+
* @description Implied rate for the in-progress window. An estimate refreshed on each accepted premium sample (roughly every sample interval plus persistence lag), not a real-time stream; absent when the window has no samples
|
|
3545
|
+
* @example 0.00012
|
|
3546
|
+
*/
|
|
3379
3547
|
estimatedNextFundingRate?: string | null;
|
|
3548
|
+
/**
|
|
3549
|
+
* @description Scheduled end of the current funding window (ms epoch string). An estimate, not a guarantee: settlement lands at or shortly after this boundary when the market is alive, and boundaries that pass while the engine is down are skipped, never settled retroactively
|
|
3550
|
+
* @example 1754006400000
|
|
3551
|
+
*/
|
|
3380
3552
|
nextFundingTime?: string | null;
|
|
3381
|
-
/**
|
|
3553
|
+
/**
|
|
3554
|
+
* Format: uint32
|
|
3555
|
+
* @description Length of a funding window in seconds, inferred from settlement history and market configuration
|
|
3556
|
+
* @example 3600
|
|
3557
|
+
*/
|
|
3382
3558
|
fundingIntervalSeconds?: number | null;
|
|
3559
|
+
/**
|
|
3560
|
+
* @description Close of the most recently settled window (ms epoch string); absent before the first settlement
|
|
3561
|
+
* @example 1754002800000
|
|
3562
|
+
*/
|
|
3383
3563
|
lastFundingTime?: string | null;
|
|
3384
3564
|
updatedAt?: string | null;
|
|
3385
3565
|
};
|
|
@@ -3739,7 +3919,8 @@ export interface components {
|
|
|
3739
3919
|
*/
|
|
3740
3920
|
marginAccountId?: string | null;
|
|
3741
3921
|
/**
|
|
3742
|
-
* @
|
|
3922
|
+
* @deprecated
|
|
3923
|
+
* @description DEPRECATED derived compatibility value. Order side is authoritative.
|
|
3743
3924
|
* @example LONG
|
|
3744
3925
|
*/
|
|
3745
3926
|
positionSide?: string | null;
|
|
@@ -3831,6 +4012,11 @@ export interface components {
|
|
|
3831
4012
|
* @description Batch UUID for batch orders
|
|
3832
4013
|
*/
|
|
3833
4014
|
batchId?: string | null;
|
|
4015
|
+
/**
|
|
4016
|
+
* @description Stable terminal cause for a cancelled order: USER_REQUESTED, REPLACED, LIQUIDATION, INSUFFICIENT_MARGIN, REDUCE_ONLY_EXHAUSTED, POSITION_CLOSED, OCO_SIBLING_TRIGGERED, or SYSTEM
|
|
4017
|
+
* @example REDUCE_ONLY_EXHAUSTED
|
|
4018
|
+
*/
|
|
4019
|
+
terminalReason?: string | null;
|
|
3834
4020
|
};
|
|
3835
4021
|
/** @description Orderbook snapshot with token metadata and sequence number. */
|
|
3836
4022
|
GetOrderbookResponse: {
|
|
@@ -4024,7 +4210,7 @@ export interface components {
|
|
|
4024
4210
|
perpsEquity?: string | null;
|
|
4025
4211
|
/**
|
|
4026
4212
|
* Format: double
|
|
4027
|
-
* @description
|
|
4213
|
+
* @description Position-level win rate: winning positions over winning + losing positions (break-even excluded). Each position (one flat->open->flat round-trip) is classified once by its net realized PnL after all fees, not per fill. Null when the period has no closed positions.
|
|
4028
4214
|
* @example 0.65
|
|
4029
4215
|
*/
|
|
4030
4216
|
winLossRatio?: number | null;
|
|
@@ -4073,13 +4259,23 @@ export interface components {
|
|
|
4073
4259
|
/** Format: uuid */
|
|
4074
4260
|
tradingPairId?: string | null;
|
|
4075
4261
|
side?: string | null;
|
|
4262
|
+
/**
|
|
4263
|
+
* @description Open rows: current absolute position quantity. Terminal rows
|
|
4264
|
+
* (CLOSED/LIQUIDATED/EXPIRED): total quantity closed over the position's
|
|
4265
|
+
* life, summed from its reducing executions when available.
|
|
4266
|
+
*/
|
|
4076
4267
|
size?: string | null;
|
|
4077
4268
|
entryPrice?: string | null;
|
|
4078
4269
|
markPrice?: string | null;
|
|
4079
4270
|
indexPrice?: string | null;
|
|
4080
4271
|
unrealizedPnl?: string | null;
|
|
4081
4272
|
realizedPnl?: string | null;
|
|
4082
|
-
/**
|
|
4273
|
+
/**
|
|
4274
|
+
* @description Open rows: current isolated collateral for this position's risk bucket.
|
|
4275
|
+
* Terminal rows: total initial margin allocated across the position's
|
|
4276
|
+
* reducing executions when available — the margin basis for lifetime
|
|
4277
|
+
* realized return.
|
|
4278
|
+
*/
|
|
4083
4279
|
isolatedMargin?: string | null;
|
|
4084
4280
|
leverage?: string | null;
|
|
4085
4281
|
/**
|
|
@@ -4106,6 +4302,21 @@ export interface components {
|
|
|
4106
4302
|
updatedAt?: string | null;
|
|
4107
4303
|
riskBucketId?: string | null;
|
|
4108
4304
|
marginMode?: string | null;
|
|
4305
|
+
/**
|
|
4306
|
+
* @description Lifetime realized PnL net of trading fees and funding. Terminal rows
|
|
4307
|
+
* only; absent when the position's reducing executions are unavailable.
|
|
4308
|
+
*/
|
|
4309
|
+
netRealizedPnl?: string | null;
|
|
4310
|
+
/**
|
|
4311
|
+
* @description Lifetime realized return on the total allocated initial margin, as a
|
|
4312
|
+
* percentage, computed from NET realized PnL (after trading fees and
|
|
4313
|
+
* funding). The denominator is initial margin only: fees and funding are
|
|
4314
|
+
* costs rather than posted collateral, and funding is signed, so folding it
|
|
4315
|
+
* into the denominator could drive it to zero or negative. Terminal rows
|
|
4316
|
+
* only; absent when unavailable, including when the position's reducing
|
|
4317
|
+
* executions do not account for its whole lifetime.
|
|
4318
|
+
*/
|
|
4319
|
+
realizedRoe?: string | null;
|
|
4109
4320
|
};
|
|
4110
4321
|
GetPositionRiskResponse: {
|
|
4111
4322
|
positionId?: string | null;
|
|
@@ -4194,6 +4405,26 @@ export interface components {
|
|
|
4194
4405
|
*/
|
|
4195
4406
|
applicationMakerFeeBps?: number | null;
|
|
4196
4407
|
};
|
|
4408
|
+
GetPulseResponse: {
|
|
4409
|
+
/**
|
|
4410
|
+
* @description When this snapshot was produced upstream, ISO-8601 UTC; also serves as the response ETag value
|
|
4411
|
+
* @example 2026-07-22T15:17:14Z
|
|
4412
|
+
*/
|
|
4413
|
+
generatedAt?: string | null;
|
|
4414
|
+
/**
|
|
4415
|
+
* @description Asset universe this snapshot was synthesized against
|
|
4416
|
+
* @example [
|
|
4417
|
+
* "BTC",
|
|
4418
|
+
* "ETH",
|
|
4419
|
+
* "SOL",
|
|
4420
|
+
* "SEI",
|
|
4421
|
+
* "HYPE"
|
|
4422
|
+
* ]
|
|
4423
|
+
*/
|
|
4424
|
+
watchlist?: string[] | null;
|
|
4425
|
+
/** @description Pulse items, pre-sorted: watchlist order first, MARKET last, most-recent-first within each asset. Items with unverified figures are removed server-side. */
|
|
4426
|
+
items?: components["schemas"]["PulseItem"][] | null;
|
|
4427
|
+
};
|
|
4197
4428
|
GetRewardsBalanceResponse: {
|
|
4198
4429
|
/** @description One entry per reward token that has a non-zero available balance. */
|
|
4199
4430
|
balances?: components["schemas"]["RewardsBalanceEntry"][] | null;
|
|
@@ -4295,6 +4526,22 @@ export interface components {
|
|
|
4295
4526
|
* @example 8
|
|
4296
4527
|
*/
|
|
4297
4528
|
totalPages?: string | null;
|
|
4529
|
+
/**
|
|
4530
|
+
* @description Cursor for the next page. Empty on every page-number (legacy) response —
|
|
4531
|
+
* page-number mode never mints a token, full page or not, since resuming
|
|
4532
|
+
* a client from a legacy-minted position could silently strand archived
|
|
4533
|
+
* history newer than wherever that page happened to end. To walk full
|
|
4534
|
+
* history, start a cursor-mode request with `page_token` present but
|
|
4535
|
+
* empty (`""`); from then on the token is present whenever that page
|
|
4536
|
+
* returned any rows (AIP-158 "maybe more" semantics), not only when the
|
|
4537
|
+
* page is exactly full. Empty only when a cursor-mode page returned zero
|
|
4538
|
+
* rows, which is the sole proof the walk is exhausted; a non-empty token
|
|
4539
|
+
* does not guarantee further results, so keep following it until a
|
|
4540
|
+
* response returns zero rows and an empty token. The two modes never
|
|
4541
|
+
* bridge: a page-number response's empty token is not "done," it simply
|
|
4542
|
+
* means page-number mode does not participate in cursor continuation.
|
|
4543
|
+
*/
|
|
4544
|
+
nextPageToken?: string | null;
|
|
4298
4545
|
};
|
|
4299
4546
|
IndexComponent: {
|
|
4300
4547
|
provider?: string | null;
|
|
@@ -4457,6 +4704,15 @@ export interface components {
|
|
|
4457
4704
|
*/
|
|
4458
4705
|
balanceId?: string | null;
|
|
4459
4706
|
};
|
|
4707
|
+
ListAllFundingHistoryResponse: {
|
|
4708
|
+
records?: components["schemas"]["FundingRecord"][] | null;
|
|
4709
|
+
/** Format: uint32 */
|
|
4710
|
+
total?: number | null;
|
|
4711
|
+
/** Format: uint32 */
|
|
4712
|
+
page?: number | null;
|
|
4713
|
+
/** Format: uint32 */
|
|
4714
|
+
pageSize?: number | null;
|
|
4715
|
+
};
|
|
4460
4716
|
ListAppBalancesResponse: {
|
|
4461
4717
|
balances?: components["schemas"]["ApplicationBalance"][] | null;
|
|
4462
4718
|
/**
|
|
@@ -4653,6 +4909,22 @@ export interface components {
|
|
|
4653
4909
|
* @example 8
|
|
4654
4910
|
*/
|
|
4655
4911
|
totalPages?: number | null;
|
|
4912
|
+
/**
|
|
4913
|
+
* @description Cursor for the next page. Empty on every page-number (legacy) response —
|
|
4914
|
+
* page-number mode never mints a token, full page or not, since resuming
|
|
4915
|
+
* a client from a legacy-minted position could silently strand archived
|
|
4916
|
+
* history newer than wherever that page happened to end. To walk full
|
|
4917
|
+
* history, start a cursor-mode request with `page_token` present but
|
|
4918
|
+
* empty (`""`); from then on the token is present whenever that page
|
|
4919
|
+
* returned any rows (AIP-158 "maybe more" semantics), not only when the
|
|
4920
|
+
* page is exactly full. Empty only when a cursor-mode page returned zero
|
|
4921
|
+
* rows, which is the sole proof the walk is exhausted; a non-empty token
|
|
4922
|
+
* does not guarantee further results, so keep following it until a
|
|
4923
|
+
* response returns zero rows and an empty token. The two modes never
|
|
4924
|
+
* bridge: a page-number response's empty token is not "done," it simply
|
|
4925
|
+
* means page-number mode does not participate in cursor continuation.
|
|
4926
|
+
*/
|
|
4927
|
+
nextPageToken?: string | null;
|
|
4656
4928
|
};
|
|
4657
4929
|
ListPendingWithdrawalsResponse: {
|
|
4658
4930
|
withdrawals?: components["schemas"]["PendingWithdrawal"][] | null;
|
|
@@ -5011,12 +5283,23 @@ export interface components {
|
|
|
5011
5283
|
date?: string | null;
|
|
5012
5284
|
netRealizedPnl?: string | null;
|
|
5013
5285
|
};
|
|
5286
|
+
/**
|
|
5287
|
+
* @description Win rate is position-level: winners/losers/break_even and win_rate_pct count
|
|
5288
|
+
* each position (one flat -> open -> flat round-trip) once, classified by its
|
|
5289
|
+
* net realized PnL after all fees. `count` stays fill-based (each partial
|
|
5290
|
+
* closing fill is counted).
|
|
5291
|
+
*/
|
|
5014
5292
|
PortfolioClosedTradeStats: {
|
|
5015
5293
|
count?: string | null;
|
|
5016
5294
|
winners?: string | null;
|
|
5017
5295
|
losers?: string | null;
|
|
5018
5296
|
breakEven?: string | null;
|
|
5019
5297
|
winRatePct?: string | null;
|
|
5298
|
+
/**
|
|
5299
|
+
* @description Total classified positions (= winners + losers + break_even): the
|
|
5300
|
+
* position-level denominator, distinct from the fill-based `count`.
|
|
5301
|
+
*/
|
|
5302
|
+
positions?: string | null;
|
|
5020
5303
|
};
|
|
5021
5304
|
PortfolioMarginPositionCounts: {
|
|
5022
5305
|
total?: string | null;
|
|
@@ -5136,13 +5419,23 @@ export interface components {
|
|
|
5136
5419
|
/** Format: uuid */
|
|
5137
5420
|
tradingPairId?: string | null;
|
|
5138
5421
|
side?: string | null;
|
|
5422
|
+
/**
|
|
5423
|
+
* @description Open rows: current absolute position quantity. Terminal rows
|
|
5424
|
+
* (CLOSED/LIQUIDATED/EXPIRED): total quantity closed over the position's
|
|
5425
|
+
* life, summed from its reducing executions when available.
|
|
5426
|
+
*/
|
|
5139
5427
|
size?: string | null;
|
|
5140
5428
|
entryPrice?: string | null;
|
|
5141
5429
|
markPrice?: string | null;
|
|
5142
5430
|
indexPrice?: string | null;
|
|
5143
5431
|
unrealizedPnl?: string | null;
|
|
5144
5432
|
realizedPnl?: string | null;
|
|
5145
|
-
/**
|
|
5433
|
+
/**
|
|
5434
|
+
* @description Open rows: current isolated collateral for this position's risk bucket.
|
|
5435
|
+
* Terminal rows: total initial margin allocated across the position's
|
|
5436
|
+
* reducing executions when available — the margin basis for lifetime
|
|
5437
|
+
* realized return.
|
|
5438
|
+
*/
|
|
5146
5439
|
isolatedMargin?: string | null;
|
|
5147
5440
|
leverage?: string | null;
|
|
5148
5441
|
/**
|
|
@@ -5169,6 +5462,21 @@ export interface components {
|
|
|
5169
5462
|
updatedAt?: string | null;
|
|
5170
5463
|
riskBucketId?: string | null;
|
|
5171
5464
|
marginMode?: string | null;
|
|
5465
|
+
/**
|
|
5466
|
+
* @description Lifetime realized PnL net of trading fees and funding. Terminal rows
|
|
5467
|
+
* only; absent when the position's reducing executions are unavailable.
|
|
5468
|
+
*/
|
|
5469
|
+
netRealizedPnl?: string | null;
|
|
5470
|
+
/**
|
|
5471
|
+
* @description Lifetime realized return on the total allocated initial margin, as a
|
|
5472
|
+
* percentage, computed from NET realized PnL (after trading fees and
|
|
5473
|
+
* funding). The denominator is initial margin only: fees and funding are
|
|
5474
|
+
* costs rather than posted collateral, and funding is signed, so folding it
|
|
5475
|
+
* into the denominator could drive it to zero or negative. Terminal rows
|
|
5476
|
+
* only; absent when unavailable, including when the position's reducing
|
|
5477
|
+
* executions do not account for its whole lifetime.
|
|
5478
|
+
*/
|
|
5479
|
+
realizedRoe?: string | null;
|
|
5172
5480
|
};
|
|
5173
5481
|
PositionHistoryEvent: {
|
|
5174
5482
|
id?: string | null;
|
|
@@ -5322,6 +5630,58 @@ export interface components {
|
|
|
5322
5630
|
*/
|
|
5323
5631
|
tradingMode?: string | null;
|
|
5324
5632
|
};
|
|
5633
|
+
PulseItem: {
|
|
5634
|
+
/**
|
|
5635
|
+
* @description Watchlist ticker (e.g. "BTC") or "MARKET" for a cross-asset story
|
|
5636
|
+
* @example SEI
|
|
5637
|
+
*/
|
|
5638
|
+
asset?: string | null;
|
|
5639
|
+
/**
|
|
5640
|
+
* @description Sentiment tag: "Bullish", "Neutral", or "Bearish"
|
|
5641
|
+
* @example Bullish
|
|
5642
|
+
*/
|
|
5643
|
+
sentiment?: string | null;
|
|
5644
|
+
/**
|
|
5645
|
+
* @description Synthesized 1-2 sentence summary, at most 240 characters
|
|
5646
|
+
* @example SEI gained 4% amid ecosystem growth.
|
|
5647
|
+
*/
|
|
5648
|
+
summary?: string | null;
|
|
5649
|
+
/**
|
|
5650
|
+
* @description Timestamp of the most recent source in the cluster, ISO-8601; render relative time client-side
|
|
5651
|
+
* @example 2026-07-21T02:15:19
|
|
5652
|
+
*/
|
|
5653
|
+
updatedAt?: string | null;
|
|
5654
|
+
/** @description Provenance for the item, for attribution links */
|
|
5655
|
+
sources?: components["schemas"]["PulseSource"][] | null;
|
|
5656
|
+
};
|
|
5657
|
+
PulseSource: {
|
|
5658
|
+
/**
|
|
5659
|
+
* @description Source article or post URL
|
|
5660
|
+
* @example https://coinmarketcap.com/top-stories/6a5f0c340787ae5558351f0f/
|
|
5661
|
+
*/
|
|
5662
|
+
url?: string | null;
|
|
5663
|
+
/**
|
|
5664
|
+
* @description Source author or publication name
|
|
5665
|
+
* @example CoinMarketCap
|
|
5666
|
+
*/
|
|
5667
|
+
author?: string | null;
|
|
5668
|
+
/**
|
|
5669
|
+
* @description Source channel: "twitter" or "news"
|
|
5670
|
+
* @example news
|
|
5671
|
+
*/
|
|
5672
|
+
source?: string | null;
|
|
5673
|
+
/**
|
|
5674
|
+
* @description Source publication time, ISO-8601
|
|
5675
|
+
* @example 2026-07-21T02:15:19
|
|
5676
|
+
*/
|
|
5677
|
+
createdAt?: string | null;
|
|
5678
|
+
/**
|
|
5679
|
+
* Format: uint32
|
|
5680
|
+
* @description Relevance score, 1 (low) to 5 (high)
|
|
5681
|
+
* @example 4
|
|
5682
|
+
*/
|
|
5683
|
+
relevance?: number | null;
|
|
5684
|
+
};
|
|
5325
5685
|
ReducePositionMarginRequest: {
|
|
5326
5686
|
amount?: string | null;
|
|
5327
5687
|
};
|
|
@@ -5415,7 +5775,13 @@ export interface components {
|
|
|
5415
5775
|
RiskTier: {
|
|
5416
5776
|
initialMarginRatio?: string | null;
|
|
5417
5777
|
maintenanceMarginRatio?: string | null;
|
|
5778
|
+
/**
|
|
5779
|
+
* @deprecated
|
|
5780
|
+
* @description DEPRECATED compatibility alias. This value is a maximum absolute base-asset quantity, not a notional. Use maxPositionSize.
|
|
5781
|
+
*/
|
|
5418
5782
|
maxPositionNotional?: string | null;
|
|
5783
|
+
/** @description Maximum authoritative absolute position size in base-asset quantity. */
|
|
5784
|
+
maxPositionSize?: string | null;
|
|
5419
5785
|
};
|
|
5420
5786
|
/** @description Per-pair screener row. Window fields null when insufficient history. */
|
|
5421
5787
|
ScreenerItem: {
|
|
@@ -5497,6 +5863,16 @@ export interface components {
|
|
|
5497
5863
|
* @example 482931
|
|
5498
5864
|
*/
|
|
5499
5865
|
totalTradeCountLtd?: string | null;
|
|
5866
|
+
/**
|
|
5867
|
+
* @description Latest settled funding rate as a decimal fraction per funding window (the capped settled value); null for spot pairs and margin pairs with no settled funding window yet
|
|
5868
|
+
* @example 0.000125
|
|
5869
|
+
*/
|
|
5870
|
+
latestFundingRate?: string | null;
|
|
5871
|
+
/**
|
|
5872
|
+
* @description Close time of the latest settled funding window (ms since epoch); null for spot pairs and margin pairs with no settled funding window yet
|
|
5873
|
+
* @example 1745308800000
|
|
5874
|
+
*/
|
|
5875
|
+
lastFundingTime?: string | null;
|
|
5500
5876
|
};
|
|
5501
5877
|
/** @description One UTC-day bucket in a pair's 7-day snapshot. */
|
|
5502
5878
|
ScreenerSnapshotPoint: {
|
|
@@ -5615,10 +5991,15 @@ export interface components {
|
|
|
5615
5991
|
/** Format: uuid */
|
|
5616
5992
|
tradingPairId?: string | null;
|
|
5617
5993
|
side?: string | null;
|
|
5994
|
+
/**
|
|
5995
|
+
* @description Deprecated compatibility value. `side` is authoritative; when present,
|
|
5996
|
+
* BUY must carry LONG and SELL must carry SHORT.
|
|
5997
|
+
*/
|
|
5618
5998
|
positionSide?: string | null;
|
|
5619
5999
|
orderType?: string | null;
|
|
5620
6000
|
price?: string | null;
|
|
5621
6001
|
quantity?: string | null;
|
|
6002
|
+
/** @description Required for normal orders; optional and ignored for reduce-only. */
|
|
5622
6003
|
leverage?: string | null;
|
|
5623
6004
|
reduceOnly?: boolean | null;
|
|
5624
6005
|
};
|
|
@@ -5657,10 +6038,12 @@ export interface components {
|
|
|
5657
6038
|
/** Format: uuid */
|
|
5658
6039
|
tradingPairId?: string | null;
|
|
5659
6040
|
side?: string | null;
|
|
6041
|
+
/** @description Deprecated compatibility value; `side` is authoritative. */
|
|
5660
6042
|
positionSide?: string | null;
|
|
5661
6043
|
orderType?: string | null;
|
|
5662
6044
|
price?: string | null;
|
|
5663
6045
|
quantity?: string | null;
|
|
6046
|
+
/** @description Required for normal orders; optional and ignored for reduce-only. */
|
|
5664
6047
|
leverage?: string | null;
|
|
5665
6048
|
reduceOnly?: boolean | null;
|
|
5666
6049
|
};
|
|
@@ -5669,10 +6052,12 @@ export interface components {
|
|
|
5669
6052
|
tradingPairId?: string | null;
|
|
5670
6053
|
strategyKey?: string | null;
|
|
5671
6054
|
side?: string | null;
|
|
6055
|
+
/** @description Deprecated compatibility value; `side` is authoritative. */
|
|
5672
6056
|
positionSide?: string | null;
|
|
5673
6057
|
orderType?: string | null;
|
|
5674
6058
|
price?: string | null;
|
|
5675
6059
|
quantity?: string | null;
|
|
6060
|
+
/** @description Required for normal orders; optional and ignored for reduce-only. */
|
|
5676
6061
|
leverage?: string | null;
|
|
5677
6062
|
reduceOnly?: boolean | null;
|
|
5678
6063
|
/** @description Risk bucket mode. Defaults to ISOLATED. Values: ISOLATED, CROSS. */
|
|
@@ -5814,6 +6199,12 @@ export interface components {
|
|
|
5814
6199
|
/** Format: int32 */
|
|
5815
6200
|
slippageToleranceBps?: number | null;
|
|
5816
6201
|
expiresAt?: string | null;
|
|
6202
|
+
/**
|
|
6203
|
+
* @description Resolve the full live position size when triggered. Mutually exclusive
|
|
6204
|
+
* with quantity. For compatibility, omitting both quantity and this field
|
|
6205
|
+
* also means full-position close.
|
|
6206
|
+
*/
|
|
6207
|
+
closePosition?: boolean | null;
|
|
5817
6208
|
};
|
|
5818
6209
|
/** @description Core fields of a single executed trade, nested under `data` in the public trade event envelope. */
|
|
5819
6210
|
TradeData: {
|
|
@@ -6349,6 +6740,7 @@ export interface operations {
|
|
|
6349
6740
|
query?: never;
|
|
6350
6741
|
header?: never;
|
|
6351
6742
|
path: {
|
|
6743
|
+
/** @example 1905d968-cc65-4cc7-b77c-1905d968cc65 */
|
|
6352
6744
|
assetId: string;
|
|
6353
6745
|
};
|
|
6354
6746
|
cookie?: never;
|
|
@@ -7002,6 +7394,7 @@ export interface operations {
|
|
|
7002
7394
|
query?: never;
|
|
7003
7395
|
header?: never;
|
|
7004
7396
|
path: {
|
|
7397
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000005 */
|
|
7005
7398
|
subAccountId: string;
|
|
7006
7399
|
};
|
|
7007
7400
|
cookie?: never;
|
|
@@ -7052,7 +7445,9 @@ export interface operations {
|
|
|
7052
7445
|
query?: never;
|
|
7053
7446
|
header?: never;
|
|
7054
7447
|
path: {
|
|
7448
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000005 */
|
|
7055
7449
|
subAccountId: string;
|
|
7450
|
+
/** @example 1905d968-cc65-4cc7-b77c-1905d968cc65 */
|
|
7056
7451
|
assetId: string;
|
|
7057
7452
|
};
|
|
7058
7453
|
cookie?: never;
|
|
@@ -7117,7 +7512,9 @@ export interface operations {
|
|
|
7117
7512
|
};
|
|
7118
7513
|
header?: never;
|
|
7119
7514
|
path: {
|
|
7515
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000005 */
|
|
7120
7516
|
subAccountId: string;
|
|
7517
|
+
/** @example 1905d968-cc65-4cc7-b77c-1905d968cc65 */
|
|
7121
7518
|
assetId: string;
|
|
7122
7519
|
};
|
|
7123
7520
|
cookie?: never;
|
|
@@ -7179,6 +7576,24 @@ export interface operations {
|
|
|
7179
7576
|
pageSize?: number;
|
|
7180
7577
|
/** @description Trading pair identifier (UUID) */
|
|
7181
7578
|
tradingPairId?: string;
|
|
7579
|
+
/**
|
|
7580
|
+
* @description Pagination cursor with three distinct states:
|
|
7581
|
+
* - Omitted: legacy page-number pagination via `page`, limited to recent
|
|
7582
|
+
* history once the archive window is enabled.
|
|
7583
|
+
* - Empty string (""): start a cursor walk with no prior position, from
|
|
7584
|
+
* the newest row (this endpoint always sorts newest-first).
|
|
7585
|
+
* - Non-empty: an opaque cursor from a previous response's
|
|
7586
|
+
* `next_page_token`; results resume immediately after that position.
|
|
7587
|
+
*
|
|
7588
|
+
* In either cursor-walk state (empty or non-empty), `page` is ignored, the
|
|
7589
|
+
* response omits exact totals (total/total_pages/page are 0), and results
|
|
7590
|
+
* cover full trade history — hot and archived rows merged — unlike
|
|
7591
|
+
* page-number mode, which only ever sees recent history. Clients that need
|
|
7592
|
+
* complete trade history must use the cursor form (start with an empty
|
|
7593
|
+
* string, then follow next_page_token) rather than `page`. Filters must
|
|
7594
|
+
* match the request that produced the token.
|
|
7595
|
+
*/
|
|
7596
|
+
pageToken?: string;
|
|
7182
7597
|
};
|
|
7183
7598
|
header?: never;
|
|
7184
7599
|
path?: never;
|
|
@@ -7912,6 +8327,7 @@ export interface operations {
|
|
|
7912
8327
|
query?: never;
|
|
7913
8328
|
header?: never;
|
|
7914
8329
|
path: {
|
|
8330
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000007 */
|
|
7915
8331
|
delegatedAgentId: string;
|
|
7916
8332
|
};
|
|
7917
8333
|
cookie?: never;
|
|
@@ -7964,6 +8380,47 @@ export interface operations {
|
|
|
7964
8380
|
};
|
|
7965
8381
|
};
|
|
7966
8382
|
};
|
|
8383
|
+
get_faucet_info: {
|
|
8384
|
+
parameters: {
|
|
8385
|
+
query?: never;
|
|
8386
|
+
header?: never;
|
|
8387
|
+
path?: never;
|
|
8388
|
+
cookie?: never;
|
|
8389
|
+
};
|
|
8390
|
+
requestBody?: never;
|
|
8391
|
+
responses: {
|
|
8392
|
+
/** @description OK */
|
|
8393
|
+
200: {
|
|
8394
|
+
headers: {
|
|
8395
|
+
[name: string]: unknown;
|
|
8396
|
+
};
|
|
8397
|
+
content: {
|
|
8398
|
+
"application/json": components["schemas"]["GetFaucetInfoResponse"];
|
|
8399
|
+
};
|
|
8400
|
+
};
|
|
8401
|
+
/** @description Authentication required */
|
|
8402
|
+
401: {
|
|
8403
|
+
headers: {
|
|
8404
|
+
[name: string]: unknown;
|
|
8405
|
+
};
|
|
8406
|
+
content?: never;
|
|
8407
|
+
};
|
|
8408
|
+
/** @description Internal server error */
|
|
8409
|
+
500: {
|
|
8410
|
+
headers: {
|
|
8411
|
+
[name: string]: unknown;
|
|
8412
|
+
};
|
|
8413
|
+
content?: never;
|
|
8414
|
+
};
|
|
8415
|
+
/** @description Faucet quota configuration unavailable; safe to retry */
|
|
8416
|
+
503: {
|
|
8417
|
+
headers: {
|
|
8418
|
+
[name: string]: unknown;
|
|
8419
|
+
};
|
|
8420
|
+
content?: never;
|
|
8421
|
+
};
|
|
8422
|
+
};
|
|
8423
|
+
};
|
|
7967
8424
|
mint_tokens: {
|
|
7968
8425
|
parameters: {
|
|
7969
8426
|
query?: never;
|
|
@@ -8177,7 +8634,10 @@ export interface operations {
|
|
|
8177
8634
|
};
|
|
8178
8635
|
header?: never;
|
|
8179
8636
|
path: {
|
|
8180
|
-
/**
|
|
8637
|
+
/**
|
|
8638
|
+
* @description Margin account UUID for the current isolated bucket.
|
|
8639
|
+
* @example 2b1a5f9c-0000-4000-8000-000000000001
|
|
8640
|
+
*/
|
|
8181
8641
|
marginAccountId: string;
|
|
8182
8642
|
};
|
|
8183
8643
|
cookie?: never;
|
|
@@ -8200,7 +8660,10 @@ export interface operations {
|
|
|
8200
8660
|
query?: never;
|
|
8201
8661
|
header?: never;
|
|
8202
8662
|
path: {
|
|
8203
|
-
/**
|
|
8663
|
+
/**
|
|
8664
|
+
* @description Parent margin account UUID that receives collateral.
|
|
8665
|
+
* @example 2b1a5f9c-0000-4000-8000-000000000001
|
|
8666
|
+
*/
|
|
8204
8667
|
marginAccountId: string;
|
|
8205
8668
|
};
|
|
8206
8669
|
cookie?: never;
|
|
@@ -8227,7 +8690,10 @@ export interface operations {
|
|
|
8227
8690
|
query?: never;
|
|
8228
8691
|
header?: never;
|
|
8229
8692
|
path: {
|
|
8230
|
-
/**
|
|
8693
|
+
/**
|
|
8694
|
+
* @description Parent margin account UUID that releases collateral.
|
|
8695
|
+
* @example 2b1a5f9c-0000-4000-8000-000000000001
|
|
8696
|
+
*/
|
|
8231
8697
|
marginAccountId: string;
|
|
8232
8698
|
};
|
|
8233
8699
|
cookie?: never;
|
|
@@ -8260,7 +8726,10 @@ export interface operations {
|
|
|
8260
8726
|
};
|
|
8261
8727
|
header?: never;
|
|
8262
8728
|
path: {
|
|
8263
|
-
/**
|
|
8729
|
+
/**
|
|
8730
|
+
* @description Margin account UUID for the current isolated bucket.
|
|
8731
|
+
* @example 2b1a5f9c-0000-4000-8000-000000000001
|
|
8732
|
+
*/
|
|
8264
8733
|
marginAccountId: string;
|
|
8265
8734
|
};
|
|
8266
8735
|
cookie?: never;
|
|
@@ -8283,7 +8752,10 @@ export interface operations {
|
|
|
8283
8752
|
query?: never;
|
|
8284
8753
|
header?: never;
|
|
8285
8754
|
path: {
|
|
8286
|
-
/**
|
|
8755
|
+
/**
|
|
8756
|
+
* @description Margin account UUID for the isolated bucket being simulated.
|
|
8757
|
+
* @example 2b1a5f9c-0000-4000-8000-000000000001
|
|
8758
|
+
*/
|
|
8287
8759
|
marginAccountId: string;
|
|
8288
8760
|
};
|
|
8289
8761
|
cookie?: never;
|
|
@@ -8496,6 +8968,37 @@ export interface operations {
|
|
|
8496
8968
|
};
|
|
8497
8969
|
};
|
|
8498
8970
|
};
|
|
8971
|
+
list_all_funding_history: {
|
|
8972
|
+
parameters: {
|
|
8973
|
+
query?: {
|
|
8974
|
+
/** @description Start time as Unix timestamp (milliseconds) */
|
|
8975
|
+
startTime?: number;
|
|
8976
|
+
/** @description End time as Unix timestamp (milliseconds) */
|
|
8977
|
+
endTime?: number;
|
|
8978
|
+
/** @description Page number (1-indexed) */
|
|
8979
|
+
page?: number;
|
|
8980
|
+
/** @description Items per page (max 100) */
|
|
8981
|
+
pageSize?: number;
|
|
8982
|
+
/** @description Sort direction for settledAt */
|
|
8983
|
+
orderBy?: "ASC" | "DESC";
|
|
8984
|
+
};
|
|
8985
|
+
header?: never;
|
|
8986
|
+
path?: never;
|
|
8987
|
+
cookie?: never;
|
|
8988
|
+
};
|
|
8989
|
+
requestBody?: never;
|
|
8990
|
+
responses: {
|
|
8991
|
+
/** @description OK */
|
|
8992
|
+
200: {
|
|
8993
|
+
headers: {
|
|
8994
|
+
[name: string]: unknown;
|
|
8995
|
+
};
|
|
8996
|
+
content: {
|
|
8997
|
+
"application/json": components["schemas"]["ListAllFundingHistoryResponse"];
|
|
8998
|
+
};
|
|
8999
|
+
};
|
|
9000
|
+
};
|
|
9001
|
+
};
|
|
8499
9002
|
list_trading_pairs: {
|
|
8500
9003
|
parameters: {
|
|
8501
9004
|
query?: {
|
|
@@ -8553,7 +9056,9 @@ export interface operations {
|
|
|
8553
9056
|
};
|
|
8554
9057
|
header?: never;
|
|
8555
9058
|
path: {
|
|
9059
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8556
9060
|
tradingPairId: string;
|
|
9061
|
+
/** @example 1m */
|
|
8557
9062
|
interval: string;
|
|
8558
9063
|
};
|
|
8559
9064
|
cookie?: never;
|
|
@@ -8597,6 +9102,7 @@ export interface operations {
|
|
|
8597
9102
|
query?: never;
|
|
8598
9103
|
header?: never;
|
|
8599
9104
|
path: {
|
|
9105
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8600
9106
|
tradingPairId: string;
|
|
8601
9107
|
};
|
|
8602
9108
|
cookie?: never;
|
|
@@ -8633,6 +9139,7 @@ export interface operations {
|
|
|
8633
9139
|
query?: never;
|
|
8634
9140
|
header?: never;
|
|
8635
9141
|
path: {
|
|
9142
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8636
9143
|
tradingPairId: string;
|
|
8637
9144
|
};
|
|
8638
9145
|
cookie?: never;
|
|
@@ -8661,9 +9168,12 @@ export interface operations {
|
|
|
8661
9168
|
page?: number;
|
|
8662
9169
|
/** @description Items per page (max 100) */
|
|
8663
9170
|
pageSize?: number;
|
|
9171
|
+
/** @description Sort direction for createdAt */
|
|
9172
|
+
orderBy?: "ASC" | "DESC";
|
|
8664
9173
|
};
|
|
8665
9174
|
header?: never;
|
|
8666
9175
|
path: {
|
|
9176
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8667
9177
|
tradingPairId: string;
|
|
8668
9178
|
};
|
|
8669
9179
|
cookie?: never;
|
|
@@ -8686,6 +9196,7 @@ export interface operations {
|
|
|
8686
9196
|
query?: never;
|
|
8687
9197
|
header?: never;
|
|
8688
9198
|
path: {
|
|
9199
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8689
9200
|
tradingPairId: string;
|
|
8690
9201
|
};
|
|
8691
9202
|
cookie?: never;
|
|
@@ -8708,6 +9219,7 @@ export interface operations {
|
|
|
8708
9219
|
query?: never;
|
|
8709
9220
|
header?: never;
|
|
8710
9221
|
path: {
|
|
9222
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8711
9223
|
tradingPairId: string;
|
|
8712
9224
|
};
|
|
8713
9225
|
cookie?: never;
|
|
@@ -8730,6 +9242,7 @@ export interface operations {
|
|
|
8730
9242
|
query?: never;
|
|
8731
9243
|
header?: never;
|
|
8732
9244
|
path: {
|
|
9245
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8733
9246
|
tradingPairId: string;
|
|
8734
9247
|
};
|
|
8735
9248
|
cookie?: never;
|
|
@@ -8766,6 +9279,7 @@ export interface operations {
|
|
|
8766
9279
|
query?: never;
|
|
8767
9280
|
header?: never;
|
|
8768
9281
|
path: {
|
|
9282
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8769
9283
|
tradingPairId: string;
|
|
8770
9284
|
};
|
|
8771
9285
|
cookie?: never;
|
|
@@ -8802,6 +9316,7 @@ export interface operations {
|
|
|
8802
9316
|
query?: never;
|
|
8803
9317
|
header?: never;
|
|
8804
9318
|
path: {
|
|
9319
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8805
9320
|
tradingPairId: string;
|
|
8806
9321
|
};
|
|
8807
9322
|
cookie?: never;
|
|
@@ -8824,6 +9339,7 @@ export interface operations {
|
|
|
8824
9339
|
query?: never;
|
|
8825
9340
|
header?: never;
|
|
8826
9341
|
path: {
|
|
9342
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8827
9343
|
tradingPairId: string;
|
|
8828
9344
|
};
|
|
8829
9345
|
cookie?: never;
|
|
@@ -8925,6 +9441,7 @@ export interface operations {
|
|
|
8925
9441
|
};
|
|
8926
9442
|
header?: never;
|
|
8927
9443
|
path: {
|
|
9444
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
8928
9445
|
tradingPairId: string;
|
|
8929
9446
|
};
|
|
8930
9447
|
cookie?: never;
|
|
@@ -8979,6 +9496,24 @@ export interface operations {
|
|
|
8979
9496
|
marginAccountId?: string;
|
|
8980
9497
|
/** @description Sort direction for createdAt */
|
|
8981
9498
|
orderBy?: "ASC" | "DESC";
|
|
9499
|
+
/**
|
|
9500
|
+
* @description Pagination cursor with three distinct states:
|
|
9501
|
+
* - Omitted: legacy page-number pagination via `page`, limited to recent
|
|
9502
|
+
* history once the archive window is enabled.
|
|
9503
|
+
* - Empty string (""): start a cursor walk with no prior position, from
|
|
9504
|
+
* the newest row (or the oldest, when `orderBy` is ASC).
|
|
9505
|
+
* - Non-empty: an opaque cursor from a previous response's
|
|
9506
|
+
* `next_page_token`; results resume immediately after that position.
|
|
9507
|
+
*
|
|
9508
|
+
* In either cursor-walk state (empty or non-empty), `page` is ignored, the
|
|
9509
|
+
* response omits exact totals (total/total_pages/page are 0), and results
|
|
9510
|
+
* cover full order history — hot and archived rows merged — unlike
|
|
9511
|
+
* page-number mode, which only ever sees recent history. Clients that need
|
|
9512
|
+
* complete order history must use the cursor form (start with an empty
|
|
9513
|
+
* string, then follow next_page_token) rather than `page`. Filters and
|
|
9514
|
+
* orderBy must match the request that produced the token.
|
|
9515
|
+
*/
|
|
9516
|
+
pageToken?: string;
|
|
8982
9517
|
};
|
|
8983
9518
|
header?: never;
|
|
8984
9519
|
path?: never;
|
|
@@ -9161,6 +9696,7 @@ export interface operations {
|
|
|
9161
9696
|
query?: never;
|
|
9162
9697
|
header?: never;
|
|
9163
9698
|
path: {
|
|
9699
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
9164
9700
|
tradingPairId: string;
|
|
9165
9701
|
};
|
|
9166
9702
|
cookie?: never;
|
|
@@ -9375,6 +9911,7 @@ export interface operations {
|
|
|
9375
9911
|
query?: never;
|
|
9376
9912
|
header?: never;
|
|
9377
9913
|
path: {
|
|
9914
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000004 */
|
|
9378
9915
|
conditionalOrderId: string;
|
|
9379
9916
|
};
|
|
9380
9917
|
cookie?: never;
|
|
@@ -9397,6 +9934,7 @@ export interface operations {
|
|
|
9397
9934
|
query?: never;
|
|
9398
9935
|
header?: never;
|
|
9399
9936
|
path: {
|
|
9937
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000004 */
|
|
9400
9938
|
conditionalOrderId: string;
|
|
9401
9939
|
};
|
|
9402
9940
|
cookie?: never;
|
|
@@ -9419,6 +9957,7 @@ export interface operations {
|
|
|
9419
9957
|
query?: never;
|
|
9420
9958
|
header?: never;
|
|
9421
9959
|
path: {
|
|
9960
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000003 */
|
|
9422
9961
|
orderId: string;
|
|
9423
9962
|
};
|
|
9424
9963
|
cookie?: never;
|
|
@@ -9476,6 +10015,7 @@ export interface operations {
|
|
|
9476
10015
|
query?: never;
|
|
9477
10016
|
header?: never;
|
|
9478
10017
|
path: {
|
|
10018
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000003 */
|
|
9479
10019
|
orderId: string;
|
|
9480
10020
|
};
|
|
9481
10021
|
cookie?: never;
|
|
@@ -9564,6 +10104,7 @@ export interface operations {
|
|
|
9564
10104
|
query?: never;
|
|
9565
10105
|
header?: never;
|
|
9566
10106
|
path: {
|
|
10107
|
+
/** @example 0x742d35cc6634c0532925a3b8d4060f31e2c3d8b5 */
|
|
9567
10108
|
code: string;
|
|
9568
10109
|
};
|
|
9569
10110
|
cookie?: never;
|
|
@@ -9772,6 +10313,7 @@ export interface operations {
|
|
|
9772
10313
|
query?: never;
|
|
9773
10314
|
header?: never;
|
|
9774
10315
|
path: {
|
|
10316
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000002 */
|
|
9775
10317
|
positionId: string;
|
|
9776
10318
|
};
|
|
9777
10319
|
cookie?: never;
|
|
@@ -9794,6 +10336,7 @@ export interface operations {
|
|
|
9794
10336
|
query?: never;
|
|
9795
10337
|
header?: never;
|
|
9796
10338
|
path: {
|
|
10339
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000002 */
|
|
9797
10340
|
positionId: string;
|
|
9798
10341
|
};
|
|
9799
10342
|
cookie?: never;
|
|
@@ -9820,7 +10363,10 @@ export interface operations {
|
|
|
9820
10363
|
query?: never;
|
|
9821
10364
|
header?: never;
|
|
9822
10365
|
path: {
|
|
9823
|
-
/**
|
|
10366
|
+
/**
|
|
10367
|
+
* @description Position UUID for the isolated bucket being adjusted.
|
|
10368
|
+
* @example 2b1a5f9c-0000-4000-8000-000000000002
|
|
10369
|
+
*/
|
|
9824
10370
|
positionId: string;
|
|
9825
10371
|
};
|
|
9826
10372
|
cookie?: never;
|
|
@@ -9847,7 +10393,10 @@ export interface operations {
|
|
|
9847
10393
|
query?: never;
|
|
9848
10394
|
header?: never;
|
|
9849
10395
|
path: {
|
|
9850
|
-
/**
|
|
10396
|
+
/**
|
|
10397
|
+
* @description Position UUID for the isolated bucket being adjusted.
|
|
10398
|
+
* @example 2b1a5f9c-0000-4000-8000-000000000002
|
|
10399
|
+
*/
|
|
9851
10400
|
positionId: string;
|
|
9852
10401
|
};
|
|
9853
10402
|
cookie?: never;
|
|
@@ -9881,6 +10430,7 @@ export interface operations {
|
|
|
9881
10430
|
};
|
|
9882
10431
|
header?: never;
|
|
9883
10432
|
path: {
|
|
10433
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000002 */
|
|
9884
10434
|
positionId: string;
|
|
9885
10435
|
};
|
|
9886
10436
|
cookie?: never;
|
|
@@ -9931,6 +10481,7 @@ export interface operations {
|
|
|
9931
10481
|
query?: never;
|
|
9932
10482
|
header?: never;
|
|
9933
10483
|
path: {
|
|
10484
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000002 */
|
|
9934
10485
|
positionId: string;
|
|
9935
10486
|
};
|
|
9936
10487
|
cookie?: never;
|
|
@@ -9953,6 +10504,7 @@ export interface operations {
|
|
|
9953
10504
|
query?: never;
|
|
9954
10505
|
header?: never;
|
|
9955
10506
|
path: {
|
|
10507
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000002 */
|
|
9956
10508
|
positionId: string;
|
|
9957
10509
|
};
|
|
9958
10510
|
cookie?: never;
|
|
@@ -9974,11 +10526,39 @@ export interface operations {
|
|
|
9974
10526
|
};
|
|
9975
10527
|
};
|
|
9976
10528
|
};
|
|
10529
|
+
get_pulse: {
|
|
10530
|
+
parameters: {
|
|
10531
|
+
query?: never;
|
|
10532
|
+
header?: never;
|
|
10533
|
+
path?: never;
|
|
10534
|
+
cookie?: never;
|
|
10535
|
+
};
|
|
10536
|
+
requestBody?: never;
|
|
10537
|
+
responses: {
|
|
10538
|
+
/** @description OK */
|
|
10539
|
+
200: {
|
|
10540
|
+
headers: {
|
|
10541
|
+
[name: string]: unknown;
|
|
10542
|
+
};
|
|
10543
|
+
content: {
|
|
10544
|
+
"application/json": components["schemas"]["GetPulseResponse"];
|
|
10545
|
+
};
|
|
10546
|
+
};
|
|
10547
|
+
/** @description Pulse feed not yet available */
|
|
10548
|
+
503: {
|
|
10549
|
+
headers: {
|
|
10550
|
+
[name: string]: unknown;
|
|
10551
|
+
};
|
|
10552
|
+
content?: never;
|
|
10553
|
+
};
|
|
10554
|
+
};
|
|
10555
|
+
};
|
|
9977
10556
|
get_trade_by_id: {
|
|
9978
10557
|
parameters: {
|
|
9979
10558
|
query?: never;
|
|
9980
10559
|
header?: never;
|
|
9981
10560
|
path: {
|
|
10561
|
+
/** @example 2b1a5f9c-0000-4000-8000-000000000006 */
|
|
9982
10562
|
tradeId: string;
|
|
9983
10563
|
};
|
|
9984
10564
|
cookie?: never;
|
|
@@ -10027,6 +10607,7 @@ export interface operations {
|
|
|
10027
10607
|
};
|
|
10028
10608
|
header?: never;
|
|
10029
10609
|
path: {
|
|
10610
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
10030
10611
|
tradingPairId: string;
|
|
10031
10612
|
};
|
|
10032
10613
|
cookie?: never;
|
|
@@ -10227,6 +10808,7 @@ export interface operations {
|
|
|
10227
10808
|
query?: never;
|
|
10228
10809
|
header?: never;
|
|
10229
10810
|
path: {
|
|
10811
|
+
/** @example 0 */
|
|
10230
10812
|
withdrawalIndex: string;
|
|
10231
10813
|
};
|
|
10232
10814
|
cookie?: never;
|