zklighter-perps 1.0.269 → 1.0.271

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.
@@ -94,6 +94,8 @@ models/MarkPriceCandle.ts
94
94
  models/MarkPriceCandles.ts
95
95
  models/MarketConfig.ts
96
96
  models/MarketMetricData.ts
97
+ models/MarketPriceChart.ts
98
+ models/MarketPriceCharts.ts
97
99
  models/NextNonce.ts
98
100
  models/NotificationPreferences.ts
99
101
  models/Order.ts
@@ -162,6 +164,7 @@ models/ReqGetLiquidationInfos.ts
162
164
  models/ReqGetMakerOnlyApiKeys.ts
163
165
  models/ReqGetMarkPriceCandles.ts
164
166
  models/ReqGetMarketMetrics.ts
167
+ models/ReqGetMarketPriceCharts.ts
165
168
  models/ReqGetNextNonce.ts
166
169
  models/ReqGetOrderBookDetails.ts
167
170
  models/ReqGetOrderBookOrders.ts
@@ -248,6 +248,7 @@ export interface PositionFundingRequest {
248
248
  authorization?: string;
249
249
  auth?: string;
250
250
  market_id?: number;
251
+ market_ids?: number;
251
252
  cursor?: string;
252
253
  side?: PositionFundingSideEnum;
253
254
  start_timestamp?: number;
@@ -1558,6 +1559,10 @@ export class AccountApi extends runtime.BaseAPI {
1558
1559
  queryParameters['market_id'] = requestParameters['market_id'];
1559
1560
  }
1560
1561
 
1562
+ if (requestParameters['market_ids'] != null) {
1563
+ queryParameters['market_ids'] = requestParameters['market_ids'];
1564
+ }
1565
+
1561
1566
  if (requestParameters['cursor'] != null) {
1562
1567
  queryParameters['cursor'] = requestParameters['cursor'];
1563
1568
  }
@@ -18,6 +18,7 @@ import type {
18
18
  Candles,
19
19
  Fundings,
20
20
  MarkPriceCandles,
21
+ MarketPriceCharts,
21
22
  ResultCode,
22
23
  } from '../models/index';
23
24
  import {
@@ -27,6 +28,8 @@ import {
27
28
  FundingsToJSON,
28
29
  MarkPriceCandlesFromJSON,
29
30
  MarkPriceCandlesToJSON,
31
+ MarketPriceChartsFromJSON,
32
+ MarketPriceChartsToJSON,
30
33
  ResultCodeFromJSON,
31
34
  ResultCodeToJSON,
32
35
  } from '../models/index';
@@ -56,6 +59,10 @@ export interface MarkPriceCandlesRequest {
56
59
  count_back: number;
57
60
  }
58
61
 
62
+ export interface MarketPriceChartsRequest {
63
+ market_ids?: number;
64
+ }
65
+
59
66
  /**
60
67
  *
61
68
  */
@@ -314,6 +321,38 @@ export class CandlestickApi extends runtime.BaseAPI {
314
321
  return await response.value();
315
322
  }
316
323
 
324
+ /**
325
+ * Get last 24h hourly prices for all markets (mark price for perps, index price for spot)
326
+ * marketPriceCharts
327
+ */
328
+ async marketPriceChartsRaw(requestParameters: MarketPriceChartsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<MarketPriceCharts>> {
329
+ const queryParameters: any = {};
330
+
331
+ if (requestParameters['market_ids'] != null) {
332
+ queryParameters['market_ids'] = requestParameters['market_ids'];
333
+ }
334
+
335
+ const headerParameters: runtime.HTTPHeaders = {};
336
+
337
+ const response = await this.request({
338
+ path: `/api/v1/marketPriceCharts`,
339
+ method: 'GET',
340
+ headers: headerParameters,
341
+ query: queryParameters,
342
+ }, initOverrides);
343
+
344
+ return new runtime.JSONApiResponse(response, (jsonValue) => MarketPriceChartsFromJSON(jsonValue));
345
+ }
346
+
347
+ /**
348
+ * Get last 24h hourly prices for all markets (mark price for perps, index price for spot)
349
+ * marketPriceCharts
350
+ */
351
+ async marketPriceCharts(requestParameters: MarketPriceChartsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<MarketPriceCharts> {
352
+ const response = await this.marketPriceChartsRaw(requestParameters, initOverrides);
353
+ return await response.value();
354
+ }
355
+
317
356
  }
318
357
 
319
358
  /**
@@ -43,6 +43,12 @@ export interface NotificationPreferences {
43
43
  * @memberof NotificationPreferences
44
44
  */
45
45
  price_alerts_enabled: boolean;
46
+ /**
47
+ *
48
+ * @type {boolean}
49
+ * @memberof NotificationPreferences
50
+ */
51
+ order_filled_enabled: boolean;
46
52
  }
47
53
 
48
54
  /**
@@ -53,6 +59,7 @@ export function instanceOfNotificationPreferences(value: object): value is Notif
53
59
  if (!('global_announcements_enabled' in value) || value['global_announcements_enabled'] === undefined) return false;
54
60
  if (!('private_announcements_enabled' in value) || value['private_announcements_enabled'] === undefined) return false;
55
61
  if (!('price_alerts_enabled' in value) || value['price_alerts_enabled'] === undefined) return false;
62
+ if (!('order_filled_enabled' in value) || value['order_filled_enabled'] === undefined) return false;
56
63
  return true;
57
64
  }
58
65
 
@@ -70,6 +77,7 @@ export function NotificationPreferencesFromJSONTyped(json: any, ignoreDiscrimina
70
77
  'global_announcements_enabled': json['global_announcements_enabled'],
71
78
  'private_announcements_enabled': json['private_announcements_enabled'],
72
79
  'price_alerts_enabled': json['price_alerts_enabled'],
80
+ 'order_filled_enabled': json['order_filled_enabled'],
73
81
  };
74
82
  }
75
83
 
@@ -83,6 +91,7 @@ export function NotificationPreferencesToJSON(value?: NotificationPreferences |
83
91
  'global_announcements_enabled': value['global_announcements_enabled'],
84
92
  'private_announcements_enabled': value['private_announcements_enabled'],
85
93
  'price_alerts_enabled': value['price_alerts_enabled'],
94
+ 'order_filled_enabled': value['order_filled_enabled'],
86
95
  };
87
96
  }
88
97
 
@@ -49,6 +49,18 @@ export interface PriceAlert {
49
49
  * @memberof PriceAlert
50
50
  */
51
51
  enabled: boolean;
52
+ /**
53
+ *
54
+ * @type {boolean}
55
+ * @memberof PriceAlert
56
+ */
57
+ triggered: boolean;
58
+ /**
59
+ *
60
+ * @type {number}
61
+ * @memberof PriceAlert
62
+ */
63
+ triggered_at: number;
52
64
  }
53
65
 
54
66
  /**
@@ -60,6 +72,8 @@ export function instanceOfPriceAlert(value: object): value is PriceAlert {
60
72
  if (!('direction' in value) || value['direction'] === undefined) return false;
61
73
  if (!('frequency_minutes' in value) || value['frequency_minutes'] === undefined) return false;
62
74
  if (!('enabled' in value) || value['enabled'] === undefined) return false;
75
+ if (!('triggered' in value) || value['triggered'] === undefined) return false;
76
+ if (!('triggered_at' in value) || value['triggered_at'] === undefined) return false;
63
77
  return true;
64
78
  }
65
79
 
@@ -78,6 +92,8 @@ export function PriceAlertFromJSONTyped(json: any, ignoreDiscriminator: boolean)
78
92
  'direction': json['direction'],
79
93
  'frequency_minutes': json['frequency_minutes'],
80
94
  'enabled': json['enabled'],
95
+ 'triggered': json['triggered'],
96
+ 'triggered_at': json['triggered_at'],
81
97
  };
82
98
  }
83
99
 
@@ -92,6 +108,8 @@ export function PriceAlertToJSON(value?: PriceAlert | null): any {
92
108
  'direction': value['direction'],
93
109
  'frequency_minutes': value['frequency_minutes'],
94
110
  'enabled': value['enabled'],
111
+ 'triggered': value['triggered'],
112
+ 'triggered_at': value['triggered_at'],
95
113
  };
96
114
  }
97
115
 
@@ -49,6 +49,18 @@ export interface PriceChangeAlert {
49
49
  * @memberof PriceChangeAlert
50
50
  */
51
51
  enabled: boolean;
52
+ /**
53
+ *
54
+ * @type {boolean}
55
+ * @memberof PriceChangeAlert
56
+ */
57
+ triggered: boolean;
58
+ /**
59
+ *
60
+ * @type {number}
61
+ * @memberof PriceChangeAlert
62
+ */
63
+ triggered_at: number;
52
64
  }
53
65
 
54
66
  /**
@@ -60,6 +72,8 @@ export function instanceOfPriceChangeAlert(value: object): value is PriceChangeA
60
72
  if (!('reference_price' in value) || value['reference_price'] === undefined) return false;
61
73
  if (!('frequency_minutes' in value) || value['frequency_minutes'] === undefined) return false;
62
74
  if (!('enabled' in value) || value['enabled'] === undefined) return false;
75
+ if (!('triggered' in value) || value['triggered'] === undefined) return false;
76
+ if (!('triggered_at' in value) || value['triggered_at'] === undefined) return false;
63
77
  return true;
64
78
  }
65
79
 
@@ -78,6 +92,8 @@ export function PriceChangeAlertFromJSONTyped(json: any, ignoreDiscriminator: bo
78
92
  'reference_price': json['reference_price'],
79
93
  'frequency_minutes': json['frequency_minutes'],
80
94
  'enabled': json['enabled'],
95
+ 'triggered': json['triggered'],
96
+ 'triggered_at': json['triggered_at'],
81
97
  };
82
98
  }
83
99
 
@@ -92,6 +108,8 @@ export function PriceChangeAlertToJSON(value?: PriceChangeAlert | null): any {
92
108
  'reference_price': value['reference_price'],
93
109
  'frequency_minutes': value['frequency_minutes'],
94
110
  'enabled': value['enabled'],
111
+ 'triggered': value['triggered'],
112
+ 'triggered_at': value['triggered_at'],
95
113
  };
96
114
  }
97
115
 
@@ -32,11 +32,17 @@ export interface ReqGetPositionFunding {
32
32
  */
33
33
  account_index: number;
34
34
  /**
35
- *
35
+ * kept for backward compat, use MarketIDs instead
36
36
  * @type {number}
37
37
  * @memberof ReqGetPositionFunding
38
38
  */
39
39
  market_id?: number;
40
+ /**
41
+ *
42
+ * @type {Array<number>}
43
+ * @memberof ReqGetPositionFunding
44
+ */
45
+ market_ids?: Array<number>;
40
46
  /**
41
47
  *
42
48
  * @type {string}
@@ -103,6 +109,7 @@ export function ReqGetPositionFundingFromJSONTyped(json: any, ignoreDiscriminato
103
109
  'auth': json['auth'] == null ? undefined : json['auth'],
104
110
  'account_index': json['account_index'],
105
111
  'market_id': json['market_id'] == null ? undefined : json['market_id'],
112
+ 'market_ids': json['market_ids'] == null ? undefined : json['market_ids'],
106
113
  'cursor': json['cursor'] == null ? undefined : json['cursor'],
107
114
  'limit': json['limit'],
108
115
  'side': json['side'] == null ? undefined : json['side'],
@@ -120,6 +127,7 @@ export function ReqGetPositionFundingToJSON(value?: ReqGetPositionFunding | null
120
127
  'auth': value['auth'],
121
128
  'account_index': value['account_index'],
122
129
  'market_id': value['market_id'],
130
+ 'market_ids': value['market_ids'],
123
131
  'cursor': value['cursor'],
124
132
  'limit': value['limit'],
125
133
  'side': value['side'],
package/models/index.ts CHANGED
@@ -75,6 +75,8 @@ export * from './MarkPriceCandle';
75
75
  export * from './MarkPriceCandles';
76
76
  export * from './MarketConfig';
77
77
  export * from './MarketMetricData';
78
+ export * from './MarketPriceChart';
79
+ export * from './MarketPriceCharts';
78
80
  export * from './NextNonce';
79
81
  export * from './NotificationPreferences';
80
82
  export * from './Order';
@@ -143,6 +145,7 @@ export * from './ReqGetLiquidationInfos';
143
145
  export * from './ReqGetMakerOnlyApiKeys';
144
146
  export * from './ReqGetMarkPriceCandles';
145
147
  export * from './ReqGetMarketMetrics';
148
+ export * from './ReqGetMarketPriceCharts';
146
149
  export * from './ReqGetNextNonce';
147
150
  export * from './ReqGetOrderBookDetails';
148
151
  export * from './ReqGetOrderBookOrders';
package/openapi.json CHANGED
@@ -2818,6 +2818,42 @@
2818
2818
  "description": "Get market metrics for a specific timestamp, returns data for all markets"
2819
2819
  }
2820
2820
  },
2821
+ "/api/v1/marketPriceCharts": {
2822
+ "get": {
2823
+ "summary": "marketPriceCharts",
2824
+ "operationId": "marketPriceCharts",
2825
+ "responses": {
2826
+ "200": {
2827
+ "description": "A successful response.",
2828
+ "schema": {
2829
+ "$ref": "#/definitions/MarketPriceCharts"
2830
+ }
2831
+ },
2832
+ "400": {
2833
+ "description": "Bad request",
2834
+ "schema": {
2835
+ "$ref": "#/definitions/ResultCode"
2836
+ }
2837
+ }
2838
+ },
2839
+ "parameters": [
2840
+ {
2841
+ "name": "market_ids",
2842
+ "in": "query",
2843
+ "required": false,
2844
+ "type": "integer",
2845
+ "format": "int16"
2846
+ }
2847
+ ],
2848
+ "tags": [
2849
+ "candlestick"
2850
+ ],
2851
+ "consumes": [
2852
+ "multipart/form-data"
2853
+ ],
2854
+ "description": "Get last 24h hourly prices for all markets (mark price for perps, index price for spot)"
2855
+ }
2856
+ },
2821
2857
  "/api/v1/nextNonce": {
2822
2858
  "get": {
2823
2859
  "summary": "nextNonce",
@@ -3251,12 +3287,20 @@
3251
3287
  },
3252
3288
  {
3253
3289
  "name": "market_id",
3290
+ "description": " kept for backward compat, use MarketIDs instead",
3254
3291
  "in": "query",
3255
3292
  "required": false,
3256
3293
  "type": "integer",
3257
3294
  "format": "int16",
3258
3295
  "default": "255"
3259
3296
  },
3297
+ {
3298
+ "name": "market_ids",
3299
+ "in": "query",
3300
+ "required": false,
3301
+ "type": "integer",
3302
+ "format": "int16"
3303
+ },
3260
3304
  {
3261
3305
  "name": "cursor",
3262
3306
  "in": "query",
@@ -8449,6 +8493,55 @@
8449
8493
  "data"
8450
8494
  ]
8451
8495
  },
8496
+ "MarketPriceChart": {
8497
+ "type": "object",
8498
+ "properties": {
8499
+ "market_id": {
8500
+ "type": "integer",
8501
+ "format": "int16"
8502
+ },
8503
+ "prices": {
8504
+ "type": "array",
8505
+ "items": {
8506
+ "type": "string"
8507
+ }
8508
+ }
8509
+ },
8510
+ "title": "MarketPriceChart",
8511
+ "required": [
8512
+ "market_id",
8513
+ "prices"
8514
+ ]
8515
+ },
8516
+ "MarketPriceCharts": {
8517
+ "type": "object",
8518
+ "properties": {
8519
+ "code": {
8520
+ "type": "integer",
8521
+ "format": "int32",
8522
+ "example": "200"
8523
+ },
8524
+ "message": {
8525
+ "type": "string"
8526
+ },
8527
+ "resolution": {
8528
+ "type": "string",
8529
+ "example": "1h"
8530
+ },
8531
+ "price_charts": {
8532
+ "type": "array",
8533
+ "items": {
8534
+ "$ref": "#/definitions/MarketPriceChart"
8535
+ }
8536
+ }
8537
+ },
8538
+ "title": "MarketPriceCharts",
8539
+ "required": [
8540
+ "code",
8541
+ "resolution",
8542
+ "price_charts"
8543
+ ]
8544
+ },
8452
8545
  "NextNonce": {
8453
8546
  "type": "object",
8454
8547
  "properties": {
@@ -8490,6 +8583,10 @@
8490
8583
  "price_alerts_enabled": {
8491
8584
  "type": "boolean",
8492
8585
  "format": "boolean"
8586
+ },
8587
+ "order_filled_enabled": {
8588
+ "type": "boolean",
8589
+ "format": "boolean"
8493
8590
  }
8494
8591
  },
8495
8592
  "title": "NotificationPreferences",
@@ -8497,7 +8594,8 @@
8497
8594
  "liquidations_enabled",
8498
8595
  "global_announcements_enabled",
8499
8596
  "private_announcements_enabled",
8500
- "price_alerts_enabled"
8597
+ "price_alerts_enabled",
8598
+ "order_filled_enabled"
8501
8599
  ]
8502
8600
  },
8503
8601
  "Order": {
@@ -9825,6 +9923,14 @@
9825
9923
  "enabled": {
9826
9924
  "type": "boolean",
9827
9925
  "format": "boolean"
9926
+ },
9927
+ "triggered": {
9928
+ "type": "boolean",
9929
+ "format": "boolean"
9930
+ },
9931
+ "triggered_at": {
9932
+ "type": "integer",
9933
+ "format": "int64"
9828
9934
  }
9829
9935
  },
9830
9936
  "title": "PriceAlert",
@@ -9833,7 +9939,9 @@
9833
9939
  "trigger_price",
9834
9940
  "direction",
9835
9941
  "frequency_minutes",
9836
- "enabled"
9942
+ "enabled",
9943
+ "triggered",
9944
+ "triggered_at"
9837
9945
  ]
9838
9946
  },
9839
9947
  "PriceChangeAlert": {
@@ -9857,6 +9965,14 @@
9857
9965
  "enabled": {
9858
9966
  "type": "boolean",
9859
9967
  "format": "boolean"
9968
+ },
9969
+ "triggered": {
9970
+ "type": "boolean",
9971
+ "format": "boolean"
9972
+ },
9973
+ "triggered_at": {
9974
+ "type": "integer",
9975
+ "format": "int64"
9860
9976
  }
9861
9977
  },
9862
9978
  "title": "PriceChangeAlert",
@@ -9865,7 +9981,9 @@
9865
9981
  "change_percent",
9866
9982
  "reference_price",
9867
9983
  "frequency_minutes",
9868
- "enabled"
9984
+ "enabled",
9985
+ "triggered",
9986
+ "triggered_at"
9869
9987
  ]
9870
9988
  },
9871
9989
  "PriceLevel": {
@@ -11541,6 +11659,19 @@
11541
11659
  "kind"
11542
11660
  ]
11543
11661
  },
11662
+ "ReqGetMarketPriceCharts": {
11663
+ "type": "object",
11664
+ "properties": {
11665
+ "market_ids": {
11666
+ "type": "array",
11667
+ "items": {
11668
+ "type": "integer",
11669
+ "format": "int64"
11670
+ }
11671
+ }
11672
+ },
11673
+ "title": "ReqGetMarketPriceCharts"
11674
+ },
11544
11675
  "ReqGetNextNonce": {
11545
11676
  "type": "object",
11546
11677
  "properties": {
@@ -11657,7 +11788,15 @@
11657
11788
  "market_id": {
11658
11789
  "type": "integer",
11659
11790
  "format": "int16",
11660
- "default": "255"
11791
+ "default": "255",
11792
+ "description": " kept for backward compat, use MarketIDs instead"
11793
+ },
11794
+ "market_ids": {
11795
+ "type": "array",
11796
+ "items": {
11797
+ "type": "integer",
11798
+ "format": "int64"
11799
+ }
11661
11800
  },
11662
11801
  "cursor": {
11663
11802
  "type": "string"
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "zklighter-perps",
3
- "version": "1.0.269",
3
+ "version": "1.0.271",
4
4
  "description": "Lighter Perps SDK",
5
5
  "main": "index.ts",
6
6
  "directories": {