@0xmonaco/types 1.0.88 → 1.0.90
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/market/index.d.ts +132 -0
- package/dist/profile/index.d.ts +49 -12
- package/dist/sdk/index.d.ts +2 -1
- package/dist/sweeper/index.d.ts +128 -2
- package/dist/trading/orders.d.ts +1 -1
- package/dist/validation/profile.d.ts +2 -0
- package/dist/validation/profile.js +2 -0
- package/dist/websocket/client.d.ts +8 -1
- package/dist/websocket/events/index.d.ts +1 -0
- package/dist/websocket/events/index.js +1 -0
- package/dist/websocket/events/market-liquidation-events.d.ts +26 -0
- package/dist/websocket/events/market-liquidation-events.js +1 -0
- package/dist/wire/operations.d.ts +1 -1
- package/dist/wire/operations.js +6 -0
- package/dist/wire/schema.d.ts +960 -35
- package/package.json +2 -2
package/dist/wire/schema.d.ts
CHANGED
|
@@ -2202,6 +2202,48 @@ export interface paths {
|
|
|
2202
2202
|
patch?: never;
|
|
2203
2203
|
trace?: never;
|
|
2204
2204
|
};
|
|
2205
|
+
"/api/v1/market/pairs/{tradingPairId}/liquidation-events": {
|
|
2206
|
+
parameters: {
|
|
2207
|
+
query?: never;
|
|
2208
|
+
header?: never;
|
|
2209
|
+
path?: never;
|
|
2210
|
+
cookie?: never;
|
|
2211
|
+
};
|
|
2212
|
+
/**
|
|
2213
|
+
* Liquidation Events
|
|
2214
|
+
* @description Stored liquidation events for one market. Wallet-addressed events are
|
|
2215
|
+
* newest-first and keyset-paged; event and side-summary reads remain
|
|
2216
|
+
* separate so clients can fetch either surface independently.
|
|
2217
|
+
*/
|
|
2218
|
+
get: operations["list_liquidation_events"];
|
|
2219
|
+
put?: never;
|
|
2220
|
+
post?: never;
|
|
2221
|
+
delete?: never;
|
|
2222
|
+
options?: never;
|
|
2223
|
+
head?: never;
|
|
2224
|
+
patch?: never;
|
|
2225
|
+
trace?: never;
|
|
2226
|
+
};
|
|
2227
|
+
"/api/v1/market/pairs/{tradingPairId}/liquidation-metrics": {
|
|
2228
|
+
parameters: {
|
|
2229
|
+
query?: never;
|
|
2230
|
+
header?: never;
|
|
2231
|
+
path?: never;
|
|
2232
|
+
cookie?: never;
|
|
2233
|
+
};
|
|
2234
|
+
/**
|
|
2235
|
+
* Liquidation Metrics
|
|
2236
|
+
* @description UTC-aligned long/short liquidation totals for a bounded market time range.
|
|
2237
|
+
*/
|
|
2238
|
+
get: operations["get_liquidation_metrics"];
|
|
2239
|
+
put?: never;
|
|
2240
|
+
post?: never;
|
|
2241
|
+
delete?: never;
|
|
2242
|
+
options?: never;
|
|
2243
|
+
head?: never;
|
|
2244
|
+
patch?: never;
|
|
2245
|
+
trace?: never;
|
|
2246
|
+
};
|
|
2205
2247
|
"/api/v1/market/pairs/{tradingPairId}/mark-price": {
|
|
2206
2248
|
parameters: {
|
|
2207
2249
|
query?: never;
|
|
@@ -2297,6 +2339,46 @@ export interface paths {
|
|
|
2297
2339
|
patch?: never;
|
|
2298
2340
|
trace?: never;
|
|
2299
2341
|
};
|
|
2342
|
+
"/api/v1/market/pairs/{tradingPairId}/trade-flow": {
|
|
2343
|
+
parameters: {
|
|
2344
|
+
query?: never;
|
|
2345
|
+
header?: never;
|
|
2346
|
+
path?: never;
|
|
2347
|
+
cookie?: never;
|
|
2348
|
+
};
|
|
2349
|
+
/**
|
|
2350
|
+
* Trade Flow
|
|
2351
|
+
* @description Bounded quote-notional taker flow and cumulative volume delta for a perp.
|
|
2352
|
+
*/
|
|
2353
|
+
get: operations["get_trade_flow"];
|
|
2354
|
+
put?: never;
|
|
2355
|
+
post?: never;
|
|
2356
|
+
delete?: never;
|
|
2357
|
+
options?: never;
|
|
2358
|
+
head?: never;
|
|
2359
|
+
patch?: never;
|
|
2360
|
+
trace?: never;
|
|
2361
|
+
};
|
|
2362
|
+
"/api/v1/market/pairs/{tradingPairId}/trader-metrics": {
|
|
2363
|
+
parameters: {
|
|
2364
|
+
query?: never;
|
|
2365
|
+
header?: never;
|
|
2366
|
+
path?: never;
|
|
2367
|
+
cookie?: never;
|
|
2368
|
+
};
|
|
2369
|
+
/**
|
|
2370
|
+
* Trader Metrics
|
|
2371
|
+
* @description Current public trader positioning and participation aggregates for a perp.
|
|
2372
|
+
*/
|
|
2373
|
+
get: operations["get_trader_metrics"];
|
|
2374
|
+
put?: never;
|
|
2375
|
+
post?: never;
|
|
2376
|
+
delete?: never;
|
|
2377
|
+
options?: never;
|
|
2378
|
+
head?: never;
|
|
2379
|
+
patch?: never;
|
|
2380
|
+
trace?: never;
|
|
2381
|
+
};
|
|
2300
2382
|
"/api/v1/market/screener": {
|
|
2301
2383
|
parameters: {
|
|
2302
2384
|
query?: never;
|
|
@@ -2969,6 +3051,85 @@ export interface paths {
|
|
|
2969
3051
|
patch?: never;
|
|
2970
3052
|
trace?: never;
|
|
2971
3053
|
};
|
|
3054
|
+
"/api/v1/sweeper/deposits": {
|
|
3055
|
+
parameters: {
|
|
3056
|
+
query?: never;
|
|
3057
|
+
header?: never;
|
|
3058
|
+
path?: never;
|
|
3059
|
+
cookie?: never;
|
|
3060
|
+
};
|
|
3061
|
+
/**
|
|
3062
|
+
* List the caller's sweeper deposits, newest first
|
|
3063
|
+
* @description The caller's sweeper deposits, newest first.
|
|
3064
|
+
*
|
|
3065
|
+
* Every transfer into one of the caller's deposit addresses, on any
|
|
3066
|
+
* supported chain, as the same `SweeperDeposit` entries
|
|
3067
|
+
* `get_sweeper_deposit_status` returns — so a client that has lost a
|
|
3068
|
+
* deposit's transaction hash can still find it and follow it. A swept CCTP
|
|
3069
|
+
* deposit is listed once, by its source-chain transfer: its hub mint is the
|
|
3070
|
+
* same deposit's second leg, not a deposit of its own. A burn made straight
|
|
3071
|
+
* to the hub deposit address has no source-chain transfer to the address,
|
|
3072
|
+
* so it is listed by its hub mint.
|
|
3073
|
+
*
|
|
3074
|
+
* Newest recorded first, walked by an opaque cursor: omit `pageToken` (or
|
|
3075
|
+
* send `""`) to start, then pass each response's `nextPageToken` until it
|
|
3076
|
+
* comes back empty. A shorter page proves the end; the token is pinned to
|
|
3077
|
+
* this listing and position-only — the caller always comes from the session.
|
|
3078
|
+
*
|
|
3079
|
+
* Authenticated: only deposits credited to the session's own address.
|
|
3080
|
+
*/
|
|
3081
|
+
get: operations["list_sweeper_deposits"];
|
|
3082
|
+
put?: never;
|
|
3083
|
+
post?: never;
|
|
3084
|
+
delete?: never;
|
|
3085
|
+
options?: never;
|
|
3086
|
+
head?: never;
|
|
3087
|
+
patch?: never;
|
|
3088
|
+
trace?: never;
|
|
3089
|
+
};
|
|
3090
|
+
"/api/v1/sweeper/deposits/{txHash}": {
|
|
3091
|
+
parameters: {
|
|
3092
|
+
query?: never;
|
|
3093
|
+
header?: never;
|
|
3094
|
+
path?: never;
|
|
3095
|
+
cookie?: never;
|
|
3096
|
+
};
|
|
3097
|
+
/**
|
|
3098
|
+
* Get the status of the caller's sweeper deposits in one transaction
|
|
3099
|
+
* @description Where the caller's sweeper deposits made by one transaction are.
|
|
3100
|
+
*
|
|
3101
|
+
* Look a deposit up by the hash of the transaction that sent funds to one of
|
|
3102
|
+
* the caller's deposit addresses, on any supported chain. One transaction
|
|
3103
|
+
* can carry several such transfers, so the answer is a list (in chain, then
|
|
3104
|
+
* log order); it is empty until the sweeper has indexed the transaction, and
|
|
3105
|
+
* never includes deposits to anyone else's address.
|
|
3106
|
+
*
|
|
3107
|
+
* Each deposit moves through `RECEIVED` (indexed; not yet swept — a balance
|
|
3108
|
+
* below the asset's minimum waits for a later deposit) and then, on the hub
|
|
3109
|
+
* chain, straight to `DEPOSITED` when the sweep lands. A deposit on another
|
|
3110
|
+
* chain is bridged by CCTP: `BURNED` (swept off the source chain),
|
|
3111
|
+
* `ATTESTING` (waiting for Circle's attestation), `ATTESTED`, `SETTLING`
|
|
3112
|
+
* (minted on the hub, being swept into the exchange) and `DEPOSITED`.
|
|
3113
|
+
* `FAILED` means the sweep returned the funds to the depositor's wallet
|
|
3114
|
+
* (`failureReason` `REFUNDED`): the exchange was paused, the user is blocked,
|
|
3115
|
+
* or the token is not accepted.
|
|
3116
|
+
*
|
|
3117
|
+
* Sweeps move balances rather than individual transfers, so a sweep that
|
|
3118
|
+
* collected several deposits is attributed to each of them first in, first
|
|
3119
|
+
* out. Deposits bridged by a route other than CCTP stay at `BURNED`.
|
|
3120
|
+
*
|
|
3121
|
+
* Authenticated: the deposits returned are those credited to the session's
|
|
3122
|
+
* own address.
|
|
3123
|
+
*/
|
|
3124
|
+
get: operations["get_sweeper_deposit_status"];
|
|
3125
|
+
put?: never;
|
|
3126
|
+
post?: never;
|
|
3127
|
+
delete?: never;
|
|
3128
|
+
options?: never;
|
|
3129
|
+
head?: never;
|
|
3130
|
+
patch?: never;
|
|
3131
|
+
trace?: never;
|
|
3132
|
+
};
|
|
2972
3133
|
"/api/v1/sweeper/register": {
|
|
2973
3134
|
parameters: {
|
|
2974
3135
|
query?: never;
|
|
@@ -3503,6 +3664,30 @@ export interface components {
|
|
|
3503
3664
|
*/
|
|
3504
3665
|
version?: number | null;
|
|
3505
3666
|
};
|
|
3667
|
+
ActiveTraderWindow: {
|
|
3668
|
+
/**
|
|
3669
|
+
* @description Rolling window ending at asOf: 1h, 24h, or 7d
|
|
3670
|
+
* @example 24h
|
|
3671
|
+
*/
|
|
3672
|
+
window?: string | null;
|
|
3673
|
+
/**
|
|
3674
|
+
* Format: int64
|
|
3675
|
+
* @description Distinct maker or taker user IDs in executed trade records in this window, including system IDs on liquidation and ADL fills; all counts are null when this window is suppressed
|
|
3676
|
+
*/
|
|
3677
|
+
activeTraderCount?: number | null;
|
|
3678
|
+
/**
|
|
3679
|
+
* Format: int64
|
|
3680
|
+
* @description Distinct taker buyer user IDs in executed trade records in this window, including system IDs on liquidation and ADL fills; all counts are null when this window is suppressed
|
|
3681
|
+
*/
|
|
3682
|
+
takerBuyerCount?: number | null;
|
|
3683
|
+
/**
|
|
3684
|
+
* Format: int64
|
|
3685
|
+
* @description Distinct taker seller user IDs in executed trade records in this window, including system IDs on liquidation and ADL fills; all counts are null when this window is suppressed
|
|
3686
|
+
*/
|
|
3687
|
+
takerSellerCount?: number | null;
|
|
3688
|
+
/** @description True when any user count in this window is below five; all counts in the window are then null */
|
|
3689
|
+
suppressed?: boolean | null;
|
|
3690
|
+
};
|
|
3506
3691
|
AddFollowPositionMarginRequest: {
|
|
3507
3692
|
/**
|
|
3508
3693
|
* Format: uuid
|
|
@@ -5045,7 +5230,7 @@ export interface components {
|
|
|
5045
5230
|
*/
|
|
5046
5231
|
useMasterBalance?: boolean | null;
|
|
5047
5232
|
/**
|
|
5048
|
-
* @description Client-assigned idempotency key (max 36 chars), unique per user and application. A duplicate is rejected with 409.
|
|
5233
|
+
* @description Client-assigned idempotency key (max 36 chars), unique per user and application while the parent is live and for a reservation lifetime after it ends (30 days by default, operator-configurable). A duplicate inside that window is rejected with 409; after it the key may be used again.
|
|
5049
5234
|
* @example oms-3f6a1c
|
|
5050
5235
|
*/
|
|
5051
5236
|
clientTwapId?: string | null;
|
|
@@ -5726,6 +5911,10 @@ export interface components {
|
|
|
5726
5911
|
*/
|
|
5727
5912
|
clientId?: string | null;
|
|
5728
5913
|
};
|
|
5914
|
+
GetDepositStatusResponse: {
|
|
5915
|
+
/** @description The caller's deposits made by the transaction, in chain then log order; empty until the sweeper has indexed it */
|
|
5916
|
+
deposits?: components["schemas"]["SweeperDeposit"][] | null;
|
|
5917
|
+
};
|
|
5729
5918
|
GetFaucetInfoResponse: {
|
|
5730
5919
|
/**
|
|
5731
5920
|
* Format: uint32
|
|
@@ -5807,6 +5996,36 @@ export interface components {
|
|
|
5807
5996
|
GetLimitsResponse: {
|
|
5808
5997
|
limits?: components["schemas"]["SubAccountLimit"][] | null;
|
|
5809
5998
|
};
|
|
5999
|
+
/** @description Populated UTC-aligned buckets of long/short liquidation totals. Buckets with no events on either side are omitted. */
|
|
6000
|
+
GetLiquidationMetricsResponse: {
|
|
6001
|
+
/**
|
|
6002
|
+
* Format: uuid
|
|
6003
|
+
* @description Trading pair UUID
|
|
6004
|
+
*/
|
|
6005
|
+
tradingPairId?: string | null;
|
|
6006
|
+
/**
|
|
6007
|
+
* @description Quote asset denomination for mark notionals; no USD FX conversion
|
|
6008
|
+
* @example USDC
|
|
6009
|
+
*/
|
|
6010
|
+
quoteAssetSymbol?: string | null;
|
|
6011
|
+
/**
|
|
6012
|
+
* @description UTC-aligned bucket size
|
|
6013
|
+
* @example 5m
|
|
6014
|
+
*/
|
|
6015
|
+
interval?: string | null;
|
|
6016
|
+
/**
|
|
6017
|
+
* Format: int64
|
|
6018
|
+
* @description Inclusive selected range start as Unix milliseconds
|
|
6019
|
+
*/
|
|
6020
|
+
startTime?: number | null;
|
|
6021
|
+
/**
|
|
6022
|
+
* Format: int64
|
|
6023
|
+
* @description Exclusive selected range end as Unix milliseconds
|
|
6024
|
+
*/
|
|
6025
|
+
endTime?: number | null;
|
|
6026
|
+
/** @description Populated UTC-aligned buckets; intervals with no events are omitted. */
|
|
6027
|
+
buckets?: components["schemas"]["LiquidationMetricsBucket"][] | null;
|
|
6028
|
+
};
|
|
5810
6029
|
GetMarginAccountMovementsResponse: {
|
|
5811
6030
|
movements?: components["schemas"]["MarginAccountMovement"][] | null;
|
|
5812
6031
|
/** Format: uint32 */
|
|
@@ -6400,7 +6619,7 @@ export interface components {
|
|
|
6400
6619
|
postOnly?: boolean | null;
|
|
6401
6620
|
/**
|
|
6402
6621
|
* Format: int64
|
|
6403
|
-
* @description Opaque, compare-only revision counter for this order's state: the sequencer step that wrote it. A strictly higher value is strictly newer state for that order. The SAME counter is carried on every order WebSocket event and on the `orders` snapshot frame, so a reconnecting client reconciles on `(id, version)` — take the REST row when `snapshot.version >= local.version`, else keep local state. Note `>=`, not `>`: on the stream, equal versions mean the SAME STEP rather than identical state, because one step emits several events for one order (an `OrderPlaced` and then its fills) and a batch shares one step across every item. A REST row is that step's FINAL state, so it wins a tie. Between two REST reads the comparison is simpler — equal there does mean identical state. Do not read anything else into the number: it is not a count of updates, consecutive values are not expected (it is drawn from a global sequence shared by every order, so per-order values are sparse and gaps are normal), and it is not comparable across different orders. Absent means unknown: an order last written before this field existed. Fall back to a full field comparison for those rather than treating absent as version zero — and note that a comparison against an absent value is false in both directions, so an order held locally without one is never refreshed by the merge above; take the REST row unconditionally for those. Reconciling on this counter does NOT on its own close a reconnect gap: an order that filled or was cancelled while the socket was down appears in neither the resting snapshot nor the stream, so recover fills from `
|
|
6622
|
+
* @description Opaque, compare-only revision counter for this order's state: the sequencer step that wrote it. A strictly higher value is strictly newer state for that order. The SAME counter is carried on every order WebSocket event and on the `orders` snapshot frame, so a reconnecting client reconciles on `(id, version)` — take the REST row when `snapshot.version >= local.version`, else keep local state. Note `>=`, not `>`: on the stream, equal versions mean the SAME STEP rather than identical state, because one step emits several events for one order (an `OrderPlaced` and then its fills) and a batch shares one step across every item. A REST row is that step's FINAL state, so it wins a tie. Between two REST reads the comparison is simpler — equal there does mean identical state. Do not read anything else into the number: it is not a count of updates, consecutive values are not expected (it is drawn from a global sequence shared by every order, so per-order values are sparse and gaps are normal), and it is not comparable across different orders. Absent means unknown: an order last written before this field existed. Fall back to a full field comparison for those rather than treating absent as version zero — and note that a comparison against an absent value is false in both directions, so an order held locally without one is never refreshed by the merge above; take the REST row unconditionally for those. Reconciling on this counter does NOT on its own close a reconnect gap: an order that filled or was cancelled while the socket was down appears in neither the resting snapshot nor the stream, so recover fills from `getUserTrades` (`GET /api/v1/accounts/trades`, newest first) and resolve anything your local state believes is resting that the snapshot no longer lists with a targeted `getOrder`. Unlike `updatedAt`, this value is identical on every REST endpoint that serves the same order state, and never advances without a state change.
|
|
6404
6623
|
* @example 918342
|
|
6405
6624
|
*/
|
|
6406
6625
|
version?: number | null;
|
|
@@ -6505,6 +6724,11 @@ export interface components {
|
|
|
6505
6724
|
/** @description The market's full margin ladder, ascending by lowerBoundNotional and always non-empty (a market with no configured brackets reports a single tier). A position's bracket is the LAST tier whose lowerBoundNotional is at or below its notional, abs(quantity) x markPrice. */
|
|
6506
6725
|
riskTiers?: components["schemas"]["RiskTier"][] | null;
|
|
6507
6726
|
updatedAt?: string | null;
|
|
6727
|
+
/**
|
|
6728
|
+
* @description Quote notional Q_m that each funding premium sample walks through each side of the book to read the market's impact bid and impact ask. Set per market; markets start at 2000.
|
|
6729
|
+
* @example 2000
|
|
6730
|
+
*/
|
|
6731
|
+
fundingImpactNotional?: string | null;
|
|
6508
6732
|
};
|
|
6509
6733
|
GetPerpMarketSummaryResponse: {
|
|
6510
6734
|
/** Format: uuid */
|
|
@@ -7061,6 +7285,36 @@ export interface components {
|
|
|
7061
7285
|
*/
|
|
7062
7286
|
tradingMode?: string | null;
|
|
7063
7287
|
};
|
|
7288
|
+
/** @description Taker buy/sell quote notional, net flow and cumulative volume delta for a bounded time range. All executed trades, including liquidation and ADL fills, are included. Empty buckets are omitted. Buckets that closed more than two minutes before the request may be served from a per-replica cache for up to ten minutes. */
|
|
7289
|
+
GetTradeFlowResponse: {
|
|
7290
|
+
/**
|
|
7291
|
+
* Format: uuid
|
|
7292
|
+
* @description Trading pair UUID
|
|
7293
|
+
*/
|
|
7294
|
+
tradingPairId?: string | null;
|
|
7295
|
+
/**
|
|
7296
|
+
* @description Quote asset used for all notional values, with no USD conversion
|
|
7297
|
+
* @example USDC
|
|
7298
|
+
*/
|
|
7299
|
+
quoteAssetSymbol?: string | null;
|
|
7300
|
+
/**
|
|
7301
|
+
* @description UTC-aligned bucket size
|
|
7302
|
+
* @example 5m
|
|
7303
|
+
*/
|
|
7304
|
+
interval?: string | null;
|
|
7305
|
+
/**
|
|
7306
|
+
* Format: int64
|
|
7307
|
+
* @description Inclusive selected start time as Unix milliseconds
|
|
7308
|
+
*/
|
|
7309
|
+
startTime?: number | null;
|
|
7310
|
+
/**
|
|
7311
|
+
* Format: int64
|
|
7312
|
+
* @description Exclusive selected end time as Unix milliseconds
|
|
7313
|
+
*/
|
|
7314
|
+
endTime?: number | null;
|
|
7315
|
+
/** @description Populated UTC-aligned buckets; intervals without trades are omitted. */
|
|
7316
|
+
buckets?: components["schemas"]["TradeFlowBucket"][] | null;
|
|
7317
|
+
};
|
|
7064
7318
|
GetTraderCodeInfoResponse: {
|
|
7065
7319
|
/**
|
|
7066
7320
|
* @description The resolved TraderCode (normalized wallet address)
|
|
@@ -7068,6 +7322,45 @@ export interface components {
|
|
|
7068
7322
|
*/
|
|
7069
7323
|
code?: string | null;
|
|
7070
7324
|
};
|
|
7325
|
+
/** @description Current public long/short account positioning and active trader aggregates. Accounts are classified by net position across OPEN risk buckets. Account identifiers are never returned; position metrics are null when either side has fewer than five accounts. Responses may be reused from a per-pair cache for up to 30 seconds. */
|
|
7326
|
+
GetTraderMetricsResponse: {
|
|
7327
|
+
/**
|
|
7328
|
+
* Format: uuid
|
|
7329
|
+
* @description Trading pair UUID
|
|
7330
|
+
*/
|
|
7331
|
+
tradingPairId?: string | null;
|
|
7332
|
+
/**
|
|
7333
|
+
* @description Quote asset symbol for this trading pair
|
|
7334
|
+
* @example USDC
|
|
7335
|
+
*/
|
|
7336
|
+
quoteAssetSymbol?: string | null;
|
|
7337
|
+
/**
|
|
7338
|
+
* Format: int64
|
|
7339
|
+
* @description Snapshot calculation time in Unix milliseconds
|
|
7340
|
+
* @example 1736742000000
|
|
7341
|
+
*/
|
|
7342
|
+
asOf?: number | null;
|
|
7343
|
+
/** @description True when either net-long or net-short side has fewer than five margin accounts; all position split fields are then null */
|
|
7344
|
+
positionMetricsSuppressed?: boolean | null;
|
|
7345
|
+
/**
|
|
7346
|
+
* Format: int64
|
|
7347
|
+
* @description Distinct margin accounts with positive net position across OPEN risk buckets; null when suppressed
|
|
7348
|
+
*/
|
|
7349
|
+
longAccountCount?: number | null;
|
|
7350
|
+
/**
|
|
7351
|
+
* Format: int64
|
|
7352
|
+
* @description Distinct margin accounts with negative net position across OPEN risk buckets; null when suppressed
|
|
7353
|
+
*/
|
|
7354
|
+
shortAccountCount?: number | null;
|
|
7355
|
+
/** @description Long account count divided by long plus short account counts, rounded to six decimal places; null when suppressed */
|
|
7356
|
+
longAccountShare?: string | null;
|
|
7357
|
+
/** @description Short account count divided by long plus short account counts, rounded to six decimal places; null when suppressed */
|
|
7358
|
+
shortAccountShare?: string | null;
|
|
7359
|
+
/** @description Net-long account count divided by net-short account count, rounded to six decimal places; null when suppressed */
|
|
7360
|
+
accountRatio?: string | null;
|
|
7361
|
+
/** @description Active-trader counts grouped by rolling time window. */
|
|
7362
|
+
activeTraderWindows?: components["schemas"]["ActiveTraderWindow"][] | null;
|
|
7363
|
+
};
|
|
7071
7364
|
/** @description Recent trades for a trading pair. */
|
|
7072
7365
|
GetTradesResponse: {
|
|
7073
7366
|
trades?: components["schemas"]["PublicTrade"][] | null;
|
|
@@ -7552,6 +7845,86 @@ export interface components {
|
|
|
7552
7845
|
*/
|
|
7553
7846
|
earned?: string | null;
|
|
7554
7847
|
};
|
|
7848
|
+
/** @description One public per-position liquidation event. markNotional is positionSize multiplied by the mark price captured with the event, in quote-asset units. */
|
|
7849
|
+
LiquidationEvent: {
|
|
7850
|
+
/**
|
|
7851
|
+
* Format: uuid
|
|
7852
|
+
* @description Stable identifier of the stored liquidation event; use it to deduplicate REST backfills and WebSocket updates
|
|
7853
|
+
*/
|
|
7854
|
+
eventId?: string | null;
|
|
7855
|
+
/**
|
|
7856
|
+
* Format: int64
|
|
7857
|
+
* @description Event time as Unix milliseconds
|
|
7858
|
+
* @example 1736742000123
|
|
7859
|
+
*/
|
|
7860
|
+
timestamp?: number | null;
|
|
7861
|
+
/**
|
|
7862
|
+
* Format: uuid
|
|
7863
|
+
* @description Trading pair UUID
|
|
7864
|
+
*/
|
|
7865
|
+
tradingPairId?: string | null;
|
|
7866
|
+
/**
|
|
7867
|
+
* @description Public wallet address associated with the liquidated position
|
|
7868
|
+
* @example 0x1234567890abcdef1234567890abcdef12345678
|
|
7869
|
+
*/
|
|
7870
|
+
wallet?: string | null;
|
|
7871
|
+
/**
|
|
7872
|
+
* @description Liquidated position side: LONG or SHORT
|
|
7873
|
+
* @example LONG
|
|
7874
|
+
* @enum {string|null}
|
|
7875
|
+
*/
|
|
7876
|
+
side?: "LONG" | "SHORT" | null;
|
|
7877
|
+
/**
|
|
7878
|
+
* @description Absolute position size in base-asset units
|
|
7879
|
+
* @example 0.25
|
|
7880
|
+
*/
|
|
7881
|
+
positionSize?: string | null;
|
|
7882
|
+
/**
|
|
7883
|
+
* @description Mark price captured for this event, in quote units per base unit
|
|
7884
|
+
* @example 95410.25
|
|
7885
|
+
*/
|
|
7886
|
+
markPrice?: string | null;
|
|
7887
|
+
/**
|
|
7888
|
+
* @description Position size multiplied by the event-time mark price, in quote-asset units; no USD FX conversion
|
|
7889
|
+
* @example 23852.5625
|
|
7890
|
+
*/
|
|
7891
|
+
markNotional?: string | null;
|
|
7892
|
+
/**
|
|
7893
|
+
* @description Quote asset denomination of markNotional
|
|
7894
|
+
* @example USDC
|
|
7895
|
+
*/
|
|
7896
|
+
quoteAssetSymbol?: string | null;
|
|
7897
|
+
};
|
|
7898
|
+
LiquidationMetricsBucket: {
|
|
7899
|
+
/**
|
|
7900
|
+
* Format: int64
|
|
7901
|
+
* @description UTC-aligned bucket start as Unix milliseconds
|
|
7902
|
+
* @example 1736742000000
|
|
7903
|
+
*/
|
|
7904
|
+
bucketStart?: number | null;
|
|
7905
|
+
/** @description Long-side totals; zero-valued when the bucket has no long-side events */
|
|
7906
|
+
long?: components["schemas"]["LiquidationSideMetrics"] | null;
|
|
7907
|
+
/** @description Short-side totals; zero-valued when the bucket has no short-side events */
|
|
7908
|
+
short?: components["schemas"]["LiquidationSideMetrics"] | null;
|
|
7909
|
+
};
|
|
7910
|
+
LiquidationSideMetrics: {
|
|
7911
|
+
/**
|
|
7912
|
+
* Format: int64
|
|
7913
|
+
* @description Number of stored liquidation-event rows for this position side in the bucket; not a unique-wallet count
|
|
7914
|
+
* @example 12
|
|
7915
|
+
*/
|
|
7916
|
+
eventCount?: number | null;
|
|
7917
|
+
/**
|
|
7918
|
+
* @description Sum of event position sizes in base-asset units
|
|
7919
|
+
* @example 3.75
|
|
7920
|
+
*/
|
|
7921
|
+
positionSize?: string | null;
|
|
7922
|
+
/**
|
|
7923
|
+
* @description Sum of each event's positionSize multiplied by its event-time markPrice, in quote-asset units
|
|
7924
|
+
* @example 358163.4375
|
|
7925
|
+
*/
|
|
7926
|
+
markNotional?: string | null;
|
|
7927
|
+
};
|
|
7555
7928
|
ListAllFundingHistoryResponse: {
|
|
7556
7929
|
records?: components["schemas"]["FundingRecord"][] | null;
|
|
7557
7930
|
/**
|
|
@@ -7729,6 +8102,12 @@ export interface components {
|
|
|
7729
8102
|
/** @description The calling owner's delegated agents */
|
|
7730
8103
|
agents?: components["schemas"]["DelegatedAgent"][] | null;
|
|
7731
8104
|
};
|
|
8105
|
+
ListDepositsResponse: {
|
|
8106
|
+
/** @description This page of the caller's deposits, newest recorded first */
|
|
8107
|
+
deposits?: components["schemas"]["SweeperDeposit"][] | null;
|
|
8108
|
+
/** @description Cursor for the next page; empty when this page is the last */
|
|
8109
|
+
nextPageToken?: string | null;
|
|
8110
|
+
};
|
|
7732
8111
|
ListFollowLeaderPositionsResponse: {
|
|
7733
8112
|
positions?: components["schemas"]["LeadTraderOpenPosition"][] | null;
|
|
7734
8113
|
};
|
|
@@ -7828,6 +8207,23 @@ export interface components {
|
|
|
7828
8207
|
/** @description Time of the leaderboard snapshot these rows come from (RFC 3339) */
|
|
7829
8208
|
asOf?: string | null;
|
|
7830
8209
|
};
|
|
8210
|
+
ListLiquidationEventsResponse: {
|
|
8211
|
+
/**
|
|
8212
|
+
* Format: uuid
|
|
8213
|
+
* @description Trading pair UUID
|
|
8214
|
+
*/
|
|
8215
|
+
tradingPairId?: string | null;
|
|
8216
|
+
/** @description Events in reverse chronological order (newest first). Each row contains only public event fields. */
|
|
8217
|
+
events?: components["schemas"]["LiquidationEvent"][] | null;
|
|
8218
|
+
/**
|
|
8219
|
+
* Format: uint32
|
|
8220
|
+
* @description Number of events requested for this page
|
|
8221
|
+
* @example 50
|
|
8222
|
+
*/
|
|
8223
|
+
pageSize?: number | null;
|
|
8224
|
+
/** @description Opaque cursor for the next page; empty when the page is the end of the ordered result */
|
|
8225
|
+
nextPageToken?: string | null;
|
|
8226
|
+
};
|
|
7831
8227
|
ListManagedMarketAssignmentsResponse: {
|
|
7832
8228
|
/** @description Expected assignments, including phases currently unable to quote. */
|
|
7833
8229
|
items?: components["schemas"]["ManagedMarketAssignment"][] | null;
|
|
@@ -10375,23 +10771,100 @@ export interface components {
|
|
|
10375
10771
|
*/
|
|
10376
10772
|
minSweepRaw?: string | null;
|
|
10377
10773
|
};
|
|
10378
|
-
|
|
10379
|
-
|
|
10380
|
-
|
|
10381
|
-
|
|
10382
|
-
|
|
10383
|
-
|
|
10384
|
-
/**
|
|
10385
|
-
|
|
10386
|
-
expiresAt?: string | null;
|
|
10774
|
+
/**
|
|
10775
|
+
* @description One transfer into one of the caller's deposit addresses, and how far it has
|
|
10776
|
+
* got. Amounts are raw base units of the token on the source chain.
|
|
10777
|
+
* Timestamps are RFC3339 and record when the sweeper observed each step.
|
|
10778
|
+
*/
|
|
10779
|
+
SweeperDeposit: {
|
|
10780
|
+
/** @description The deposit transaction's hash, lowercase */
|
|
10781
|
+
txHash?: string | null;
|
|
10387
10782
|
/**
|
|
10388
|
-
*
|
|
10389
|
-
*
|
|
10390
|
-
*
|
|
10391
|
-
|
|
10392
|
-
|
|
10393
|
-
|
|
10394
|
-
*
|
|
10783
|
+
* Format: int64
|
|
10784
|
+
* @description EVM chain id the deposit was made on, as listed by `get_sweeper_chains`
|
|
10785
|
+
* @example 8453
|
|
10786
|
+
*/
|
|
10787
|
+
sourceChainId?: number | null;
|
|
10788
|
+
/**
|
|
10789
|
+
* Format: uint32
|
|
10790
|
+
* @description The source chain's CCTP domain, once the deposit's CCTP burn is known; absent for hub deposits and before then
|
|
10791
|
+
* @example 6
|
|
10792
|
+
*/
|
|
10793
|
+
sourceDomain?: number | null;
|
|
10794
|
+
/** @description The address the deposit is credited to (the caller's own), lowercase */
|
|
10795
|
+
beneficiary?: string | null;
|
|
10796
|
+
/** @description Client id of the application the deposit address was registered under */
|
|
10797
|
+
clientId?: string | null;
|
|
10798
|
+
/**
|
|
10799
|
+
* @description The ledger the deposit address asks to be credited to
|
|
10800
|
+
* @enum {string|null}
|
|
10801
|
+
*/
|
|
10802
|
+
depositTarget?: "SPOT" | "MARGIN" | null;
|
|
10803
|
+
/** @description The deposited token's address on the source chain, lowercase */
|
|
10804
|
+
token?: string | null;
|
|
10805
|
+
/**
|
|
10806
|
+
* @description Amount deposited, raw base units of `token`
|
|
10807
|
+
* @example 5000000
|
|
10808
|
+
*/
|
|
10809
|
+
amountRaw?: string | null;
|
|
10810
|
+
/**
|
|
10811
|
+
* @description Amount credited to the exchange, once `DEPOSITED`. Absent when one CCTP burn carried several deposits (its fee cannot be split between them)
|
|
10812
|
+
* @example 4999000
|
|
10813
|
+
*/
|
|
10814
|
+
creditedAmountRaw?: string | null;
|
|
10815
|
+
/**
|
|
10816
|
+
* @description `amountRaw` minus `creditedAmountRaw` (Circle's fast-lane fee for a CCTP deposit, 0 on the hub); absent whenever `creditedAmountRaw` is
|
|
10817
|
+
* @example 1000
|
|
10818
|
+
*/
|
|
10819
|
+
feeChargedRaw?: string | null;
|
|
10820
|
+
/**
|
|
10821
|
+
* @description The CCTP lane the burn requested, once the burn is known; absent for hub deposits
|
|
10822
|
+
* @enum {string|null}
|
|
10823
|
+
*/
|
|
10824
|
+
transferType?: "FAST" | "STANDARD" | null;
|
|
10825
|
+
/**
|
|
10826
|
+
* @description Where the deposit is; see the operation description
|
|
10827
|
+
* @example ATTESTING
|
|
10828
|
+
* @enum {string|null}
|
|
10829
|
+
*/
|
|
10830
|
+
status?: "RECEIVED" | "BURNED" | "ATTESTING" | "ATTESTED" | "SETTLING" | "DEPOSITED" | "FAILED" | null;
|
|
10831
|
+
/**
|
|
10832
|
+
* @description Why the deposit `FAILED`
|
|
10833
|
+
* @enum {string|null}
|
|
10834
|
+
*/
|
|
10835
|
+
failureReason?: "REFUNDED" | null;
|
|
10836
|
+
/** @description The source-chain transaction that swept the deposit (the CCTP burn for a remote deposit), once swept */
|
|
10837
|
+
sweepTx?: string | null;
|
|
10838
|
+
/** @description The hub transaction that deposited the funds into the exchange, once `DEPOSITED` (the sweep itself for a hub deposit) */
|
|
10839
|
+
settleTx?: string | null;
|
|
10840
|
+
/** @description When Circle's attestation was first seen */
|
|
10841
|
+
attestedAt?: string | null;
|
|
10842
|
+
/** @description When the deposit was seen `DEPOSITED` */
|
|
10843
|
+
settledAt?: string | null;
|
|
10844
|
+
/** @description When the deposit was seen `FAILED` */
|
|
10845
|
+
failedAt?: string | null;
|
|
10846
|
+
/** @description When the sweeper indexed the deposit */
|
|
10847
|
+
createdAt?: string | null;
|
|
10848
|
+
/** @description When the sweeper last observed progress on the deposit */
|
|
10849
|
+
updatedAt?: string | null;
|
|
10850
|
+
};
|
|
10851
|
+
TpSlLeg: {
|
|
10852
|
+
triggerPrice?: string | null;
|
|
10853
|
+
orderType?: string | null;
|
|
10854
|
+
limitPrice?: string | null;
|
|
10855
|
+
quantity?: string | null;
|
|
10856
|
+
timeInForce?: string | null;
|
|
10857
|
+
/** Format: int32 */
|
|
10858
|
+
slippageToleranceBps?: number | null;
|
|
10859
|
+
expiresAt?: string | null;
|
|
10860
|
+
/**
|
|
10861
|
+
* @description Resolve the full live position size when triggered. Mutually exclusive
|
|
10862
|
+
* with quantity. For compatibility, omitting both quantity and this field
|
|
10863
|
+
* also means full-position close.
|
|
10864
|
+
*
|
|
10865
|
+
* Attaching a full-close leg to a position SUPERSEDES that position's
|
|
10866
|
+
* previously active full-close legs of the same condition type: they are
|
|
10867
|
+
* cancelled in the same engine step that creates the replacement, so moving
|
|
10395
10868
|
* a take-profit or stop-loss is one call with no window in which the
|
|
10396
10869
|
* position holds both levels or neither. Fixed-quantity legs never
|
|
10397
10870
|
* participate — laddered partial exits stack — and a superseded leg's
|
|
@@ -10437,6 +10910,28 @@ export interface components {
|
|
|
10437
10910
|
*/
|
|
10438
10911
|
tradeId?: string | null;
|
|
10439
10912
|
};
|
|
10913
|
+
TradeFlowBucket: {
|
|
10914
|
+
/**
|
|
10915
|
+
* Format: int64
|
|
10916
|
+
* @description UTC-aligned bucket start as Unix milliseconds
|
|
10917
|
+
*/
|
|
10918
|
+
bucketStart?: number | null;
|
|
10919
|
+
/** @description Executed quote notional where maker side was SELL, in quote-asset units */
|
|
10920
|
+
takerBuyNotional?: string | null;
|
|
10921
|
+
/** @description Executed quote notional where maker side was BUY, in quote-asset units */
|
|
10922
|
+
takerSellNotional?: string | null;
|
|
10923
|
+
/** @description Taker buy notional divided by taker sell notional, rounded to six decimal places; null when sell notional is zero */
|
|
10924
|
+
buySellRatio?: string | null;
|
|
10925
|
+
/** @description Taker buy notional minus taker sell notional, in quote-asset units */
|
|
10926
|
+
netNotional?: string | null;
|
|
10927
|
+
/** @description Cumulative net notional from the selected range start through this bucket, in quote-asset units */
|
|
10928
|
+
cumulativeVolumeDelta?: string | null;
|
|
10929
|
+
/**
|
|
10930
|
+
* Format: int64
|
|
10931
|
+
* @description Number of executed trades in this bucket
|
|
10932
|
+
*/
|
|
10933
|
+
tradeCount?: number | null;
|
|
10934
|
+
};
|
|
10440
10935
|
TraderCodeResponse: {
|
|
10441
10936
|
/**
|
|
10442
10937
|
* @description Your TraderCode — your normalized wallet address (clients render it `Monaco - <address>`). Always present; the permanent reward identity and a public alias even when a custom handle is set.
|
|
@@ -11280,33 +11775,120 @@ export interface components {
|
|
|
11280
11775
|
username?: string | null;
|
|
11281
11776
|
};
|
|
11282
11777
|
UserTrade: {
|
|
11778
|
+
/**
|
|
11779
|
+
* Format: uuid
|
|
11780
|
+
* @description Trade UUID
|
|
11781
|
+
* @example 123e4567-e89b-12d3-a456-426614174000
|
|
11782
|
+
*/
|
|
11283
11783
|
tradeId?: string | null;
|
|
11284
|
-
/**
|
|
11285
|
-
|
|
11286
|
-
|
|
11287
|
-
|
|
11784
|
+
/**
|
|
11785
|
+
* Format: uuid
|
|
11786
|
+
* @description Trading pair UUID
|
|
11787
|
+
* @example 456e7890-e12b-12d3-a456-426614174000
|
|
11788
|
+
*/
|
|
11288
11789
|
tradingPairId?: string | null;
|
|
11289
|
-
|
|
11790
|
+
/**
|
|
11791
|
+
* @description Execution price
|
|
11792
|
+
* @example 35000.00
|
|
11793
|
+
*/
|
|
11290
11794
|
price?: string | null;
|
|
11795
|
+
/**
|
|
11796
|
+
* @description Traded quantity
|
|
11797
|
+
* @example 0.5
|
|
11798
|
+
*/
|
|
11291
11799
|
quantity?: string | null;
|
|
11292
|
-
liquidityRole?: string | null;
|
|
11293
11800
|
/**
|
|
11294
|
-
* @description
|
|
11295
|
-
*
|
|
11296
|
-
|
|
11297
|
-
|
|
11801
|
+
* @description Quote volume (price * quantity)
|
|
11802
|
+
* @example 17500.00
|
|
11803
|
+
*/
|
|
11804
|
+
quoteVolume?: string | null;
|
|
11805
|
+
/**
|
|
11806
|
+
* @description User's side: Buy or Sell
|
|
11807
|
+
* @example Buy
|
|
11808
|
+
*/
|
|
11809
|
+
side?: string | null;
|
|
11810
|
+
/**
|
|
11811
|
+
* @description Total fee paid by this user for this trade. For a taker this is Monaco's taker fee plus the frontend's builder fee; for a maker it is the maker fee (negative for a rebate) plus the frontend's maker add-on. Equals `monacoFee + builderFee`.
|
|
11812
|
+
* @example 0.875
|
|
11298
11813
|
*/
|
|
11299
11814
|
fee?: string | null;
|
|
11300
|
-
|
|
11301
|
-
|
|
11302
|
-
|
|
11815
|
+
/**
|
|
11816
|
+
* @description Token address of the fee
|
|
11817
|
+
* @example 0x6a86da986797d59a839d136db490292cd560c131
|
|
11818
|
+
*/
|
|
11819
|
+
feeToken?: string | null;
|
|
11820
|
+
/**
|
|
11821
|
+
* @description Trade execution timestamp (RFC3339 with +00:00 offset)
|
|
11822
|
+
* @example 2023-11-13T10:30:00+00:00
|
|
11823
|
+
*/
|
|
11824
|
+
executedAt?: string | null;
|
|
11825
|
+
/**
|
|
11826
|
+
* @description Trading mode: SPOT or MARGIN
|
|
11827
|
+
* @example SPOT
|
|
11828
|
+
*/
|
|
11829
|
+
tradingMode?: string | null;
|
|
11830
|
+
/**
|
|
11831
|
+
* Format: uuid
|
|
11832
|
+
* @description Maker order UUID
|
|
11833
|
+
* @example 123e4567-e89b-12d3-a456-426614174000
|
|
11834
|
+
*/
|
|
11835
|
+
makerOrderId?: string | null;
|
|
11836
|
+
/**
|
|
11837
|
+
* Format: uuid
|
|
11838
|
+
* @description Taker order UUID
|
|
11839
|
+
* @example 456e7890-e12b-12d3-a456-426614174000
|
|
11840
|
+
*/
|
|
11841
|
+
takerOrderId?: string | null;
|
|
11842
|
+
/**
|
|
11843
|
+
* @description Traded quantity in smallest base-token unit
|
|
11844
|
+
* @example 500000000000000000
|
|
11845
|
+
*/
|
|
11846
|
+
quantityRaw?: string | null;
|
|
11847
|
+
/**
|
|
11848
|
+
* @description Quote volume in smallest quote-token unit
|
|
11849
|
+
* @example 17500000000
|
|
11850
|
+
*/
|
|
11851
|
+
quoteVolumeRaw?: string | null;
|
|
11852
|
+
/**
|
|
11853
|
+
* @description Total fee (`fee`) in smallest quote-token unit. Equals `monacoFeeRaw + builderFeeRaw`.
|
|
11854
|
+
* @example 875000
|
|
11855
|
+
*/
|
|
11856
|
+
feeRaw?: string | null;
|
|
11857
|
+
/**
|
|
11858
|
+
* @description Settlement status: PENDING, SETTLED, or FAILED
|
|
11859
|
+
* @example SETTLED
|
|
11860
|
+
*/
|
|
11861
|
+
settlementStatus?: string | null;
|
|
11862
|
+
/**
|
|
11863
|
+
* @description On-chain settlement transaction hash
|
|
11864
|
+
* @example 0xabc123
|
|
11865
|
+
*/
|
|
11866
|
+
settlementTxHash?: string | null;
|
|
11867
|
+
/**
|
|
11868
|
+
* @description Monaco's component of `fee`
|
|
11869
|
+
* @example 0.875
|
|
11870
|
+
*/
|
|
11303
11871
|
monacoFee?: string | null;
|
|
11304
11872
|
/**
|
|
11305
|
-
* @description
|
|
11306
|
-
*
|
|
11307
|
-
|
|
11873
|
+
* @description Monaco's component of `feeRaw`, in smallest quote-token unit
|
|
11874
|
+
* @example 875000
|
|
11875
|
+
*/
|
|
11876
|
+
monacoFeeRaw?: string | null;
|
|
11877
|
+
/**
|
|
11878
|
+
* @description The frontend's builder fee component of `fee`: for a taker, the builder fee its frontend charged; for a maker, the maker add-on its frontend charged at the rate the order stored when it was placed. "0" when the frontend charges none.
|
|
11879
|
+
* @example 0
|
|
11308
11880
|
*/
|
|
11309
11881
|
builderFee?: string | null;
|
|
11882
|
+
/**
|
|
11883
|
+
* @description The frontend's builder fee component of `feeRaw`, in smallest quote-token unit
|
|
11884
|
+
* @example 0
|
|
11885
|
+
*/
|
|
11886
|
+
builderFeeRaw?: string | null;
|
|
11887
|
+
/**
|
|
11888
|
+
* @description This user's role in the fill: MAKER or TAKER. A self-trade reads as MAKER.
|
|
11889
|
+
* @example TAKER
|
|
11890
|
+
*/
|
|
11891
|
+
liquidityRole?: string | null;
|
|
11310
11892
|
};
|
|
11311
11893
|
VerifyRequest: {
|
|
11312
11894
|
/**
|
|
@@ -12560,6 +13142,21 @@ export interface operations {
|
|
|
12560
13142
|
* that produced the token.
|
|
12561
13143
|
*/
|
|
12562
13144
|
pageToken?: string;
|
|
13145
|
+
/**
|
|
13146
|
+
* @description Optional margin account UUID filter: only trades where this user's side of
|
|
13147
|
+
* the fill was placed from this margin account. A self-trade is read as its
|
|
13148
|
+
* maker side, so it matches through its maker order's account. Like
|
|
13149
|
+
* `trading_pair_id`, a filtered response carries no `total`, and the filter
|
|
13150
|
+
* must match the request that produced a `page_token`.
|
|
13151
|
+
*/
|
|
13152
|
+
marginAccountId?: string;
|
|
13153
|
+
/**
|
|
13154
|
+
* @description Optional order UUID filter: only trades where this user's side of the
|
|
13155
|
+
* fill was placed by this order. A self-trade is read as its maker side, so
|
|
13156
|
+
* it matches its maker order only. A filtered response carries no `total`,
|
|
13157
|
+
* and the filter must match the request that produced a `page_token`.
|
|
13158
|
+
*/
|
|
13159
|
+
orderId?: string;
|
|
12563
13160
|
};
|
|
12564
13161
|
header?: never;
|
|
12565
13162
|
path?: never;
|
|
@@ -16420,6 +17017,112 @@ export interface operations {
|
|
|
16420
17017
|
};
|
|
16421
17018
|
};
|
|
16422
17019
|
};
|
|
17020
|
+
list_liquidation_events: {
|
|
17021
|
+
parameters: {
|
|
17022
|
+
query?: {
|
|
17023
|
+
/** @description Start time as Unix timestamp (milliseconds) */
|
|
17024
|
+
startTime?: number;
|
|
17025
|
+
/** @description End time as Unix timestamp (milliseconds) */
|
|
17026
|
+
endTime?: number;
|
|
17027
|
+
/** @description Events per page (max 1000) */
|
|
17028
|
+
pageSize?: number;
|
|
17029
|
+
/**
|
|
17030
|
+
* @description Opaque keyset cursor from the previous response. The token is bound to
|
|
17031
|
+
* this pair and the requested time filters.
|
|
17032
|
+
*/
|
|
17033
|
+
pageToken?: string;
|
|
17034
|
+
};
|
|
17035
|
+
header?: never;
|
|
17036
|
+
path: {
|
|
17037
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
17038
|
+
tradingPairId: string;
|
|
17039
|
+
};
|
|
17040
|
+
cookie?: never;
|
|
17041
|
+
};
|
|
17042
|
+
requestBody?: never;
|
|
17043
|
+
responses: {
|
|
17044
|
+
/** @description OK */
|
|
17045
|
+
200: {
|
|
17046
|
+
headers: {
|
|
17047
|
+
[name: string]: unknown;
|
|
17048
|
+
};
|
|
17049
|
+
content: {
|
|
17050
|
+
"application/json": components["schemas"]["ListLiquidationEventsResponse"];
|
|
17051
|
+
};
|
|
17052
|
+
};
|
|
17053
|
+
/** @description Invalid liquidation-event filter or page token */
|
|
17054
|
+
400: {
|
|
17055
|
+
headers: {
|
|
17056
|
+
[name: string]: unknown;
|
|
17057
|
+
};
|
|
17058
|
+
content?: never;
|
|
17059
|
+
};
|
|
17060
|
+
/** @description Trading pair not found */
|
|
17061
|
+
404: {
|
|
17062
|
+
headers: {
|
|
17063
|
+
[name: string]: unknown;
|
|
17064
|
+
};
|
|
17065
|
+
content?: never;
|
|
17066
|
+
};
|
|
17067
|
+
/** @description Internal server error */
|
|
17068
|
+
500: {
|
|
17069
|
+
headers: {
|
|
17070
|
+
[name: string]: unknown;
|
|
17071
|
+
};
|
|
17072
|
+
content?: never;
|
|
17073
|
+
};
|
|
17074
|
+
};
|
|
17075
|
+
};
|
|
17076
|
+
get_liquidation_metrics: {
|
|
17077
|
+
parameters: {
|
|
17078
|
+
query?: {
|
|
17079
|
+
interval?: string;
|
|
17080
|
+
/** @description Start time as Unix timestamp (milliseconds) */
|
|
17081
|
+
startTime?: number;
|
|
17082
|
+
/** @description End time as Unix timestamp (milliseconds) */
|
|
17083
|
+
endTime?: number;
|
|
17084
|
+
};
|
|
17085
|
+
header?: never;
|
|
17086
|
+
path: {
|
|
17087
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
17088
|
+
tradingPairId: string;
|
|
17089
|
+
};
|
|
17090
|
+
cookie?: never;
|
|
17091
|
+
};
|
|
17092
|
+
requestBody?: never;
|
|
17093
|
+
responses: {
|
|
17094
|
+
/** @description OK */
|
|
17095
|
+
200: {
|
|
17096
|
+
headers: {
|
|
17097
|
+
[name: string]: unknown;
|
|
17098
|
+
};
|
|
17099
|
+
content: {
|
|
17100
|
+
"application/json": components["schemas"]["GetLiquidationMetricsResponse"];
|
|
17101
|
+
};
|
|
17102
|
+
};
|
|
17103
|
+
/** @description Invalid interval or out-of-bounds time range */
|
|
17104
|
+
400: {
|
|
17105
|
+
headers: {
|
|
17106
|
+
[name: string]: unknown;
|
|
17107
|
+
};
|
|
17108
|
+
content?: never;
|
|
17109
|
+
};
|
|
17110
|
+
/** @description Trading pair not found */
|
|
17111
|
+
404: {
|
|
17112
|
+
headers: {
|
|
17113
|
+
[name: string]: unknown;
|
|
17114
|
+
};
|
|
17115
|
+
content?: never;
|
|
17116
|
+
};
|
|
17117
|
+
/** @description Internal server error */
|
|
17118
|
+
500: {
|
|
17119
|
+
headers: {
|
|
17120
|
+
[name: string]: unknown;
|
|
17121
|
+
};
|
|
17122
|
+
content?: never;
|
|
17123
|
+
};
|
|
17124
|
+
};
|
|
17125
|
+
};
|
|
16423
17126
|
get_mark_price: {
|
|
16424
17127
|
parameters: {
|
|
16425
17128
|
query?: never;
|
|
@@ -16563,6 +17266,101 @@ export interface operations {
|
|
|
16563
17266
|
};
|
|
16564
17267
|
};
|
|
16565
17268
|
};
|
|
17269
|
+
get_trade_flow: {
|
|
17270
|
+
parameters: {
|
|
17271
|
+
query: {
|
|
17272
|
+
/** @description UTC-aligned bucket interval */
|
|
17273
|
+
interval: "1m" | "5m" | "1h";
|
|
17274
|
+
/** @description Unix timestamp in milliseconds; range is at most seven days */
|
|
17275
|
+
startTime: number;
|
|
17276
|
+
/** @description Unix timestamp in milliseconds; range is at most seven days */
|
|
17277
|
+
endTime: number;
|
|
17278
|
+
};
|
|
17279
|
+
header?: never;
|
|
17280
|
+
path: {
|
|
17281
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
17282
|
+
tradingPairId: string;
|
|
17283
|
+
};
|
|
17284
|
+
cookie?: never;
|
|
17285
|
+
};
|
|
17286
|
+
requestBody?: never;
|
|
17287
|
+
responses: {
|
|
17288
|
+
/** @description OK */
|
|
17289
|
+
200: {
|
|
17290
|
+
headers: {
|
|
17291
|
+
[name: string]: unknown;
|
|
17292
|
+
};
|
|
17293
|
+
content: {
|
|
17294
|
+
"application/json": components["schemas"]["GetTradeFlowResponse"];
|
|
17295
|
+
};
|
|
17296
|
+
};
|
|
17297
|
+
/** @description Invalid or out-of-bounds time range */
|
|
17298
|
+
400: {
|
|
17299
|
+
headers: {
|
|
17300
|
+
[name: string]: unknown;
|
|
17301
|
+
};
|
|
17302
|
+
content?: never;
|
|
17303
|
+
};
|
|
17304
|
+
/** @description Trading pair not found */
|
|
17305
|
+
404: {
|
|
17306
|
+
headers: {
|
|
17307
|
+
[name: string]: unknown;
|
|
17308
|
+
};
|
|
17309
|
+
content?: never;
|
|
17310
|
+
};
|
|
17311
|
+
/** @description Internal server error */
|
|
17312
|
+
500: {
|
|
17313
|
+
headers: {
|
|
17314
|
+
[name: string]: unknown;
|
|
17315
|
+
};
|
|
17316
|
+
content?: never;
|
|
17317
|
+
};
|
|
17318
|
+
};
|
|
17319
|
+
};
|
|
17320
|
+
get_trader_metrics: {
|
|
17321
|
+
parameters: {
|
|
17322
|
+
query?: never;
|
|
17323
|
+
header?: never;
|
|
17324
|
+
path: {
|
|
17325
|
+
/** @example 893d2add-2f36-4ee7-b660-893d2add2f36 */
|
|
17326
|
+
tradingPairId: string;
|
|
17327
|
+
};
|
|
17328
|
+
cookie?: never;
|
|
17329
|
+
};
|
|
17330
|
+
requestBody?: never;
|
|
17331
|
+
responses: {
|
|
17332
|
+
/** @description OK */
|
|
17333
|
+
200: {
|
|
17334
|
+
headers: {
|
|
17335
|
+
[name: string]: unknown;
|
|
17336
|
+
};
|
|
17337
|
+
content: {
|
|
17338
|
+
"application/json": components["schemas"]["GetTraderMetricsResponse"];
|
|
17339
|
+
};
|
|
17340
|
+
};
|
|
17341
|
+
/** @description Invalid market request */
|
|
17342
|
+
400: {
|
|
17343
|
+
headers: {
|
|
17344
|
+
[name: string]: unknown;
|
|
17345
|
+
};
|
|
17346
|
+
content?: never;
|
|
17347
|
+
};
|
|
17348
|
+
/** @description Trading pair not found */
|
|
17349
|
+
404: {
|
|
17350
|
+
headers: {
|
|
17351
|
+
[name: string]: unknown;
|
|
17352
|
+
};
|
|
17353
|
+
content?: never;
|
|
17354
|
+
};
|
|
17355
|
+
/** @description Internal server error */
|
|
17356
|
+
500: {
|
|
17357
|
+
headers: {
|
|
17358
|
+
[name: string]: unknown;
|
|
17359
|
+
};
|
|
17360
|
+
content?: never;
|
|
17361
|
+
};
|
|
17362
|
+
};
|
|
17363
|
+
};
|
|
16566
17364
|
get_screener: {
|
|
16567
17365
|
parameters: {
|
|
16568
17366
|
query?: {
|
|
@@ -17351,7 +18149,7 @@ export interface operations {
|
|
|
17351
18149
|
};
|
|
17352
18150
|
content?: never;
|
|
17353
18151
|
};
|
|
17354
|
-
/** @description Duplicate clientTwapId for this user and application */
|
|
18152
|
+
/** @description Duplicate clientTwapId for this user and application: a parent with that key is live or ended within the reservation lifetime (30 days by default) */
|
|
17355
18153
|
409: {
|
|
17356
18154
|
headers: {
|
|
17357
18155
|
[name: string]: unknown;
|
|
@@ -18176,6 +18974,133 @@ export interface operations {
|
|
|
18176
18974
|
};
|
|
18177
18975
|
};
|
|
18178
18976
|
};
|
|
18977
|
+
list_sweeper_deposits: {
|
|
18978
|
+
parameters: {
|
|
18979
|
+
query?: {
|
|
18980
|
+
/** @description Items per page (max 100) */
|
|
18981
|
+
pageSize?: number;
|
|
18982
|
+
/**
|
|
18983
|
+
* @description Pagination cursor with two states:
|
|
18984
|
+
* - Omitted or empty string (""): start the walk from the newest deposit.
|
|
18985
|
+
* - Non-empty: an opaque cursor from a previous response's
|
|
18986
|
+
* `next_page_token`; results resume immediately after that position.
|
|
18987
|
+
*
|
|
18988
|
+
* The walk seeks on `(created_at, id)` descending over the caller's
|
|
18989
|
+
* inflows, served by `idx_sweeper_transfers_user_inflows`. `created_at` is
|
|
18990
|
+
* when the sweeper recorded the deposit and `id` an insertion-ordered
|
|
18991
|
+
* identity, so the key is total and immutable.
|
|
18992
|
+
*/
|
|
18993
|
+
pageToken?: string;
|
|
18994
|
+
};
|
|
18995
|
+
header?: never;
|
|
18996
|
+
path?: never;
|
|
18997
|
+
cookie?: never;
|
|
18998
|
+
};
|
|
18999
|
+
requestBody?: never;
|
|
19000
|
+
responses: {
|
|
19001
|
+
/** @description OK */
|
|
19002
|
+
200: {
|
|
19003
|
+
headers: {
|
|
19004
|
+
[name: string]: unknown;
|
|
19005
|
+
};
|
|
19006
|
+
content: {
|
|
19007
|
+
"application/json": components["schemas"]["ListDepositsResponse"];
|
|
19008
|
+
};
|
|
19009
|
+
};
|
|
19010
|
+
/** @description pageSize out of range, or a pageToken that is malformed or minted by another listing */
|
|
19011
|
+
400: {
|
|
19012
|
+
headers: {
|
|
19013
|
+
[name: string]: unknown;
|
|
19014
|
+
};
|
|
19015
|
+
content?: never;
|
|
19016
|
+
};
|
|
19017
|
+
/** @description Authentication required */
|
|
19018
|
+
401: {
|
|
19019
|
+
headers: {
|
|
19020
|
+
[name: string]: unknown;
|
|
19021
|
+
};
|
|
19022
|
+
content?: never;
|
|
19023
|
+
};
|
|
19024
|
+
/** @description Read rate limit exceeded — every authenticated read draws one request from the account's read budget; retry after the interval in details.retryAfter */
|
|
19025
|
+
429: {
|
|
19026
|
+
headers: {
|
|
19027
|
+
[name: string]: unknown;
|
|
19028
|
+
};
|
|
19029
|
+
content?: never;
|
|
19030
|
+
};
|
|
19031
|
+
/** @description Internal server error */
|
|
19032
|
+
500: {
|
|
19033
|
+
headers: {
|
|
19034
|
+
[name: string]: unknown;
|
|
19035
|
+
};
|
|
19036
|
+
content?: never;
|
|
19037
|
+
};
|
|
19038
|
+
/** @description Deposit status not available in this environment, or the read took too long; safe to retry */
|
|
19039
|
+
503: {
|
|
19040
|
+
headers: {
|
|
19041
|
+
[name: string]: unknown;
|
|
19042
|
+
};
|
|
19043
|
+
content?: never;
|
|
19044
|
+
};
|
|
19045
|
+
};
|
|
19046
|
+
};
|
|
19047
|
+
get_sweeper_deposit_status: {
|
|
19048
|
+
parameters: {
|
|
19049
|
+
query?: never;
|
|
19050
|
+
header?: never;
|
|
19051
|
+
path: {
|
|
19052
|
+
txHash: string;
|
|
19053
|
+
};
|
|
19054
|
+
cookie?: never;
|
|
19055
|
+
};
|
|
19056
|
+
requestBody?: never;
|
|
19057
|
+
responses: {
|
|
19058
|
+
/** @description OK */
|
|
19059
|
+
200: {
|
|
19060
|
+
headers: {
|
|
19061
|
+
[name: string]: unknown;
|
|
19062
|
+
};
|
|
19063
|
+
content: {
|
|
19064
|
+
"application/json": components["schemas"]["GetDepositStatusResponse"];
|
|
19065
|
+
};
|
|
19066
|
+
};
|
|
19067
|
+
/** @description txHash is not a 0x-prefixed 32-byte hex hash */
|
|
19068
|
+
400: {
|
|
19069
|
+
headers: {
|
|
19070
|
+
[name: string]: unknown;
|
|
19071
|
+
};
|
|
19072
|
+
content?: never;
|
|
19073
|
+
};
|
|
19074
|
+
/** @description Authentication required */
|
|
19075
|
+
401: {
|
|
19076
|
+
headers: {
|
|
19077
|
+
[name: string]: unknown;
|
|
19078
|
+
};
|
|
19079
|
+
content?: never;
|
|
19080
|
+
};
|
|
19081
|
+
/** @description Read rate limit exceeded — every authenticated read draws one request from the account's read budget; retry after the interval in details.retryAfter */
|
|
19082
|
+
429: {
|
|
19083
|
+
headers: {
|
|
19084
|
+
[name: string]: unknown;
|
|
19085
|
+
};
|
|
19086
|
+
content?: never;
|
|
19087
|
+
};
|
|
19088
|
+
/** @description Internal server error */
|
|
19089
|
+
500: {
|
|
19090
|
+
headers: {
|
|
19091
|
+
[name: string]: unknown;
|
|
19092
|
+
};
|
|
19093
|
+
content?: never;
|
|
19094
|
+
};
|
|
19095
|
+
/** @description Deposit status not available in this environment, or the read took too long; safe to retry */
|
|
19096
|
+
503: {
|
|
19097
|
+
headers: {
|
|
19098
|
+
[name: string]: unknown;
|
|
19099
|
+
};
|
|
19100
|
+
content?: never;
|
|
19101
|
+
};
|
|
19102
|
+
};
|
|
19103
|
+
};
|
|
18179
19104
|
register_deposit_address: {
|
|
18180
19105
|
parameters: {
|
|
18181
19106
|
query?: never;
|