Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v3.6.1 #181

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Release v3.6.1 #181

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Changelog

## 3.6.1 - 2025-01-08

### Changed
- Updated documentation links.

## 3.6.0 - 2024-12-19

### Added
Expand Down
2 changes: 1 addition & 1 deletion docs_src/docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
npx jsdoc --readme ./docs_src/gettingStarted.md src/modules/restful/blvt.js
npx jsdoc --readme ./docs_src/gettingStarted.md src/modules/restful/subAccount.js
node ./docs_src/generateDoc.js
rm -R out
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@binance/connector",
"version": "3.6.0",
"version": "3.6.1",
"description": "This is a lightweight library that works as a connector to the Binance public API.",
"main": "src/index.js",
"scripts": {
Expand Down
28 changes: 14 additions & 14 deletions src/modules/restful/market.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ const Market = superclass => class extends superclass {
* GET /api/v3/ping<br>
*
* Test connectivity to the Rest API.<br>
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#test-connectivity}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#test-connectivity}
*/
ping () {
return this.publicRequest('GET', '/api/v3/ping')
Expand All @@ -26,7 +26,7 @@ const Market = superclass => class extends superclass {
* GET /api/v3/time<br>
*
* Test connectivity to the Rest API and get the current server time.<br>
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#check-server-time}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#check-server-time}
*
* @param {object} [options]
* @param {string} [options.timeUnit] - The preferred time unit for time and timestamp fields. It can be either 'MILLISECOND' or 'MICROSECOND'
Expand All @@ -42,7 +42,7 @@ const Market = superclass => class extends superclass {
* GET /api/v3/exchangeInfo<br>
*
* Current exchange trading rules and symbol information<br>
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#exchange-information}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#exchange-information}
*
* @param {object} [options]
* @param {string} [options.symbol] - symbol
Expand All @@ -69,7 +69,7 @@ const Market = superclass => class extends superclass {
*
* GET /api/v3/depth<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#order-book}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#order-book}
*
* @param {string} symbol
* @param {object} [options]
Expand All @@ -94,7 +94,7 @@ const Market = superclass => class extends superclass {
* GET /api/v3/trades<br>
*
* Get recent trades.<br>
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#recent-trades-list}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#recent-trades-list}
*
* @param {string} symbol
* @param {object} [options]
Expand All @@ -119,7 +119,7 @@ const Market = superclass => class extends superclass {
* GET /api/v3/historicalTrades<br>
*
* Get older market trades.<br>
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#old-trade-lookup}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#old-trade-lookup}
*
* @param {string} symbol
* @param {object} [options]
Expand All @@ -144,7 +144,7 @@ const Market = superclass => class extends superclass {
*
* GET /api/v3/aggTrades<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#compressedaggregate-trades-list}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#compressedaggregate-trades-list}
*
* @param {string} symbol
* @param {object} [options]
Expand All @@ -171,7 +171,7 @@ const Market = superclass => class extends superclass {
*
* GET /api/v3/klines<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#klinecandlestick-data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#klinecandlestick-data}
*
* @param {string} symbol
* @param {string} interval
Expand All @@ -198,7 +198,7 @@ const Market = superclass => class extends superclass {
*
* GET /api/v3/uiKlines<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#uiklines}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#uiklines}
*
* @param {string} symbol
* @param {string} interval
Expand Down Expand Up @@ -226,7 +226,7 @@ const Market = superclass => class extends superclass {
* GET /api/v3/avgPrice<br>
*
* Current average price for a symbol.<br>
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#current-average-price}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#current-average-price}
*
* @param {string} symbol
* @param {object} [options]
Expand All @@ -249,7 +249,7 @@ const Market = superclass => class extends superclass {
*
* GET /api/v3/ticker/24hr<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#24hr-ticker-price-change-statistics}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#24hr-ticker-price-change-statistics}
*
* @param {string} [symbol]
* @param {Array} [symbols] - an array of symbols
Expand All @@ -276,7 +276,7 @@ const Market = superclass => class extends superclass {
*
* GET /api/v3/ticker/price<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#symbol-price-ticker}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-price-ticker}
*
* @param {string} [symbol]
* @param {Array} [symbols] - an array of symbols
Expand All @@ -300,7 +300,7 @@ const Market = superclass => class extends superclass {
* GET /api/v3/ticker/bookTicker<br>
*
* Best price/qty on the order book for a symbol or symbols.<br>
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#symbol-order-book-ticker}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-order-book-ticker}
*
* @param {string} [symbol]
* @param {Array} [symbols] - an array of symbols
Expand Down Expand Up @@ -333,7 +333,7 @@ const Market = superclass => class extends superclass {
*
* The weight for this request will cap at 100 once the number of symbols in the request is more than 50.<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#rolling-window-price-change-statistics}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#rolling-window-price-change-statistics}
*
* @param {string} [symbol]
* @param {Array} [symbols] - an array of symbols
Expand Down
6 changes: 3 additions & 3 deletions src/modules/restful/stream.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const Stream = superclass => class extends superclass {
*
* POST /api/v3/userDataStream<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#start-user-data-stream-user_stream}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/user-data-stream#create-a-listenkey-user_stream}
*
* @param {object} [options]
* @param {string} [options.timeUnit] - The preferred time unit for time and timestamp fields. It can be either 'MILLISECOND' or 'MICROSECOND'
Expand All @@ -31,7 +31,7 @@ const Stream = superclass => class extends superclass {
*
* PUT /api/v3/userDataStream<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#keepalive-user-data-stream-user_stream}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/user-data-stream#pingkeep-alive-a-listenkey-user_stream}
*
* @param {string} listenKey
* @param {object} [options]
Expand All @@ -53,7 +53,7 @@ const Stream = superclass => class extends superclass {
*
* DELETE /api/v3/userDataStream<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#close-user-data-stream-user_stream}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/user-data-stream#close-a-listenkey-user_stream}
*
* @param {string} listenKey
* @param {object} [options]
Expand Down
32 changes: 16 additions & 16 deletions src/modules/restful/trade.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const Trade = superclass => class extends superclass {
*
* POST /api/v3/order/test<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#test-new-order-trade}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#test-new-order-trade}
*
* @param {string} symbol
* @param {string} side
Expand Down Expand Up @@ -53,7 +53,7 @@ const Trade = superclass => class extends superclass {
*
* POST /api/v3/order<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#new-order-trade}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade}
*
* @param {string} symbol
* @param {string} side
Expand Down Expand Up @@ -92,7 +92,7 @@ const Trade = superclass => class extends superclass {
*
* DELETE /api/v3/order<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#cancel-order-trade}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#cancel-order-trade}
*
* @param {string} symbol
* @param {object} [options]
Expand All @@ -119,7 +119,7 @@ const Trade = superclass => class extends superclass {
*
* DELETE /api/v3/openOrders<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#cancel-all-open-orders-on-a-symbol-trade}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#cancel-all-open-orders-on-a-symbol-trade}
* @param {string} symbol
* @param {object} [options]
* @param {number} [options.recvWindow] - The value cannot be greater than 60000
Expand All @@ -142,7 +142,7 @@ const Trade = superclass => class extends superclass {
*
* GET /api/v3/order<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#query-order-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#query-order-user_data}
*
* @param {string} symbol
* @param {object} [options]
Expand Down Expand Up @@ -173,7 +173,7 @@ const Trade = superclass => class extends superclass {
*
* POST /api/v3/order/cancelReplace<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#cancel-an-existing-order-and-send-a-new-order-trade}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#cancel-an-existing-order-and-send-a-new-order-trade}
*
* @param {string} symbol
* @param {string} side
Expand Down Expand Up @@ -217,7 +217,7 @@ const Trade = superclass => class extends superclass {
*
* GET /api/v3/openOrders<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#current-open-orders-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#current-open-orders-user_data}
*
* @param {object} [options]
* @param {string} [options.symbol]
Expand All @@ -237,7 +237,7 @@ const Trade = superclass => class extends superclass {
*
* GET /api/v3/allOrders<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#all-orders-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#all-orders-user_data}
*
* @param {string} symbol
* @param {object} [options]
Expand All @@ -264,7 +264,7 @@ const Trade = superclass => class extends superclass {
*
* POST /api/v3/orderList/oco<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#new-oco---deprecated-trade}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-list---oco-trade}
*
* @param {string} symbol
* @param {string} side
Expand Down Expand Up @@ -315,7 +315,7 @@ const Trade = superclass => class extends superclass {
*
* DELETE /api/v3/orderList<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#cancel-order-list-trade}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#cancel-order-list-trade}
*
* @param {string} symbol
* @param {object} [options]
Expand All @@ -342,7 +342,7 @@ const Trade = superclass => class extends superclass {
*
* GET /api/v3/orderList<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#query-order-lists-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#query-order-list-user_data}
*
* @param {object} [options]
* @param {number} [options.orderListId]
Expand All @@ -363,7 +363,7 @@ const Trade = superclass => class extends superclass {
*
* GET /api/v3/allOrderList<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#query-all-order-lists-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#query-all-order-lists-user_data}
*
* @param {object} [options]
* @param {number} [options.fromId]
Expand All @@ -386,7 +386,7 @@ const Trade = superclass => class extends superclass {
*
* GET /api/v3/openOrderList<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#query-open-order-lists-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#query-open-order-lists-user_data}
*
* @param {object} [options]
* @param {number} [options.recvWindow] - The value cannot be greater than 60000
Expand All @@ -405,7 +405,7 @@ const Trade = superclass => class extends superclass {
*
* GET /api/v3/account<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#account-information-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#account-information-user_data}
*
* @param {object} [options]
* @param {number} [options.recvWindow] - The value cannot be greater than 60000
Expand All @@ -424,7 +424,7 @@ const Trade = superclass => class extends superclass {
*
* GET /api/v3/myTrades<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#account-trade-list-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#account-trade-list-user_data}
*
* @param {string} symbol
* @param {object} [options]
Expand Down Expand Up @@ -453,7 +453,7 @@ const Trade = superclass => class extends superclass {
*
* GET /api/v3/rateLimit/order<br>
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api#query-current-order-count-usage-trade}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/account-endpoints#query-unfilled-order-count-user_data}
*
* @param {object} [options]
* @param {number} [options.recvWindow] - The value cannot be greater than 60000
Expand Down
12 changes: 6 additions & 6 deletions src/modules/websocket/api/account.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ const Account = superclass => class extends superclass {
* Query information about your account.<br>
*
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api#account-information-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests#account-information-user_data}
*
* @param {object} [options]
* @param {number} [options.recvWindow]
Expand All @@ -27,7 +27,7 @@ const Account = superclass => class extends superclass {
* Query your current order rate limit.<br>
*
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api#account-order-rate-limits-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests#unfilled-order-count-user_data}
*
* @param {object} [options]
* @param {number} [options.recvWindow]
Expand All @@ -42,7 +42,7 @@ const Account = superclass => class extends superclass {
* Query information about all your orders – active, canceled, filled – filtered by time range.<br>
*
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api#account-order-history-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests#account-order-history-user_data}
*
* @param {string} symbol
* @param {object} [options]
Expand All @@ -68,7 +68,7 @@ const Account = superclass => class extends superclass {
* Query information about all your OCOs, filtered by time range.<br>
*
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests#account-order-list-history-user_data}
*
* @param {object} [options]
* @param {number} [options.fromId]
Expand All @@ -92,7 +92,7 @@ const Account = superclass => class extends superclass {
* Query information about all your trades, filtered by time range.<br>
*
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api#account-trade-history-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests#account-trade-history-user_data}
*
* @param {string} [symbol]
* @param {object} [options]
Expand All @@ -119,7 +119,7 @@ const Account = superclass => class extends superclass {
* Displays the list of orders that were expired because of STP trigger.<br>
*
*
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api#account-prevented-matches-user_data}
* {@link https://developers.binance.com/docs/binance-spot-api-docs/web-socket-api/account-requests#account-prevented-matches-user_data}
*
* @param {string} [symbol]
* @param {object} [options]
Expand Down
Loading
Loading