@aicoin/opendata-mcp 1.0.29 → 2.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 +70 -183
  2. package/build/index.js +978 -2249
  3. package/package.json +1 -1
package/README.md CHANGED
@@ -1,185 +1,39 @@
1
- # AiCoin OpenData MCP Server
1
+ # @aicoin/opendata-mcp
2
2
 
3
- Crypto market data, news, and analytics via AiCoin Open API.
3
+ AiCoin OpenData MCP Server — real-time crypto market data & analytics for any AI assistant.
4
4
 
5
- ## Features
5
+ **30 tools** · Market data · K-lines · Funding rates · Liquidations · Order flow · Hyperliquid analytics · News
6
6
 
7
- - 100+ data tools across 5 modules (coins, contents, markets, features, hyperliquid)
8
- - HmacSHA1 auto-signing for all API requests
9
- - Covers real-time tickers, K-lines, news, whale tracking, liquidation data
10
- - stdio transport for local MCP clients
7
+ > Need exchange trading (place orders, check balances)? Use [@aicoin/aicoin-mcp](https://www.npmjs.com/package/@aicoin/aicoin-mcp) instead — it includes everything here plus 11 CCXT trading tools.
11
8
 
12
9
  ## Quick Start
13
10
 
14
- ```bash
15
- npm install
16
- cp .env.example .env
17
- # Edit .env with your AiCoin API credentials
18
- npm run build
19
- npm start
20
- ```
11
+ Works out of the box — a free API key is built in (10 req/min, IP rate-limited).
21
12
 
22
- ## Environment Variables
13
+ ### Claude Code
23
14
 
24
15
  ```bash
25
- AICOIN_ACCESS_KEY_ID=your_access_key_id
26
- AICOIN_ACCESS_SECRET=your_access_secret
16
+ claude mcp add aicoin-opendata -- npx -y @aicoin/opendata-mcp
27
17
  ```
28
18
 
29
- ## Available Tools
19
+ ### Other Clients
30
20
 
31
- ### Coins
32
-
33
- | Tool | Description |
34
- |------|-------------|
35
- | `get_coin_list` | All supported coins |
36
- | `get_coin_ticker` | Real-time price, change, volume |
37
- | `get_coin_config` | Coin profile/description |
38
- | `get_ai_coin_analysis` | AI interpretation and prediction |
39
- | `get_funding_rate_history` | Funding rate history |
40
- | `get_liquidation_map` | Liquidation heatmap |
41
- | `get_weighted_funding_rate_history` | Volume-weighted funding rate history |
42
- | `get_aggregated_stablecoin_oi_history` | Aggregated stablecoin OI history |
43
- | `get_aggregated_coin_margin_oi_history` | Aggregated coin-margin OI history |
44
- | `get_liquidation_history` | Liquidation order history |
45
- | `get_estimated_liquidation_history` | Estimated liquidation chart data |
46
- | `get_historical_depth` | Historical order book depth |
47
- | `get_super_depth_history` | Large order depth history |
48
- | `get_trade_data` | Latest futures trade data |
49
-
50
- ### Contents
51
-
52
- | Tool | Description |
53
- |------|-------------|
54
- | `get_newsflash` | Flash news (kuaixun) |
55
- | `get_news_list` | News article list |
56
- | `get_news_detail` | Full article content |
57
- | `get_rss_news_list` | RSS news feed |
58
- | `get_flash_list` | Industry flash news with classification |
59
- | `get_exchange_listing_flash` | Exchange listing/delisting news |
60
-
61
- ### Markets
62
-
63
- | Tool | Description |
64
- |------|-------------|
65
- | `get_kline_data` | K-line/candlestick data |
66
- | `get_market_ticker` | Exchange platform ticker |
67
- | `get_markets` | All exchange platforms |
68
- | `get_futures_interest` | Futures open interest |
69
- | `get_crypto_stock_quotes` | Crypto stock quotes (MSTR, COIN) |
70
- | `get_crypto_stock_top_gainer` | Top gaining crypto-related stocks |
71
- | `get_index_price` | Index price data |
72
- | `get_hot_tab_coins` | Trending coins by category |
73
- | `get_crypto_company_info` | Crypto company details by symbol |
74
- | `get_index_info` | Index detail information |
75
- | `get_index_list` | All available indexes |
76
- | `get_indicator_kline_trading_pair` | Trading pairs for indicator K-line |
77
- | `get_indicator_kline_data` | Indicator K-line data records |
78
- | `get_coin_treasury_entities` | Coin treasury entity data |
79
- | `get_coin_treasury_history` | Coin treasury historical data |
80
- | `get_coin_treasury_accumulated` | Accumulated treasury history |
81
- | `get_latest_coin_treasury_entities` | Latest treasury entities |
82
- | `get_latest_coin_treasury_history` | Latest treasury history |
83
- | `get_coin_treasury_summary` | Treasury data summary |
84
- | `get_latest_depth` | Latest order book depth |
85
- | `get_full_depth` | Full order book depth |
86
- | `get_full_depth_grouped` | Full depth grouped by price |
87
-
88
- ### Features
89
-
90
- | Tool | Description |
91
- |------|-------------|
92
- | `get_ls_ratio` | Long/short ratio |
93
- | `get_liquidation_data` | Liquidation/forced-close data |
94
- | `get_big_orders` | Whale order tracking |
95
- | `get_agg_trades` | Aggregated large trades |
96
- | `get_trading_pair_ticker` | Trading pair ticker data |
97
- | `get_strategy_signal` | Indicator win-rate signals |
98
- | `get_nav` | Market overview navigation data |
99
- | `get_grayscale_trust` | Grayscale trust fund data |
100
- | `get_gray_scale` | Grayscale holdings data |
101
- | `get_stock_market` | Crypto-related stock market data |
102
- | `get_signal_alert` | Signal alert data |
103
- | `get_signal_alert_config` | Signal alert config options |
104
- | `delete_signal_alert` | Delete signal alert by ID |
105
- | `add_signal_alert` | Add new signal alert |
106
- | `get_signal_alert_list` | Signal alert settings list |
107
- | `get_change_signal` | Abnormal movement signals |
108
- | `get_trading_pair` | Trading pair info by key |
109
- | `get_trading_pairs` | Trading pair list for platform |
110
-
111
- ### Hyperliquid
112
-
113
- | Tool | Description |
114
- |------|-------------|
115
- | `hl_get_tickers` | All Hyperliquid tickers |
116
- | `hl_get_ticker_by_coin` | Ticker for specific coin |
117
- | `hl_get_whale_positions` | Whale open positions |
118
- | `hl_get_liquidations` | Liquidation history |
119
- | `hl_get_trader_stats` | Trader statistics by address |
120
- | `hl_info` | Generic Info API (all info types) |
121
- | `hl_get_fills_by_address` | Trade fills by wallet address |
122
- | `hl_get_fills_by_oid` | Trade fills by order ID |
123
- | `hl_get_fills_by_twapid` | Trade fills by TWAP ID |
124
- | `hl_get_top_trades` | Top trades |
125
- | `hl_get_filled_orders` | Filled orders by address |
126
- | `hl_get_filled_order_by_oid` | Filled order by order ID |
127
- | `hl_get_orders` | Latest orders by address |
128
- | `hl_get_order_by_oid` | Order by order ID |
129
- | `hl_get_top_open_orders` | Top open orders |
130
- | `hl_get_active_stats` | Active order statistics |
131
- | `hl_get_portfolio` | Account value and PNL curves |
132
- | `hl_get_pnls` | PNL curve data by address |
133
- | `hl_get_best_trades` | Most profitable trades |
134
- | `hl_get_performance_by_coin` | Per-coin trading performance |
135
- | `hl_get_completed_trades` | Completed trades list |
136
- | `hl_get_current_position_history` | Current position history |
137
- | `hl_get_completed_position_history` | Completed position history |
138
- | `hl_get_current_position_pnl` | Current position PnL |
139
- | `hl_get_completed_position_pnl` | Completed position PnL |
140
- | `hl_get_current_position_executions` | Current position executions |
141
- | `hl_get_completed_position_executions` | Completed position executions |
142
- | `hl_get_traders_accounts` | Batch trader account info |
143
- | `hl_get_traders_statistics` | Batch trader statistics |
144
- | `hl_get_whale_events` | Latest whale position events |
145
- | `hl_get_whale_directions` | Whale long/short counts |
146
- | `hl_get_whale_history_long_ratio` | Historical whale long/short ratio |
147
- | `hl_get_liquidation_stats` | Liquidation statistics |
148
- | `hl_get_liquidation_stats_by_coin` | Liquidation stats by coin |
149
- | `hl_get_liquidation_top_positions` | Top liquidated positions |
150
- | `hl_smart_find` | Discover smart money addresses |
151
- | `hl_discover_traders` | Discover traders by criteria |
152
- | `hl_get_twap_states` | TWAP order states |
153
- | `hl_get_max_drawdown` | Max drawdown by address |
154
- | `hl_get_net_flow` | Ledger net flow by address |
155
- | `hl_get_klines_with_taker_vol` | K-lines with taker volume |
156
-
157
- ## Client Configuration
158
-
159
- > Get your API credentials at [AiCoin OpenAPI](https://www.aicoin.com/opendata)
160
-
161
- ### Claude Desktop
162
-
163
- Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
21
+ Add to your MCP config (`.mcp.json`, `claude_desktop_config.json`, etc.):
164
22
 
165
23
  ```json
166
24
  {
167
25
  "mcpServers": {
168
26
  "aicoin-opendata": {
169
27
  "command": "npx",
170
- "args": ["-y", "@aicoin/opendata-mcp"],
171
- "env": {
172
- "AICOIN_ACCESS_KEY_ID": "your_access_key_id",
173
- "AICOIN_ACCESS_SECRET": "your_access_secret"
174
- }
28
+ "args": ["-y", "@aicoin/opendata-mcp"]
175
29
  }
176
30
  }
177
31
  }
178
32
  ```
179
33
 
180
- ### Cursor
34
+ ### Use Your Own API Key (Optional)
181
35
 
182
- Add to `.cursor/mcp.json`:
36
+ For higher rate limits, get a key at [aicoin.com/opendata](https://www.aicoin.com/opendata) and add env vars:
183
37
 
184
38
  ```json
185
39
  {
@@ -188,40 +42,73 @@ Add to `.cursor/mcp.json`:
188
42
  "command": "npx",
189
43
  "args": ["-y", "@aicoin/opendata-mcp"],
190
44
  "env": {
191
- "AICOIN_ACCESS_KEY_ID": "your_access_key_id",
192
- "AICOIN_ACCESS_SECRET": "your_access_secret"
45
+ "AICOIN_ACCESS_KEY_ID": "your-key-id",
46
+ "AICOIN_ACCESS_SECRET": "your-secret"
193
47
  }
194
48
  }
195
49
  }
196
50
  }
197
51
  ```
198
52
 
199
- ### Windsurf
53
+ ## Tools
200
54
 
201
- Add to `~/.codeium/windsurf/mcp_config.json` (same format as Cursor).
55
+ | Tool | What it does |
56
+ |------|-------------|
57
+ | `coin_info` | Coin list, real-time prices, profiles, AI analysis |
58
+ | `coin_funding_rate` | Funding rate history (per-exchange or volume-weighted) |
59
+ | `coin_liquidation` | Liquidation heatmap, history, estimated liquidation chart |
60
+ | `coin_open_interest` | Aggregated OI history (stablecoin / coin-margined) |
61
+ | `coin_futures_data` | Futures order book history, large orders, trade data |
62
+ | `market_info` | Exchange list, platform tickers, trending coins, futures OI rankings |
63
+ | `kline` | Standard & indicator K-lines, trading pair discovery |
64
+ | `index_data` | Index prices, details, list of all available indexes |
65
+ | `crypto_stock` | Crypto-related stock quotes, top gainers, company info |
66
+ | `coin_treasury` | Corporate holdings (entities, trade history, accumulated) |
67
+ | `depth` | Real-time order book snapshots (latest, full, grouped) |
68
+ | `market_overview` | Market nav, long/short ratio, liquidation, grayscale, stocks |
69
+ | `order_flow` | Whale order tracking, aggregated large trades |
70
+ | `trading_pair` | Trading pair tickers, pairs by platform, filtered search |
71
+ | `signal_data` | Win-rate strategy signals, alerts, abnormal price movements |
72
+ | `signal_manage` | Add or delete signal alerts |
73
+ | `news` | Paginated news articles, full article detail, RSS feed |
74
+ | `flash` | Flash news, industry flashes, exchange listing announcements |
75
+ | `hl_ticker` | Hyperliquid tickers (single coin or all) |
76
+ | `hl_whale` | HL whale positions, events, long/short directions |
77
+ | `hl_liquidation` | HL liquidation history, stats, top liquidated positions |
78
+ | `hl_open_interest` | HL OI summary, top coins, per-coin history |
79
+ | `hl_taker` | HL taker buy/sell delta, K-lines with taker volume |
80
+ | `hl_trader` | HL trader stats, best trades, performance, batch analytics |
81
+ | `hl_fills` | HL trade fills by address/order/TWAP, top trades |
82
+ | `hl_orders` | HL orders (latest, filled, top open, active stats, TWAP) |
83
+ | `hl_position` | HL position history, PnL, execution trace |
84
+ | `hl_portfolio` | HL portfolio curve, PnL, max drawdown, net flow |
85
+ | `hl_advanced` | HL generic info API, smart money finder, trader discovery |
86
+ | `guide` | Setup guides for API key and tier upgrade |
202
87
 
203
- ### VS Code (Copilot)
88
+ ## Environment Variables
204
89
 
205
- Add to `.vscode/mcp.json`:
90
+ | Variable | Required | Description |
91
+ |----------|----------|-------------|
92
+ | `AICOIN_ACCESS_KEY_ID` | No | AiCoin API key (free tier built-in, rate-limited) |
93
+ | `AICOIN_ACCESS_SECRET` | No | AiCoin API secret |
206
94
 
207
- ```json
208
- {
209
- "servers": {
210
- "aicoin-opendata": {
211
- "type": "stdio",
212
- "command": "npx",
213
- "args": ["-y", "@aicoin/opendata-mcp"],
214
- "env": {
215
- "AICOIN_ACCESS_KEY_ID": "your_access_key_id",
216
- "AICOIN_ACCESS_SECRET": "your_access_secret"
217
- }
218
- }
219
- }
220
- }
221
- ```
95
+ ## API Tiers
222
96
 
223
- ### Claude Code
97
+ | Tier | Price | Rate Limit | Features |
98
+ |------|-------|------------|----------|
99
+ | Basic | Free | 10 req/min | Market data, news, K-lines, indexes |
100
+ | Normal | ¥99/mo | 60 req/min | + Funding rate, liquidation, OI |
101
+ | Premium | ¥299/mo | 120 req/min | + Depth, whale tracking, order flow |
102
+ | Professional | ¥999/mo | 300 req/min | + Full depth, all features |
224
103
 
225
- ```bash
226
- claude mcp add aicoin-opendata -- npx -y @aicoin/opendata-mcp
227
- ```
104
+ Upgrade at [aicoin.com/opendata](https://www.aicoin.com/opendata). Your existing key is automatically upgraded.
105
+
106
+ ## Migrating from v1.x
107
+
108
+ v2.0 consolidates 100+ individual tools into **30 action-based tools**. Each tool now supports multiple actions via an `action` parameter (e.g., `coin_info` with `action: "list"` / `"ticker"` / `"config"` / `"ai_analysis"`).
109
+
110
+ This reduces context overhead for AI assistants and improves tool selection accuracy. All API endpoints remain the same — only the tool interface changed.
111
+
112
+ ## License
113
+
114
+ MIT