@0xmonaco/types 1.0.85 → 1.0.86

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.
@@ -201,7 +201,7 @@ export interface ScreenerSnapshotPoint {
201
201
  quoteVolume: string;
202
202
  /** Percent price change (close - open) / open * 100 for the day */
203
203
  priceChangePercent: string;
204
- /** Daily average of the valued completed-UTC-minute gross open-interest notionals; null for spot or when fewer than 95% of the day's 1440 minutes (1368) are valued */
204
+ /** Daily average of the valued completed-UTC-minute one-sided LONG open-interest notionals; null for spot or when fewer than 95% of the day's 1440 minutes (1368) are valued */
205
205
  openInterestNotionalAvg: string | null;
206
206
  }
207
207
  /**
@@ -252,22 +252,24 @@ export interface ScreenerItem {
252
252
  */
253
253
  lastFundingTime: string | null;
254
254
  /**
255
- * Gross open interest (longs plus shorts) in base-asset units (e.g. BTC);
256
- * null for spot pairs, "0" for a margin pair with no open positions
255
+ * One-sided LONG open interest (each contract counted once) in base-asset units
256
+ * (e.g. BTC), from the latest completed-minute sample; null for spot pairs or
257
+ * when no sample was recorded in the last five minutes, "0" for a margin pair with no
258
+ * open positions
257
259
  */
258
260
  openInterestBase: string | null;
259
261
  /**
260
- * Gross open-interest notional (longs plus shorts) in quote units
262
+ * One-sided LONG open-interest notional in quote units
261
263
  * (openInterestBase × latest trade price); null for spot pairs. Valued at the pair's latest trade price (a
262
264
  * snapshot); the mark-accurate notional lives on getPerpMarketSummary /
263
265
  * getOpenInterest
264
266
  */
265
267
  openInterestNotional: string | null;
266
- /** Average of the valued completed-UTC-minute gross open-interest notionals over the last 60 minutes; null for spot or when fewer than 95% of them (57) are valued */
268
+ /** Average of the valued completed-UTC-minute one-sided LONG open-interest notionals over the last 60 minutes; null for spot or when fewer than 95% of them (57) are valued */
267
269
  openInterestNotionalAvg1h: string | null;
268
- /** Average of the valued completed-UTC-minute gross open-interest notionals over the last 1440 minutes; null for spot or when fewer than 95% of them (1368) are valued */
270
+ /** Average of the valued completed-UTC-minute one-sided LONG open-interest notionals over the last 1440 minutes; null for spot or when fewer than 95% of them (1368) are valued */
269
271
  openInterestNotionalAvg24h: string | null;
270
- /** Average of the valued completed-UTC-minute gross open-interest notionals over the last 10080 minutes; null for spot or when fewer than 95% of them (9576) are valued */
272
+ /** Average of the valued completed-UTC-minute one-sided LONG open-interest notionals over the last 10080 minutes; null for spot or when fewer than 95% of them (9576) are valued */
271
273
  openInterestNotionalAvg7d: string | null;
272
274
  /**
273
275
  * Estimated rate for the in-progress funding window (decimal fraction per
@@ -436,11 +438,11 @@ export interface PerpMarketSummary {
436
438
  quoteVolume24h?: string;
437
439
  priceChange24h?: string;
438
440
  priceChangePercent24h?: string;
439
- /** Gross open interest (longs plus shorts) in base-asset units (legacy alias of openInterestBase) */
441
+ /** One-sided LONG open interest (each contract counted once) in base-asset units (legacy alias of openInterestBase) */
440
442
  openInterest: string;
441
- /** Gross open interest (longs plus shorts) in base-asset units (e.g. BTC) */
443
+ /** One-sided LONG open interest (each contract counted once) in base-asset units (e.g. BTC) */
442
444
  openInterestBase?: string;
443
- /** Gross open-interest notional (longs plus shorts) in quote units (openInterestBase × mark price, falling back to the last trade price when no mark is available) */
445
+ /** One-sided LONG open-interest notional in quote units (openInterestBase × mark price, falling back to the last trade price when no mark is available) */
444
446
  openInterestNotional?: string;
445
447
  currentFundingRate?: string;
446
448
  estimatedNextFundingRate?: string;
@@ -595,11 +597,11 @@ export interface ListAllFundingHistoryResponse {
595
597
  }
596
598
  export interface OpenInterest {
597
599
  tradingPairId: string;
598
- /** Gross open interest (longs plus shorts) in base-asset units (legacy alias of openInterestBase) */
600
+ /** One-sided LONG open interest (each contract counted once) in base-asset units (legacy alias of openInterestBase) */
599
601
  openInterest?: string;
600
- /** Gross open interest (longs plus shorts) in base-asset units */
602
+ /** One-sided LONG open interest (each contract counted once) in base-asset units */
601
603
  openInterestBase: string;
602
- /** Gross open-interest notional (longs plus shorts) in quote units (openInterestBase × mark price, falling back to the last trade price when no mark is available) */
604
+ /** One-sided LONG open-interest notional in quote units (openInterestBase × mark price, falling back to the last trade price when no mark is available) */
603
605
  openInterestNotional: string;
604
606
  updatedAt: string;
605
607
  }
@@ -45,7 +45,8 @@ export interface MarketStatsData {
45
45
  /** Best ask price (decimal string) */
46
46
  bestAskPrice?: string;
47
47
  /**
48
- * Gross open interest (longs plus shorts) in base units (decimal string).
48
+ * One-sided LONG open interest (each contract counted once) in base
49
+ * units (decimal string).
49
50
  * Perp-only; omitted for spot, and omitted (never zero) until the market's
50
51
  * open interest is known.
51
52
  */
@@ -58,8 +59,8 @@ export interface MarketStatsData {
58
59
  openInterestLimit?: string;
59
60
  /**
60
61
  * What is left of `openInterestLimit` at the mark, in quote (USD) notional,
61
- * never below zero (decimal string): the cap minus the gross `openInterest`
62
- * × `markPrice`. At zero, orders that open exposure are refused until open
62
+ * never below zero (decimal string): the cap minus the gross open interest
63
+ * (longs plus shorts, not derivable from `openInterest`) × `markPrice`. At zero, orders that open exposure are refused until open
63
64
  * interest or the mark falls. Perp-only; omitted for spot, when there is no
64
65
  * mark, and until open interest is known.
65
66
  */
@@ -147,7 +148,8 @@ export interface MarketStatsSummary {
147
148
  /** 24h low price (decimal string) */
148
149
  dailyPriceLow?: string;
149
150
  /**
150
- * Gross open interest (longs plus shorts) in base units (decimal string).
151
+ * One-sided LONG open interest (each contract counted once) in base
152
+ * units (decimal string).
151
153
  * Perp-only; omitted for spot, and omitted (never zero) until the market's
152
154
  * open interest is known.
153
155
  */
@@ -169,8 +171,7 @@ export interface MarketStatsSummary {
169
171
  /** Funding premium (decimal string). Perp-only; omitted for spot. */
170
172
  premium?: string;
171
173
  /**
172
- * Gross open interest (longs plus shorts) in quote notional (decimal
173
- * string): `openInterest` priced at the mark, falling back to the last trade
174
+ * One-sided LONG open interest in quote notional (decimal string): `openInterest` priced at the mark, falling back to the last trade
174
175
  * price. Perp-only; omitted for spot,
175
176
  * and omitted (never zero) until both open interest and a price are known.
176
177
  */
@@ -2242,7 +2242,7 @@ export interface paths {
2242
2242
  };
2243
2243
  /**
2244
2244
  * Open Interest
2245
- * @description Gross open interest (longs plus shorts) for a perp market.
2245
+ * @description One-sided LONG open interest (each open contract counted once) for a perp market.
2246
2246
  */
2247
2247
  get: operations["get_open_interest"];
2248
2248
  put?: never;
@@ -6384,7 +6384,7 @@ export interface components {
6384
6384
  /** @description Cursor for the next page; empty when there are no more. */
6385
6385
  nextPageToken?: string | null;
6386
6386
  };
6387
- /** @description Latest public gross open interest (longs plus shorts) for a trading pair. */
6387
+ /** @description Latest public one-sided LONG open interest (each open contract counted once) for a trading pair. */
6388
6388
  GetOpenInterestResponse: {
6389
6389
  /**
6390
6390
  * Format: uuid
@@ -6393,7 +6393,7 @@ export interface components {
6393
6393
  */
6394
6394
  tradingPairId?: string | null;
6395
6395
  /**
6396
- * @description Current gross open interest (longs plus shorts) in base-asset units
6396
+ * @description Current one-sided LONG open interest (each open contract counted once) in base-asset units
6397
6397
  * @example 12345.67
6398
6398
  */
6399
6399
  openInterest?: string | null;
@@ -6403,12 +6403,12 @@ export interface components {
6403
6403
  */
6404
6404
  updatedAt?: string | null;
6405
6405
  /**
6406
- * @description Current gross open interest (longs plus shorts) in base-asset units
6406
+ * @description Current one-sided LONG open interest (each open contract counted once) in base-asset units
6407
6407
  * @example 12345.67
6408
6408
  */
6409
6409
  openInterestBase?: string | null;
6410
6410
  /**
6411
- * @description Current gross open-interest notional (longs plus shorts) in quote units (openInterestBase x mark price, falling back to the last trade price when no mark is available)
6411
+ * @description Current one-sided LONG open-interest notional in quote units (openInterestBase x mark price, falling back to the last trade price when no mark is available)
6412
6412
  * @example 1172836500.00
6413
6413
  */
6414
6414
  openInterestNotional?: string | null;
@@ -6754,7 +6754,7 @@ export interface components {
6754
6754
  priceChange24h?: string | null;
6755
6755
  priceChangePercent24h?: string | null;
6756
6756
  /**
6757
- * @description Gross open interest (longs plus shorts) in base-asset units (legacy alias of openInterestBase)
6757
+ * @description One-sided LONG open interest (each open contract counted once) in base-asset units (legacy alias of openInterestBase)
6758
6758
  * @example 12345.67
6759
6759
  */
6760
6760
  openInterest?: string | null;
@@ -6765,12 +6765,12 @@ export interface components {
6765
6765
  marketRegime?: string | null;
6766
6766
  updatedAt?: string | null;
6767
6767
  /**
6768
- * @description Gross open interest (longs plus shorts) in base-asset units (e.g. BTC)
6768
+ * @description One-sided LONG open interest (each open contract counted once) in base-asset units (e.g. BTC)
6769
6769
  * @example 12345.67
6770
6770
  */
6771
6771
  openInterestBase?: string | null;
6772
6772
  /**
6773
- * @description Gross open-interest notional (longs plus shorts) in quote units (openInterestBase x mark price, falling back to the last trade price when no mark is available)
6773
+ * @description One-sided LONG open-interest notional in quote units (openInterestBase x mark price, falling back to the last trade price when no mark is available)
6774
6774
  * @example 1172836500.00
6775
6775
  */
6776
6776
  openInterestNotional?: string | null;
@@ -9996,27 +9996,27 @@ export interface components {
9996
9996
  */
9997
9997
  lastFundingTime?: string | null;
9998
9998
  /**
9999
- * @description Gross open interest (longs plus shorts) in base-asset units (e.g. BTC); null for spot pairs, "0" for a margin pair with no open positions
9999
+ * @description One-sided LONG open interest (each open contract counted once) in base-asset units (e.g. BTC), from the latest completed-minute sample; null for spot pairs or when no sample was recorded in the last five minutes, "0" for a margin pair with no open positions
10000
10000
  * @example 12345.67
10001
10001
  */
10002
10002
  openInterestBase?: string | null;
10003
10003
  /**
10004
- * @description Gross open-interest notional (longs plus shorts) in quote units (openInterestBase x latest trade price); null for spot pairs. Valued at the pair's latest trade price (a snapshot); the mark-accurate notional lives on getPerpMarketSummary / getOpenInterest
10004
+ * @description One-sided LONG open-interest notional in quote units (openInterestBase x latest trade price); null for spot pairs. Valued at the pair's latest trade price (a snapshot); the mark-accurate notional lives on getPerpMarketSummary / getOpenInterest
10005
10005
  * @example 1172836500.00
10006
10006
  */
10007
10007
  openInterestNotional?: string | null;
10008
10008
  /**
10009
- * @description Arithmetic mean of the valued gross open-interest notional observations (one per completed UTC minute) over the last 60 completed minutes ending at floor(now to minute); published once at least 95% of those minutes (57) carry a valued sample. Null for spot pairs or below that coverage; a minute without a trade price is unvalued, never zero; known zero is "0". Each sample is gross open position size x latest trade price in quote units. No historical backfill; this window warms after deployment.
10009
+ * @description Arithmetic mean of the valued one-sided LONG open-interest notional observations (one per completed UTC minute) over the last 60 completed minutes ending at floor(now to minute); published once at least 95% of those minutes (57) carry a valued sample. Null for spot pairs or below that coverage; a minute without a trade price is unvalued, never zero; known zero is "0". Each sample is the LONG open position size x latest trade price in quote units. No historical backfill; this window warms after deployment.
10010
10010
  * @example 1172836500.00
10011
10011
  */
10012
10012
  openInterestNotionalAvg1h?: string | null;
10013
10013
  /**
10014
- * @description Arithmetic mean of the valued gross open-interest notional observations (one per completed UTC minute) over the last 1440 completed minutes ending at floor(now to minute); published once at least 95% of those minutes (1368) carry a valued sample. Null for spot pairs or below that coverage; a minute without a trade price is unvalued, never zero; known zero is "0". Each sample is gross open position size x latest trade price in quote units. No historical backfill; this window warms after deployment.
10014
+ * @description Arithmetic mean of the valued one-sided LONG open-interest notional observations (one per completed UTC minute) over the last 1440 completed minutes ending at floor(now to minute); published once at least 95% of those minutes (1368) carry a valued sample. Null for spot pairs or below that coverage; a minute without a trade price is unvalued, never zero; known zero is "0". Each sample is the LONG open position size x latest trade price in quote units. No historical backfill; this window warms after deployment.
10015
10015
  * @example 1172836500.00
10016
10016
  */
10017
10017
  openInterestNotionalAvg24h?: string | null;
10018
10018
  /**
10019
- * @description Arithmetic mean of the valued gross open-interest notional observations (one per completed UTC minute) over the last 10080 completed minutes ending at floor(now to minute); published once at least 95% of those minutes (9576) carry a valued sample. Null for spot pairs or below that coverage; a minute without a trade price is unvalued, never zero; known zero is "0". Each sample is gross open position size x latest trade price in quote units. No historical backfill; this window warms after deployment.
10019
+ * @description Arithmetic mean of the valued one-sided LONG open-interest notional observations (one per completed UTC minute) over the last 10080 completed minutes ending at floor(now to minute); published once at least 95% of those minutes (9576) carry a valued sample. Null for spot pairs or below that coverage; a minute without a trade price is unvalued, never zero; known zero is "0". Each sample is the LONG open position size x latest trade price in quote units. No historical backfill; this window warms after deployment.
10020
10020
  * @example 1172836500.00
10021
10021
  */
10022
10022
  openInterestNotionalAvg7d?: string | null;
@@ -10044,7 +10044,7 @@ export interface components {
10044
10044
  */
10045
10045
  priceChangePercent?: string | null;
10046
10046
  /**
10047
- * @description Arithmetic mean of the valued gross open-interest notional observations (one per completed UTC minute) in this completed UTC day; published once at least 95% of its 1440 minutes (1368) carry a valued sample, null for spot pairs or below that coverage. Samples use gross open position size x latest trade price in quote units; a minute without a trade price is unvalued, never zero; known zero remains "0". No historical backfill.
10047
+ * @description Arithmetic mean of the valued one-sided LONG open-interest notional observations (one per completed UTC minute) in this completed UTC day; published once at least 95% of its 1440 minutes (1368) carry a valued sample, null for spot pairs or below that coverage. Samples use the LONG open position size x latest trade price in quote units; a minute without a trade price is unvalued, never zero; known zero remains "0". No historical backfill.
10048
10048
  * @example 1172836500.00
10049
10049
  */
10050
10050
  openInterestNotionalAvg?: string | null;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@0xmonaco/types",
3
- "version": "1.0.85",
3
+ "version": "1.0.86",
4
4
  "type": "module",
5
5
  "homepage": "https://docs.0xmonaco.com/sdk/typescript",
6
6
  "main": "./dist/index.js",
@@ -16,7 +16,7 @@
16
16
  "lint": "biome lint ."
17
17
  },
18
18
  "dependencies": {
19
- "@0xmonaco/contracts": "1.0.85",
19
+ "@0xmonaco/contracts": "1.0.86",
20
20
  "zod": "^4.1.12"
21
21
  },
22
22
  "peerDependencies": {