- Home
- MCP servers
- Hyperliquid
Hyperliquid
- python
27
GitHub Stars
python
Language
4 months ago
First Indexed
3 weeks ago
Catalog Refreshed
Documentation & install
Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.
Installation
Add the following to your MCP client configuration file.
Configuration
View docs{
"mcpServers": {
"kukapay-hyperliquid-info-mcp": {
"command": "mcp",
"args": [
"dev",
"main.py"
]
}
}
}You run a lightweight MCP server that exposes real-time Hyperliquid data and insights for bots, dashboards, and analytics. This guide walks you through using the server, installing it locally, and leveraging its end-to-end capabilities to fetch user, market, and trade data through concise prompts and tools.
How to use
You interact with the Hyperliquid Info MCP server using an MCP client to ask for data, run analyses, and fetch market information. Start the server in development mode to test prompts and tools, then use the client to trigger specific tools like getting user state, trade history, market metadata, and candlestick data. You can request ISO 8601 time strings for precise time filtering in time-based queries.
Typical usage patterns you can perform include analyzing a trading account, fetching the current user state for perpetuals, retrieving open orders, and pulling candlestick data for a trading pair. The server supports a wide range of data tools for user data, market data, and analysis prompts to help you build dashboards and automation workflows.
How to install
Prerequisites you need on your machine:
- Python 3.10 or newer to satisfy the Hyperliquid Python SDK requirements.
- A Python package manager (pip) or uvx for dependency management.
- A Hyperliquid account address for user-specific queries (if you plan to run user-related prompts).
Step-by-step installation flow you can follow locally:
# 1) Clone the project repository
git clone https://github.com/kukapay/hyperliquid-info-mcp.git
cd hyperliquid-info-mcp
# 2) Install dependencies (Python-based MCP server uses uvx/npm-like flow for setup in this environment)
# If you are using uvx, install and sync as shown here
uv sync
# 3) Run the server in development mode (initial testing)
mcp dev main.py
# 4) (Optional) Install for use in Claude Desktop or other MCP clients
mcp install main.py --name "Hyperliquid Info"
Configuration and usage notes
No additional runtime configuration is required for basic usage beyond running the standard dev or install commands. The server provides a suite of data tools you can invoke via your MCP client or operating environment, including user data queries, market data tools, and analysis prompts.
Security and access: Treat your account address and any sensitive trading data as restricted information. Use proper access controls in your MCP client environment and avoid exposing keys or addresses in unsecured logs or dashboards.
Troubleshooting tips: If the server does not start, verify you have Python 3.10 installed, ensure uvx or pip is available for dependencies, and retry the development start command. Check for port conflicts or missing dependencies indicated by the MCP client console.
Available tools
get_user_state
Fetches the current state of a user including positions, margin, and withdrawable balance for perpetuals or spot markets.
get_user_open_orders
Retrieves all open orders for a user account.
get_user_trade_history
Returns trade fill history with details such as symbol, size, and price.
get_user_funding_history
Queries funding payment history with customizable time ranges.
get_user_fees
Fetches user-specific fee structures (maker/taker rates).
get_user_staking_summary
Retrieves staking summary details for a user.
get_user_staking_rewards
Retrieves staking rewards for a user.
get_user_order_by_oid
Retrieves a specific order by its order ID.
get_user_order_by_cloid
Retrieves a specific order by its client order ID.
get_user_sub_accounts
Lists sub-accounts associated with a main account.
get_all_mids
Gets mid prices for all trading pairs.
get_l2_snapshot
Fetches Level 2 order book snapshots for a specific coin.
get_candles_snapshot
Retrieves candlestick data with customizable intervals and time ranges.
get_coin_funding_history
Queries funding rate history for a specific coin.
get_perp_dexs
Fetches metadata about perpetual markets.
get_perp_metadata
Gets detailed metadata for perpetual markets with optional asset contexts.
get_spot_metadata
Gets detailed metadata for spot markets with optional asset contexts.
analyze_positions
A guided prompt to analyze user trading activity using relevant tools.