@binance/derivatives-trading-options 16.0.5 → 16.0.7

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/index.d.mts CHANGED
@@ -305,6 +305,12 @@ interface AccountFundingFlowResponseInner {
305
305
  * @memberof AccountFundingFlowResponseInner
306
306
  */
307
307
  amount?: string;
308
+ /**
309
+ * Option symbol the record relates to. Returned only for contract-related types (e.g. `CONTRACT`, `FEE`, `EXERCISE_PNL`, `EXERCISE_FEE`); omitted for other types such as `TRANSFER`. Older records may not include this field.
310
+ * @type {string}
311
+ * @memberof AccountFundingFlowResponseInner
312
+ */
313
+ symbol?: string;
308
314
  /**
309
315
  * type (fees)
310
316
  * @type {string}
@@ -2397,7 +2403,7 @@ interface PlaceMultipleOrdersOrdersParameterInner {
2397
2403
  */
2398
2404
  isMmp?: boolean;
2399
2405
  /**
2400
- * EXPIRE_TAKER:expire taker order when STP triggers/ EXPIRE_MAKER:expire maker order when STP triggers/ EXPIRE_BOTH:expire both orders when STP triggers; Default EXPIRE_MAKER
2406
+ * EXPIRE_TAKER: expire taker order when STP triggers/ EXPIRE_MAKER: expire maker order when STP triggers/ EXPIRE_BOTH: expire both orders when STP triggers; Default EXPIRE_MAKER
2401
2407
  * @type {string}
2402
2408
  * @memberof PlaceMultipleOrdersOrdersParameterInner
2403
2409
  */
@@ -5263,7 +5269,7 @@ declare class MarketMakerEndpointsApi implements MarketMakerEndpointsApiInterfac
5263
5269
  */
5264
5270
  interface TradeApiInterface {
5265
5271
  /**
5266
- * Get trades for a specific account and symbol.
5272
+ * Get trades for a specific account and symbol. Only supports querying trades in the past 3 months; a `startTime`/`endTime` outside that window returns `-6073 SEARCH_WINDOW_RESTRICTED`.
5267
5273
  *
5268
5274
  * Weight(IP): 5
5269
5275
  *
@@ -5925,7 +5931,7 @@ declare class TradeApi implements TradeApiInterface {
5925
5931
  private localVarAxiosParamCreator;
5926
5932
  constructor(configuration: ConfigurationRestAPI);
5927
5933
  /**
5928
- * Get trades for a specific account and symbol.
5934
+ * Get trades for a specific account and symbol. Only supports querying trades in the past 3 months; a `startTime`/`endTime` outside that window returns `-6073 SEARCH_WINDOW_RESTRICTED`.
5929
5935
  *
5930
5936
  * Weight(IP): 5
5931
5937
  *
@@ -6726,7 +6732,7 @@ declare class RestAPI {
6726
6732
  */
6727
6733
  setMarketMakerProtectionConfig(requestParameters: SetMarketMakerProtectionConfigRequest): Promise<RestApiResponse<SetMarketMakerProtectionConfigResponse>>;
6728
6734
  /**
6729
- * Get trades for a specific account and symbol.
6735
+ * Get trades for a specific account and symbol. Only supports querying trades in the past 3 months; a `startTime`/`endTime` outside that window returns `-6073 SEARCH_WINDOW_RESTRICTED`.
6730
6736
  *
6731
6737
  * Weight(IP): 5
6732
6738
  *
@@ -8564,7 +8570,7 @@ interface MarketApiInterface {
8564
8570
  */
8565
8571
  newSymbolInfo(requestParameters?: NewSymbolInfoRequest): WebsocketStream<NewSymbolInfoResponse>;
8566
8572
  /**
8567
- * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125)
8573
+ * Option open interest for specific underlying asset on specific expiration date. E.g.ethusdt@openInterest@221125
8568
8574
  *
8569
8575
  * Update Speed: 60s
8570
8576
  *
@@ -8577,7 +8583,7 @@ interface MarketApiInterface {
8577
8583
  */
8578
8584
  openInterest(requestParameters: OpenInterestRequest): WebsocketStream<OpenInterestResponse>;
8579
8585
  /**
8580
- * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice)
8586
+ * The mark price for all option symbols on specific underlying asset. E.g.btcusdt@optionMarkPrice
8581
8587
  *
8582
8588
  * Update Speed: 1000ms
8583
8589
  *
@@ -8729,7 +8735,7 @@ declare class MarketApi implements MarketApiInterface {
8729
8735
  */
8730
8736
  newSymbolInfo(requestParameters?: NewSymbolInfoRequest): WebsocketStream<NewSymbolInfoResponse>;
8731
8737
  /**
8732
- * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125)
8738
+ * Option open interest for specific underlying asset on specific expiration date. E.g.ethusdt@openInterest@221125
8733
8739
  *
8734
8740
  * Update Speed: 60s
8735
8741
  *
@@ -8742,7 +8748,7 @@ declare class MarketApi implements MarketApiInterface {
8742
8748
  */
8743
8749
  openInterest(requestParameters: OpenInterestRequest): WebsocketStream<OpenInterestResponse>;
8744
8750
  /**
8745
- * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice)
8751
+ * The mark price for all option symbols on specific underlying asset. E.g.btcusdt@optionMarkPrice
8746
8752
  *
8747
8753
  * Update Speed: 1000ms
8748
8754
  *
@@ -8830,7 +8836,7 @@ interface PublicApiInterface {
8830
8836
  */
8831
8837
  partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream<PartialBookDepthStreamsResponse>;
8832
8838
  /**
8833
- * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade)
8839
+ * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.btcusdt@optionTrade
8834
8840
  *
8835
8841
  * Update Speed: 50ms
8836
8842
  *
@@ -9019,7 +9025,7 @@ declare class PublicApi implements PublicApiInterface {
9019
9025
  */
9020
9026
  partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream<PartialBookDepthStreamsResponse>;
9021
9027
  /**
9022
- * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade)
9028
+ * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.btcusdt@optionTrade
9023
9029
  *
9024
9030
  * Update Speed: 50ms
9025
9031
  *
@@ -9154,7 +9160,7 @@ declare class WebsocketStreamsConnection {
9154
9160
  */
9155
9161
  newSymbolInfo(requestParameters?: NewSymbolInfoRequest): WebsocketStream<NewSymbolInfoResponse>;
9156
9162
  /**
9157
- * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125)
9163
+ * Option open interest for specific underlying asset on specific expiration date. E.g.ethusdt@openInterest@221125
9158
9164
  *
9159
9165
  * Update Speed: 60s
9160
9166
  *
@@ -9167,7 +9173,7 @@ declare class WebsocketStreamsConnection {
9167
9173
  */
9168
9174
  openInterest(requestParameters: OpenInterestRequest): WebsocketStream<OpenInterestResponse>;
9169
9175
  /**
9170
- * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice)
9176
+ * The mark price for all option symbols on specific underlying asset. E.g.btcusdt@optionMarkPrice
9171
9177
  *
9172
9178
  * Update Speed: 1000ms
9173
9179
  *
@@ -9232,7 +9238,7 @@ declare class WebsocketStreamsConnection {
9232
9238
  */
9233
9239
  partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream<PartialBookDepthStreamsResponse>;
9234
9240
  /**
9235
- * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade)
9241
+ * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.btcusdt@optionTrade
9236
9242
  *
9237
9243
  * Update Speed: 50ms
9238
9244
  *
package/dist/index.d.ts CHANGED
@@ -306,6 +306,12 @@ interface AccountFundingFlowResponseInner {
306
306
  * @memberof AccountFundingFlowResponseInner
307
307
  */
308
308
  amount?: string;
309
+ /**
310
+ * Option symbol the record relates to. Returned only for contract-related types (e.g. `CONTRACT`, `FEE`, `EXERCISE_PNL`, `EXERCISE_FEE`); omitted for other types such as `TRANSFER`. Older records may not include this field.
311
+ * @type {string}
312
+ * @memberof AccountFundingFlowResponseInner
313
+ */
314
+ symbol?: string;
309
315
  /**
310
316
  * type (fees)
311
317
  * @type {string}
@@ -2398,7 +2404,7 @@ interface PlaceMultipleOrdersOrdersParameterInner {
2398
2404
  */
2399
2405
  isMmp?: boolean;
2400
2406
  /**
2401
- * EXPIRE_TAKER:expire taker order when STP triggers/ EXPIRE_MAKER:expire maker order when STP triggers/ EXPIRE_BOTH:expire both orders when STP triggers; Default EXPIRE_MAKER
2407
+ * EXPIRE_TAKER: expire taker order when STP triggers/ EXPIRE_MAKER: expire maker order when STP triggers/ EXPIRE_BOTH: expire both orders when STP triggers; Default EXPIRE_MAKER
2402
2408
  * @type {string}
2403
2409
  * @memberof PlaceMultipleOrdersOrdersParameterInner
2404
2410
  */
@@ -5264,7 +5270,7 @@ declare class MarketMakerEndpointsApi implements MarketMakerEndpointsApiInterfac
5264
5270
  */
5265
5271
  interface TradeApiInterface {
5266
5272
  /**
5267
- * Get trades for a specific account and symbol.
5273
+ * Get trades for a specific account and symbol. Only supports querying trades in the past 3 months; a `startTime`/`endTime` outside that window returns `-6073 SEARCH_WINDOW_RESTRICTED`.
5268
5274
  *
5269
5275
  * Weight(IP): 5
5270
5276
  *
@@ -5926,7 +5932,7 @@ declare class TradeApi implements TradeApiInterface {
5926
5932
  private localVarAxiosParamCreator;
5927
5933
  constructor(configuration: ConfigurationRestAPI);
5928
5934
  /**
5929
- * Get trades for a specific account and symbol.
5935
+ * Get trades for a specific account and symbol. Only supports querying trades in the past 3 months; a `startTime`/`endTime` outside that window returns `-6073 SEARCH_WINDOW_RESTRICTED`.
5930
5936
  *
5931
5937
  * Weight(IP): 5
5932
5938
  *
@@ -6727,7 +6733,7 @@ declare class RestAPI {
6727
6733
  */
6728
6734
  setMarketMakerProtectionConfig(requestParameters: SetMarketMakerProtectionConfigRequest): Promise<RestApiResponse<SetMarketMakerProtectionConfigResponse>>;
6729
6735
  /**
6730
- * Get trades for a specific account and symbol.
6736
+ * Get trades for a specific account and symbol. Only supports querying trades in the past 3 months; a `startTime`/`endTime` outside that window returns `-6073 SEARCH_WINDOW_RESTRICTED`.
6731
6737
  *
6732
6738
  * Weight(IP): 5
6733
6739
  *
@@ -8565,7 +8571,7 @@ interface MarketApiInterface {
8565
8571
  */
8566
8572
  newSymbolInfo(requestParameters?: NewSymbolInfoRequest): WebsocketStream<NewSymbolInfoResponse>;
8567
8573
  /**
8568
- * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125)
8574
+ * Option open interest for specific underlying asset on specific expiration date. E.g.ethusdt@openInterest@221125
8569
8575
  *
8570
8576
  * Update Speed: 60s
8571
8577
  *
@@ -8578,7 +8584,7 @@ interface MarketApiInterface {
8578
8584
  */
8579
8585
  openInterest(requestParameters: OpenInterestRequest): WebsocketStream<OpenInterestResponse>;
8580
8586
  /**
8581
- * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice)
8587
+ * The mark price for all option symbols on specific underlying asset. E.g.btcusdt@optionMarkPrice
8582
8588
  *
8583
8589
  * Update Speed: 1000ms
8584
8590
  *
@@ -8730,7 +8736,7 @@ declare class MarketApi implements MarketApiInterface {
8730
8736
  */
8731
8737
  newSymbolInfo(requestParameters?: NewSymbolInfoRequest): WebsocketStream<NewSymbolInfoResponse>;
8732
8738
  /**
8733
- * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125)
8739
+ * Option open interest for specific underlying asset on specific expiration date. E.g.ethusdt@openInterest@221125
8734
8740
  *
8735
8741
  * Update Speed: 60s
8736
8742
  *
@@ -8743,7 +8749,7 @@ declare class MarketApi implements MarketApiInterface {
8743
8749
  */
8744
8750
  openInterest(requestParameters: OpenInterestRequest): WebsocketStream<OpenInterestResponse>;
8745
8751
  /**
8746
- * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice)
8752
+ * The mark price for all option symbols on specific underlying asset. E.g.btcusdt@optionMarkPrice
8747
8753
  *
8748
8754
  * Update Speed: 1000ms
8749
8755
  *
@@ -8831,7 +8837,7 @@ interface PublicApiInterface {
8831
8837
  */
8832
8838
  partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream<PartialBookDepthStreamsResponse>;
8833
8839
  /**
8834
- * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade)
8840
+ * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.btcusdt@optionTrade
8835
8841
  *
8836
8842
  * Update Speed: 50ms
8837
8843
  *
@@ -9020,7 +9026,7 @@ declare class PublicApi implements PublicApiInterface {
9020
9026
  */
9021
9027
  partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream<PartialBookDepthStreamsResponse>;
9022
9028
  /**
9023
- * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade)
9029
+ * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.btcusdt@optionTrade
9024
9030
  *
9025
9031
  * Update Speed: 50ms
9026
9032
  *
@@ -9155,7 +9161,7 @@ declare class WebsocketStreamsConnection {
9155
9161
  */
9156
9162
  newSymbolInfo(requestParameters?: NewSymbolInfoRequest): WebsocketStream<NewSymbolInfoResponse>;
9157
9163
  /**
9158
- * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125)
9164
+ * Option open interest for specific underlying asset on specific expiration date. E.g.ethusdt@openInterest@221125
9159
9165
  *
9160
9166
  * Update Speed: 60s
9161
9167
  *
@@ -9168,7 +9174,7 @@ declare class WebsocketStreamsConnection {
9168
9174
  */
9169
9175
  openInterest(requestParameters: OpenInterestRequest): WebsocketStream<OpenInterestResponse>;
9170
9176
  /**
9171
- * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice)
9177
+ * The mark price for all option symbols on specific underlying asset. E.g.btcusdt@optionMarkPrice
9172
9178
  *
9173
9179
  * Update Speed: 1000ms
9174
9180
  *
@@ -9233,7 +9239,7 @@ declare class WebsocketStreamsConnection {
9233
9239
  */
9234
9240
  partialBookDepthStreams(requestParameters: PartialBookDepthStreamsRequest): WebsocketStream<PartialBookDepthStreamsResponse>;
9235
9241
  /**
9236
- * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade)
9242
+ * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.btcusdt@optionTrade
9237
9243
  *
9238
9244
  * Update Speed: 50ms
9239
9245
  *
package/dist/index.js CHANGED
@@ -14,7 +14,7 @@ let __binance_common = require("@binance/common");
14
14
 
15
15
  //#region package.json
16
16
  var name = "@binance/derivatives-trading-options";
17
- var version = "16.0.5";
17
+ var version = "16.0.7";
18
18
 
19
19
  //#endregion
20
20
  //#region src/rest-api/types/new-block-trade-order-legs-parameter-inner.ts
@@ -1489,7 +1489,7 @@ var TradeApi = class {
1489
1489
  this.localVarAxiosParamCreator = TradeApiAxiosParamCreator(configuration);
1490
1490
  }
1491
1491
  /**
1492
- * Get trades for a specific account and symbol.
1492
+ * Get trades for a specific account and symbol. Only supports querying trades in the past 3 months; a `startTime`/`endTime` outside that window returns `-6073 SEARCH_WINDOW_RESTRICTED`.
1493
1493
  *
1494
1494
  * Weight(IP): 5
1495
1495
  *
@@ -2437,7 +2437,7 @@ var RestAPI = class {
2437
2437
  return this.marketMakerEndpointsApi.setMarketMakerProtectionConfig(requestParameters);
2438
2438
  }
2439
2439
  /**
2440
- * Get trades for a specific account and symbol.
2440
+ * Get trades for a specific account and symbol. Only supports querying trades in the past 3 months; a `startTime`/`endTime` outside that window returns `-6073 SEARCH_WINDOW_RESTRICTED`.
2441
2441
  *
2442
2442
  * Weight(IP): 5
2443
2443
  *
@@ -2892,7 +2892,7 @@ var MarketApi = class {
2892
2892
  return (0, __binance_common.createStreamHandler)(this.websocketBase, stream, requestParameters?.id, "market");
2893
2893
  }
2894
2894
  /**
2895
- * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125)
2895
+ * Option open interest for specific underlying asset on specific expiration date. E.g.ethusdt@openInterest@221125
2896
2896
  *
2897
2897
  * Update Speed: 60s
2898
2898
  *
@@ -2908,7 +2908,7 @@ var MarketApi = class {
2908
2908
  return (0, __binance_common.createStreamHandler)(this.websocketBase, stream, requestParameters?.id, "market");
2909
2909
  }
2910
2910
  /**
2911
- * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice)
2911
+ * The mark price for all option symbols on specific underlying asset. E.g.btcusdt@optionMarkPrice
2912
2912
  *
2913
2913
  * Update Speed: 1000ms
2914
2914
  *
@@ -3076,7 +3076,7 @@ var PublicApi = class {
3076
3076
  return (0, __binance_common.createStreamHandler)(this.websocketBase, stream, requestParameters?.id, "public");
3077
3077
  }
3078
3078
  /**
3079
- * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade)
3079
+ * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.btcusdt@optionTrade
3080
3080
  *
3081
3081
  * Update Speed: 50ms
3082
3082
  *
@@ -3255,7 +3255,7 @@ var WebsocketStreamsConnection = class {
3255
3255
  return this.marketApi.newSymbolInfo(requestParameters);
3256
3256
  }
3257
3257
  /**
3258
- * Option open interest for specific underlying asset on specific expiration date. E.g.[ethusdt@openInterest@221125](wss://fstream.binance.com/market/stream?streams=ethusdt@openInterest@221125)
3258
+ * Option open interest for specific underlying asset on specific expiration date. E.g.ethusdt@openInterest@221125
3259
3259
  *
3260
3260
  * Update Speed: 60s
3261
3261
  *
@@ -3270,7 +3270,7 @@ var WebsocketStreamsConnection = class {
3270
3270
  return this.marketApi.openInterest(requestParameters);
3271
3271
  }
3272
3272
  /**
3273
- * The mark price for all option symbols on specific underlying asset. E.g.[btcusdt@optionMarkPrice](wss://fstream.binance.com/market/stream?streams=btcusdt@optionMarkPrice)
3273
+ * The mark price for all option symbols on specific underlying asset. E.g.btcusdt@optionMarkPrice
3274
3274
  *
3275
3275
  * Update Speed: 1000ms
3276
3276
  *
@@ -3345,7 +3345,7 @@ var WebsocketStreamsConnection = class {
3345
3345
  return this.publicApi.partialBookDepthStreams(requestParameters);
3346
3346
  }
3347
3347
  /**
3348
- * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.[btcusdt@optionTrade](wss://fstream.binance.com/public/stream?streams=btcusdt@optionTrade)
3348
+ * The Trade Streams push raw trade information for specific symbol or underlying asset. E.g.btcusdt@optionTrade
3349
3349
  *
3350
3350
  * Update Speed: 50ms
3351
3351
  *