Skip to content

Commit 16ec11a

Browse files
committed
add spot.md
1 parent fbfa116 commit 16ec11a

2 files changed

Lines changed: 99 additions & 1 deletion

File tree

README.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,13 @@ export API_SECRET="your_api_secret"
1919
All commands are to be used in the following format:
2020
```
2121
./binance-cli [Module] [Subcommand] [Arguments]
22+
23+
Available Commands:
24+
futures Futures
25+
help Help about any command
26+
portfolio Portfolio
27+
spot Spot
28+
universal-transfer User universal transfer
2229
```
2330

2431
### Spot Module
@@ -30,6 +37,8 @@ Available Commands:
3037
dividend Get dividend information
3138
order Support create, cancel, list orders
3239
```
40+
**[View detailed documentation](docs/spot.md)**
41+
3342

3443
### Futures Module
3544
Exec: `./binance-cli futures [Subcommand] [Arguments]`
@@ -45,7 +54,7 @@ Available Commands:
4554
symbol Symbol config(leverage & margin type)
4655
trade Get trades for a specific account and symbol.
4756
```
48-
### Portfolio
57+
### Portfolio Module
4958
#### Portfolio USDⓈ-Margined Futures
5059
Exec: `./binance-cli portfolio um [Subcommand] [Arguments]`
5160
```shell

docs/spot.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
# Spot Module
2+
3+
## Quick Navigation
4+
- [Account](#account--show-account-info)
5+
- [Asset](#asset---show-account-assets)
6+
- [Dividend](#dividend---query-asset-dividend-record)
7+
- [Order](#order)
8+
- [Create Market Order](#order---create-market-order)
9+
- [Create Limit Order](#order---create-limit-order)
10+
- [List open orders](#order---list-open-orders)
11+
- [List orders](#order---list-orders)
12+
- [Cancel order by ID](#order---cancel-order-by-id)
13+
- [Cancel all order by symbol](#order---cancel-all-order-by-symbol)
14+
15+
## Account — Show account info
16+
Exec: `./binance-cli spot account`
17+
```shell
18+
┌────────────┬────────────────────┬───────────┬──────────────┬─────────────┬──────────────┬───────────────┬─────────────────────┐
19+
│ UID │ COMMISSION RATES │ CAN TRADE │ CAN WITHDRAW │ CAN DEPOSIT │ ACCOUNT TYPE │ PERMISSIONS │ UPDATE TIME │
20+
├────────────┼────────────────────┼───────────┼──────────────┼─────────────┼──────────────┼───────────────┼─────────────────────┤
21+
│ xxxxxxxxxx │ Maker: 0.00000000 │ truetruetrue │ SPOT │ [TRD_GRP_176] │ 2025-08-17 13:39:26 │
22+
│ │ Taker: 0.00025000 │ │ │ │ │ │ │
23+
│ │ Buyer: 0.00000000 │ │ │ │ │ │ │
24+
│ │ Seller: 0.00000000 │ │ │ │ │ │ │
25+
└────────────┴────────────────────┴───────────┴──────────────┴─────────────┴──────────────┴───────────────┴─────────────────────┘
26+
```
27+
28+
## Asset - Show account assets
29+
Exec: `./binance-cli spot asset ls`
30+
```shell
31+
┌───────┬──────────────┬────────────┐
32+
│ ASSET │ FREE │ LOCKED │
33+
├───────┼──────────────┼────────────┤
34+
│ BTC │ 1.00000000 │ 0.00000000 │
35+
│ USDT │ 100.00000000 │ 0.00000000 │
36+
└───────┴──────────────┴────────────┘
37+
```
38+
39+
## Dividend - Query asset dividend record
40+
Exec: `./binance-cli spot dividend ls`
41+
```shell
42+
┌─────────────────────┬───────┬──────────┬─────────────────────┬────────────────────┬────────────────┐
43+
│ ID │ ASSET │ AMOUNT │ DIVIDEND TIME │ INFO │ TRANSACTION ID │
44+
├─────────────────────┼───────┼──────────┼─────────────────────┼────────────────────┼────────────────┤
45+
│ 4656120748007646527 │ USDT │ 42.1329 │ 2025-08-18 02:40:22 │ BFUSD Daily reward │ 287113442430 │
46+
│ 4654671248778998830 │ USDT │ 108.6762 │ 2025-08-17 02:40:26 │ BFUSD Daily reward │ 286847043264 │
47+
│ 4653237662432310020 │ USDT │ 99.3702 │ 2025-08-16 02:56:17 │ BFUSD Daily reward │ 286622065819 │
48+
│ 4651975355145888522 │ USDT │ 116.2712 │ 2025-08-15 06:02:18 │ BFUSD Daily reward │ 286330628796 │
49+
│ 4650581332527448370 │ USDT │ 147.4873 │ 2025-08-14 06:57:28 │ BFUSD Daily reward │ 285921655320 │
50+
└─────────────────────┴───────┴──────────┴─────────────────────┴────────────────────┴────────────────┘
51+
```
52+
53+
## Order
54+
> support all docs parameters
55+
> Docs Link: https://developers.binance.com/docs/binance-spot-api-docs/rest-api/trading-endpoints#new-order-trade
56+
57+
### Order - Create Market Order
58+
Exec: `./binance-cli spot order create --symbol=BTCUSDT --side=BUY --type=MARKET --quantity=1.0`
59+
60+
### Order - Create Limit Order
61+
Exec: `./binance-cli spot order create --symbol=SOLUSDT --side=BUY --type=LIMIT --quantity=0.2 --price=170 --timeInForce=GTC`
62+
63+
### Order - list open orders
64+
Exec: `./binance-cli spot order open`
65+
```shell
66+
┌─────────────┬──────────────────────────────────┬─────────┬──────┬───────┬────────┬──────────────┬────────────┬───────────────────┐
67+
│ ORDER ID │ CLIENT ORDER ID │ SYMBOL │ SIDE │ TYPE │ STATUS │ PRICE │ QUANTITY │ EXECUTED QUANTITY │
68+
├─────────────┼──────────────────────────────────┼─────────┼──────┼───────┼────────┼──────────────┼────────────┼───────────────────┤
69+
│ 13557621683 │ x-HNA2TXFJba82951e4dd3404daa2da4 │ SOLUSDT │ BUY │ LIMIT │ NEW │ 170.00000000 │ 0.20000000 │ 0.00000000 │
70+
└─────────────┴──────────────────────────────────┴─────────┴──────┴───────┴────────┴──────────────┴────────────┴───────────────────┘
71+
```
72+
73+
### Order - list orders
74+
Exec: `./binance-cli spot order ls --symbol=SOLUSDT`
75+
```shell
76+
┌─────────────┬──────────────────────────────────┬─────────┬──────┬───────┬────────┬──────────────┬────────────┬───────────────────┐
77+
│ ORDER ID │ CLIENT ORDER ID │ SYMBOL │ SIDE │ TYPE │ STATUS │ PRICE │ QUANTITY │ EXECUTED QUANTITY │
78+
├─────────────┼──────────────────────────────────┼─────────┼──────┼───────┼────────┼──────────────┼────────────┼───────────────────┤
79+
│ 13557621683 │ x-HNA2TXFJba82951e4dd3404daa2da4 │ SOLUSDT │ BUY │ LIMIT │ NEW │ 170.00000000 │ 0.20000000 │ 0.00000000 │
80+
└─────────────┴──────────────────────────────────┴─────────┴──────┴───────┴────────┴──────────────┴────────────┴───────────────────┘
81+
```
82+
83+
### Order - Cancel order by ID
84+
Exec: `./binance-cli spot order cancel --origClientOrderId=xxxxx --symbol=SOLUSDT`
85+
OR
86+
Exec: `./binance-cli spot order cancel --clientId=xxxxx --symbol=SOLUSDT`
87+
88+
### Order - Cancel all order by symbol
89+
Exec: `./binance-cli spot order cancel --symbol=SOLUSDT`

0 commit comments

Comments
 (0)