@0xmonaco/types 1.0.25-develop.1fab96c → 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.
@@ -1052,6 +1052,26 @@ export interface paths {
1052
1052
  patch?: never;
1053
1053
  trace?: never;
1054
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
+ };
1055
1075
  "/api/v1/market/pairs": {
1056
1076
  parameters: {
1057
1077
  query?: never;
@@ -1854,6 +1874,33 @@ export interface paths {
1854
1874
  patch?: never;
1855
1875
  trace?: never;
1856
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
+ };
1857
1904
  "/api/v1/trades/by-id/{tradeId}": {
1858
1905
  parameters: {
1859
1906
  query?: never;
@@ -2508,7 +2555,7 @@ export interface components {
2508
2555
  */
2509
2556
  expirationDate?: string | null;
2510
2557
  /**
2511
- * @description Time in force: GTC, IOC, or FOK
2558
+ * @description Time in force: GTC, IOC, or FOK. LIMIT orders only; rejected on MARKET orders.
2512
2559
  * @example GTC
2513
2560
  */
2514
2561
  timeInForce?: string | null;
@@ -2957,7 +3004,7 @@ export interface components {
2957
3004
  */
2958
3005
  expirationDate?: string | null;
2959
3006
  /**
2960
- * @description Time in force: GTC, IOC, or FOK
3007
+ * @description Time in force: GTC, IOC, or FOK. LIMIT orders only; rejected on MARKET orders.
2961
3008
  * @example GTC
2962
3009
  */
2963
3010
  timeInForce?: string | null;
@@ -3176,9 +3223,13 @@ export interface components {
3176
3223
  /** @description On-chain transaction hash; absent when the transaction was submitted but never confirmed */
3177
3224
  txHash?: string | null;
3178
3225
  };
3179
- /** @description One past faucet request (one endpoint call; all tokens minted together). */
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
+ */
3180
3231
  FaucetRequestRecord: {
3181
- /** @description Timestamp (ISO 8601) of the request, truncated to the minute (the quota-session granularity) */
3232
+ /** @description Timestamp (ISO 8601) of the request, truncated to the minute (display grouping; the daily quota counts every call) */
3182
3233
  requestedAt?: string | null;
3183
3234
  minted?: components["schemas"]["FaucetMintRecord"][] | null;
3184
3235
  };
@@ -3266,19 +3317,48 @@ export interface components {
3266
3317
  */
3267
3318
  createdAt?: string | null;
3268
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
+ */
3269
3325
  FundingRecord: {
3270
3326
  /** Format: uuid */
3271
3327
  tradingPairId?: string | null;
3272
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
+ */
3273
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
+ */
3274
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
+ */
3275
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
+ */
3276
3350
  referencePrice?: string | null;
3277
3351
  /** Format: uint32 */
3278
3352
  sampleCount?: number | null;
3279
3353
  windowStartedAt?: string | null;
3280
3354
  windowClosedAt?: string | null;
3281
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;
3282
3362
  };
3283
3363
  GetAppStatsResponse: {
3284
3364
  /**
@@ -3447,19 +3527,39 @@ export interface components {
3447
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. */
3448
3528
  nextAvailableAt?: string | null;
3449
3529
  /**
3450
- * @description Up to 5 most recent faucet requests, newest first, regardless of the
3451
- * 24h window.
3530
+ * @description Up to 5 most recent faucet request groups, newest first, regardless of
3531
+ * the 24h window.
3452
3532
  */
3453
3533
  recentRequests?: components["schemas"]["FaucetRequestRecord"][] | null;
3454
3534
  };
3455
3535
  GetFundingStateResponse: {
3456
3536
  /** Format: uuid */
3457
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
+ */
3458
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
+ */
3459
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
+ */
3460
3552
  nextFundingTime?: string | null;
3461
- /** Format: uint32 */
3553
+ /**
3554
+ * Format: uint32
3555
+ * @description Length of a funding window in seconds, inferred from settlement history and market configuration
3556
+ * @example 3600
3557
+ */
3462
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
+ */
3463
3563
  lastFundingTime?: string | null;
3464
3564
  updatedAt?: string | null;
3465
3565
  };
@@ -4110,7 +4210,7 @@ export interface components {
4110
4210
  perpsEquity?: string | null;
4111
4211
  /**
4112
4212
  * Format: double
4113
- * @description Ratio of profitable trades to total trades
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.
4114
4214
  * @example 0.65
4115
4215
  */
4116
4216
  winLossRatio?: number | null;
@@ -4159,13 +4259,23 @@ export interface components {
4159
4259
  /** Format: uuid */
4160
4260
  tradingPairId?: string | null;
4161
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
+ */
4162
4267
  size?: string | null;
4163
4268
  entryPrice?: string | null;
4164
4269
  markPrice?: string | null;
4165
4270
  indexPrice?: string | null;
4166
4271
  unrealizedPnl?: string | null;
4167
4272
  realizedPnl?: string | null;
4168
- /** @description Current isolated collateral for this position's margin-account bucket. */
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
+ */
4169
4279
  isolatedMargin?: string | null;
4170
4280
  leverage?: string | null;
4171
4281
  /**
@@ -4192,6 +4302,21 @@ export interface components {
4192
4302
  updatedAt?: string | null;
4193
4303
  riskBucketId?: string | null;
4194
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;
4195
4320
  };
4196
4321
  GetPositionRiskResponse: {
4197
4322
  positionId?: string | null;
@@ -4280,6 +4405,26 @@ export interface components {
4280
4405
  */
4281
4406
  applicationMakerFeeBps?: number | null;
4282
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
+ };
4283
4428
  GetRewardsBalanceResponse: {
4284
4429
  /** @description One entry per reward token that has a non-zero available balance. */
4285
4430
  balances?: components["schemas"]["RewardsBalanceEntry"][] | null;
@@ -4381,6 +4526,22 @@ export interface components {
4381
4526
  * @example 8
4382
4527
  */
4383
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;
4384
4545
  };
4385
4546
  IndexComponent: {
4386
4547
  provider?: string | null;
@@ -4543,6 +4704,15 @@ export interface components {
4543
4704
  */
4544
4705
  balanceId?: string | null;
4545
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
+ };
4546
4716
  ListAppBalancesResponse: {
4547
4717
  balances?: components["schemas"]["ApplicationBalance"][] | null;
4548
4718
  /**
@@ -4739,6 +4909,22 @@ export interface components {
4739
4909
  * @example 8
4740
4910
  */
4741
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;
4742
4928
  };
4743
4929
  ListPendingWithdrawalsResponse: {
4744
4930
  withdrawals?: components["schemas"]["PendingWithdrawal"][] | null;
@@ -5097,12 +5283,23 @@ export interface components {
5097
5283
  date?: string | null;
5098
5284
  netRealizedPnl?: string | null;
5099
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
+ */
5100
5292
  PortfolioClosedTradeStats: {
5101
5293
  count?: string | null;
5102
5294
  winners?: string | null;
5103
5295
  losers?: string | null;
5104
5296
  breakEven?: string | null;
5105
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;
5106
5303
  };
5107
5304
  PortfolioMarginPositionCounts: {
5108
5305
  total?: string | null;
@@ -5222,13 +5419,23 @@ export interface components {
5222
5419
  /** Format: uuid */
5223
5420
  tradingPairId?: string | null;
5224
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
+ */
5225
5427
  size?: string | null;
5226
5428
  entryPrice?: string | null;
5227
5429
  markPrice?: string | null;
5228
5430
  indexPrice?: string | null;
5229
5431
  unrealizedPnl?: string | null;
5230
5432
  realizedPnl?: string | null;
5231
- /** @description Current isolated collateral for this position's margin-account bucket. */
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
+ */
5232
5439
  isolatedMargin?: string | null;
5233
5440
  leverage?: string | null;
5234
5441
  /**
@@ -5255,6 +5462,21 @@ export interface components {
5255
5462
  updatedAt?: string | null;
5256
5463
  riskBucketId?: string | null;
5257
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;
5258
5480
  };
5259
5481
  PositionHistoryEvent: {
5260
5482
  id?: string | null;
@@ -5408,6 +5630,58 @@ export interface components {
5408
5630
  */
5409
5631
  tradingMode?: string | null;
5410
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
+ };
5411
5685
  ReducePositionMarginRequest: {
5412
5686
  amount?: string | null;
5413
5687
  };
@@ -5589,6 +5863,16 @@ export interface components {
5589
5863
  * @example 482931
5590
5864
  */
5591
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;
5592
5876
  };
5593
5877
  /** @description One UTC-day bucket in a pair's 7-day snapshot. */
5594
5878
  ScreenerSnapshotPoint: {
@@ -6456,6 +6740,7 @@ export interface operations {
6456
6740
  query?: never;
6457
6741
  header?: never;
6458
6742
  path: {
6743
+ /** @example 1905d968-cc65-4cc7-b77c-1905d968cc65 */
6459
6744
  assetId: string;
6460
6745
  };
6461
6746
  cookie?: never;
@@ -7109,6 +7394,7 @@ export interface operations {
7109
7394
  query?: never;
7110
7395
  header?: never;
7111
7396
  path: {
7397
+ /** @example 2b1a5f9c-0000-4000-8000-000000000005 */
7112
7398
  subAccountId: string;
7113
7399
  };
7114
7400
  cookie?: never;
@@ -7159,7 +7445,9 @@ export interface operations {
7159
7445
  query?: never;
7160
7446
  header?: never;
7161
7447
  path: {
7448
+ /** @example 2b1a5f9c-0000-4000-8000-000000000005 */
7162
7449
  subAccountId: string;
7450
+ /** @example 1905d968-cc65-4cc7-b77c-1905d968cc65 */
7163
7451
  assetId: string;
7164
7452
  };
7165
7453
  cookie?: never;
@@ -7224,7 +7512,9 @@ export interface operations {
7224
7512
  };
7225
7513
  header?: never;
7226
7514
  path: {
7515
+ /** @example 2b1a5f9c-0000-4000-8000-000000000005 */
7227
7516
  subAccountId: string;
7517
+ /** @example 1905d968-cc65-4cc7-b77c-1905d968cc65 */
7228
7518
  assetId: string;
7229
7519
  };
7230
7520
  cookie?: never;
@@ -7286,6 +7576,24 @@ export interface operations {
7286
7576
  pageSize?: number;
7287
7577
  /** @description Trading pair identifier (UUID) */
7288
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;
7289
7597
  };
7290
7598
  header?: never;
7291
7599
  path?: never;
@@ -8019,6 +8327,7 @@ export interface operations {
8019
8327
  query?: never;
8020
8328
  header?: never;
8021
8329
  path: {
8330
+ /** @example 2b1a5f9c-0000-4000-8000-000000000007 */
8022
8331
  delegatedAgentId: string;
8023
8332
  };
8024
8333
  cookie?: never;
@@ -8325,7 +8634,10 @@ export interface operations {
8325
8634
  };
8326
8635
  header?: never;
8327
8636
  path: {
8328
- /** @description Margin account UUID for the current isolated bucket. */
8637
+ /**
8638
+ * @description Margin account UUID for the current isolated bucket.
8639
+ * @example 2b1a5f9c-0000-4000-8000-000000000001
8640
+ */
8329
8641
  marginAccountId: string;
8330
8642
  };
8331
8643
  cookie?: never;
@@ -8348,7 +8660,10 @@ export interface operations {
8348
8660
  query?: never;
8349
8661
  header?: never;
8350
8662
  path: {
8351
- /** @description Parent margin account UUID that receives collateral. */
8663
+ /**
8664
+ * @description Parent margin account UUID that receives collateral.
8665
+ * @example 2b1a5f9c-0000-4000-8000-000000000001
8666
+ */
8352
8667
  marginAccountId: string;
8353
8668
  };
8354
8669
  cookie?: never;
@@ -8375,7 +8690,10 @@ export interface operations {
8375
8690
  query?: never;
8376
8691
  header?: never;
8377
8692
  path: {
8378
- /** @description Parent margin account UUID that releases collateral. */
8693
+ /**
8694
+ * @description Parent margin account UUID that releases collateral.
8695
+ * @example 2b1a5f9c-0000-4000-8000-000000000001
8696
+ */
8379
8697
  marginAccountId: string;
8380
8698
  };
8381
8699
  cookie?: never;
@@ -8408,7 +8726,10 @@ export interface operations {
8408
8726
  };
8409
8727
  header?: never;
8410
8728
  path: {
8411
- /** @description Margin account UUID for the current isolated bucket. */
8729
+ /**
8730
+ * @description Margin account UUID for the current isolated bucket.
8731
+ * @example 2b1a5f9c-0000-4000-8000-000000000001
8732
+ */
8412
8733
  marginAccountId: string;
8413
8734
  };
8414
8735
  cookie?: never;
@@ -8431,7 +8752,10 @@ export interface operations {
8431
8752
  query?: never;
8432
8753
  header?: never;
8433
8754
  path: {
8434
- /** @description Margin account UUID for the isolated bucket being simulated. */
8755
+ /**
8756
+ * @description Margin account UUID for the isolated bucket being simulated.
8757
+ * @example 2b1a5f9c-0000-4000-8000-000000000001
8758
+ */
8435
8759
  marginAccountId: string;
8436
8760
  };
8437
8761
  cookie?: never;
@@ -8644,6 +8968,37 @@ export interface operations {
8644
8968
  };
8645
8969
  };
8646
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
+ };
8647
9002
  list_trading_pairs: {
8648
9003
  parameters: {
8649
9004
  query?: {
@@ -8701,7 +9056,9 @@ export interface operations {
8701
9056
  };
8702
9057
  header?: never;
8703
9058
  path: {
9059
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8704
9060
  tradingPairId: string;
9061
+ /** @example 1m */
8705
9062
  interval: string;
8706
9063
  };
8707
9064
  cookie?: never;
@@ -8745,6 +9102,7 @@ export interface operations {
8745
9102
  query?: never;
8746
9103
  header?: never;
8747
9104
  path: {
9105
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8748
9106
  tradingPairId: string;
8749
9107
  };
8750
9108
  cookie?: never;
@@ -8781,6 +9139,7 @@ export interface operations {
8781
9139
  query?: never;
8782
9140
  header?: never;
8783
9141
  path: {
9142
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8784
9143
  tradingPairId: string;
8785
9144
  };
8786
9145
  cookie?: never;
@@ -8809,9 +9168,12 @@ export interface operations {
8809
9168
  page?: number;
8810
9169
  /** @description Items per page (max 100) */
8811
9170
  pageSize?: number;
9171
+ /** @description Sort direction for createdAt */
9172
+ orderBy?: "ASC" | "DESC";
8812
9173
  };
8813
9174
  header?: never;
8814
9175
  path: {
9176
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8815
9177
  tradingPairId: string;
8816
9178
  };
8817
9179
  cookie?: never;
@@ -8834,6 +9196,7 @@ export interface operations {
8834
9196
  query?: never;
8835
9197
  header?: never;
8836
9198
  path: {
9199
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8837
9200
  tradingPairId: string;
8838
9201
  };
8839
9202
  cookie?: never;
@@ -8856,6 +9219,7 @@ export interface operations {
8856
9219
  query?: never;
8857
9220
  header?: never;
8858
9221
  path: {
9222
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8859
9223
  tradingPairId: string;
8860
9224
  };
8861
9225
  cookie?: never;
@@ -8878,6 +9242,7 @@ export interface operations {
8878
9242
  query?: never;
8879
9243
  header?: never;
8880
9244
  path: {
9245
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8881
9246
  tradingPairId: string;
8882
9247
  };
8883
9248
  cookie?: never;
@@ -8914,6 +9279,7 @@ export interface operations {
8914
9279
  query?: never;
8915
9280
  header?: never;
8916
9281
  path: {
9282
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8917
9283
  tradingPairId: string;
8918
9284
  };
8919
9285
  cookie?: never;
@@ -8950,6 +9316,7 @@ export interface operations {
8950
9316
  query?: never;
8951
9317
  header?: never;
8952
9318
  path: {
9319
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8953
9320
  tradingPairId: string;
8954
9321
  };
8955
9322
  cookie?: never;
@@ -8972,6 +9339,7 @@ export interface operations {
8972
9339
  query?: never;
8973
9340
  header?: never;
8974
9341
  path: {
9342
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
8975
9343
  tradingPairId: string;
8976
9344
  };
8977
9345
  cookie?: never;
@@ -9073,6 +9441,7 @@ export interface operations {
9073
9441
  };
9074
9442
  header?: never;
9075
9443
  path: {
9444
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
9076
9445
  tradingPairId: string;
9077
9446
  };
9078
9447
  cookie?: never;
@@ -9127,6 +9496,24 @@ export interface operations {
9127
9496
  marginAccountId?: string;
9128
9497
  /** @description Sort direction for createdAt */
9129
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;
9130
9517
  };
9131
9518
  header?: never;
9132
9519
  path?: never;
@@ -9309,6 +9696,7 @@ export interface operations {
9309
9696
  query?: never;
9310
9697
  header?: never;
9311
9698
  path: {
9699
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
9312
9700
  tradingPairId: string;
9313
9701
  };
9314
9702
  cookie?: never;
@@ -9523,6 +9911,7 @@ export interface operations {
9523
9911
  query?: never;
9524
9912
  header?: never;
9525
9913
  path: {
9914
+ /** @example 2b1a5f9c-0000-4000-8000-000000000004 */
9526
9915
  conditionalOrderId: string;
9527
9916
  };
9528
9917
  cookie?: never;
@@ -9545,6 +9934,7 @@ export interface operations {
9545
9934
  query?: never;
9546
9935
  header?: never;
9547
9936
  path: {
9937
+ /** @example 2b1a5f9c-0000-4000-8000-000000000004 */
9548
9938
  conditionalOrderId: string;
9549
9939
  };
9550
9940
  cookie?: never;
@@ -9567,6 +9957,7 @@ export interface operations {
9567
9957
  query?: never;
9568
9958
  header?: never;
9569
9959
  path: {
9960
+ /** @example 2b1a5f9c-0000-4000-8000-000000000003 */
9570
9961
  orderId: string;
9571
9962
  };
9572
9963
  cookie?: never;
@@ -9624,6 +10015,7 @@ export interface operations {
9624
10015
  query?: never;
9625
10016
  header?: never;
9626
10017
  path: {
10018
+ /** @example 2b1a5f9c-0000-4000-8000-000000000003 */
9627
10019
  orderId: string;
9628
10020
  };
9629
10021
  cookie?: never;
@@ -9712,6 +10104,7 @@ export interface operations {
9712
10104
  query?: never;
9713
10105
  header?: never;
9714
10106
  path: {
10107
+ /** @example 0x742d35cc6634c0532925a3b8d4060f31e2c3d8b5 */
9715
10108
  code: string;
9716
10109
  };
9717
10110
  cookie?: never;
@@ -9920,6 +10313,7 @@ export interface operations {
9920
10313
  query?: never;
9921
10314
  header?: never;
9922
10315
  path: {
10316
+ /** @example 2b1a5f9c-0000-4000-8000-000000000002 */
9923
10317
  positionId: string;
9924
10318
  };
9925
10319
  cookie?: never;
@@ -9942,6 +10336,7 @@ export interface operations {
9942
10336
  query?: never;
9943
10337
  header?: never;
9944
10338
  path: {
10339
+ /** @example 2b1a5f9c-0000-4000-8000-000000000002 */
9945
10340
  positionId: string;
9946
10341
  };
9947
10342
  cookie?: never;
@@ -9968,7 +10363,10 @@ export interface operations {
9968
10363
  query?: never;
9969
10364
  header?: never;
9970
10365
  path: {
9971
- /** @description Position UUID for the isolated bucket being adjusted. */
10366
+ /**
10367
+ * @description Position UUID for the isolated bucket being adjusted.
10368
+ * @example 2b1a5f9c-0000-4000-8000-000000000002
10369
+ */
9972
10370
  positionId: string;
9973
10371
  };
9974
10372
  cookie?: never;
@@ -9995,7 +10393,10 @@ export interface operations {
9995
10393
  query?: never;
9996
10394
  header?: never;
9997
10395
  path: {
9998
- /** @description Position UUID for the isolated bucket being adjusted. */
10396
+ /**
10397
+ * @description Position UUID for the isolated bucket being adjusted.
10398
+ * @example 2b1a5f9c-0000-4000-8000-000000000002
10399
+ */
9999
10400
  positionId: string;
10000
10401
  };
10001
10402
  cookie?: never;
@@ -10029,6 +10430,7 @@ export interface operations {
10029
10430
  };
10030
10431
  header?: never;
10031
10432
  path: {
10433
+ /** @example 2b1a5f9c-0000-4000-8000-000000000002 */
10032
10434
  positionId: string;
10033
10435
  };
10034
10436
  cookie?: never;
@@ -10079,6 +10481,7 @@ export interface operations {
10079
10481
  query?: never;
10080
10482
  header?: never;
10081
10483
  path: {
10484
+ /** @example 2b1a5f9c-0000-4000-8000-000000000002 */
10082
10485
  positionId: string;
10083
10486
  };
10084
10487
  cookie?: never;
@@ -10101,6 +10504,7 @@ export interface operations {
10101
10504
  query?: never;
10102
10505
  header?: never;
10103
10506
  path: {
10507
+ /** @example 2b1a5f9c-0000-4000-8000-000000000002 */
10104
10508
  positionId: string;
10105
10509
  };
10106
10510
  cookie?: never;
@@ -10122,11 +10526,39 @@ export interface operations {
10122
10526
  };
10123
10527
  };
10124
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
+ };
10125
10556
  get_trade_by_id: {
10126
10557
  parameters: {
10127
10558
  query?: never;
10128
10559
  header?: never;
10129
10560
  path: {
10561
+ /** @example 2b1a5f9c-0000-4000-8000-000000000006 */
10130
10562
  tradeId: string;
10131
10563
  };
10132
10564
  cookie?: never;
@@ -10175,6 +10607,7 @@ export interface operations {
10175
10607
  };
10176
10608
  header?: never;
10177
10609
  path: {
10610
+ /** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
10178
10611
  tradingPairId: string;
10179
10612
  };
10180
10613
  cookie?: never;
@@ -10375,6 +10808,7 @@ export interface operations {
10375
10808
  query?: never;
10376
10809
  header?: never;
10377
10810
  path: {
10811
+ /** @example 0 */
10378
10812
  withdrawalIndex: string;
10379
10813
  };
10380
10814
  cookie?: never;