@apicity/binance 0.3.3
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/LICENSE +21 -0
- package/README.md +330 -0
- package/dist/src/binance.d.ts +3 -0
- package/dist/src/binance.d.ts.map +1 -0
- package/dist/src/binance.js +299 -0
- package/dist/src/binance.js.map +1 -0
- package/dist/src/example.d.ts +8 -0
- package/dist/src/example.d.ts.map +1 -0
- package/dist/src/example.js +85 -0
- package/dist/src/example.js.map +1 -0
- package/dist/src/index.d.ts +6 -0
- package/dist/src/index.d.ts.map +1 -0
- package/dist/src/index.js +5 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/middleware.d.ts +12 -0
- package/dist/src/middleware.d.ts.map +1 -0
- package/dist/src/middleware.js +69 -0
- package/dist/src/middleware.js.map +1 -0
- package/dist/src/types.d.ts +404 -0
- package/dist/src/types.d.ts.map +1 -0
- package/dist/src/types.js +13 -0
- package/dist/src/types.js.map +1 -0
- package/dist/src/zod.d.ts +252 -0
- package/dist/src/zod.d.ts.map +1 -0
- package/dist/src/zod.js +110 -0
- package/dist/src/zod.js.map +1 -0
- package/package.json +54 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Justin Tanner
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,330 @@
|
|
|
1
|
+
# @apicity/binance
|
|
2
|
+
|
|
3
|
+
[](https://www.npmjs.com/package/@apicity/binance)
|
|
4
|
+
[](package.json)
|
|
5
|
+
[](tsconfig.json)
|
|
6
|
+
[](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-api-information)
|
|
7
|
+
|
|
8
|
+
Binance Spot REST API provider.
|
|
9
|
+
|
|
10
|
+
## Installation
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install @apicity/binance
|
|
14
|
+
# or
|
|
15
|
+
pnpm add @apicity/binance
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
## Quick Start
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { createBinance } from "@apicity/binance";
|
|
22
|
+
|
|
23
|
+
const binance = createBinance();
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## API Reference
|
|
27
|
+
|
|
28
|
+
18 endpoints across 13 groups. Each method mirrors an upstream URL path.
|
|
29
|
+
|
|
30
|
+
### aggTrades
|
|
31
|
+
|
|
32
|
+
<details>
|
|
33
|
+
<summary><code>GET</code> <b><code>binance.api.v3.aggTrades</code></b></summary>
|
|
34
|
+
|
|
35
|
+
<code>GET https://api.binance.com/api/v3/aggTrades{query}</code>
|
|
36
|
+
|
|
37
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#compressedaggregate-trades-list)
|
|
38
|
+
|
|
39
|
+
```typescript
|
|
40
|
+
const res = await binance.api.v3.aggTrades({ /* ... */ });
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
44
|
+
|
|
45
|
+
</details>
|
|
46
|
+
|
|
47
|
+
### avgPrice
|
|
48
|
+
|
|
49
|
+
<details>
|
|
50
|
+
<summary><code>GET</code> <b><code>binance.api.v3.avgPrice</code></b></summary>
|
|
51
|
+
|
|
52
|
+
<code>GET https://api.binance.com/api/v3/avgPrice{query}</code>
|
|
53
|
+
|
|
54
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#current-average-price)
|
|
55
|
+
|
|
56
|
+
```typescript
|
|
57
|
+
const res = await binance.api.v3.avgPrice({ /* ... */ });
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
61
|
+
|
|
62
|
+
</details>
|
|
63
|
+
|
|
64
|
+
### depth
|
|
65
|
+
|
|
66
|
+
<details>
|
|
67
|
+
<summary><code>GET</code> <b><code>binance.api.v3.depth</code></b></summary>
|
|
68
|
+
|
|
69
|
+
<code>GET https://api.binance.com/api/v3/depth{query}</code>
|
|
70
|
+
|
|
71
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#order-book)
|
|
72
|
+
|
|
73
|
+
```typescript
|
|
74
|
+
const res = await binance.api.v3.depth({ /* ... */ });
|
|
75
|
+
```
|
|
76
|
+
|
|
77
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
78
|
+
|
|
79
|
+
</details>
|
|
80
|
+
|
|
81
|
+
### exchangeInfo
|
|
82
|
+
|
|
83
|
+
<details>
|
|
84
|
+
<summary><code>GET</code> <b><code>binance.api.v3.exchangeInfo</code></b></summary>
|
|
85
|
+
|
|
86
|
+
<code>GET https://api.binance.com/api/v3/exchangeInfo{query}</code>
|
|
87
|
+
|
|
88
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#exchange-information)
|
|
89
|
+
|
|
90
|
+
```typescript
|
|
91
|
+
const res = await binance.api.v3.exchangeInfo({ /* ... */ });
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
95
|
+
|
|
96
|
+
</details>
|
|
97
|
+
|
|
98
|
+
### historicalBlockTrades
|
|
99
|
+
|
|
100
|
+
<details>
|
|
101
|
+
<summary><code>GET</code> <b><code>binance.api.v3.historicalBlockTrades</code></b></summary>
|
|
102
|
+
|
|
103
|
+
<code>GET https://api.binance.com/api/v3/historicalBlockTrades{query}</code>
|
|
104
|
+
|
|
105
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#historical-block-trades)
|
|
106
|
+
|
|
107
|
+
```typescript
|
|
108
|
+
const res = await binance.api.v3.historicalBlockTrades({ /* ... */ });
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
112
|
+
|
|
113
|
+
</details>
|
|
114
|
+
|
|
115
|
+
### historicalTrades
|
|
116
|
+
|
|
117
|
+
<details>
|
|
118
|
+
<summary><code>GET</code> <b><code>binance.api.v3.historicalTrades</code></b></summary>
|
|
119
|
+
|
|
120
|
+
<code>GET https://api.binance.com/api/v3/historicalTrades{query}</code>
|
|
121
|
+
|
|
122
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#old-trade-lookup)
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
const res = await binance.api.v3.historicalTrades({ /* ... */ });
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
129
|
+
|
|
130
|
+
</details>
|
|
131
|
+
|
|
132
|
+
### klines
|
|
133
|
+
|
|
134
|
+
<details>
|
|
135
|
+
<summary><code>GET</code> <b><code>binance.api.v3.klines</code></b></summary>
|
|
136
|
+
|
|
137
|
+
<code>GET https://api.binance.com/api/v3/klines{query}</code>
|
|
138
|
+
|
|
139
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#klinecandlestick-data)
|
|
140
|
+
|
|
141
|
+
```typescript
|
|
142
|
+
const res = await binance.api.v3.klines({ /* ... */ });
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
146
|
+
|
|
147
|
+
</details>
|
|
148
|
+
|
|
149
|
+
### ping
|
|
150
|
+
|
|
151
|
+
<details>
|
|
152
|
+
<summary><code>GET</code> <b><code>binance.api.v3.ping</code></b></summary>
|
|
153
|
+
|
|
154
|
+
<code>GET https://api.binance.com/api/v3/ping</code>
|
|
155
|
+
|
|
156
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#test-connectivity)
|
|
157
|
+
|
|
158
|
+
```typescript
|
|
159
|
+
const res = await binance.api.v3.ping({ /* ... */ });
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
163
|
+
|
|
164
|
+
</details>
|
|
165
|
+
|
|
166
|
+
### referencePrice
|
|
167
|
+
|
|
168
|
+
<details>
|
|
169
|
+
<summary><code>GET</code> <b><code>binance.api.v3.referencePrice</code></b></summary>
|
|
170
|
+
|
|
171
|
+
<code>GET https://api.binance.com/api/v3/referencePrice{query}</code>
|
|
172
|
+
|
|
173
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#query-reference-price)
|
|
174
|
+
|
|
175
|
+
```typescript
|
|
176
|
+
const res = await binance.api.v3.referencePrice({ /* ... */ });
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
180
|
+
|
|
181
|
+
</details>
|
|
182
|
+
|
|
183
|
+
<details>
|
|
184
|
+
<summary><code>GET</code> <b><code>binance.api.v3.referencePrice.calculation</code></b></summary>
|
|
185
|
+
|
|
186
|
+
<code>GET https://api.binance.com/api/v3/referencePrice/calculation{query}</code>
|
|
187
|
+
|
|
188
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#query-reference-price-calculation)
|
|
189
|
+
|
|
190
|
+
```typescript
|
|
191
|
+
const res = await binance.api.v3.referencePrice.calculation({ /* ... */ });
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
195
|
+
|
|
196
|
+
</details>
|
|
197
|
+
|
|
198
|
+
### ticker
|
|
199
|
+
|
|
200
|
+
<details>
|
|
201
|
+
<summary><code>GET</code> <b><code>binance.api.v3.ticker</code></b></summary>
|
|
202
|
+
|
|
203
|
+
<code>GET https://api.binance.com/api/v3/ticker{query}</code>
|
|
204
|
+
|
|
205
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#rolling-window-price-change-statistics)
|
|
206
|
+
|
|
207
|
+
```typescript
|
|
208
|
+
const res = await binance.api.v3.ticker({ /* ... */ });
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
212
|
+
|
|
213
|
+
</details>
|
|
214
|
+
|
|
215
|
+
<details>
|
|
216
|
+
<summary><code>GET</code> <b><code>binance.api.v3.ticker.bookTicker</code></b></summary>
|
|
217
|
+
|
|
218
|
+
<code>GET https://api.binance.com/api/v3/ticker/bookTicker{query}</code>
|
|
219
|
+
|
|
220
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-order-book-ticker)
|
|
221
|
+
|
|
222
|
+
```typescript
|
|
223
|
+
const res = await binance.api.v3.ticker.bookTicker({ /* ... */ });
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
227
|
+
|
|
228
|
+
</details>
|
|
229
|
+
|
|
230
|
+
<details>
|
|
231
|
+
<summary><code>GET</code> <b><code>binance.api.v3.ticker.price</code></b></summary>
|
|
232
|
+
|
|
233
|
+
<code>GET https://api.binance.com/api/v3/ticker/price{query}</code>
|
|
234
|
+
|
|
235
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-price-ticker)
|
|
236
|
+
|
|
237
|
+
```typescript
|
|
238
|
+
const res = await binance.api.v3.ticker.price({ /* ... */ });
|
|
239
|
+
```
|
|
240
|
+
|
|
241
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
242
|
+
|
|
243
|
+
</details>
|
|
244
|
+
|
|
245
|
+
<details>
|
|
246
|
+
<summary><code>GET</code> <b><code>binance.api.v3.ticker.tradingDay</code></b></summary>
|
|
247
|
+
|
|
248
|
+
<code>GET https://api.binance.com/api/v3/ticker/tradingDay{query}</code>
|
|
249
|
+
|
|
250
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#trading-day-ticker)
|
|
251
|
+
|
|
252
|
+
```typescript
|
|
253
|
+
const res = await binance.api.v3.ticker.tradingDay({ /* ... */ });
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
257
|
+
|
|
258
|
+
</details>
|
|
259
|
+
|
|
260
|
+
<details>
|
|
261
|
+
<summary><code>GET</code> <b><code>binance.api.v3.ticker.twentyFourHr</code></b></summary>
|
|
262
|
+
|
|
263
|
+
<code>GET https://api.binance.com/api/v3/ticker/24hr{query}</code>
|
|
264
|
+
|
|
265
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#24hr-ticker-price-change-statistics)
|
|
266
|
+
|
|
267
|
+
```typescript
|
|
268
|
+
const res = await binance.api.v3.ticker.twentyFourHr({ /* ... */ });
|
|
269
|
+
```
|
|
270
|
+
|
|
271
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
272
|
+
|
|
273
|
+
</details>
|
|
274
|
+
|
|
275
|
+
### time
|
|
276
|
+
|
|
277
|
+
<details>
|
|
278
|
+
<summary><code>GET</code> <b><code>binance.api.v3.time</code></b></summary>
|
|
279
|
+
|
|
280
|
+
<code>GET https://api.binance.com/api/v3/time</code>
|
|
281
|
+
|
|
282
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#check-server-time)
|
|
283
|
+
|
|
284
|
+
```typescript
|
|
285
|
+
const res = await binance.api.v3.time({ /* ... */ });
|
|
286
|
+
```
|
|
287
|
+
|
|
288
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
289
|
+
|
|
290
|
+
</details>
|
|
291
|
+
|
|
292
|
+
### trades
|
|
293
|
+
|
|
294
|
+
<details>
|
|
295
|
+
<summary><code>GET</code> <b><code>binance.api.v3.trades</code></b></summary>
|
|
296
|
+
|
|
297
|
+
<code>GET https://api.binance.com/api/v3/trades{query}</code>
|
|
298
|
+
|
|
299
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#recent-trades-list)
|
|
300
|
+
|
|
301
|
+
```typescript
|
|
302
|
+
const res = await binance.api.v3.trades({ /* ... */ });
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
306
|
+
|
|
307
|
+
</details>
|
|
308
|
+
|
|
309
|
+
### uiKlines
|
|
310
|
+
|
|
311
|
+
<details>
|
|
312
|
+
<summary><code>GET</code> <b><code>binance.api.v3.uiKlines</code></b></summary>
|
|
313
|
+
|
|
314
|
+
<code>GET https://api.binance.com/api/v3/uiKlines{query}</code>
|
|
315
|
+
|
|
316
|
+
[Upstream docs ↗](https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#uiklines)
|
|
317
|
+
|
|
318
|
+
```typescript
|
|
319
|
+
const res = await binance.api.v3.uiKlines({ /* ... */ });
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
Source: [`packages/provider/binance/src/binance.ts`](src/binance.ts)
|
|
323
|
+
|
|
324
|
+
</details>
|
|
325
|
+
|
|
326
|
+
Part of the [apicity](https://github.com/justintanner/apicity) monorepo.
|
|
327
|
+
|
|
328
|
+
## License
|
|
329
|
+
|
|
330
|
+
MIT — see [LICENSE](LICENSE).
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"binance.d.ts","sourceRoot":"","sources":["../../src/binance.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAeV,cAAc,EAEd,eAAe,EAoBhB,MAAM,SAAS,CAAC;AA2BjB,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,cAAc,GAAG,eAAe,CAwhBpE"}
|
|
@@ -0,0 +1,299 @@
|
|
|
1
|
+
import { BinanceError } from "./types.js";
|
|
2
|
+
import { BinanceAggTradesRequestSchema, BinanceAvgPriceRequestSchema, BinanceDepthRequestSchema, BinanceExchangeInfoRequestSchema, BinanceHistoricalBlockTradesRequestSchema, BinanceHistoricalTradesRequestSchema, BinanceKlinesRequestSchema, BinanceReferencePriceCalculationRequestSchema, BinanceReferencePriceRequestSchema, BinanceTicker24hrRequestSchema, BinanceTickerBookTickerRequestSchema, BinanceTickerPriceRequestSchema, BinanceTickerRequestSchema, BinanceTickerTradingDayRequestSchema, BinanceTradesRequestSchema, BinanceUiKlinesRequestSchema, } from "./zod.js";
|
|
3
|
+
export function createBinance(opts) {
|
|
4
|
+
const baseURL = (opts?.baseURL ?? "https://api.binance.com").replace(/\/+$/, "");
|
|
5
|
+
const doFetch = opts?.fetch ?? fetch;
|
|
6
|
+
const timeout = opts?.timeout ?? 30000;
|
|
7
|
+
function attachAbortHandler(signal, controller) {
|
|
8
|
+
if (signal.aborted) {
|
|
9
|
+
controller.abort();
|
|
10
|
+
return;
|
|
11
|
+
}
|
|
12
|
+
signal.addEventListener("abort", () => controller.abort(), { once: true });
|
|
13
|
+
}
|
|
14
|
+
function formatErrorMessage(status, body) {
|
|
15
|
+
if (typeof body === "object" && body !== null) {
|
|
16
|
+
const b = body;
|
|
17
|
+
if (b.msg) {
|
|
18
|
+
return `Binance API error ${status}: ${b.msg}`;
|
|
19
|
+
}
|
|
20
|
+
if (b.message) {
|
|
21
|
+
return `Binance API error ${status}: ${b.message}`;
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
return `Binance API error: ${status}`;
|
|
25
|
+
}
|
|
26
|
+
function errorCode(body) {
|
|
27
|
+
if (typeof body === "object" && body !== null) {
|
|
28
|
+
const code = body.code;
|
|
29
|
+
if (typeof code === "number" || typeof code === "string") {
|
|
30
|
+
return String(code);
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
return undefined;
|
|
34
|
+
}
|
|
35
|
+
async function makeJsonRequest(method, path, body, signal) {
|
|
36
|
+
const controller = new AbortController();
|
|
37
|
+
const timeoutId = setTimeout(() => controller.abort(), timeout);
|
|
38
|
+
if (signal) {
|
|
39
|
+
attachAbortHandler(signal, controller);
|
|
40
|
+
}
|
|
41
|
+
try {
|
|
42
|
+
const headers = {};
|
|
43
|
+
const init = {
|
|
44
|
+
method,
|
|
45
|
+
headers,
|
|
46
|
+
signal: controller.signal,
|
|
47
|
+
};
|
|
48
|
+
if (opts?.apiKey) {
|
|
49
|
+
headers["X-MBX-APIKEY"] = opts.apiKey;
|
|
50
|
+
}
|
|
51
|
+
if (body !== undefined) {
|
|
52
|
+
headers["Content-Type"] = "application/json";
|
|
53
|
+
init.body = JSON.stringify(body);
|
|
54
|
+
}
|
|
55
|
+
const res = await doFetch(`${baseURL}${path}`, init);
|
|
56
|
+
clearTimeout(timeoutId);
|
|
57
|
+
if (!res.ok) {
|
|
58
|
+
let resBody = null;
|
|
59
|
+
try {
|
|
60
|
+
resBody = await res.json();
|
|
61
|
+
}
|
|
62
|
+
catch {
|
|
63
|
+
// ignore parse errors
|
|
64
|
+
}
|
|
65
|
+
throw new BinanceError(formatErrorMessage(res.status, resBody), res.status, resBody, errorCode(resBody));
|
|
66
|
+
}
|
|
67
|
+
return (await res.json());
|
|
68
|
+
}
|
|
69
|
+
catch (error) {
|
|
70
|
+
clearTimeout(timeoutId);
|
|
71
|
+
if (error instanceof BinanceError)
|
|
72
|
+
throw error;
|
|
73
|
+
throw new BinanceError(`Binance request failed: ${error}`, 500);
|
|
74
|
+
}
|
|
75
|
+
}
|
|
76
|
+
function buildQuery(params) {
|
|
77
|
+
const qs = new URLSearchParams();
|
|
78
|
+
for (const [key, value] of Object.entries(params)) {
|
|
79
|
+
if (value === undefined) {
|
|
80
|
+
continue;
|
|
81
|
+
}
|
|
82
|
+
qs.append(key, Array.isArray(value) ? JSON.stringify(value) : String(value));
|
|
83
|
+
}
|
|
84
|
+
const query = qs.toString();
|
|
85
|
+
return query ? `?${query}` : "";
|
|
86
|
+
}
|
|
87
|
+
// GET https://api.binance.com/api/v3/ping
|
|
88
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#test-connectivity
|
|
89
|
+
const ping = Object.assign(async (signal) => {
|
|
90
|
+
return makeJsonRequest("GET", "/api/v3/ping", undefined, signal);
|
|
91
|
+
}, { schema: undefined });
|
|
92
|
+
// GET https://api.binance.com/api/v3/time
|
|
93
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#check-server-time
|
|
94
|
+
const time = Object.assign(async (signal) => {
|
|
95
|
+
return makeJsonRequest("GET", "/api/v3/time", undefined, signal);
|
|
96
|
+
}, { schema: undefined });
|
|
97
|
+
// GET https://api.binance.com/api/v3/exchangeInfo{query}
|
|
98
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#exchange-information
|
|
99
|
+
const exchangeInfo = Object.assign(async (req = {}, signal) => {
|
|
100
|
+
const query = buildQuery({
|
|
101
|
+
symbol: req.symbol,
|
|
102
|
+
symbols: req.symbols,
|
|
103
|
+
permissions: req.permissions,
|
|
104
|
+
showPermissionSets: req.showPermissionSets,
|
|
105
|
+
symbolStatus: req.symbolStatus,
|
|
106
|
+
});
|
|
107
|
+
return makeJsonRequest("GET", `/api/v3/exchangeInfo${query}`, undefined, signal);
|
|
108
|
+
}, { schema: BinanceExchangeInfoRequestSchema });
|
|
109
|
+
// GET https://api.binance.com/api/v3/depth{query}
|
|
110
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#order-book
|
|
111
|
+
const depth = Object.assign(async (req, signal) => {
|
|
112
|
+
const query = buildQuery({
|
|
113
|
+
symbol: req.symbol,
|
|
114
|
+
limit: req.limit,
|
|
115
|
+
symbolStatus: req.symbolStatus,
|
|
116
|
+
});
|
|
117
|
+
return makeJsonRequest("GET", `/api/v3/depth${query}`, undefined, signal);
|
|
118
|
+
}, { schema: BinanceDepthRequestSchema });
|
|
119
|
+
// GET https://api.binance.com/api/v3/trades{query}
|
|
120
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#recent-trades-list
|
|
121
|
+
const trades = Object.assign(async (req, signal) => {
|
|
122
|
+
const query = buildQuery({
|
|
123
|
+
symbol: req.symbol,
|
|
124
|
+
limit: req.limit,
|
|
125
|
+
});
|
|
126
|
+
return makeJsonRequest("GET", `/api/v3/trades${query}`, undefined, signal);
|
|
127
|
+
}, { schema: BinanceTradesRequestSchema });
|
|
128
|
+
// GET https://api.binance.com/api/v3/historicalTrades{query}
|
|
129
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#old-trade-lookup
|
|
130
|
+
const historicalTrades = Object.assign(async (req, signal) => {
|
|
131
|
+
const query = buildQuery({
|
|
132
|
+
symbol: req.symbol,
|
|
133
|
+
limit: req.limit,
|
|
134
|
+
fromId: req.fromId,
|
|
135
|
+
});
|
|
136
|
+
return makeJsonRequest("GET", `/api/v3/historicalTrades${query}`, undefined, signal);
|
|
137
|
+
}, { schema: BinanceHistoricalTradesRequestSchema });
|
|
138
|
+
// GET https://api.binance.com/api/v3/historicalBlockTrades{query}
|
|
139
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#historical-block-trades
|
|
140
|
+
const historicalBlockTrades = Object.assign(async (req, signal) => {
|
|
141
|
+
const query = buildQuery({
|
|
142
|
+
symbol: req.symbol,
|
|
143
|
+
fromId: req.fromId,
|
|
144
|
+
limit: req.limit,
|
|
145
|
+
});
|
|
146
|
+
return makeJsonRequest("GET", `/api/v3/historicalBlockTrades${query}`, undefined, signal);
|
|
147
|
+
}, { schema: BinanceHistoricalBlockTradesRequestSchema });
|
|
148
|
+
// GET https://api.binance.com/api/v3/aggTrades{query}
|
|
149
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#compressedaggregate-trades-list
|
|
150
|
+
const aggTrades = Object.assign(async (req, signal) => {
|
|
151
|
+
const query = buildQuery({
|
|
152
|
+
symbol: req.symbol,
|
|
153
|
+
fromId: req.fromId,
|
|
154
|
+
startTime: req.startTime,
|
|
155
|
+
endTime: req.endTime,
|
|
156
|
+
limit: req.limit,
|
|
157
|
+
});
|
|
158
|
+
return makeJsonRequest("GET", `/api/v3/aggTrades${query}`, undefined, signal);
|
|
159
|
+
}, { schema: BinanceAggTradesRequestSchema });
|
|
160
|
+
// GET https://api.binance.com/api/v3/klines{query}
|
|
161
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#klinecandlestick-data
|
|
162
|
+
const klines = Object.assign(async (req, signal) => {
|
|
163
|
+
const query = buildQuery({
|
|
164
|
+
symbol: req.symbol,
|
|
165
|
+
interval: req.interval,
|
|
166
|
+
startTime: req.startTime,
|
|
167
|
+
endTime: req.endTime,
|
|
168
|
+
timeZone: req.timeZone,
|
|
169
|
+
limit: req.limit,
|
|
170
|
+
});
|
|
171
|
+
return makeJsonRequest("GET", `/api/v3/klines${query}`, undefined, signal);
|
|
172
|
+
}, { schema: BinanceKlinesRequestSchema });
|
|
173
|
+
// GET https://api.binance.com/api/v3/avgPrice{query}
|
|
174
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#current-average-price
|
|
175
|
+
const avgPrice = Object.assign(async (req, signal) => {
|
|
176
|
+
const query = buildQuery({
|
|
177
|
+
symbol: req.symbol,
|
|
178
|
+
});
|
|
179
|
+
return makeJsonRequest("GET", `/api/v3/avgPrice${query}`, undefined, signal);
|
|
180
|
+
}, { schema: BinanceAvgPriceRequestSchema });
|
|
181
|
+
// GET https://api.binance.com/api/v3/referencePrice/calculation{query}
|
|
182
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#query-reference-price-calculation
|
|
183
|
+
const referencePriceCalculation = Object.assign(async (req, signal) => {
|
|
184
|
+
const query = buildQuery({
|
|
185
|
+
symbol: req.symbol,
|
|
186
|
+
symbolStatus: req.symbolStatus,
|
|
187
|
+
});
|
|
188
|
+
return makeJsonRequest("GET", `/api/v3/referencePrice/calculation${query}`, undefined, signal);
|
|
189
|
+
}, { schema: BinanceReferencePriceCalculationRequestSchema });
|
|
190
|
+
// GET https://api.binance.com/api/v3/referencePrice{query}
|
|
191
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#query-reference-price
|
|
192
|
+
const referencePrice = Object.assign(async (req, signal) => {
|
|
193
|
+
const query = buildQuery({
|
|
194
|
+
symbol: req.symbol,
|
|
195
|
+
});
|
|
196
|
+
return makeJsonRequest("GET", `/api/v3/referencePrice${query}`, undefined, signal);
|
|
197
|
+
}, {
|
|
198
|
+
calculation: referencePriceCalculation,
|
|
199
|
+
schema: BinanceReferencePriceRequestSchema,
|
|
200
|
+
});
|
|
201
|
+
// GET https://api.binance.com/api/v3/uiKlines{query}
|
|
202
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#uiklines
|
|
203
|
+
const uiKlines = Object.assign(async (req, signal) => {
|
|
204
|
+
const query = buildQuery({
|
|
205
|
+
symbol: req.symbol,
|
|
206
|
+
interval: req.interval,
|
|
207
|
+
startTime: req.startTime,
|
|
208
|
+
endTime: req.endTime,
|
|
209
|
+
timeZone: req.timeZone,
|
|
210
|
+
limit: req.limit,
|
|
211
|
+
});
|
|
212
|
+
return makeJsonRequest("GET", `/api/v3/uiKlines${query}`, undefined, signal);
|
|
213
|
+
}, { schema: BinanceUiKlinesRequestSchema });
|
|
214
|
+
// sig-ok: upstream numeric segment exposed as a TypeScript-friendly name.
|
|
215
|
+
// GET https://api.binance.com/api/v3/ticker/24hr{query}
|
|
216
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#24hr-ticker-price-change-statistics
|
|
217
|
+
const tickerTwentyFourHr = Object.assign(async (req = {}, signal) => {
|
|
218
|
+
const query = buildQuery({
|
|
219
|
+
symbol: req.symbol,
|
|
220
|
+
symbols: req.symbols,
|
|
221
|
+
type: req.type,
|
|
222
|
+
});
|
|
223
|
+
return makeJsonRequest("GET", `/api/v3/ticker/24hr${query}`, undefined, signal);
|
|
224
|
+
}, { schema: BinanceTicker24hrRequestSchema });
|
|
225
|
+
// GET https://api.binance.com/api/v3/ticker/tradingDay{query}
|
|
226
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#trading-day-ticker
|
|
227
|
+
const tickerTradingDay = Object.assign(async (req, signal) => {
|
|
228
|
+
const query = buildQuery({
|
|
229
|
+
symbol: req.symbol,
|
|
230
|
+
symbols: req.symbols,
|
|
231
|
+
timeZone: req.timeZone,
|
|
232
|
+
type: req.type,
|
|
233
|
+
symbolStatus: req.symbolStatus,
|
|
234
|
+
});
|
|
235
|
+
return makeJsonRequest("GET", `/api/v3/ticker/tradingDay${query}`, undefined, signal);
|
|
236
|
+
}, { schema: BinanceTickerTradingDayRequestSchema });
|
|
237
|
+
// GET https://api.binance.com/api/v3/ticker/price{query}
|
|
238
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-price-ticker
|
|
239
|
+
const tickerPrice = Object.assign(async (req = {}, signal) => {
|
|
240
|
+
const query = buildQuery({
|
|
241
|
+
symbol: req.symbol,
|
|
242
|
+
symbols: req.symbols,
|
|
243
|
+
symbolStatus: req.symbolStatus,
|
|
244
|
+
});
|
|
245
|
+
return makeJsonRequest("GET", `/api/v3/ticker/price${query}`, undefined, signal);
|
|
246
|
+
}, { schema: BinanceTickerPriceRequestSchema });
|
|
247
|
+
// GET https://api.binance.com/api/v3/ticker/bookTicker{query}
|
|
248
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-order-book-ticker
|
|
249
|
+
const tickerBookTicker = Object.assign(async (req = {}, signal) => {
|
|
250
|
+
const query = buildQuery({
|
|
251
|
+
symbol: req.symbol,
|
|
252
|
+
symbols: req.symbols,
|
|
253
|
+
symbolStatus: req.symbolStatus,
|
|
254
|
+
});
|
|
255
|
+
return makeJsonRequest("GET", `/api/v3/ticker/bookTicker${query}`, undefined, signal);
|
|
256
|
+
}, { schema: BinanceTickerBookTickerRequestSchema });
|
|
257
|
+
// GET https://api.binance.com/api/v3/ticker{query}
|
|
258
|
+
// Docs: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#rolling-window-price-change-statistics
|
|
259
|
+
const ticker = Object.assign(async (req, signal) => {
|
|
260
|
+
const query = buildQuery({
|
|
261
|
+
symbol: req.symbol,
|
|
262
|
+
symbols: req.symbols,
|
|
263
|
+
windowSize: req.windowSize,
|
|
264
|
+
type: req.type,
|
|
265
|
+
symbolStatus: req.symbolStatus,
|
|
266
|
+
});
|
|
267
|
+
return makeJsonRequest("GET", `/api/v3/ticker${query}`, undefined, signal);
|
|
268
|
+
}, {
|
|
269
|
+
bookTicker: tickerBookTicker,
|
|
270
|
+
price: tickerPrice,
|
|
271
|
+
schema: BinanceTickerRequestSchema,
|
|
272
|
+
tradingDay: tickerTradingDay,
|
|
273
|
+
twentyFourHr: tickerTwentyFourHr,
|
|
274
|
+
});
|
|
275
|
+
const api = {
|
|
276
|
+
v3: {
|
|
277
|
+
aggTrades,
|
|
278
|
+
avgPrice,
|
|
279
|
+
depth,
|
|
280
|
+
exchangeInfo,
|
|
281
|
+
historicalBlockTrades,
|
|
282
|
+
historicalTrades,
|
|
283
|
+
klines,
|
|
284
|
+
ping,
|
|
285
|
+
referencePrice,
|
|
286
|
+
time,
|
|
287
|
+
ticker,
|
|
288
|
+
trades,
|
|
289
|
+
uiKlines,
|
|
290
|
+
},
|
|
291
|
+
};
|
|
292
|
+
return {
|
|
293
|
+
api,
|
|
294
|
+
get: {
|
|
295
|
+
api,
|
|
296
|
+
},
|
|
297
|
+
};
|
|
298
|
+
}
|
|
299
|
+
//# sourceMappingURL=binance.js.map
|