simple-earn
binance/binance-skills-hub
Manage Binance Simple Earn products and BFUSD/RWUSD accounts via authenticated API.
What is simple-earn?
This skill provides access to Binance's Simple Earn API endpoints for subscribing to and redeeming flexible and locked savings products, as well as managing BFUSD and RWUSD accounts. Use it to automate yield-earning strategies, check account balances, and retrieve transaction history.
- Subscribe to and redeem flexible and locked Simple Earn products
- Query account balances, quotas, and positions across Simple Earn products
- Manage BFUSD and RWUSD stablecoin accounts with subscribe/redeem operations
- Retrieve historical data including rewards, redemptions, subscriptions, and rate history
- Configure auto-subscription and redemption preferences for products
- Preview subscription amounts and potential returns before committing
How to install simple-earn
npx skills add https://github.com/binance/binance-skills-hub --skill simple-earn- Binance API key and secret key with appropriate permissions (USER_DATA and TRADE scopes)
- curl, openssl, and date command-line utilities installed
How to use simple-earn
- 1.Install the skill using the provided npm command
- 2.Set your Binance API key and secret key in your environment or configuration
- 3.Call the desired endpoint (e.g., GET /sapi/v1/simple-earn/account to check your account)
- 4.Provide required parameters such as productId, projectId, or amount depending on the endpoint
- 5.Parse the returned JSON response containing account data, positions, or transaction history
Use cases
- Automate recurring deposits into Simple Earn products for passive yield generation
- Monitor account positions and earnings across multiple Simple Earn products
- Retrieve historical transaction records for tax reporting and portfolio analysis
- Dynamically adjust subscription settings based on market conditions or portfolio rebalancing
- Manage BFUSD/RWUSD stablecoin conversions as part of a broader treasury strategy
- Binance API users managing yield-earning strategies
- Portfolio managers automating savings product allocations
- Traders integrating Simple Earn into multi-asset strategies
- Developers building Binance account automation tools
simple-earn FAQ
You need a Binance API key and secret key. The secret key is used to sign requests; ensure it has USER_DATA and TRADE permissions enabled.
Flexible products allow you to redeem at any time with variable returns, while locked products have a fixed term and typically offer higher yields but restrict early redemption.
Yes, use the subscriptionPreview endpoints (/sapi/v1/simple-earn/flexible/subscriptionPreview or /sapi/v1/simple-earn/locked/subscriptionPreview) to estimate returns for a given amount.
Use the history endpoints (e.g., /sapi/v1/simple-earn/flexible/history/rewardsRecord or /sapi/v1/simple-earn/locked/history/redemptionRecord) with optional time filters and pagination parameters.
recvWindow specifies the maximum time (in milliseconds, max 60000) that a request is valid. It protects against replay attacks by ensuring requests are processed within a specific time window.
Full instructions (SKILL.md)
Source of truth, from binance/binance-skills-hub.
name: simple-earn description: Binance Simple-earn request using the Binance API. Authentication requires API key and secret key. metadata: version: 1.1.0 author: Binance openclaw: requires: bins: - curl - openssl - date homepage: https://github.com/binance/binance-skills-hub/tree/main/skills/binance/simple-earn/SKILL.md license: MIT
Binance Simple-earn Skill
Simple-earn 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/bfusd/account (GET) | Get BFUSD Account (USER_DATA) | None | recvWindow | Yes |
/sapi/v1/bfusd/quota (GET) | Get BFUSD Quota Details (USER_DATA) | None | recvWindow | Yes |
/sapi/v1/bfusd/redeem (POST) | Redeem BFUSD(TRADE) | amount, type | recvWindow | Yes |
/sapi/v1/bfusd/subscribe (POST) | Subscribe BFUSD(TRADE) | asset, amount | recvWindow | Yes |
/sapi/v1/bfusd/history/rateHistory (GET) | Get BFUSD Rate History (USER_DATA) | None | startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/bfusd/history/redemptionHistory (GET) | Get BFUSD Redemption History (USER_DATA) | None | startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/bfusd/history/rewardsHistory (GET) | Get BFUSD Rewards History (USER_DATA) | None | startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/bfusd/history/subscriptionHistory (GET) | Get BFUSD subscription history(USER_DATA) | None | asset, startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/flexible/personalLeftQuota (GET) | Get Flexible Personal Left Quota(USER_DATA) | productId | recvWindow | Yes |
/sapi/v1/simple-earn/flexible/position (GET) | Get Flexible Product Position(USER_DATA) | None | asset, productId, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/locked/personalLeftQuota (GET) | Get Locked Personal Left Quota(USER_DATA) | projectId | recvWindow | Yes |
/sapi/v1/simple-earn/locked/position (GET) | Get Locked Product Position | None | asset, positionId, projectId, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/flexible/list (GET) | Get Simple Earn Flexible Product List(USER_DATA) | None | asset, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/locked/list (GET) | Get Simple Earn Locked Product List(USER_DATA) | None | asset, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/account (GET) | Simple Account(USER_DATA) | None | recvWindow | Yes |
/sapi/v1/simple-earn/flexible/subscriptionPreview (GET) | Get Flexible Subscription Preview(USER_DATA) | productId, amount | recvWindow | Yes |
/sapi/v1/simple-earn/locked/subscriptionPreview (GET) | Get Locked Subscription Preview(USER_DATA) | projectId, amount | autoSubscribe, recvWindow | Yes |
/sapi/v1/simple-earn/flexible/redeem (POST) | Redeem Flexible Product(TRADE) | productId | redeemAll, amount, destAccount, recvWindow | Yes |
/sapi/v1/simple-earn/locked/redeem (POST) | Redeem Locked Product(TRADE) | positionId | recvWindow | Yes |
/sapi/v1/simple-earn/flexible/setAutoSubscribe (POST) | Set Flexible Auto Subscribe(USER_DATA) | productId, autoSubscribe | recvWindow | Yes |
/sapi/v1/simple-earn/locked/setAutoSubscribe (POST) | Set Locked Auto Subscribe(USER_DATA) | positionId, autoSubscribe | recvWindow | Yes |
/sapi/v1/simple-earn/locked/setRedeemOption (POST) | Set Locked Product Redeem Option(USER_DATA) | positionId, redeemTo | recvWindow | Yes |
/sapi/v1/simple-earn/flexible/subscribe (POST) | Subscribe Flexible Product(TRADE) | productId, amount | autoSubscribe, sourceAccount, recvWindow | Yes |
/sapi/v1/simple-earn/locked/subscribe (POST) | Subscribe Locked Product(TRADE) | projectId, amount | autoSubscribe, sourceAccount, redeemTo, recvWindow | Yes |
/sapi/v1/simple-earn/flexible/history/collateralRecord (GET) | Get Collateral Record(USER_DATA) | None | productId, startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/flexible/history/redemptionRecord (GET) | Get Flexible Redemption Record(USER_DATA) | None | productId, redeemId, asset, startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/flexible/history/rewardsRecord (GET) | Get Flexible Rewards History(USER_DATA) | type | productId, asset, startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/flexible/history/subscriptionRecord (GET) | Get Flexible Subscription Record(USER_DATA) | None | productId, purchaseId, asset, startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/locked/history/redemptionRecord (GET) | Get Locked Redemption Record(USER_DATA) | None | positionId, redeemId, asset, startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/locked/history/rewardsRecord (GET) | Get Locked Rewards History(USER_DATA) | None | positionId, asset, startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/locked/history/subscriptionRecord (GET) | Get Locked Subscription Record(USER_DATA) | None | purchaseId, asset, startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/simple-earn/flexible/history/rateHistory (GET) | Get Rate History(USER_DATA) | productId | aprPeriod, startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/rwusd/quota (GET) | Get RWUSD Quota Details (USER_DATA) | None | recvWindow | Yes |
/sapi/v1/rwusd/account (GET) | Get RWUSD Account (USER_DATA) | None | recvWindow | Yes |
/sapi/v1/rwusd/redeem (POST) | Redeem RWUSD(TRADE) | amount, type | recvWindow | Yes |
/sapi/v1/rwusd/subscribe (POST) | Subscribe RWUSD(TRADE) | asset, amount | recvWindow | Yes |
/sapi/v1/rwusd/history/rateHistory (GET) | Get RWUSD Rate History (USER_DATA) | None | startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/rwusd/history/redemptionHistory (GET) | Get RWUSD Redemption History (USER_DATA) | None | startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/rwusd/history/rewardsHistory (GET) | Get RWUSD Rewards History (USER_DATA) | None | startTime, endTime, current, size, recvWindow | Yes |
/sapi/v1/rwusd/history/subscriptionHistory (GET) | Get RWUSD subscription history(USER_DATA) | None | asset, startTime, endTime, current, size, recvWindow | Yes |
Parameters
Common Parameters
- recvWindow: The value cannot be greater than 60000 (ms) (e.g., 5000)
- amount: Amount (e.g., 1.0)
- type: FAST or STANDARD, defaults to STANDARD (e.g., s)
- asset: USDT or USDC (whichever is eligible)
- startTime: (e.g., 1623319461670)
- endTime: (e.g., 1641782889000)
- current: Currently querying page. Starts from 1. Default: 1 (e.g., 1)
- size: Number of results per page. Default: 10, Max: 100 (e.g., 10)
- asset: USDC or USDT
- productId: (e.g., 1)
- productId: (e.g., 1)
- projectId: (e.g., 1)
- positionId: (e.g., 1)
- projectId: (e.g., 1)
- autoSubscribe: true or false, default true. (e.g., true)
- redeemAll: true or false, default to false
- amount: if redeemAll is false, amount is mandatory (e.g., 1.0)
- destAccount:
SPOT,FUND, defaultSPOT(e.g., SPOT) - positionId: (e.g., 1)
- autoSubscribe: true or false
- redeemTo:
SPOT,'FLEXIBLE' - sourceAccount:
SPOT,FUND,ALL, defaultSPOT(e.g., SPOT) - redeemTo:
SPOT,FLEXIBLE, defaultSPOT(e.g., SPOT) - redeemId: (e.g., 1)
- purchaseId: (e.g., 1)
- aprPeriod: "DAY","YEAR",default"DAY" (e.g., DAY)
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 in different ways. The agent will try to retrieve automatically with the two first ways the credentials, but users can also explicitly tell the agent that they have set the credentials or stored them in a .env file, and the agent should re-read that file when they do. The agent can also make http requests with the two first methods without user confirmation.
- Environment variables
Search for the following specific variables only (never dump the full environment):
Authorized environment variables
- Mainnet:
BINANCE_API_KEYandBINANCE_SECRET_KEY
Read and use in a single exec call so the raw key never enters the agent's context:
KEY="$BINANCE_API_KEY"
SECRET="$BINANCE_SECRET_KEY"
response=$(curl -s -X GET "$URL" \
-H "X-MBX-APIKEY: $KEY" \
--data-urlencode "param1=value1")
echo "$response"
Environment variables must be set before OpenClaw starts. They are inherited at process startup and cannot be injected into a running instance. If you need to add or update credentials without restarting, use a secrets file (see option 2).
- Secrets file (.env)
Check ~/.openclaw/secrets.env , ~/.env, or a .env file in the workspace. Read individual keys with grep, never source the full file:
# Try all credential locations in order
API_KEY=$(grep '^BINANCE_API_KEY=' ~/.openclaw/secrets.env 2>/dev/null | cut -d= -f2-)
SECRET_KEY=$(grep '^BINANCE_SECRET_KEY=' ~/.openclaw/secrets.env 2>/dev/null | cut -d= -f2-)
# Fallback: search .env in known directories (KEY=VALUE then raw line format)
for dir in ~/.openclaw ~; do
[ -n "$API_KEY" ] && break
env_file="$dir/.env"
[ -f "$env_file" ] || continue
# Read first two lines
line1=$(sed -n '1p' "$env_file")
line2=$(sed -n '2p' "$env_file")
# Check if lines contain '=' indicating KEY=VALUE format
if [[ "$line1" == *=* && "$line2" == *=* ]]; then
API_KEY=$(grep '^BINANCE_API_KEY=' "$env_file" 2>/dev/null | cut -d= -f2-)
SECRET_KEY=$(grep '^BINANCE_SECRET_KEY=' "$env_file" 2>/dev/null | cut -d= -f2-)
else
# Treat lines as raw values
API_KEY="$line1"
SECRET_KEY="$line2"
fi
done
This file can be updated at any time without restarting OpenClaw, keys are read fresh on each invocation. Users can tell you the variables are now set or stored in a .env file, and you should re-read that file when they do.
- Inline file
Sending a file where the content is in the following format:
abc123...xyz
secret123...key
- Never run
printenv,env,export, or set without a specific variable name - Never run
greponenvfiles without anchoring to a specific key ('^VARNAME=') - Never source a secrets file into the shell environment (
source .envor. .env) - Only read credentials explicitly needed for the current task
- Never echo or log raw credentials in output or replies
- Never commit
TOOLS.mdto version control if it contains real credentials — add it to.gitignore
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 by Inline file or message:
- Ask for account name
- Store in
TOOLS.mdwith masked display confirmation
Signing Requests
For trading endpoints that require a signature:
- Detect key type first, inspect the secret key format before signing.
- 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 4–6.
User Agent Header
Include User-Agent header with the following string: binance-simple-earn/1.1.0 (Skill)
See references/authentication.md for implementation details.
Related skills
More from binance/binance-skills-hub and the wider catalog.

spot
Execute authenticated Binance Spot API requests for trading, market data, and order management.

square-post
Publish text, images, articles, and videos to Binance Square with a single command.

sub-account
Manage Binance sub-accounts via API: create, enable features, transfer assets, and monitor positions.

trading-signal
Track smart-money buy/sell signals on BSC and Solana with trigger prices, max gains, and exit rates.

vip-loan
Request and manage VIP loans on Binance with authenticated API endpoints.

frontend-design-pro
Creates jaw-dropping, production-ready frontend interfaces AND delivers perfectly matched real photos (Unsplash/Pexels direct links) OR flawless custom image-generation prompts for hero images, backgrounds, and illustrations. Zero AI slop, zero fake URLs.