@apicity/binance 0.4.3 → 0.5.1

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/README.md CHANGED
@@ -5,7 +5,9 @@
5
5
  [![TypeScript](https://img.shields.io/badge/TypeScript-strict-blue?logo=typescript&logoColor=white)](tsconfig.json)
6
6
  [![docs](https://img.shields.io/badge/docs-developers.binance.com-blue)](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-api-information)
7
7
 
8
- Binance Spot REST API provider.
8
+ Binance Spot, USD-M Futures, COIN-M Futures, and Options public REST API provider.
9
+
10
+ Binance coverage is focused on public REST market-data reads across Spot, USD-M Futures, COIN-M Futures, and Options. The COIN-M Old Trades Lookup endpoint (`GET /dapi/v1/historicalTrades`) is intentionally not exposed because Binance requires an API key for it. USD-M Old Trades Lookup (`GET /fapi/v1/historicalTrades`), signed trade, account, and user endpoints are out of scope.
9
11
 
10
12
  Runtime dependencies:
11
13
 
@@ -27,9 +29,63 @@ import { createBinance } from "@apicity/binance";
27
29
  const binance = createBinance();
28
30
  ```
29
31
 
32
+ ## Public Market Data
33
+
34
+ `createBinance()` works without credentials for the public market-data
35
+ surface. Pass `apiKey` only when you intentionally call a Binance
36
+ endpoint that is documented as API-key or `MARKET_DATA`; signed trade,
37
+ account, and user-data-stream endpoints are not exposed by this package.
38
+
39
+ | Surface | Namespace | Default host | Auth |
40
+ |---------|-----------|--------------|------|
41
+ | Spot REST | `binance.api.v3.*` | `https://api.binance.com` | No key for public market data; optional `apiKey` header when supplied |
42
+ | Spot market-data-only REST | `binance.api.v3.*` with `spotBaseURL` | `https://data-api.binance.vision` | No key |
43
+ | USD-M Futures | `binance.fapi.v1.*`, `binance.fapi.v2.*`, `binance.futures.data.*` | `https://fapi.binance.com` | No key for exposed endpoints |
44
+ | COIN-M Futures | `binance.dapi.v1.*`, `binance.coinMFutures.data.*` | `https://dapi.binance.com` | No key for exposed endpoints |
45
+ | Options | `binance.eapi.v1.*` | `https://eapi.binance.com` | No key for exposed endpoints |
46
+
47
+ To send existing Spot public calls to Binance's market-data-only host,
48
+ override the Spot base URL. This keeps the same `api.v3` method paths
49
+ while changing the host:
50
+
51
+ ```typescript
52
+ const binance = createBinance({
53
+ spotBaseURL: "https://data-api.binance.vision",
54
+ });
55
+
56
+ const exchangeInfo = await binance.api.v3.exchangeInfo({
57
+ symbol: "BTCUSDT",
58
+ showPermissionSets: false,
59
+ });
60
+ ```
61
+
62
+ You can also configure every public host explicitly:
63
+
64
+ ```typescript
65
+ const binance = createBinance({
66
+ publicBaseURLs: {
67
+ spot: "https://data-api.binance.vision",
68
+ spotData: "https://data-api.binance.vision",
69
+ fapi: "https://fapi.binance.com",
70
+ dapi: "https://dapi.binance.com",
71
+ eapi: "https://eapi.binance.com",
72
+ },
73
+ });
74
+ ```
75
+
76
+ `binance.public.*` contains explicit no-auth smoke aliases for each
77
+ public surface, and `binance.public.coinMFutures.*` mirrors the COIN-M
78
+ public REST tree. Use the top-level namespaces above for the full
79
+ implemented market-data surface.
80
+
81
+ The `https://data.binance.vision` static archive serves public ZIP and
82
+ checksum files for historical Spot, USD-M, and COIN-M datasets. It is
83
+ intentionally outside this JSON REST provider; archive downloads need
84
+ separate binary/checksum handling and tests.
85
+
30
86
  ## API Reference
31
87
 
32
- 18 endpoints across 13 groups. Each method mirrors an upstream URL path.
88
+ 93 endpoints across 20 groups. Each method mirrors an upstream URL path.
33
89
 
34
90
  ### aggTrades
35
91
 
@@ -65,102 +121,1241 @@ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
65
121
 
66
122
  </details>
67
123
 
68
- ### depth
124
+ ### coinMFutures
69
125
 
70
126
  <details>
71
- <summary><code>GET</code> <b><code>binance.api.v3.depth</code></b></summary>
127
+ <summary><code>GET</code> <b><code>binance.coinMFutures.data.basis</code></b></summary>
72
128
 
73
- <code>GET https://api.binance.com/api/v3/depth{query}</code>
129
+ <code>GET https://dapi.binance.com/futures/data/basis{query}</code>
74
130
 
75
- [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#order-book)
131
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Basis)
76
132
 
77
133
  ```typescript
78
- const res = await binance.api.v3.depth({ /* ... */ });
134
+ const res = await binance.coinMFutures.data.basis({ /* ... */ });
79
135
  ```
80
136
 
81
137
  Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
82
138
 
83
139
  </details>
84
140
 
85
- ### exchangeInfo
141
+ <details>
142
+ <summary><code>GET</code> <b><code>binance.coinMFutures.data.deliveryPrice</code></b></summary>
143
+
144
+ <code>GET https://dapi.binance.com/futures/data/delivery-price{query}</code>
145
+
146
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Delivery-Price)
147
+
148
+ ```typescript
149
+ const res = await binance.coinMFutures.data.deliveryPrice({ /* ... */ });
150
+ ```
151
+
152
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
153
+
154
+ </details>
86
155
 
87
156
  <details>
88
- <summary><code>GET</code> <b><code>binance.api.v3.exchangeInfo</code></b></summary>
157
+ <summary><code>GET</code> <b><code>binance.coinMFutures.data.globalLongShortAccountRatio</code></b></summary>
89
158
 
90
- <code>GET https://api.binance.com/api/v3/exchangeInfo{query}</code>
159
+ <code>GET https://dapi.binance.com/futures/data/globalLongShortAccountRatio{query}</code>
91
160
 
92
- [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#exchange-information)
161
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Long-Short-Ratio)
93
162
 
94
163
  ```typescript
95
- const res = await binance.api.v3.exchangeInfo({ /* ... */ });
164
+ const res = await binance.coinMFutures.data.globalLongShortAccountRatio({ /* ... */ });
96
165
  ```
97
166
 
98
167
  Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
99
168
 
100
169
  </details>
101
170
 
102
- ### historicalBlockTrades
171
+ <details>
172
+ <summary><code>GET</code> <b><code>binance.coinMFutures.data.openInterestHist</code></b></summary>
173
+
174
+ <code>GET https://dapi.binance.com/futures/data/openInterestHist{query}</code>
175
+
176
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Open-Interest-Statistics)
177
+
178
+ ```typescript
179
+ const res = await binance.coinMFutures.data.openInterestHist({ /* ... */ });
180
+ ```
181
+
182
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
183
+
184
+ </details>
103
185
 
104
186
  <details>
105
- <summary><code>GET</code> <b><code>binance.api.v3.historicalBlockTrades</code></b></summary>
187
+ <summary><code>GET</code> <b><code>binance.coinMFutures.data.takerBuySellVol</code></b></summary>
106
188
 
107
- <code>GET https://api.binance.com/api/v3/historicalBlockTrades{query}</code>
189
+ <code>GET https://dapi.binance.com/futures/data/takerBuySellVol{query}</code>
108
190
 
109
- [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#historical-block-trades)
191
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Taker-Buy-Sell-Volume)
110
192
 
111
193
  ```typescript
112
- const res = await binance.api.v3.historicalBlockTrades({ /* ... */ });
194
+ const res = await binance.coinMFutures.data.takerBuySellVol({ /* ... */ });
113
195
  ```
114
196
 
115
197
  Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
116
198
 
117
199
  </details>
118
200
 
119
- ### historicalTrades
201
+ <details>
202
+ <summary><code>GET</code> <b><code>binance.coinMFutures.data.topLongShortAccountRatio</code></b></summary>
203
+
204
+ <code>GET https://dapi.binance.com/futures/data/topLongShortAccountRatio{query}</code>
205
+
206
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Top-Long-Short-Account-Ratio)
207
+
208
+ ```typescript
209
+ const res = await binance.coinMFutures.data.topLongShortAccountRatio({ /* ... */ });
210
+ ```
211
+
212
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
213
+
214
+ </details>
120
215
 
121
216
  <details>
122
- <summary><code>GET</code> <b><code>binance.api.v3.historicalTrades</code></b></summary>
217
+ <summary><code>GET</code> <b><code>binance.coinMFutures.data.topLongShortPositionRatio</code></b></summary>
123
218
 
124
- <code>GET https://api.binance.com/api/v3/historicalTrades{query}</code>
219
+ <code>GET https://dapi.binance.com/futures/data/topLongShortPositionRatio{query}</code>
125
220
 
126
- [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#old-trade-lookup)
221
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Top-Trader-Long-Short-Ratio)
127
222
 
128
223
  ```typescript
129
- const res = await binance.api.v3.historicalTrades({ /* ... */ });
224
+ const res = await binance.coinMFutures.data.topLongShortPositionRatio({ /* ... */ });
130
225
  ```
131
226
 
132
227
  Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
133
228
 
134
229
  </details>
135
230
 
136
- ### klines
231
+ ### dapi
137
232
 
138
233
  <details>
139
- <summary><code>GET</code> <b><code>binance.api.v3.klines</code></b></summary>
234
+ <summary><code>GET</code> <b><code>binance.dapi.v1.aggTrades</code></b></summary>
140
235
 
141
- <code>GET https://api.binance.com/api/v3/klines{query}</code>
236
+ <code>GET https://dapi.binance.com/dapi/v1/aggTrades{query}</code>
142
237
 
143
- [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#klinecandlestick-data)
238
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Compressed-Aggregate-Trades-List)
144
239
 
145
240
  ```typescript
146
- const res = await binance.api.v3.klines({ /* ... */ });
241
+ const res = await binance.dapi.v1.aggTrades({ /* ... */ });
147
242
  ```
148
243
 
149
244
  Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
150
245
 
151
246
  </details>
152
247
 
153
- ### ping
248
+ <details>
249
+ <summary><code>GET</code> <b><code>binance.dapi.v1.constituents</code></b></summary>
250
+
251
+ <code>GET https://dapi.binance.com/dapi/v1/constituents{query}</code>
252
+
253
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Index-Constituents)
254
+
255
+ ```typescript
256
+ const res = await binance.dapi.v1.constituents({ /* ... */ });
257
+ ```
258
+
259
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
260
+
261
+ </details>
154
262
 
155
263
  <details>
156
- <summary><code>GET</code> <b><code>binance.api.v3.ping</code></b></summary>
264
+ <summary><code>GET</code> <b><code>binance.dapi.v1.continuousKlines</code></b></summary>
157
265
 
158
- <code>GET https://api.binance.com/api/v3/ping</code>
266
+ <code>GET https://dapi.binance.com/dapi/v1/continuousKlines{query}</code>
159
267
 
160
- [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#test-connectivity)
268
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Continuous-Contract-Kline-Candlestick-Data)
161
269
 
162
270
  ```typescript
163
- const res = await binance.api.v3.ping({ /* ... */ });
271
+ const res = await binance.dapi.v1.continuousKlines({ /* ... */ });
272
+ ```
273
+
274
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
275
+
276
+ </details>
277
+
278
+ <details>
279
+ <summary><code>GET</code> <b><code>binance.dapi.v1.depth</code></b></summary>
280
+
281
+ <code>GET https://dapi.binance.com/dapi/v1/depth{query}</code>
282
+
283
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Order-Book)
284
+
285
+ ```typescript
286
+ const res = await binance.dapi.v1.depth({ /* ... */ });
287
+ ```
288
+
289
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
290
+
291
+ </details>
292
+
293
+ <details>
294
+ <summary><code>GET</code> <b><code>binance.dapi.v1.exchangeInfo</code></b></summary>
295
+
296
+ <code>GET https://dapi.binance.com/dapi/v1/exchangeInfo</code>
297
+
298
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Exchange-Information)
299
+
300
+ ```typescript
301
+ const res = await binance.dapi.v1.exchangeInfo({ /* ... */ });
302
+ ```
303
+
304
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
305
+
306
+ </details>
307
+
308
+ <details>
309
+ <summary><code>GET</code> <b><code>binance.dapi.v1.fundingInfo</code></b></summary>
310
+
311
+ <code>GET https://dapi.binance.com/dapi/v1/fundingInfo</code>
312
+
313
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Get-Funding-Info)
314
+
315
+ ```typescript
316
+ const res = await binance.dapi.v1.fundingInfo({ /* ... */ });
317
+ ```
318
+
319
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
320
+
321
+ </details>
322
+
323
+ <details>
324
+ <summary><code>GET</code> <b><code>binance.dapi.v1.fundingRate</code></b></summary>
325
+
326
+ <code>GET https://dapi.binance.com/dapi/v1/fundingRate{query}</code>
327
+
328
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Get-Funding-Rate-History-of-Perpetual-Futures)
329
+
330
+ ```typescript
331
+ const res = await binance.dapi.v1.fundingRate({ /* ... */ });
332
+ ```
333
+
334
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
335
+
336
+ </details>
337
+
338
+ <details>
339
+ <summary><code>GET</code> <b><code>binance.dapi.v1.indexPriceKlines</code></b></summary>
340
+
341
+ <code>GET https://dapi.binance.com/dapi/v1/indexPriceKlines{query}</code>
342
+
343
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Index-Price-Kline-Candlestick-Data)
344
+
345
+ ```typescript
346
+ const res = await binance.dapi.v1.indexPriceKlines({ /* ... */ });
347
+ ```
348
+
349
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
350
+
351
+ </details>
352
+
353
+ <details>
354
+ <summary><code>GET</code> <b><code>binance.dapi.v1.klines</code></b></summary>
355
+
356
+ <code>GET https://dapi.binance.com/dapi/v1/klines{query}</code>
357
+
358
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Kline-Candlestick-Data)
359
+
360
+ ```typescript
361
+ const res = await binance.dapi.v1.klines({ /* ... */ });
362
+ ```
363
+
364
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
365
+
366
+ </details>
367
+
368
+ <details>
369
+ <summary><code>GET</code> <b><code>binance.dapi.v1.markPriceKlines</code></b></summary>
370
+
371
+ <code>GET https://dapi.binance.com/dapi/v1/markPriceKlines{query}</code>
372
+
373
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Mark-Price-Kline-Candlestick-Data)
374
+
375
+ ```typescript
376
+ const res = await binance.dapi.v1.markPriceKlines({ /* ... */ });
377
+ ```
378
+
379
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
380
+
381
+ </details>
382
+
383
+ <details>
384
+ <summary><code>GET</code> <b><code>binance.dapi.v1.openInterest</code></b></summary>
385
+
386
+ <code>GET https://dapi.binance.com/dapi/v1/openInterest{query}</code>
387
+
388
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Open-Interest)
389
+
390
+ ```typescript
391
+ const res = await binance.dapi.v1.openInterest({ /* ... */ });
392
+ ```
393
+
394
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
395
+
396
+ </details>
397
+
398
+ <details>
399
+ <summary><code>GET</code> <b><code>binance.dapi.v1.ping</code></b></summary>
400
+
401
+ <code>GET https://dapi.binance.com/dapi/v1/ping</code>
402
+
403
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Test-Connectivity)
404
+
405
+ ```typescript
406
+ const res = await binance.dapi.v1.ping({ /* ... */ });
407
+ ```
408
+
409
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
410
+
411
+ </details>
412
+
413
+ <details>
414
+ <summary><code>GET</code> <b><code>binance.dapi.v1.premiumIndex</code></b></summary>
415
+
416
+ <code>GET https://dapi.binance.com/dapi/v1/premiumIndex{query}</code>
417
+
418
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Index-Price-and-Mark-Price)
419
+
420
+ ```typescript
421
+ const res = await binance.dapi.v1.premiumIndex({ /* ... */ });
422
+ ```
423
+
424
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
425
+
426
+ </details>
427
+
428
+ <details>
429
+ <summary><code>GET</code> <b><code>binance.dapi.v1.premiumIndexKlines</code></b></summary>
430
+
431
+ <code>GET https://dapi.binance.com/dapi/v1/premiumIndexKlines{query}</code>
432
+
433
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Premium-Index-Kline-Data)
434
+
435
+ ```typescript
436
+ const res = await binance.dapi.v1.premiumIndexKlines({ /* ... */ });
437
+ ```
438
+
439
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
440
+
441
+ </details>
442
+
443
+ <details>
444
+ <summary><code>GET</code> <b><code>binance.dapi.v1.ticker.bookTicker</code></b></summary>
445
+
446
+ <code>GET https://dapi.binance.com/dapi/v1/ticker/bookTicker{query}</code>
447
+
448
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Symbol-Order-Book-Ticker)
449
+
450
+ ```typescript
451
+ const res = await binance.dapi.v1.ticker.bookTicker({ /* ... */ });
452
+ ```
453
+
454
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
455
+
456
+ </details>
457
+
458
+ <details>
459
+ <summary><code>GET</code> <b><code>binance.dapi.v1.ticker.price</code></b></summary>
460
+
461
+ <code>GET https://dapi.binance.com/dapi/v1/ticker/price{query}</code>
462
+
463
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Symbol-Price-Ticker)
464
+
465
+ ```typescript
466
+ const res = await binance.dapi.v1.ticker.price({ /* ... */ });
467
+ ```
468
+
469
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
470
+
471
+ </details>
472
+
473
+ <details>
474
+ <summary><code>GET</code> <b><code>binance.dapi.v1.ticker.twentyFourHr</code></b></summary>
475
+
476
+ <code>GET https://dapi.binance.com/dapi/v1/ticker/24hr{query}</code>
477
+
478
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/24hr-Ticker-Price-Change-Statistics)
479
+
480
+ ```typescript
481
+ const res = await binance.dapi.v1.ticker.twentyFourHr({ /* ... */ });
482
+ ```
483
+
484
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
485
+
486
+ </details>
487
+
488
+ <details>
489
+ <summary><code>GET</code> <b><code>binance.dapi.v1.time</code></b></summary>
490
+
491
+ <code>GET https://dapi.binance.com/dapi/v1/time</code>
492
+
493
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Check-Server-time)
494
+
495
+ ```typescript
496
+ const res = await binance.dapi.v1.time({ /* ... */ });
497
+ ```
498
+
499
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
500
+
501
+ </details>
502
+
503
+ <details>
504
+ <summary><code>GET</code> <b><code>binance.dapi.v1.trades</code></b></summary>
505
+
506
+ <code>GET https://dapi.binance.com/dapi/v1/trades{query}</code>
507
+
508
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/coin-margined-futures/market-data/rest-api/Recent-Trades-List)
509
+
510
+ ```typescript
511
+ const res = await binance.dapi.v1.trades({ /* ... */ });
512
+ ```
513
+
514
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
515
+
516
+ </details>
517
+
518
+ ### depth
519
+
520
+ <details>
521
+ <summary><code>GET</code> <b><code>binance.api.v3.depth</code></b></summary>
522
+
523
+ <code>GET https://api.binance.com/api/v3/depth{query}</code>
524
+
525
+ [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#order-book)
526
+
527
+ ```typescript
528
+ const res = await binance.api.v3.depth({ /* ... */ });
529
+ ```
530
+
531
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
532
+
533
+ </details>
534
+
535
+ ### eapi
536
+
537
+ <details>
538
+ <summary><code>GET</code> <b><code>binance.eapi.v1.blockTrades</code></b></summary>
539
+
540
+ <code>GET https://eapi.binance.com/eapi/v1/blockTrades{query}</code>
541
+
542
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Recent-Block-Trade-List)
543
+
544
+ ```typescript
545
+ const res = await binance.eapi.v1.blockTrades({ /* ... */ });
546
+ ```
547
+
548
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
549
+
550
+ </details>
551
+
552
+ <details>
553
+ <summary><code>GET</code> <b><code>binance.eapi.v1.depth</code></b></summary>
554
+
555
+ <code>GET https://eapi.binance.com/eapi/v1/depth{query}</code>
556
+
557
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Order-Book)
558
+
559
+ ```typescript
560
+ const res = await binance.eapi.v1.depth({ /* ... */ });
561
+ ```
562
+
563
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
564
+
565
+ </details>
566
+
567
+ <details>
568
+ <summary><code>GET</code> <b><code>binance.eapi.v1.exchangeInfo</code></b></summary>
569
+
570
+ <code>GET https://eapi.binance.com/eapi/v1/exchangeInfo</code>
571
+
572
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Exchange-Information)
573
+
574
+ ```typescript
575
+ const res = await binance.eapi.v1.exchangeInfo({ /* ... */ });
576
+ ```
577
+
578
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
579
+
580
+ </details>
581
+
582
+ <details>
583
+ <summary><code>GET</code> <b><code>binance.eapi.v1.exerciseHistory</code></b></summary>
584
+
585
+ <code>GET https://eapi.binance.com/eapi/v1/exerciseHistory{query}</code>
586
+
587
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Historical-Exercise-Records)
588
+
589
+ ```typescript
590
+ const res = await binance.eapi.v1.exerciseHistory({ /* ... */ });
591
+ ```
592
+
593
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
594
+
595
+ </details>
596
+
597
+ <details>
598
+ <summary><code>GET</code> <b><code>binance.eapi.v1.index</code></b></summary>
599
+
600
+ <code>GET https://eapi.binance.com/eapi/v1/index{query}</code>
601
+
602
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Symbol-Price-Ticker)
603
+
604
+ ```typescript
605
+ const res = await binance.eapi.v1.index({ /* ... */ });
606
+ ```
607
+
608
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
609
+
610
+ </details>
611
+
612
+ <details>
613
+ <summary><code>GET</code> <b><code>binance.eapi.v1.klines</code></b></summary>
614
+
615
+ <code>GET https://eapi.binance.com/eapi/v1/klines{query}</code>
616
+
617
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Kline-Candlestick-Data)
618
+
619
+ ```typescript
620
+ const res = await binance.eapi.v1.klines({ /* ... */ });
621
+ ```
622
+
623
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
624
+
625
+ </details>
626
+
627
+ <details>
628
+ <summary><code>GET</code> <b><code>binance.eapi.v1.mark</code></b></summary>
629
+
630
+ <code>GET https://eapi.binance.com/eapi/v1/mark{query}</code>
631
+
632
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Option-Mark-Price)
633
+
634
+ ```typescript
635
+ const res = await binance.eapi.v1.mark({ /* ... */ });
636
+ ```
637
+
638
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
639
+
640
+ </details>
641
+
642
+ <details>
643
+ <summary><code>GET</code> <b><code>binance.eapi.v1.openInterest</code></b></summary>
644
+
645
+ <code>GET https://eapi.binance.com/eapi/v1/openInterest{query}</code>
646
+
647
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Open-Interest)
648
+
649
+ ```typescript
650
+ const res = await binance.eapi.v1.openInterest({ /* ... */ });
651
+ ```
652
+
653
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
654
+
655
+ </details>
656
+
657
+ <details>
658
+ <summary><code>GET</code> <b><code>binance.eapi.v1.ping</code></b></summary>
659
+
660
+ <code>GET https://eapi.binance.com/eapi/v1/ping</code>
661
+
662
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Test-Connectivity)
663
+
664
+ ```typescript
665
+ const res = await binance.eapi.v1.ping({ /* ... */ });
666
+ ```
667
+
668
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
669
+
670
+ </details>
671
+
672
+ <details>
673
+ <summary><code>GET</code> <b><code>binance.eapi.v1.ticker</code></b></summary>
674
+
675
+ <code>GET https://eapi.binance.com/eapi/v1/ticker{query}</code>
676
+
677
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/24hr-Ticker-Price-Change-Statistics)
678
+
679
+ ```typescript
680
+ const res = await binance.eapi.v1.ticker({ /* ... */ });
681
+ ```
682
+
683
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
684
+
685
+ </details>
686
+
687
+ <details>
688
+ <summary><code>GET</code> <b><code>binance.eapi.v1.time</code></b></summary>
689
+
690
+ <code>GET https://eapi.binance.com/eapi/v1/time</code>
691
+
692
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Check-Server-Time)
693
+
694
+ ```typescript
695
+ const res = await binance.eapi.v1.time({ /* ... */ });
696
+ ```
697
+
698
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
699
+
700
+ </details>
701
+
702
+ <details>
703
+ <summary><code>GET</code> <b><code>binance.eapi.v1.trades</code></b></summary>
704
+
705
+ <code>GET https://eapi.binance.com/eapi/v1/trades{query}</code>
706
+
707
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Recent-Trades-List)
708
+
709
+ ```typescript
710
+ const res = await binance.eapi.v1.trades({ /* ... */ });
711
+ ```
712
+
713
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
714
+
715
+ </details>
716
+
717
+ ### exchangeInfo
718
+
719
+ <details>
720
+ <summary><code>GET</code> <b><code>binance.api.v3.exchangeInfo</code></b></summary>
721
+
722
+ <code>GET https://api.binance.com/api/v3/exchangeInfo{query}</code>
723
+
724
+ [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#exchange-information)
725
+
726
+ ```typescript
727
+ const res = await binance.api.v3.exchangeInfo({ /* ... */ });
728
+ ```
729
+
730
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
731
+
732
+ </details>
733
+
734
+ ### executionRules
735
+
736
+ <details>
737
+ <summary><code>GET</code> <b><code>binance.api.v3.executionRules</code></b></summary>
738
+
739
+ <code>GET https://api.binance.com/api/v3/executionRules{query}</code>
740
+
741
+ [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#query-execution-rules)
742
+
743
+ ```typescript
744
+ const res = await binance.api.v3.executionRules({ /* ... */ });
745
+ ```
746
+
747
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
748
+
749
+ </details>
750
+
751
+ ### fapi
752
+
753
+ <details>
754
+ <summary><code>GET</code> <b><code>binance.fapi.v1.aggTrades</code></b></summary>
755
+
756
+ <code>GET https://fapi.binance.com/fapi/v1/aggTrades{query}</code>
757
+
758
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Compressed-Aggregate-Trades-List)
759
+
760
+ ```typescript
761
+ const res = await binance.fapi.v1.aggTrades({ /* ... */ });
762
+ ```
763
+
764
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
765
+
766
+ </details>
767
+
768
+ <details>
769
+ <summary><code>GET</code> <b><code>binance.fapi.v1.assetIndex</code></b></summary>
770
+
771
+ <code>GET https://fapi.binance.com/fapi/v1/assetIndex{query}</code>
772
+
773
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Multi-Assets-Mode-Asset-Index)
774
+
775
+ ```typescript
776
+ const res = await binance.fapi.v1.assetIndex({ /* ... */ });
777
+ ```
778
+
779
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
780
+
781
+ </details>
782
+
783
+ <details>
784
+ <summary><code>GET</code> <b><code>binance.fapi.v1.constituents</code></b></summary>
785
+
786
+ <code>GET https://fapi.binance.com/fapi/v1/constituents{query}</code>
787
+
788
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Index-Constituents)
789
+
790
+ ```typescript
791
+ const res = await binance.fapi.v1.constituents({ /* ... */ });
792
+ ```
793
+
794
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
795
+
796
+ </details>
797
+
798
+ <details>
799
+ <summary><code>GET</code> <b><code>binance.fapi.v1.continuousKlines</code></b></summary>
800
+
801
+ <code>GET https://fapi.binance.com/fapi/v1/continuousKlines{query}</code>
802
+
803
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Continuous-Contract-Kline-Candlestick-Data)
804
+
805
+ ```typescript
806
+ const res = await binance.fapi.v1.continuousKlines({ /* ... */ });
807
+ ```
808
+
809
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
810
+
811
+ </details>
812
+
813
+ <details>
814
+ <summary><code>GET</code> <b><code>binance.fapi.v1.depth</code></b></summary>
815
+
816
+ <code>GET https://fapi.binance.com/fapi/v1/depth{query}</code>
817
+
818
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Order-Book)
819
+
820
+ ```typescript
821
+ const res = await binance.fapi.v1.depth({ /* ... */ });
822
+ ```
823
+
824
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
825
+
826
+ </details>
827
+
828
+ <details>
829
+ <summary><code>GET</code> <b><code>binance.fapi.v1.exchangeInfo</code></b></summary>
830
+
831
+ <code>GET https://fapi.binance.com/fapi/v1/exchangeInfo</code>
832
+
833
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Exchange-Information)
834
+
835
+ ```typescript
836
+ const res = await binance.fapi.v1.exchangeInfo({ /* ... */ });
837
+ ```
838
+
839
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
840
+
841
+ </details>
842
+
843
+ <details>
844
+ <summary><code>GET</code> <b><code>binance.fapi.v1.fundingInfo</code></b></summary>
845
+
846
+ <code>GET https://fapi.binance.com/fapi/v1/fundingInfo</code>
847
+
848
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Get-Funding-Rate-Info)
849
+
850
+ ```typescript
851
+ const res = await binance.fapi.v1.fundingInfo({ /* ... */ });
852
+ ```
853
+
854
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
855
+
856
+ </details>
857
+
858
+ <details>
859
+ <summary><code>GET</code> <b><code>binance.fapi.v1.fundingRate</code></b></summary>
860
+
861
+ <code>GET https://fapi.binance.com/fapi/v1/fundingRate{query}</code>
862
+
863
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Get-Funding-Rate-History)
864
+
865
+ ```typescript
866
+ const res = await binance.fapi.v1.fundingRate({ /* ... */ });
867
+ ```
868
+
869
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
870
+
871
+ </details>
872
+
873
+ <details>
874
+ <summary><code>GET</code> <b><code>binance.fapi.v1.indexInfo</code></b></summary>
875
+
876
+ <code>GET https://fapi.binance.com/fapi/v1/indexInfo{query}</code>
877
+
878
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Composite-Index-Symbol-Information)
879
+
880
+ ```typescript
881
+ const res = await binance.fapi.v1.indexInfo({ /* ... */ });
882
+ ```
883
+
884
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
885
+
886
+ </details>
887
+
888
+ <details>
889
+ <summary><code>GET</code> <b><code>binance.fapi.v1.indexPriceKlines</code></b></summary>
890
+
891
+ <code>GET https://fapi.binance.com/fapi/v1/indexPriceKlines{query}</code>
892
+
893
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Index-Price-Kline-Candlestick-Data)
894
+
895
+ ```typescript
896
+ const res = await binance.fapi.v1.indexPriceKlines({ /* ... */ });
897
+ ```
898
+
899
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
900
+
901
+ </details>
902
+
903
+ <details>
904
+ <summary><code>GET</code> <b><code>binance.fapi.v1.insuranceBalance</code></b></summary>
905
+
906
+ <code>GET https://fapi.binance.com/fapi/v1/insuranceBalance{query}</code>
907
+
908
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Insurance-Fund-Balance)
909
+
910
+ ```typescript
911
+ const res = await binance.fapi.v1.insuranceBalance({ /* ... */ });
912
+ ```
913
+
914
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
915
+
916
+ </details>
917
+
918
+ <details>
919
+ <summary><code>GET</code> <b><code>binance.fapi.v1.klines</code></b></summary>
920
+
921
+ <code>GET https://fapi.binance.com/fapi/v1/klines{query}</code>
922
+
923
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Kline-Candlestick-Data)
924
+
925
+ ```typescript
926
+ const res = await binance.fapi.v1.klines({ /* ... */ });
927
+ ```
928
+
929
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
930
+
931
+ </details>
932
+
933
+ <details>
934
+ <summary><code>GET</code> <b><code>binance.fapi.v1.markPriceKlines</code></b></summary>
935
+
936
+ <code>GET https://fapi.binance.com/fapi/v1/markPriceKlines{query}</code>
937
+
938
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Mark-Price-Kline-Candlestick-Data)
939
+
940
+ ```typescript
941
+ const res = await binance.fapi.v1.markPriceKlines({ /* ... */ });
942
+ ```
943
+
944
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
945
+
946
+ </details>
947
+
948
+ <details>
949
+ <summary><code>GET</code> <b><code>binance.fapi.v1.openInterest</code></b></summary>
950
+
951
+ <code>GET https://fapi.binance.com/fapi/v1/openInterest{query}</code>
952
+
953
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Open-Interest)
954
+
955
+ ```typescript
956
+ const res = await binance.fapi.v1.openInterest({ /* ... */ });
957
+ ```
958
+
959
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
960
+
961
+ </details>
962
+
963
+ <details>
964
+ <summary><code>GET</code> <b><code>binance.fapi.v1.ping</code></b></summary>
965
+
966
+ <code>GET https://fapi.binance.com/fapi/v1/ping</code>
967
+
968
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Test-Connectivity)
969
+
970
+ ```typescript
971
+ const res = await binance.fapi.v1.ping({ /* ... */ });
972
+ ```
973
+
974
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
975
+
976
+ </details>
977
+
978
+ <details>
979
+ <summary><code>GET</code> <b><code>binance.fapi.v1.premiumIndex</code></b></summary>
980
+
981
+ <code>GET https://fapi.binance.com/fapi/v1/premiumIndex{query}</code>
982
+
983
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Mark-Price)
984
+
985
+ ```typescript
986
+ const res = await binance.fapi.v1.premiumIndex({ /* ... */ });
987
+ ```
988
+
989
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
990
+
991
+ </details>
992
+
993
+ <details>
994
+ <summary><code>GET</code> <b><code>binance.fapi.v1.premiumIndexKlines</code></b></summary>
995
+
996
+ <code>GET https://fapi.binance.com/fapi/v1/premiumIndexKlines{query}</code>
997
+
998
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Premium-Index-Kline-Data)
999
+
1000
+ ```typescript
1001
+ const res = await binance.fapi.v1.premiumIndexKlines({ /* ... */ });
1002
+ ```
1003
+
1004
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1005
+
1006
+ </details>
1007
+
1008
+ <details>
1009
+ <summary><code>GET</code> <b><code>binance.fapi.v1.rpiDepth</code></b></summary>
1010
+
1011
+ <code>GET https://fapi.binance.com/fapi/v1/rpiDepth{query}</code>
1012
+
1013
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Order-Book-RPI)
1014
+
1015
+ ```typescript
1016
+ const res = await binance.fapi.v1.rpiDepth({ /* ... */ });
1017
+ ```
1018
+
1019
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1020
+
1021
+ </details>
1022
+
1023
+ <details>
1024
+ <summary><code>GET</code> <b><code>binance.fapi.v1.symbolAdlRisk</code></b></summary>
1025
+
1026
+ <code>GET https://fapi.binance.com/fapi/v1/symbolAdlRisk{query}</code>
1027
+
1028
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/ADL-Risk)
1029
+
1030
+ ```typescript
1031
+ const res = await binance.fapi.v1.symbolAdlRisk({ /* ... */ });
1032
+ ```
1033
+
1034
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1035
+
1036
+ </details>
1037
+
1038
+ <details>
1039
+ <summary><code>GET</code> <b><code>binance.fapi.v1.ticker.bookTicker</code></b></summary>
1040
+
1041
+ <code>GET https://fapi.binance.com/fapi/v1/ticker/bookTicker{query}</code>
1042
+
1043
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Symbol-Order-Book-Ticker)
1044
+
1045
+ ```typescript
1046
+ const res = await binance.fapi.v1.ticker.bookTicker({ /* ... */ });
1047
+ ```
1048
+
1049
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1050
+
1051
+ </details>
1052
+
1053
+ <details>
1054
+ <summary><code>GET</code> <b><code>binance.fapi.v1.ticker.twentyFourHr</code></b></summary>
1055
+
1056
+ <code>GET https://fapi.binance.com/fapi/v1/ticker/24hr{query}</code>
1057
+
1058
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/24hr-Ticker-Price-Change-Statistics)
1059
+
1060
+ ```typescript
1061
+ const res = await binance.fapi.v1.ticker.twentyFourHr({ /* ... */ });
1062
+ ```
1063
+
1064
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1065
+
1066
+ </details>
1067
+
1068
+ <details>
1069
+ <summary><code>GET</code> <b><code>binance.fapi.v1.time</code></b></summary>
1070
+
1071
+ <code>GET https://fapi.binance.com/fapi/v1/time</code>
1072
+
1073
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Check-Server-Time)
1074
+
1075
+ ```typescript
1076
+ const res = await binance.fapi.v1.time({ /* ... */ });
1077
+ ```
1078
+
1079
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1080
+
1081
+ </details>
1082
+
1083
+ <details>
1084
+ <summary><code>GET</code> <b><code>binance.fapi.v1.trades</code></b></summary>
1085
+
1086
+ <code>GET https://fapi.binance.com/fapi/v1/trades{query}</code>
1087
+
1088
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Recent-Trades-List)
1089
+
1090
+ ```typescript
1091
+ const res = await binance.fapi.v1.trades({ /* ... */ });
1092
+ ```
1093
+
1094
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1095
+
1096
+ </details>
1097
+
1098
+ <details>
1099
+ <summary><code>GET</code> <b><code>binance.fapi.v1.tradingSchedule</code></b></summary>
1100
+
1101
+ <code>GET https://fapi.binance.com/fapi/v1/tradingSchedule</code>
1102
+
1103
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Trading-Schedule)
1104
+
1105
+ ```typescript
1106
+ const res = await binance.fapi.v1.tradingSchedule({ /* ... */ });
1107
+ ```
1108
+
1109
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1110
+
1111
+ </details>
1112
+
1113
+ <details>
1114
+ <summary><code>GET</code> <b><code>binance.fapi.v2.ticker.price</code></b></summary>
1115
+
1116
+ <code>GET https://fapi.binance.com/fapi/v2/ticker/price{query}</code>
1117
+
1118
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Symbol-Price-Ticker-v2)
1119
+
1120
+ ```typescript
1121
+ const res = await binance.fapi.v2.ticker.price({ /* ... */ });
1122
+ ```
1123
+
1124
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1125
+
1126
+ </details>
1127
+
1128
+ ### futures
1129
+
1130
+ <details>
1131
+ <summary><code>GET</code> <b><code>binance.futures.data.basis</code></b></summary>
1132
+
1133
+ <code>GET https://fapi.binance.com/futures/data/basis{query}</code>
1134
+
1135
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Basis)
1136
+
1137
+ ```typescript
1138
+ const res = await binance.futures.data.basis({ /* ... */ });
1139
+ ```
1140
+
1141
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1142
+
1143
+ </details>
1144
+
1145
+ <details>
1146
+ <summary><code>GET</code> <b><code>binance.futures.data.deliveryPrice</code></b></summary>
1147
+
1148
+ <code>GET https://fapi.binance.com/futures/data/delivery-price{query}</code>
1149
+
1150
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Delivery-Price)
1151
+
1152
+ ```typescript
1153
+ const res = await binance.futures.data.deliveryPrice({ /* ... */ });
1154
+ ```
1155
+
1156
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1157
+
1158
+ </details>
1159
+
1160
+ <details>
1161
+ <summary><code>GET</code> <b><code>binance.futures.data.globalLongShortAccountRatio</code></b></summary>
1162
+
1163
+ <code>GET https://fapi.binance.com/futures/data/globalLongShortAccountRatio{query}</code>
1164
+
1165
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Long-Short-Ratio)
1166
+
1167
+ ```typescript
1168
+ const res = await binance.futures.data.globalLongShortAccountRatio({ /* ... */ });
1169
+ ```
1170
+
1171
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1172
+
1173
+ </details>
1174
+
1175
+ <details>
1176
+ <summary><code>GET</code> <b><code>binance.futures.data.openInterestHist</code></b></summary>
1177
+
1178
+ <code>GET https://fapi.binance.com/futures/data/openInterestHist{query}</code>
1179
+
1180
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Open-Interest-Statistics)
1181
+
1182
+ ```typescript
1183
+ const res = await binance.futures.data.openInterestHist({ /* ... */ });
1184
+ ```
1185
+
1186
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1187
+
1188
+ </details>
1189
+
1190
+ <details>
1191
+ <summary><code>GET</code> <b><code>binance.futures.data.takerlongshortRatio</code></b></summary>
1192
+
1193
+ <code>GET https://fapi.binance.com/futures/data/takerlongshortRatio{query}</code>
1194
+
1195
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Taker-BuySell-Volume)
1196
+
1197
+ ```typescript
1198
+ const res = await binance.futures.data.takerlongshortRatio({ /* ... */ });
1199
+ ```
1200
+
1201
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1202
+
1203
+ </details>
1204
+
1205
+ <details>
1206
+ <summary><code>GET</code> <b><code>binance.futures.data.topLongShortAccountRatio</code></b></summary>
1207
+
1208
+ <code>GET https://fapi.binance.com/futures/data/topLongShortAccountRatio{query}</code>
1209
+
1210
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Top-Long-Short-Account-Ratio)
1211
+
1212
+ ```typescript
1213
+ const res = await binance.futures.data.topLongShortAccountRatio({ /* ... */ });
1214
+ ```
1215
+
1216
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1217
+
1218
+ </details>
1219
+
1220
+ <details>
1221
+ <summary><code>GET</code> <b><code>binance.futures.data.topLongShortPositionRatio</code></b></summary>
1222
+
1223
+ <code>GET https://fapi.binance.com/futures/data/topLongShortPositionRatio{query}</code>
1224
+
1225
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Top-Trader-Long-Short-Ratio)
1226
+
1227
+ ```typescript
1228
+ const res = await binance.futures.data.topLongShortPositionRatio({ /* ... */ });
1229
+ ```
1230
+
1231
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1232
+
1233
+ </details>
1234
+
1235
+ ### historicalBlockTrades
1236
+
1237
+ <details>
1238
+ <summary><code>GET</code> <b><code>binance.api.v3.historicalBlockTrades</code></b></summary>
1239
+
1240
+ <code>GET https://api.binance.com/api/v3/historicalBlockTrades{query}</code>
1241
+
1242
+ [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#historical-block-trades)
1243
+
1244
+ ```typescript
1245
+ const res = await binance.api.v3.historicalBlockTrades({ /* ... */ });
1246
+ ```
1247
+
1248
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1249
+
1250
+ </details>
1251
+
1252
+ ### historicalTrades
1253
+
1254
+ <details>
1255
+ <summary><code>GET</code> <b><code>binance.api.v3.historicalTrades</code></b></summary>
1256
+
1257
+ <code>GET https://api.binance.com/api/v3/historicalTrades{query}</code>
1258
+
1259
+ [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#old-trade-lookup)
1260
+
1261
+ ```typescript
1262
+ const res = await binance.api.v3.historicalTrades({ /* ... */ });
1263
+ ```
1264
+
1265
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1266
+
1267
+ </details>
1268
+
1269
+ ### klines
1270
+
1271
+ <details>
1272
+ <summary><code>GET</code> <b><code>binance.api.v3.klines</code></b></summary>
1273
+
1274
+ <code>GET https://api.binance.com/api/v3/klines{query}</code>
1275
+
1276
+ [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#klinecandlestick-data)
1277
+
1278
+ ```typescript
1279
+ const res = await binance.api.v3.klines({ /* ... */ });
1280
+ ```
1281
+
1282
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1283
+
1284
+ </details>
1285
+
1286
+ ### ping
1287
+
1288
+ <details>
1289
+ <summary><code>GET</code> <b><code>binance.api.v3.ping</code></b></summary>
1290
+
1291
+ <code>GET https://api.binance.com/api/v3/ping</code>
1292
+
1293
+ [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#test-connectivity)
1294
+
1295
+ ```typescript
1296
+ const res = await binance.api.v3.ping({ /* ... */ });
1297
+ ```
1298
+
1299
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1300
+
1301
+ </details>
1302
+
1303
+ ### public
1304
+
1305
+ <details>
1306
+ <summary><code>GET</code> <b><code>binance.public.options.eapi.v1.ping</code></b></summary>
1307
+
1308
+ <code>GET https://eapi.binance.com/eapi/v1/ping</code>
1309
+
1310
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/options-trading/market-data/Test-Connectivity)
1311
+
1312
+ ```typescript
1313
+ const res = await binance.public.options.eapi.v1.ping({ /* ... */ });
1314
+ ```
1315
+
1316
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1317
+
1318
+ </details>
1319
+
1320
+ <details>
1321
+ <summary><code>GET</code> <b><code>binance.public.spot.api.v3.ping</code></b></summary>
1322
+
1323
+ <code>GET https://api.binance.com/api/v3/ping</code>
1324
+
1325
+ [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#test-connectivity)
1326
+
1327
+ ```typescript
1328
+ const res = await binance.public.spot.api.v3.ping({ /* ... */ });
1329
+ ```
1330
+
1331
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1332
+
1333
+ </details>
1334
+
1335
+ <details>
1336
+ <summary><code>GET</code> <b><code>binance.public.spotData.api.v3.ping</code></b></summary>
1337
+
1338
+ <code>GET https://data-api.binance.vision/api/v3/ping</code>
1339
+
1340
+ [Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/faqs/market_data_only)
1341
+
1342
+ ```typescript
1343
+ const res = await binance.public.spotData.api.v3.ping({ /* ... */ });
1344
+ ```
1345
+
1346
+ Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
1347
+
1348
+ </details>
1349
+
1350
+ <details>
1351
+ <summary><code>GET</code> <b><code>binance.public.usdMFutures.fapi.v1.ping</code></b></summary>
1352
+
1353
+ <code>GET https://fapi.binance.com/fapi/v1/ping</code>
1354
+
1355
+ [Upstream docs ↗](https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Test-Connectivity)
1356
+
1357
+ ```typescript
1358
+ const res = await binance.public.usdMFutures.fapi.v1.ping({ /* ... */ });
164
1359
  ```
165
1360
 
166
1361
  Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)