PluginBench
Skill
Fail
Audit score 45

alpha

binance/binance-skills-hub

Access Binance Alpha trading data via authenticated API endpoints.

What is alpha?

The Binance Alpha skill provides access to Binance's Alpha trading API for retrieving ticker data, aggregated trades, exchange info, and candlestick data. Use it when you need real-time or historical market data for Alpha tokens on Binance.

  • Fetch 24-hour ticker statistics for Alpha trading pairs
  • Retrieve aggregated trade history with optional time and ID filtering
  • Get exchange information and available trading symbols
  • Retrieve candlestick (kline) data across multiple time intervals
  • List available Alpha tokens from Binance wallet
  • Query data without authentication for public endpoints

How to install alpha

npx skills add https://github.com/binance/binance-skills-hub --skill alpha
Prerequisites
  • Binance API key and secret key (for authenticated endpoints)
  • curl, openssl, and date command-line tools installed
  • Environment variables BINANCE_API_KEY and BINANCE_SECRET_KEY configured, or credentials stored in ~/.openclaw/secrets.env or .env file
Claude Code
Cursor
Windsurf
Cline

How to use alpha

  1. 1.Set up Binance API credentials via environment variables (BINANCE_API_KEY, BINANCE_SECRET_KEY) or store in ~/.openclaw/secrets.env
  2. 2.Retrieve the token list using the Token List endpoint to identify available Alpha symbols
  3. 3.Make GET requests to the desired endpoint (ticker, agg-trades, klines, or exchange-info) with required parameters like symbol and interval
  4. 4.Include the X-MBX-APIKEY header and signature (if required) in your requests
  5. 5.Parse the returned JSON response containing market data

Use cases

Good for
  • Monitor real-time price statistics and trading volume for Alpha tokens
  • Analyze historical trade data to understand market activity patterns
  • Retrieve candlestick charts for technical analysis across 1s to 1M intervals
  • Build trading dashboards that display current exchange info and token lists
  • Backtest trading strategies using historical aggregated trades and kline data
Who it's for
  • Cryptocurrency traders analyzing Alpha token markets
  • Developers building trading bots or market analysis tools
  • Financial analysts studying Binance Alpha trading patterns
  • Agents automating market data collection and monitoring

alpha FAQ

Do I need API credentials for all endpoints?

No. Public endpoints like ticker, aggregated trades, klines, exchange info, and token list do not require authentication. Only certain trading endpoints require API key and secret.

What symbol format should I use?

Use the token ID from the Token List endpoint, formatted as 'ALPHA_175USDT' or similar. The exact format depends on the available trading pairs.

What time intervals are supported for candlestick data?

Supported intervals are: 1s, 15s, 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M.

How should I handle API credentials securely?

Store credentials in environment variables or a .env file, never hardcode them. The skill will read from BINANCE_API_KEY and BINANCE_SECRET_KEY automatically. Never log or display full credentials.

What is the maximum limit for returned results?

The default limit is 500 results, with a maximum of 1000 results per request.

Full instructions (SKILL.md)

Source of truth, from binance/binance-skills-hub.


name: alpha description: Binance Alpha 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/alpha/SKILL.md license: MIT

Binance Alpha Skill

Alpha request on Binance using authenticated API endpoints. Requires API key and secret key for certain endpoints. Return the result in JSON format.

Quick Reference

EndpointDescriptionRequiredOptionalAuthentication
/bapi/defi/v1/public/alpha-trade/ticker (GET)Ticker (24hr Price Statistics)symbolNoneNo
/bapi/defi/v1/public/alpha-trade/agg-trades (GET)Aggregated TradessymbolfromId, startTime, endTime, limitNo
/bapi/defi/v1/public/alpha-trade/get-exchange-info (GET)Get Exchange InfoNoneNoneNo
/bapi/defi/v1/public/alpha-trade/klines (GET)Klines (Candlestick Data)symbol, intervallimit, startTime, endTimeNo
/bapi/defi/v1/public/wallet-direct/buw/wallet/cex/alpha/all/token/list (GET)Token ListNoneNoneNo

Parameters

Common Parameters

  • symbol: e.g., "ALPHA_175USDT" – use token ID from Token List
  • fromId: starting trade ID to fetch from (e.g., 1)
  • startTime: start timestamp (milliseconds) (e.g., 1623319461670)
  • endTime: end timestamp (milliseconds) (e.g., 1641782889000)
  • limit: number of results to return (default 500, max 1000) (e.g., 500)
  • interval: e.g., "1h" – supported intervals: 1s, 15s, 1m, 3m, 5m, 15m, 30m, 1h, 2h, 4h, 6h, 8h, 12h, 1d, 3d, 1w, 1M

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:

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.

  1. Environment variables

Search for the following specific variables only (never dump the full environment):

Authorized environment variables

  • Mainnet: BINANCE_API_KEY and BINANCE_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).

  1. 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.

  1. 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 grep on env files without anchoring to a specific key ('^VARNAME=')
  • Never source a secrets file into the shell environment (source .env or . .env)
  • Only read credentials explicitly needed for the current task
  • Never echo or log raw credentials in output or replies
  • Never commit TOOLS.md to 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

  1. Credentials requested: Mask secrets (show last 5 chars only)
  2. Listing accounts: Show names and environment, never keys
  3. Account selection: Ask if ambiguous, default to main
  4. When doing a transaction in mainnet, confirm with user before by asking to write "CONFIRM" to proceed
  5. 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.md with masked display confirmation

Signing Requests

For trading endpoints that require a signature:

  1. Detect key type first, inspect the secret key format before signing.
  2. Build query string with all parameters, including the timestamp (Unix ms).
  3. Percent-encode the parameters using UTF-8 according to RFC 3986.
  4. Sign query string with secretKey using HMAC SHA256, RSA, or Ed25519 (depending on the account configuration).
  5. Append signature to query string.
  6. Include X-MBX-APIKEY header.

Otherwise, do not perform steps 4–6.

User Agent Header

Include User-Agent header with the following string: binance-alpha/1.1.0 (Skill)

See references/authentication.md for implementation details.