You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+37-3Lines changed: 37 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,7 +17,6 @@ color=blueviolet 🔵q
17
17
18
18
19
19
20
-
21
20
# Node Binance API
22
21
23
22
[](https://t.me/nodebinanceapi)[](https://www.npmjs.com/package/node-binance-api)[](https://x.com/jaggedsoft)
@@ -58,7 +57,7 @@ Actively maintained, typed, and safe SDK for the Binance REST APIs and Websocket
58
57
59
58
### Features
60
59
- Spot, Margin, Futures and Delivery API
61
-
- Portfolio Margin API *soon*
60
+
- Portfolio Margin API *\*soon*\*
62
61
- Testnet support
63
62
- Proxy support (REST and WS)
64
63
- Customizable HTTP headers
@@ -71,7 +70,7 @@ Actively maintained, typed, and safe SDK for the Binance REST APIs and Websocket
71
70
72
71
### Upgrading to v1.0.0+
73
72
74
-
The library was fully refactored to use modern and typed JavaScript/Typescript version, using the built-in await/async syntax and unifying some methods' signatures.
73
+
The library was fully refactored to use modern and typed JavaScript/Typescript version, using the built-in await/async syntax and unifying some methods' signatures. Some important changes include the removal of callbacks as parameters of REST methods, adaptation of signatures to directly receive some important request values (symbol, orderId, ...), etc.
75
74
76
75
**We highly advise you to update from 0.0.X but minor adjustments might be needed.**
// Batch orders, remaining WebSocket streams, and better documentation will be come later
233
232
```
234
233
234
+
### Proxy support
235
+
236
+
In some specific cases using a proxy is required, for example:
237
+
- Exchange is not available in your location
238
+
- You need to make a large amount of requests without getting blocked
239
+
- ...
240
+
241
+
This package supports the following proxy types, `httpsProxy`, `proxyUrl` and `socksProxy`
242
+
243
+
#### httpsProxy
244
+
245
+
To set a real http(s) proxy for your scripts, you need to have an access to a remote http or https proxy, so calls will be made directly to the target exchange, tunneled through your proxy server:
246
+
247
+
```Js
248
+
client.httpsProxy='http://1.2.3.4:8080/';
249
+
```
250
+
251
+
#### proxyUrl
252
+
253
+
This property prepends an url to API requests. It might be useful for simple redirection or bypassing CORS browser restriction.
254
+
255
+
```Js
256
+
client.proxyUrl='YOUR_PROXY_URL';
257
+
```
258
+
259
+
#### socksProxy
260
+
261
+
Tou can also use socks proxy with the following format:
0 commit comments