@aicoin/aicoin-mcp 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +114 -112
  2. package/build/index.js +2 -2
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,139 +1,141 @@
1
- # @aicoin/mcp
1
+ # @aicoin/aicoin-mcp
2
2
 
3
- Unified AiCoin MCP Server — crypto market data + trading in one package.
3
+ AiCoin MCP Server — connect any AI assistant to real-time crypto market data and exchange trading.
4
4
 
5
- Merges `@aicoin/opendata-mcp` (market data via AiCoin API) and `@aicoin/trade-mcp` (trading via CCXT) into **41 tools**.
5
+ **41 tools** covering market data, K-lines, funding rates, liquidations, order flow, Hyperliquid analytics, news, and multi-exchange trading via CCXT.
6
6
 
7
7
  ## Quick Start
8
8
 
9
+ ### 1. Get your API Key
10
+
11
+ Visit [aicoin.com/opendata](https://www.aicoin.com/opendata) to create a free API key.
12
+
13
+ ### 2. Add to your MCP client
14
+
15
+ **Claude Desktop / Cursor / Windsurf** — edit your MCP config:
16
+
9
17
  ```json
10
18
  {
11
19
  "mcpServers": {
12
20
  "aicoin": {
13
21
  "command": "npx",
14
- "args": ["-y", "@aicoin/mcp"],
22
+ "args": ["-y", "@aicoin/aicoin-mcp"],
15
23
  "env": {
16
- "AICOIN_ACCESS_KEY_ID": "<your opendata key>",
17
- "AICOIN_ACCESS_SECRET": "<your opendata secret>",
18
- "DEFAULT_EXCHANGE": "binance",
19
- "BINANCE_API_KEY": "<your key>",
20
- "BINANCE_SECRET": "<your secret>",
21
- "USE_PROXY": "false"
24
+ "AICOIN_ACCESS_KEY_ID": "your-key-id",
25
+ "AICOIN_ACCESS_SECRET": "your-secret"
22
26
  }
23
27
  }
24
28
  }
25
29
  }
26
30
  ```
27
31
 
32
+ **Claude Code** — add to `.mcp.json` in your project root, same format as above.
33
+
34
+ That's it. Your AI assistant now has access to 41 crypto data tools.
35
+
36
+ ### 3. (Optional) Enable exchange trading
37
+
38
+ To place orders, check balances, etc., add your exchange API key:
39
+
40
+ ```json
41
+ {
42
+ "mcpServers": {
43
+ "aicoin": {
44
+ "command": "npx",
45
+ "args": ["-y", "@aicoin/aicoin-mcp"],
46
+ "env": {
47
+ "AICOIN_ACCESS_KEY_ID": "your-key-id",
48
+ "AICOIN_ACCESS_SECRET": "your-secret",
49
+ "DEFAULT_EXCHANGE": "okx",
50
+ "OKX_API_KEY": "your-exchange-api-key",
51
+ "OKX_SECRET": "your-exchange-secret",
52
+ "OKX_PASSPHRASE": "your-passphrase"
53
+ }
54
+ }
55
+ }
56
+ }
57
+ ```
58
+
59
+ Exchange API keys are stored locally only and never sent to AiCoin servers.
60
+
28
61
  ## Environment Variables
29
62
 
30
63
  | Variable | Required | Description |
31
64
  |----------|----------|-------------|
32
- | `AICOIN_ACCESS_KEY_ID` | No | AiCoin OpenData API key (free tier built-in) |
33
- | `AICOIN_ACCESS_SECRET` | No | AiCoin OpenData API secret |
34
- | `DEFAULT_EXCHANGE` | No | Default exchange for trading (default: binance) |
65
+ | `AICOIN_ACCESS_KEY_ID` | No | AiCoin API key (free tier built-in, rate-limited) |
66
+ | `AICOIN_ACCESS_SECRET` | No | AiCoin API secret |
67
+ | `DEFAULT_EXCHANGE` | No | Default exchange for trading (default: `binance`) |
35
68
  | `{EXCHANGE}_API_KEY` | For trading | Exchange API key |
36
69
  | `{EXCHANGE}_SECRET` | For trading | Exchange API secret |
37
70
  | `{EXCHANGE}_PASSPHRASE` | OKX/Bitget | Exchange passphrase |
38
- | `USE_PROXY` | No | Enable proxy (true/false) |
39
- | `PROXY_URL` | No | Proxy URL (http/https/socks5) |
40
-
41
- Supported exchanges: `binance`, `binanceusdm`, `binancecoinm`, `okx`, `bybit`, `bitget`, `gate`, `huobi`, `hyperliquid`
42
-
43
- ## Tools (41)
44
-
45
- ### Trade (11) — CCXT-based exchange trading
46
-
47
- | # | Tool | Description |
48
- |---|------|-------------|
49
- | 1 | `exchange_info` | List exchanges, query trading pairs. Actions: `exchanges`, `markets` |
50
- | 2 | `exchange_ticker` | Real-time ticker (single or batch) |
51
- | 3 | `exchange_market_data` | Order book, trades, OHLCV. Actions: `orderbook`, `trades`, `ohlcv` |
52
- | 4 | `exchange_funding` | Funding rates. Actions: `current`, `history` |
53
- | 5 | `account_status` | Account balance & positions. Actions: `balance`, `positions` |
54
- | 6 | `account_orders` | Order queries. Actions: `open`, `closed`, `by_id`, `my_trades` |
55
- | 7 | `account_history` | Account history. Actions: `ledger`, `deposits`, `withdrawals` |
56
- | 8 | `create_order` | Place market/limit orders |
57
- | 9 | `cancel_order` | Cancel single or all orders |
58
- | 10 | `set_trading_config` | Set leverage & margin mode. Actions: `leverage`, `margin_mode` |
59
- | 11 | `transfer` | Transfer funds between accounts |
60
-
61
- ### Coins (5) — AiCoin coin data
62
-
63
- | # | Tool | Description |
64
- |---|------|-------------|
65
- | 12 | `coin_info` | Coin data. Actions: `list`, `ticker`, `config`, `ai_analysis` |
66
- | 13 | `coin_funding_rate` | Funding rate history (regular or volume-weighted) |
67
- | 14 | `coin_liquidation` | Liquidation data. Actions: `map`, `history`, `estimated` |
68
- | 15 | `coin_open_interest` | Aggregated OI history (stablecoin or coin-margined) |
69
- | 16 | `coin_futures_data` | Futures depth & trades. Actions: `historical_depth`, `super_depth`, `trade_data` |
70
-
71
- ### Contents (2) — News & flash
72
-
73
- | # | Tool | Description |
74
- |---|------|-------------|
75
- | 17 | `news` | News articles. Actions: `list`, `detail`, `rss` |
76
- | 18 | `flash` | Flash news. Actions: `newsflash`, `list`, `exchange_listing` |
77
-
78
- ### Markets (6) — Market & index data
79
-
80
- | # | Tool | Description |
81
- |---|------|-------------|
82
- | 19 | `market_info` | Exchange/market data. Actions: `exchanges`, `ticker`, `hot_coins`, `futures_interest` |
83
- | 20 | `kline` | K-line data. Actions: `data`, `indicator`, `trading_pair` |
84
- | 21 | `index_data` | Index data. Actions: `price`, `info`, `list` |
85
- | 22 | `crypto_stock` | Crypto stocks. Actions: `quotes`, `top_gainer`, `company` |
86
- | 23 | `coin_treasury` | Corporate holdings. Actions: `entities`, `history`, `accumulated`, `latest_entities`, `latest_history`, `summary` |
87
- | 24 | `depth` | Order book depth. Actions: `latest`, `full`, `grouped` |
88
-
89
- ### Features (5) — Signals & analytics
90
-
91
- | # | Tool | Description |
92
- |---|------|-------------|
93
- | 25 | `market_overview` | Market overview. Actions: `nav`, `ls_ratio`, `liquidation`, `grayscale_trust`, `gray_scale`, `stock_market` |
94
- | 26 | `order_flow` | Order flow. Actions: `big_orders`, `agg_trades` |
95
- | 27 | `trading_pair` | Trading pairs. Actions: `ticker`, `by_market`, `list` |
96
- | 28 | `signal_data` | Signal data. Actions: `strategy`, `alert`, `config`, `alert_list`, `change` |
97
- | 29 | `signal_manage` | Manage alerts. Actions: `add`, `delete` |
98
-
99
- ### Hyperliquid (11) — HL-specific analytics
100
-
101
- | # | Tool | Description |
102
- |---|------|-------------|
103
- | 30 | `hl_ticker` | HL tickers (single coin or batch) |
104
- | 31 | `hl_whale` | Whale data. Actions: `positions`, `events`, `directions`, `history_ratio` |
105
- | 32 | `hl_liquidation` | Liquidation data. Actions: `history`, `stats`, `stats_by_coin`, `top_positions` |
106
- | 33 | `hl_open_interest` | OI data. Actions: `summary`, `top_coins`, `history` |
107
- | 34 | `hl_taker` | Taker data. Actions: `delta`, `klines` |
108
- | 35 | `hl_trader` | Trader analytics. Actions: `stats`, `best_trades`, `performance`, `completed_trades`, `accounts`, `statistics` |
109
- | 36 | `hl_fills` | Trade fills. Actions: `by_address`, `by_oid`, `by_twapid`, `top_trades` |
110
- | 37 | `hl_orders` | Orders. Actions: `latest`, `by_oid`, `filled`, `filled_by_oid`, `top_open`, `active_stats`, `twap_states` |
111
- | 38 | `hl_position` | Position data. Actions: `current_history`, `completed_history`, `current_pnl`, `completed_pnl`, `current_executions`, `completed_executions` |
112
- | 39 | `hl_portfolio` | Portfolio data. Actions: `portfolio`, `pnls`, `max_drawdown`, `net_flow` |
113
- | 40 | `hl_advanced` | Advanced. Actions: `info`, `smart_find`, `discover` |
114
-
115
- ### Guide (1)
116
-
117
- | # | Tool | Description |
118
- |---|------|-------------|
119
- | 41 | `guide` | Setup guides. Actions: `api_key`, `upgrade`, `trade_setup` |
120
-
121
- ## Testing
122
-
123
- ```bash
124
- npm run build
125
- node test-tools.mjs # Test all tools
126
- node test-tools.mjs hl_ # Test Hyperliquid only
127
- node test-tools.mjs coin # Test coin-related only
128
- ```
129
-
130
- ## Development
131
-
132
- ```bash
133
- npm run dev # Watch mode
134
- npm run build # Production build
135
- npm start # Run server
136
- ```
71
+ | `USE_PROXY` | No | Enable proxy (`true`/`false`) |
72
+ | `PROXY_URL` | No | Proxy URL, e.g. `http://127.0.0.1:7890` |
73
+
74
+ Supported exchanges: `binance` `binanceusdm` `binancecoinm` `okx` `bybit` `bitget` `gate` `huobi` `hyperliquid`
75
+
76
+ ## Tools
77
+
78
+ ### Market Data (30 tools)
79
+
80
+ | Tool | What it does |
81
+ |------|-------------|
82
+ | `coin_info` | Coin list, real-time prices, profiles, AI analysis |
83
+ | `coin_funding_rate` | Funding rate history (per-exchange or volume-weighted) |
84
+ | `coin_liquidation` | Liquidation heatmap, history, estimated liquidation chart |
85
+ | `coin_open_interest` | Aggregated OI history (stablecoin / coin-margined) |
86
+ | `coin_futures_data` | Futures order book history, large orders, trade data |
87
+ | `market_info` | Exchange list, platform tickers, trending coins, futures OI rankings |
88
+ | `kline` | Standard & indicator K-lines, trading pair discovery |
89
+ | `index_data` | Index prices, details, list of all available indexes |
90
+ | `crypto_stock` | Crypto-related stock quotes, top gainers, company info |
91
+ | `coin_treasury` | Corporate holdings (entities, trade history, accumulated) |
92
+ | `depth` | Real-time order book snapshots (latest, full, grouped) |
93
+ | `market_overview` | Market nav, long/short ratio, liquidation, grayscale, stocks |
94
+ | `order_flow` | Whale order tracking, aggregated large trades |
95
+ | `trading_pair` | Trading pair tickers, pairs by platform, filtered search |
96
+ | `signal_data` | Win-rate strategy signals, alerts, abnormal price movements |
97
+ | `signal_manage` | Create and delete signal alerts |
98
+ | `news` | Paginated news articles, full article detail, RSS feed |
99
+ | `flash` | Flash news, industry flashes, exchange listing announcements |
100
+ | `hl_ticker` | Hyperliquid tickers (single coin or all) |
101
+ | `hl_whale` | HL whale positions, events, long/short directions |
102
+ | `hl_liquidation` | HL liquidation history, stats, top liquidated positions |
103
+ | `hl_open_interest` | HL OI summary, top coins, per-coin history |
104
+ | `hl_taker` | HL taker buy/sell delta, K-lines with taker volume |
105
+ | `hl_trader` | HL trader stats, best trades, performance, batch analytics |
106
+ | `hl_fills` | HL trade fills by address/order/TWAP, top trades |
107
+ | `hl_orders` | HL orders (latest, filled, top open, active stats, TWAP) |
108
+ | `hl_position` | HL position history, PnL, execution trace |
109
+ | `hl_portfolio` | HL portfolio curve, PnL, max drawdown, net flow |
110
+ | `hl_advanced` | HL generic info API, smart money finder, trader discovery |
111
+ | `guide` | Setup guides for API key, tier upgrade, exchange trading |
112
+
113
+ ### Exchange Trading (11 tools, requires exchange API key)
114
+
115
+ | Tool | What it does |
116
+ |------|-------------|
117
+ | `exchange_info` | List supported exchanges, query trading pairs |
118
+ | `exchange_ticker` | Real-time ticker (single or batch) |
119
+ | `exchange_market_data` | Order book, recent trades, OHLCV candlesticks |
120
+ | `exchange_funding` | Current and historical funding rates |
121
+ | `account_status` | Account balance and open positions |
122
+ | `account_orders` | Query open/closed orders, trade history |
123
+ | `account_history` | Ledger, deposit, and withdrawal history |
124
+ | `create_order` | Place market or limit orders |
125
+ | `cancel_order` | Cancel single or all open orders |
126
+ | `set_trading_config` | Set leverage and margin mode |
127
+ | `transfer` | Transfer funds between accounts (spot/futures) |
128
+
129
+ ## API Tiers
130
+
131
+ | Tier | Price | Rate Limit | Features |
132
+ |------|-------|------------|----------|
133
+ | Basic | Free | 10 req/min | Market data, news, K-lines, indexes |
134
+ | Normal | ¥99/mo | 60 req/min | + Funding rate, liquidation, OI |
135
+ | Premium | ¥299/mo | 120 req/min | + Depth, whale tracking, order flow |
136
+ | Professional | ¥999/mo | 300 req/min | + Full depth, all features |
137
+
138
+ Upgrade at [aicoin.com/opendata](https://www.aicoin.com/opendata). Your existing key is automatically upgraded.
137
139
 
138
140
  ## License
139
141
 
package/build/index.js CHANGED
@@ -2133,7 +2133,7 @@ Add them to your MCP client config:
2133
2133
  "mcpServers": {
2134
2134
  "aicoin": {
2135
2135
  "command": "npx",
2136
- "args": ["-y", "@aicoin/mcp"],
2136
+ "args": ["-y", "@aicoin/aicoin-mcp"],
2137
2137
  "env": {
2138
2138
  "AICOIN_ACCESS_KEY_ID": "<your accessKeyId>",
2139
2139
  "AICOIN_ACCESS_SECRET": "<your accessSecret>"
@@ -2235,7 +2235,7 @@ Common proxy ports:
2235
2235
  "mcpServers": {
2236
2236
  "aicoin": {
2237
2237
  "command": "npx",
2238
- "args": ["-y", "@aicoin/mcp"],
2238
+ "args": ["-y", "@aicoin/aicoin-mcp"],
2239
2239
  "env": {
2240
2240
  "AICOIN_ACCESS_KEY_ID": "<your opendata key>",
2241
2241
  "AICOIN_ACCESS_SECRET": "<your opendata secret>",
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@aicoin/aicoin-mcp",
3
- "version": "1.0.0",
3
+ "version": "1.0.1",
4
4
  "description": "AiCoin MCP Server - unified crypto market data & trading via AiCoin API + CCXT",
5
5
  "main": "build/index.js",
6
6
  "type": "module",