algo
Binance Algo Skill
Algo request on Binance using authenticated API endpoints. Requires API key and secret key for certain endpoints. Return the result in JSON format.
Quick Reference
| Endpoint | Description | Required | Optional | Authentication |
|---|---|---|---|---|
/sapi/v1/algo/futures/order (DELETE) |
Cancel Algo Order(TRADE) | algoId | recvWindow | Yes |
/sapi/v1/algo/futures/openOrders (GET) |
Query Current Algo Open Orders(USER_DATA) | None | recvWindow | Yes |
/sapi/v1/algo/futures/historicalOrders (GET) |
Query Historical Algo Orders(USER_DATA) | None | symbol, side, startTime, endTime, page, pageSize, recvWindow | Yes |
/sapi/v1/algo/futures/subOrders (GET) |
Query Sub Orders(USER_DATA) | algoId | page, pageSize, recvWindow | Yes |
/sapi/v1/algo/futures/newOrderTwap (POST) |
Time-Weighted Average Price(Twap) New Order(TRADE) | symbol, side, quantity, duration | positionSide, clientAlgoId, reduceOnly, limitPrice, recvWindow | Yes |
/sapi/v1/algo/futures/newOrderVp (POST) |
Volume Participation(VP) New Order (TRADE) | symbol, side, quantity, urgency | positionSide, clientAlgoId, reduceOnly, limitPrice, recvWindow | Yes |
/sapi/v1/algo/spot/order (DELETE) |
Cancel Algo Order(TRADE) | algoId | recvWindow | Yes |
/sapi/v1/algo/spot/openOrders (GET) |
Query Current Algo Open Orders(USER_DATA) | None | recvWindow | Yes |
/sapi/v1/algo/spot/historicalOrders (GET) |
Query Historical Algo Orders(USER_DATA) | None | symbol, side, startTime, endTime, page, pageSize, recvWindow | Yes |
/sapi/v1/algo/spot/subOrders (GET) |
Query Sub Orders(USER_DATA) | algoId | page, pageSize, recvWindow | Yes |
/sapi/v1/algo/spot/newOrderTwap (POST) |
Time-Weighted Average Price(Twap) New Order(TRADE) | symbol, side, quantity, duration | clientAlgoId, limitPrice | Yes |
Parameters
Common Parameters
- algoId: eg. 14511 (e.g., 1)
- recvWindow: (e.g., 5000)
- symbol: Trading symbol eg. BTCUSDT (e.g., BTCUSDT)
- side: BUY or SELL (e.g., BUY)
- startTime: in milliseconds eg.1641522717552 (e.g., 1623319461670)
- endTime: in milliseconds eg.1641522526562 (e.g., 1641782889000)
- page: Default is 1 (e.g., 1)
- pageSize: MIN 1, MAX 100; Default 100 (e.g., 100)
- symbol: Trading symbol eg. BTCUSDT (e.g., BTCUSDT)
- side: Trading side ( BUY or SELL ) (e.g., BUY)
- positionSide: Default
BOTHfor One-way Mode ;LONGorSHORTfor Hedge Mode. It must be sent in Hedge Mode. (e.g., BOTH) - quantity: Quantity of base asset; Maximum notional per order is 200k, 2mm or 10mm, depending on symbol. Please reduce your size if you order is above the maximum notional per order. (e.g., 1.0)
- duration: Duration for TWAP orders in seconds. [300, 86400] (e.g., 5000)
- clientAlgoId: A unique id among Algo orders (length should be 32 characters), If it is not sent, we will give default value (e.g., 1)
- reduceOnly: "true" or "false". Default "false"; Cannot be sent in Hedge Mode; Cannot be sent when you open a position
- limitPrice: Limit price of the order; If it is not sent, will place order by market price by default (e.g., 1.0)
- urgency: Represent the relative speed of the current execution; ENUM: LOW, MEDIUM, HIGH (e.g., LOW)
Authentication
For endpoints that require authentication, you will need to provide Binance API credentials. Required credentials:
- apiKey: Your Binance API key (for header)
- secretKey: Your Binance API secret (for signing)
Base URLs:
- Mainnet: https://api.binance.com
Security
Share Credentials
Users can provide Binance API credentials by sending a file where the content is in the following format:
abc123...xyz
secret123...key
Never Disclose API Key and Secret
Never disclose the location of the API key and secret file.
Never send the API key and secret to any website other than Mainnet and Testnet.
Never Display Full Secrets
When showing credentials to users:
- API Key: Show first 5 + last 4 characters:
su1Qc...8akf - Secret Key: Always mask, show only last 5:
***...aws1
Example response when asked for credentials: Account: main API Key: su1Qc...8akf Secret: ***...aws1
Listing Accounts
When listing accounts, show names and environment only — never keys: Binance Accounts:
- main (Mainnet)
- futures-keys (Mainnet)
Transactions in Mainnet
When performing transactions in mainnet, always confirm with the user before proceeding by asking them to write "CONFIRM" to proceed.
Binance Accounts
main
- API Key: your_mainnet_api_key
- Secret: your_mainnet_secret
TOOLS.md Structure
## Binance Accounts
### main
- API Key: abc123...xyz
- Secret: secret123...key
- Description: Primary trading account
### futures-keys
- API Key: futures789...def
- Secret: futuressecret...uvw
- Description: Futures trading account
Agent Behavior
- Credentials requested: Mask secrets (show last 5 chars only)
- Listing accounts: Show names and environment, never keys
- Account selection: Ask if ambiguous, default to main
- When doing a transaction in mainnet, confirm with user before by asking to write "CONFIRM" to proceed
- New credentials: Prompt for name, environment, signing mode
Adding New Accounts
When user provides new credentials:
- Ask for account name
- Store in
TOOLS.mdwith masked display confirmation
Signing Requests
For trading endpoints that require a signature:
- Build query string with all parameters, including the timestamp (Unix ms).
- Percent-encode the parameters using UTF-8 according to RFC 3986.
- Sign query string with secretKey using HMAC SHA256, RSA, or Ed25519 (depending on the account configuration).
- Append signature to query string.
- Include
X-MBX-APIKEYheader.
Otherwise, do not perform steps 3–5.
User Agent Header
Include User-Agent header with the following string: binance-algo/1.0.0 (Skill)
See references/authentication.md for implementation details.