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 v0.3.15 #45

Merged
merged 1 commit into from
Jan 8, 2025
Merged

Release v0.3.15 #45

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
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Changelog

## 0.3.15 - 2025-01-08
### Changed
- Updated documentation links

## 0.3.14 - 2024-11-27
### Added
- `Margin`:
Expand Down
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-typescript",
"version": "0.3.14",
"version": "0.3.15",
"description": "This is a lightweight library that works as a connector to the Binance public API.",
"main": "./dist/index.js",
"module": "./dist/index.mjs",
Expand Down
30 changes: 15 additions & 15 deletions src/modules/restful/market/market.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,23 +34,23 @@ import { Interval } from '../../enum';
export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketMethods> & T {
return class extends base {
/**
* Test Connectivity {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#test-connectivity}
* Test Connectivity {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#test-connectivity}
*/
async testConnectivity(): Promise<Record<string, never>> {
return await this.makeRequest('GET', '/api/v3/ping');
}


/**
* Check Server Time {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#check-server-time}
* Check Server Time {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/general-endpoints#check-server-time}
*/
async checkServerTime(): Promise<checkServerTimeResponse> {
return await this.makeRequest('GET', '/api/v3/time');
}


/**
* Exchange Information {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#exchange-information}
* 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] - Trading symbol, e.g. BNBUSDT
Expand All @@ -68,7 +68,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Order Book {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#order-book}
* Order Book {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#order-book}
*
* @param {string} symbol - Trading symbol, e.g. BNBUSDT
* @param {object} [options]
Expand All @@ -89,7 +89,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Recent Trades List {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#recent-trades-list}
* Recent Trades List {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#recent-trades-list}
*
* @param {string} symbol - Trading symbol, e.g. BNBUSDT
* @param {object} [options]
Expand All @@ -110,7 +110,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Old Trade Lookup {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#old-trade-lookup}
* Old Trade Lookup {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#old-trade-lookup}
*
* @param {string} symbol - Trading symbol, e.g. BNBUSDT
* @param {object} [options]
Expand All @@ -132,7 +132,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Compressed/Aggregate Trades List {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#compressedaggregate-trades-list}
* Compressed/Aggregate Trades List {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#compressedaggregate-trades-list}
*
* @param {string} symbol - Trading symbol, e.g. BNBUSDT
* @param {object} [options]
Expand All @@ -156,7 +156,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Kline/Candlestick Data {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#klinecandlestick-data}
* Kline/Candlestick Data {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#klinecandlestick-data}
*
* @param {string} symbol - Trading symbol, e.g. BNBUSDT
* @param {Interval} interval - kline intervals
Expand All @@ -182,7 +182,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* UIKlines {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#uiklines}
* UIKlines {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#uiklines}
*
* @param {string} symbol - Trading symbol, e.g. BNBUSDT
* @param {Interval} interval - kline intervals
Expand All @@ -208,7 +208,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Current Average Price {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#current-average-price}
* Current Average Price {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#current-average-price}
*
* @param {string} symbol - Trading symbol, e.g. BNBUSDT
*/
Expand All @@ -223,7 +223,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* 24hr Ticker Price Change Statistics {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#24hr-ticker-price-change-statistics}
* 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 {object} [options]
* @param {string} [options.symbol] - Trading symbol, e.g. BNBUSDT
Expand All @@ -239,7 +239,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Symbol Price Ticker {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#symbol-price-ticker}
* Symbol Price Ticker {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-price-ticker}
*
* @param {object} [options]
* @param {string} [options.symbol] - Trading symbol, e.g. BNBUSDT
Expand All @@ -254,7 +254,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Symbol Order Book Ticker {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#symbol-order-book-ticker}
* Symbol Order Book Ticker {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#symbol-order-book-ticker}
*
* @param {object} [options]
* @param {string} [options.symbol] - Trading symbol, e.g. BNBUSDT
Expand All @@ -269,7 +269,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Rolling window price change statistics {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#rolling-window-price-change-statistics}
* 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 {object} [options]
* @param {string} [options.symbol] - Trading symbol, e.g. BNBUSDT
Expand All @@ -286,7 +286,7 @@ export function mixinMarket<T extends Constructor>(base: T): Constructor<MarketM


/**
* Trading Day Ticker {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/public-api-endpoints#trading-day-ticker}
* Trading Day Ticker {@link https://developers.binance.com/docs/binance-spot-api-docs/rest-api/market-data-endpoints#trading-day-ticker}
*
* @param {object} [options]
* @param {string} [options.symbol] - Trading symbol, e.g. BNBUSDT
Expand Down
Loading
Loading