Binance MCP

🚀 Binance MCP Server Usage Guide

This guide provides a comprehensive overview of the Binance MCP Server, including installation, configuration, feature modules, and more. It helps users quickly get started with the server and perform various operations.

🚀 Quick Start

Installation

Download the Source Code

git clone https://github.com/yourusername/binance-mcp-server.git
cd binance-mcp-server

Install Dependencies

Run the following command in the project root directory:

npm install

Start the Server

Start the server after setting the environment variables:

node build/index.js

Configuration

Environment Variable Configuration

Create a .env file and add the following content:

BINANCE_API_KEY=your_api_key
BINANCE_API_SECRET=your_api_secret

Modify the Startup Script

Add the startup command to the scripts section of package.json:

{
  "scripts": {
    "start": "set BINANCE_API_KEY=your_api_key & set BINANCE_API_SECRET=your_api_secret & node build/index.js",
    ...
  }
}

✨ Features

Account Information Query

Use the get_account command to get account details:

node index.js get_account

Asset List Query

List all tradable assets:

node index.js list_assets

Market Data Retrieval

Get real-time market information through the market_data module, for example:

node index.js market_data --symbol=BTCUSDT

Order Operations

View Pending Orders

node index.js get_orders --symbol=BTCUSDT

Cancel an Order

node index.js cancel_order --order_id=12345

Place an Order

node index.js place_order --symbol=BTCUSDT --side=sell --quantity=0.01 --type=market

📚 Documentation

Error Handling

Common Errors

1. Environment Variables Not Set

The BINANCE_API_KEY and BINANCE_API_SECRET environment variables are required.

2. API Request Failure

• Problem: The API returns an error code 403 (Forbidden).
• Solution: Check the API key permission settings.

3. Network Connection Issues

• Cause: Unstable internet connection or Binance server restrictions.
• Solution: Use a VPN or check if the IP address is allowed to access.

Security Tips

API Key Management

• Privacy Protection: Avoid hardcoding API keys directly in the code. It is recommended to use environment variables or professional key management tools.
• Permission Control: Set the minimum necessary permission scope for API keys.
• IP Whitelist: Enable IP restrictions in the Binance account settings.

Security Warnings

• Avoid transmitting sensitive information over public networks.
• Regularly update API keys and revoke old keys.

Deployment Options

Development Environment Deployment

1. Clone the Repository

git clone https://github.com/yourusername/binance-mcp-server.git
cd binance-mcp-server

2. Install Dependencies

npm install

3. Start the Service

node build/index.js

Production Environment Deployment

1. Build and Optimize

npm run build

2. Configure Environment Variables

export BINANCE_API_KEY=your_api_key
export BINANCE_API_SECRET=your_api_secret

3. Start the Service

node build/index.js start --production

💻 Usage Examples

Basic Usage

const { BinanceMcpServer } = require('binance-mcp-server');

async function main() {
    const server = new BinanceMcpServer({
        apiKey: process.env.BINANCE_API_KEY,
        apiSecret: process.env.BINANCE_API_SECRET
    });

    await server.start();
}

main().catch(err => console.error(err));

🔧 Technical Details

Compatibility

• Supported Node.js versions: >=14.0.0

Error Code Reference

Maintenance Guide

• Regularly check for API documentation updates.
• Update dependency packages to the latest versions.
• Monitor server logs.

📄 Contact Information

If you need help or want to report an issue, please contact: support@binance.com