mcpField
B
blofin-setup

blofin-setup

github.com/blofinAgent workflows880 installsUpdated 32w ago
Repository

About blofin-setup

A setup guide for configuring the BloFin MCP server, aimed at users connecting BloFin exchange access to an agent. It covers installation, API credentials, demo and production endpoints, verification, and troubleshooting.

Key features

  1. 01Install blofin-mcp
  2. 02Create and configure API keys
  3. 03Set demo or production endpoint
  4. 04Verify server connection
  5. 05Troubleshoot common setup issues

Use cases

  1. 01Install the server with npm
  2. 02Configure credentials in MCP settings
  3. 03Test access on demo trading
  4. 04Diagnose API authentication or connectivity issues

MCP support

Guides users in adding and configuring the BloFin MCP server in an agent's MCP configuration, then verifying its API access.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/blofin/blofin-skills-hub --skill blofin-setup

After installing, type/blofin-setupin Claude Code to confirm it loaded.

Details

From the project README

BloFin Setup

Guide users through setting up and configuring the BloFin MCP server for trading on BloFin exchange.

Prerequisites

  • Node.js (v18+) and npm installed
  • A BloFin account at blofin.com

Setup Steps

1. Install blofin-mcp
npm install -g blofin-mcp

Or install locally:

git clone https://github.com/blofin/blofin-mcp.git
cd blofin-mcp
npm install
npm run build
2. Create BloFin API Keys

Direct the user to BloFin API Management:

  1. Log in to BloFin
  2. Navigate to Account > API Management
  3. Click Create API Key
  4. Set permissions:
    • READ — view balances, order history, positions
    • TRADE — place and cancel orders
    • TRANSFER — move funds between accounts
  5. Set a Passphrase (remember this)
  6. (Recommended) Bind to IP whitelist for security
  7. Save the API Key and Secret Key — the secret is shown only once
3. Configure MCP Server

Add the blofin MCP server to your agent's MCP configuration (e.g. mcp.json or settings.json):

{
  "mcpServers": {
    "blofin": {
      "command": "node",
      "args": ["/path/to/blofin-mcp/dist/index.js"],
      "env": {
        "BLOFIN_API_KEY": "your-api-key",
        "BLOFIN_API_SECRET": "your-api-secret",
        "BLOFIN_PASSPHRASE": "your-passphrase",
        "BLOFIN_BROKER_ID": "your-broker-id (optional)",
        "BLOFIN_BASE_URL": "https://openapi.blofin.com"
      }
    }
  }
}

Replace /path/to/blofin-mcp with the actual installation path (e.g., the global npm path or the local clone directory).

4. Base URL Configuration
EnvironmentBase URLUse Case
Demo Tradinghttps://demo-trading-openapi.blofin.comTesting, learning, paper trading
Productionhttps://openapi.blofin.comReal money trading
  • Default is demo trading if BLOFIN_BASE_URL is not set
  • Always start with demo trading to verify your setup works correctly
  • Switch to production only after successful demo testing
5. Verify Connection

After configuration, verify the setup works:

  1. Use get_apikey_info to verify API key permissions and status
  2. Use get_tickers with instId: "BTC-USDT" to test public data access
  3. Use get_balance to verify authenticated access
  4. Check that the API key has the expected permissions (readOnly field: 0 = Read+Write, 1 = Read only)
6. Troubleshooting
IssueSolution
Signature verification failedCheck that API secret and passphrase are correct; ensure no extra spaces
IP not in whitelist (152406)Add your current IP to the API key's whitelist on BloFin
Access key expired (152402)Keys without IP binding expire after 90 days; recreate or bind an IP
Rate limit (429)Reduce request frequency; REST API limit is 500/min per IP
Connection timeoutCheck your network; verify the base URL is correct

Environment Variables Reference

VariableRequiredDescription
BLOFIN_API_KEYYesYour BloFin API key
BLOFIN_API_SECRETYesYour BloFin API secret key
BLOFIN_PASSPHRASEYesThe passphrase set when creating the API key
BLOFIN_BROKER_IDNoBroker ID for order attribution (provided by BloFin)
BLOFIN_BASE_URLNoAPI base URL (defaults to demo trading endpoint)

Security Best Practices

  • Never share or expose your API secret and passphrase
  • Always bind API keys to specific IP addresses in production
  • Use the minimum required permissions for your use case
  • Regularly rotate API keys
  • Start with READ permission only and upgrade as needed

Comments

Markdown supported