Release v0.3.14

.github/workflows/tspackage.yaml

@@ -10,7 +10,7 @@ jobs:
     build:
         strategy:
             matrix:
-              node-version: [16.x, 18.x, 20.x]
+              node-version: [18.x, 20.x, 22.x]
         runs-on: ubuntu-latest
         steps:
             - uses: actions/checkout@v3

CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 0.3.14 - 2024-11-27
+### Added
+- `Margin`:
+  - `POST /sapi/v1/margin/order/oto`
+  - `POST /sapi/v1/margin/order/otoco`
+- `Portfolio`:
+  - `GET /sapi/v1/portfolio/balance`
+  - `GET /sapi/v2/portfolio/account`
+  - `GET /sapi/v2/portfolio/collateralRate`
+- `Simple Earn`:
+  - `POST /sapi/v1/simple-earn/locked/setRedeemOption`
+- `Wallet`:
+  - `GET /sapi/v1/account/info`
+  - `GET /sapi/v1/asset/custody/transfer-history`
+  - `GET /sapi/v1/asset/wallet/balance`
+  - `GET /sapi/v1/capital/deposit/address/list`
+  - `GET /sapi/v1/spot/delist-schedule`
+
+### Changed
+- Updated dependencies
+- Added optional parameters `showPermissionSets` and `symbolStatus` to endpoint `GET /api/v3/exchangeInfo`
+- Fixed response type issue in `GET /sapi/v1/margin/crossMarginCollateralRatio`
+- `POST /sapi/v1/simple-earn/locked/subscribe` new parameter: `redeemTo`
+- Updated fields in response for the following endpoints:
+  - `GET /sapi/v1/margin/account`
+  - `GET /sapi/v1/simple-earn/locked/position`
+  - `GET /sapi/v1/simple-earn/flexible/history/subscriptionRecord`
+  - `GET /sapi/v1/simple-earn/locked/history/subscriptionRecord`
+  - `GET /sapi/v1/simple-earn/locked/history/redemptionRecord`
+  - `GET /sapi/v4/sub-account/assets`
+  - `GET /sapi/v3/sub-account/assets`
+
 ## 0.3.13 - 2024-10-11
 ### Added
 - `Dual Investment`:

examples/restful/margin/crossMarginCollateralRatio.ts

@@ -0,0 +1,13 @@
+import dotenv from 'dotenv';
+import { RestMarginTypes, Spot } from '../../../src/index';
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+client.crossMarginCollateralRatio().then((res: RestMarginTypes.crossMarginCollateralRatioResponse[]) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/margin/getAllCrossMarginPairs.ts

@@ -4,8 +4,9 @@ import { RestMarginTypes, Spot } from '../../../src/index';
 dotenv.config();
 
 const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
 const baseURL = process.env.BINANCE_BASE_URL || '';
-const client = new Spot(apiKey, '', { baseURL: baseURL });
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
 
 client.getAllCrossMarginPairs().then((res: RestMarginTypes.getAllCrossMarginPairsResponse[]) => {
     console.log(res);

examples/restful/margin/getAllMarginAssets.ts

@@ -4,9 +4,14 @@ import { RestMarginTypes, Spot } from '../../../src/index';
 dotenv.config();
 
 const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
 const baseURL = process.env.BINANCE_BASE_URL || '';
-const client = new Spot(apiKey, '', { baseURL: baseURL });
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
 
-client.getAllMarginAssets().then((res: RestMarginTypes.getAllMarginAssetsResponse[]) => {
+const options = {
+    asset: 'BNB',
+};
+
+client.getAllMarginAssets(options).then((res: RestMarginTypes.getAllMarginAssetsResponse[]) => {
     console.log(res);
 }).catch(err => { console.log(err); });

examples/restful/margin/getMarginPriceindex.ts

@@ -4,8 +4,9 @@ import { RestMarginTypes, Spot } from '../../../src/index';
 dotenv.config();
 
 const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
 const baseURL = process.env.BINANCE_BASE_URL || '';
-const client = new Spot(apiKey, '', { baseURL: baseURL });
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
 
 
 client.getMarginPriceIndex('BNBUSDT').then((res: RestMarginTypes.getMarginPriceIndexResponse) => {

examples/restful/margin/marginAccountNewOto.ts

@@ -0,0 +1,31 @@
+import dotenv from 'dotenv';
+import { OtoPendingType, OrderListWorkingType, RestMarginTypes, Side, Spot, TimeInForce } from '../../../src/index';
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+const options: RestMarginTypes.marginAccountNewOtoOptions = {
+    workingTimeInForce: TimeInForce.GTC,
+    pendingPrice: 595,
+    pendingTimeInForce: TimeInForce.GTC,
+    workingIcebergQty: 0.1,
+    recvWindow: 5000,
+};
+
+client.marginAccountNewOto(
+    'BNBUSDT',
+    OrderListWorkingType.LIMIT,
+    Side.SELL,
+    600,
+    1,
+    OtoPendingType.LIMIT,
+    Side.BUY,
+    1,
+    options
+).then((res: RestMarginTypes.marginAccountNewOtoResponse) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/margin/marginAccountNewOtoco.ts

@@ -0,0 +1,32 @@
+import dotenv from 'dotenv';
+import { OrderListAboveBelowType, OrderListWorkingType, RestMarginTypes, Side, Spot, TimeInForce } from '../../../src/index';
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+const options: RestMarginTypes.marginAccountNewOtocoOptions = {
+    workingTimeInForce: TimeInForce.GTC,
+    pendingAbovePrice: 605,
+    pendingBelowType: OrderListAboveBelowType.LIMIT_MAKER,
+    pendingBelowPrice: 595,
+    workingIcebergQty: 0.1,
+    recvWindow: 5000,
+};
+
+client.marginAccountNewOtoco(
+    'BNBUSDT',
+    OrderListWorkingType.LIMIT,
+    Side.BUY,
+    600,
+    1,
+    Side.SELL,
+    1,
+    OrderListAboveBelowType.LIMIT_MAKER,
+    options
+).then((res: RestMarginTypes.marginAccountNewOtocoResponse) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/portfolioMargin/getAccountBalance.ts

@@ -0,0 +1,19 @@
+import { Spot } from '../../../src/index';
+import dotenv from 'dotenv';
+import { getAccountBalanceOptions, getAccountBalanceResponse } from '../../../src/modules/restful/portfolioMargin/types';
+
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+const options: getAccountBalanceOptions = {
+    recvWindow: 5000,
+};
+
+client.getAccountBalance(options).then((res: getAccountBalanceResponse[]) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/portfolioMargin/getSpanAccountInfo.ts

@@ -0,0 +1,19 @@
+import { Spot } from '../../../src/index';
+import dotenv from 'dotenv';
+import { getSpanAccountInfoOptions, getSpanAccountInfoResponse } from '../../../src/modules/restful/portfolioMargin/types';
+
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+const options: getSpanAccountInfoOptions = {
+    recvWindow: 5000,
+};
+
+client.getSpanAccountInfo(options).then((res: getSpanAccountInfoResponse) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/portfolioMargin/getTieredCollateralRate.ts

@@ -0,0 +1,19 @@
+import { Spot } from '../../../src/index';
+import dotenv from 'dotenv';
+import { getTieredCollateralRateOptions, getTieredCollateralRateResponse } from '../../../src/modules/restful/portfolioMargin/types';
+
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+const options: getTieredCollateralRateOptions = {
+    recvWindow: 5000,
+};
+
+client.getTieredCollateralRate(options).then((res: getTieredCollateralRateResponse[]) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/simpleEarn/setLockedRedeemOption.ts

@@ -0,0 +1,17 @@
+import dotenv from 'dotenv';
+import { RedeemOption, RestSimpleEarnTypes, Spot } from '../../../src/index';
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+const options: RestSimpleEarnTypes.setLockedRedeemOptionOptions = {
+    recvWindow: 5000,
+};
+
+client.setLockedRedeemOption('1', RedeemOption.SPOT, options).then((res: RestSimpleEarnTypes.setLockedRedeemOptionResponse) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/wallet/accountInfo.ts

@@ -0,0 +1,14 @@
+import dotenv from 'dotenv';
+import { RestWalletTypes, Spot } from '../../../src/index';
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+
+client.accountInfo().then((res: RestWalletTypes.accountInfoResponse) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/wallet/depositAddressList.ts

@@ -0,0 +1,14 @@
+import dotenv from 'dotenv';
+import { RestWalletTypes, Spot } from '../../../src/index';
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+
+client.depositAddressList('BNB').then((res: RestWalletTypes.depositAddressListResponse[]) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/wallet/getSymbolsDelistSchedule.ts

@@ -0,0 +1,14 @@
+import dotenv from 'dotenv';
+import { RestWalletTypes, Spot } from '../../../src/index';
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+
+client.getSymbolsDelistSchedule().then((res: RestWalletTypes.getSymbolsDelistScheduleResponse[]) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/wallet/queryUserDelegationHistory.ts

@@ -0,0 +1,14 @@
+import dotenv from 'dotenv';
+import { RestWalletTypes, Spot } from '../../../src/index';
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+
+client.queryUserDelegationHistory('email', 1695205000000, 1695205999999).then((res: RestWalletTypes.queryUserDelegationHistoryResponse) => {
+    console.log(res);
+}).catch(err => { console.log(err); });

examples/restful/wallet/queryUserWalletBalance.ts

@@ -0,0 +1,14 @@
+import dotenv from 'dotenv';
+import { RestWalletTypes, Spot } from '../../../src/index';
+
+dotenv.config();
+
+const apiKey = process.env.BINANCE_API_KEY || '';
+const apiSecret = process.env.BINANCE_API_SECRET || '';
+const baseURL = process.env.BINANCE_BASE_URL || '';
+const client = new Spot(apiKey, apiSecret, { baseURL: baseURL });
+
+
+client.queryUserWalletBalance().then((res: RestWalletTypes.queryUserWalletBalanceResponse[]) => {
+    console.log(res);
+}).catch(err => { console.log(err); });