@aicoin/opendata-mcp 1.0.0

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.
package/.env.example ADDED
@@ -0,0 +1,9 @@
1
+ # AiCoin OpenData MCP - API credentials
2
+ # NOTE: AiCoin 后台的字段名和这里的变量名是反的!
3
+ # 后台 "api_key" → 填到 AICOIN_ACCESS_KEY(用作 AccessKeyId)
4
+ # 后台 "access_key" → 填到 AICOIN_ACCESS_SECRET(用作 HMAC 签名密钥)
5
+ AICOIN_ACCESS_KEY=your_api_key_from_aicoin
6
+ AICOIN_ACCESS_SECRET=your_access_key_from_aicoin
7
+
8
+ # Optional: API base URL (default: https://open.aicoin.com/api/v2)
9
+ # AICOIN_BASE_URL=https://open.aicoin.com/api/v2
package/README.md ADDED
@@ -0,0 +1,228 @@
1
+ # AiCoin OpenData MCP Server
2
+
3
+ Crypto market data, news, and analytics via AiCoin Open API.
4
+
5
+ ## Features
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
11
+
12
+ ## Quick Start
13
+
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
+ ```
21
+
22
+ ## Environment Variables
23
+
24
+ ```bash
25
+ AICOIN_ACCESS_KEY=your_access_key_id
26
+ AICOIN_ACCESS_SECRET=your_access_secret
27
+ ```
28
+
29
+ ## Available Tools
30
+
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_index_price` | Index price data |
71
+ | `get_hot_tab_coins` | Trending coins by category |
72
+ | `get_crypto_company_info` | Crypto company details by symbol |
73
+ | `get_index_info` | Index detail information |
74
+ | `get_index_list` | All available indexes |
75
+ | `get_indicator_kline_trading_pair` | Trading pairs for indicator K-line |
76
+ | `get_indicator_kline_data` | Indicator K-line data records |
77
+ | `get_coin_treasury_entities` | Coin treasury entity data |
78
+ | `get_coin_treasury_history` | Coin treasury historical data |
79
+ | `get_coin_treasury_accumulated` | Accumulated treasury history |
80
+ | `get_latest_coin_treasury_entities` | Latest treasury entities |
81
+ | `get_latest_coin_treasury_history` | Latest treasury history |
82
+ | `get_coin_treasury_summary` | Treasury data summary |
83
+ | `get_latest_depth` | Latest order book depth |
84
+ | `get_full_depth` | Full order book depth |
85
+ | `get_full_depth_grouped` | Full depth grouped by price |
86
+
87
+ ### Features
88
+
89
+ | Tool | Description |
90
+ |------|-------------|
91
+ | `get_ls_ratio` | Long/short ratio |
92
+ | `get_liquidation_data` | Liquidation/forced-close data |
93
+ | `get_big_orders` | Whale order tracking |
94
+ | `get_agg_trades` | Aggregated large trades |
95
+ | `get_trading_pair_ticker` | Trading pair ticker data |
96
+ | `get_strategy_signal` | Indicator win-rate signals |
97
+ | `get_nav` | Market overview navigation data |
98
+ | `get_grayscale_trust` | Grayscale trust fund data |
99
+ | `get_gray_scale` | Grayscale holdings data |
100
+ | `get_stock_market` | Crypto-related stock market data |
101
+ | `get_signal_alert` | Signal alert data |
102
+ | `get_signal_alert_config` | Signal alert config options |
103
+ | `delete_signal_alert` | Delete signal alert by ID |
104
+ | `add_signal_alert` | Add new signal alert |
105
+ | `get_signal_alert_list` | Signal alert settings list |
106
+ | `get_change_signal` | Abnormal movement signals |
107
+ | `get_trading_pair` | Trading pair info by key |
108
+ | `get_trading_pairs` | Trading pair list for platform |
109
+
110
+ ### Hyperliquid
111
+
112
+ | Tool | Description |
113
+ |------|-------------|
114
+ | `hl_get_tickers` | All Hyperliquid tickers |
115
+ | `hl_get_ticker_by_coin` | Ticker for specific coin |
116
+ | `hl_get_whale_positions` | Whale open positions |
117
+ | `hl_get_liquidations` | Liquidation history |
118
+ | `hl_get_trader_stats` | Trader statistics by address |
119
+ | `hl_info` | Generic Info API (all info types) |
120
+ | `hl_get_fills_by_address` | Trade fills by wallet address |
121
+ | `hl_get_fills_by_oid` | Trade fills by order ID |
122
+ | `hl_get_fills_by_twapid` | Trade fills by TWAP ID |
123
+ | `hl_get_top_trades` | Top trades |
124
+ | `hl_get_filled_orders` | Filled orders by address |
125
+ | `hl_get_filled_order_by_oid` | Filled order by order ID |
126
+ | `hl_get_orders` | Latest orders by address |
127
+ | `hl_get_order_by_oid` | Order by order ID |
128
+ | `hl_get_top_open_orders` | Top open orders |
129
+ | `hl_get_active_stats` | Active order statistics |
130
+ | `hl_get_portfolio` | Account value and PNL curves |
131
+ | `hl_get_pnls` | PNL curve data by address |
132
+ | `hl_get_best_trades` | Most profitable trades |
133
+ | `hl_get_performance_by_coin` | Per-coin trading performance |
134
+ | `hl_get_completed_trades` | Completed trades list |
135
+ | `hl_get_current_position_history` | Current position history |
136
+ | `hl_get_completed_position_history` | Completed position history |
137
+ | `hl_get_current_position_pnl` | Current position PnL |
138
+ | `hl_get_completed_position_pnl` | Completed position PnL |
139
+ | `hl_get_current_position_executions` | Current position executions |
140
+ | `hl_get_completed_position_executions` | Completed position executions |
141
+ | `hl_get_traders_accounts` | Batch trader account info |
142
+ | `hl_get_traders_statistics` | Batch trader statistics |
143
+ | `hl_get_whale_events` | Latest whale position events |
144
+ | `hl_get_whale_directions` | Whale long/short counts |
145
+ | `hl_get_whale_history_long_ratio` | Historical whale long/short ratio |
146
+ | `hl_get_liquidation_stats` | Liquidation statistics |
147
+ | `hl_get_liquidation_stats_by_coin` | Liquidation stats by coin |
148
+ | `hl_get_liquidation_top_positions` | Top liquidated positions |
149
+ | `hl_smart_find` | Discover smart money addresses |
150
+ | `hl_discover_traders` | Discover traders by criteria |
151
+ | `hl_get_twap_states` | TWAP order states |
152
+ | `hl_get_max_drawdown` | Max drawdown by address |
153
+ | `hl_get_net_flow` | Ledger net flow by address |
154
+ | `hl_get_klines_with_taker_vol` | K-lines with taker volume |
155
+
156
+ ## Client Configuration
157
+
158
+ > **Note:** AiCoin 后台字段名和环境变量是反的:
159
+ > - 后台 `api_key` → `AICOIN_ACCESS_KEY`
160
+ > - 后台 `access_key` → `AICOIN_ACCESS_SECRET`
161
+
162
+ ### Claude Desktop
163
+
164
+ Add to `~/Library/Application Support/Claude/claude_desktop_config.json`:
165
+
166
+ ```json
167
+ {
168
+ "mcpServers": {
169
+ "aicoin-opendata": {
170
+ "command": "npx",
171
+ "args": ["-y", "@aicoin/opendata-mcp"],
172
+ "env": {
173
+ "AICOIN_ACCESS_KEY": "your_api_key_from_aicoin",
174
+ "AICOIN_ACCESS_SECRET": "your_access_key_from_aicoin"
175
+ }
176
+ }
177
+ }
178
+ }
179
+ ```
180
+
181
+ ### Cursor
182
+
183
+ Add to `.cursor/mcp.json`:
184
+
185
+ ```json
186
+ {
187
+ "mcpServers": {
188
+ "aicoin-opendata": {
189
+ "command": "npx",
190
+ "args": ["-y", "@aicoin/opendata-mcp"],
191
+ "env": {
192
+ "AICOIN_ACCESS_KEY": "your_api_key_from_aicoin",
193
+ "AICOIN_ACCESS_SECRET": "your_access_key_from_aicoin"
194
+ }
195
+ }
196
+ }
197
+ }
198
+ ```
199
+
200
+ ### Windsurf
201
+
202
+ Add to `~/.codeium/windsurf/mcp_config.json` (same format as Cursor).
203
+
204
+ ### VS Code (Copilot)
205
+
206
+ Add to `.vscode/mcp.json`:
207
+
208
+ ```json
209
+ {
210
+ "servers": {
211
+ "aicoin-opendata": {
212
+ "type": "stdio",
213
+ "command": "npx",
214
+ "args": ["-y", "@aicoin/opendata-mcp"],
215
+ "env": {
216
+ "AICOIN_ACCESS_KEY": "your_api_key_from_aicoin",
217
+ "AICOIN_ACCESS_SECRET": "your_access_key_from_aicoin"
218
+ }
219
+ }
220
+ }
221
+ }
222
+ ```
223
+
224
+ ### Claude Code
225
+
226
+ ```bash
227
+ claude mcp add aicoin-opendata -- npx -y @aicoin/opendata-mcp
228
+ ```