{"_id":"@aurracloud/hyperliquid-mcp","_rev":"3-0b213cc7de511547666669063fcc2c06","name":"@aurracloud/hyperliquid-mcp","dist-tags":{"latest":"1.0.2","beta":"1.0.1"},"versions":{"1.0.0":{"name":"@aurracloud/hyperliquid-mcp","version":"1.0.0","keywords":["mcp","model-context-protocol","hyperliquid","defi","perpetuals","trading","blockchain","web3","api","tools","claude","ai"],"author":{"name":"Aura"},"license":"MIT","_id":"@aurracloud/hyperliquid-mcp@1.0.0","maintainers":[{"name":"yahya_aurracloud","email":"yahya@aurracloud.com"}],"homepage":"https://github.com/aurracloud/hyperliquid-mcp#readme","bugs":{"url":"https://github.com/aurracloud/hyperliquid-mcp/issues"},"bin":{"hyperliquid-mcp":"dist/index.js"},"dist":{"shasum":"d7a8ee7a9981f4c7a440d3905c5a1f04838b3ed7","tarball":"https://registry.npmjs.org/@aurracloud/hyperliquid-mcp/-/hyperliquid-mcp-1.0.0.tgz","fileCount":15,"integrity":"sha512-LGs6mqfwrXAGA7fRkGqQeX/7UkKKW6zsI0hABx9N26GGrb4UDQXp9kwM85cdCRanQRuAkHzmxuUAKBpCBTji2A==","signatures":[{"sig":"MEUCIBif0bvbPopvvJ2hzvu8Wb4gFUxqEAEmkEfBSIKcXjaSAiEA/ylAY9uVjcy/0D2hrzOaYWRrjbBK6tNyY1lCPfTvNwQ=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":82314},"main":"dist/lib.js","type":"module","types":"dist/lib.d.ts","engines":{"node":">=18.0.0"},"gitHead":"9d93b1b52d515a3b7fd81e57947ccc59ee0048d5","scripts":{"dev":"ts-node src/index.ts","test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepublishOnly":"npm run build"},"_npmUser":{"name":"yahya_aurracloud","email":"yahya@aurracloud.com"},"mcpServer":{"config":{"$schema":"https://schemas.aurracloud.com/server-config-v1.json","environment":{"optional":{"DEBUG":{"type":"boolean","default":false,"description":"Enable debug logging"},"HYPERLIQUID_TESTNET":{"type":"boolean","default":false,"description":"Use Hyperliquid testnet instead of mainnet"}}}},"metadata":{"category":"defi","keywords":["mcp","hyperliquid","defi","perpetuals","trading","web3","api"]},"connection":{"args":["-y","@aurracloud/hyperliquid-mcp"],"type":"stdio","command":"npx","timeout":30000},"description":"MCP server for Hyperliquid API integration. Provides tools for querying Hyperliquid perpetual trading data including positions, trades, vaults, and real-time market information.","capabilities":{"tools":true,"prompts":false,"resources":false}},"repository":{"url":"git+https://github.com/aurracloud/hyperliquid-mcp.git","type":"git"},"_npmVersion":"10.9.0","description":"Model Context Protocol (MCP) server for Hyperliquid API integration. Provides tools for querying Hyperliquid data including balances, positions, trades, vaults, and real-time market data.","directories":{},"_nodeVersion":"23.3.0","dependencies":{"zod":"^3.25.30","dotenv":"^16.5.0","@nktkas/hyperliquid":"^0.21.1","@modelcontextprotocol/sdk":"^1.12.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.2","typescript":"^5.8.3","@types/node":"^22.15.21","@tsconfig/recommended":"^1.0.8"},"_npmOperationalInternal":{"tmp":"tmp/hyperliquid-mcp_1.0.0_1749049133718_0.013931588834994013","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@aurracloud/hyperliquid-mcp","version":"1.0.1","keywords":["mcp","model-context-protocol","hyperliquid","defi","perpetuals","trading","blockchain","web3","api","tools","claude","ai"],"author":{"name":"Aura"},"license":"MIT","_id":"@aurracloud/hyperliquid-mcp@1.0.1","maintainers":[{"name":"yahya_aurracloud","email":"yahya@aurracloud.com"}],"homepage":"https://github.com/aurracloud/hyperliquid-mcp#readme","bugs":{"url":"https://github.com/aurracloud/hyperliquid-mcp/issues"},"bin":{"hyperliquid-mcp":"dist/index.js"},"dist":{"shasum":"4af07bce64186e60f4f640e77f038f129fbd66fd","tarball":"https://registry.npmjs.org/@aurracloud/hyperliquid-mcp/-/hyperliquid-mcp-1.0.1.tgz","fileCount":15,"integrity":"sha512-Qcyvt8UpfRNKTFYSjlRpKguyiXdygPx2hZTlJ40M+kz7ygLMuo6sdrxJjw64cyw715LmoE+qvRE1Ey1j4zc8Rg==","signatures":[{"sig":"MEQCIAmaIyV/JFFns77HC7Db6YwAwgYG0hw/h3hprgJKLUWbAiBPgXJ4e0udS8dC4/iwBvUbGC3UdHiWqI9TQ2P/vXBW3A==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":82779},"main":"dist/lib.js","type":"module","types":"dist/lib.d.ts","engines":{"node":">=18.0.0"},"gitHead":"f68d35804dbb9c05c3f7572eaab2a9887ed2fbe2","scripts":{"dev":"ts-node src/index.ts","test":"echo \"Error: no test specified\" && exit 1","build":"tsc","prepare":"npm run build","release":"./scripts/release.sh","release:major":"npm version major && git push origin main && git push origin --tags","release:minor":"npm version minor && git push origin main && git push origin --tags","release:patch":"npm version patch && git push origin main && git push origin --tags","prepublishOnly":"npm run build"},"_npmUser":{"name":"yahya_aurracloud","email":"yahya@aurracloud.com"},"mcpServer":{"config":{"$schema":"https://schemas.aurracloud.com/server-config-v1.json","environment":{"optional":{"DEBUG":{"type":"boolean","default":false,"description":"Enable debug logging"},"HYPERLIQUID_TESTNET":{"type":"boolean","default":false,"description":"Use Hyperliquid testnet instead of mainnet"}}}},"metadata":{"category":"defi","keywords":["mcp","hyperliquid","defi","perpetuals","trading","web3","api"]},"connection":{"args":["-y","@aurracloud/hyperliquid-mcp"],"type":"stdio","command":"npx","timeout":30000},"description":"MCP server for Hyperliquid API integration. Provides tools for querying Hyperliquid perpetual trading data including positions, trades, vaults, and real-time market information.","capabilities":{"tools":true,"prompts":false,"resources":false}},"repository":{"url":"git+https://github.com/aurracloud/hyperliquid-mcp.git","type":"git"},"_npmVersion":"10.9.0","description":"Model Context Protocol (MCP) server for Hyperliquid API integration. Provides tools for querying Hyperliquid data including balances, positions, trades, vaults, and real-time market data.","directories":{},"_nodeVersion":"23.3.0","dependencies":{"zod":"^3.25.30","dotenv":"^16.5.0","@nktkas/hyperliquid":"^0.21.1","@modelcontextprotocol/sdk":"^1.12.0"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"ts-node":"^10.9.2","typescript":"^5.8.3","@types/node":"^22.15.21","@tsconfig/recommended":"^1.0.8"},"_npmOperationalInternal":{"tmp":"tmp/hyperliquid-mcp_1.0.1_1749050110719_0.4052950446320416","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@aurracloud/hyperliquid-mcp","version":"1.0.2","description":"Model Context Protocol (MCP) server for Hyperliquid API integration. Provides tools for querying Hyperliquid data including balances, positions, trades, vaults, and real-time market data.","type":"module","main":"dist/lib.js","types":"dist/lib.d.ts","bin":{"hyperliquid-mcp":"dist/index.js"},"scripts":{"build":"tsc","prepublishOnly":"npm run build","test":"echo \"Error: no test specified\" && exit 1","dev":"ts-node src/index.ts","prepare":"npm run build","release":"./scripts/release.sh","release:patch":"npm version patch && git push origin main && git push origin --tags","release:minor":"npm version minor && git push origin main && git push origin --tags","release:major":"npm version major && git push origin main && git push origin --tags"},"keywords":["mcp","model-context-protocol","hyperliquid","defi","perpetuals","trading","blockchain","web3","api","tools","claude","ai"],"author":{"name":"Aura"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/aurracloud/hyperliquid-mcp.git"},"homepage":"https://github.com/aurracloud/hyperliquid-mcp#readme","bugs":{"url":"https://github.com/aurracloud/hyperliquid-mcp/issues"},"engines":{"node":">=18.0.0"},"publishConfig":{"access":"public"},"mcpServer":{"description":"MCP server for Hyperliquid API integration. Provides tools for querying Hyperliquid perpetual trading data including positions, trades, vaults, and real-time market information.","connection":{"type":"stdio","command":"npx","args":["-y","@aurracloud/hyperliquid-mcp"],"timeout":30000},"config":{"$schema":"https://schemas.aurracloud.com/server-config-v1.json","environment":{"optional":{"DEBUG":{"type":"boolean","description":"Enable debug logging","default":false},"HYPERLIQUID_TESTNET":{"type":"boolean","description":"Use Hyperliquid testnet instead of mainnet","default":false}}}},"capabilities":{"tools":true,"resources":false,"prompts":false},"metadata":{"keywords":["mcp","hyperliquid","defi","perpetuals","trading","web3","api"],"category":"defi"}},"devDependencies":{"@tsconfig/recommended":"^1.0.8","@types/node":"^22.15.21","ts-node":"^10.9.2","typescript":"^5.8.3"},"dependencies":{"@modelcontextprotocol/sdk":"^1.12.0","@nktkas/hyperliquid":"^0.21.1","dotenv":"^16.5.0","zod":"^3.25.30"},"_id":"@aurracloud/hyperliquid-mcp@1.0.2","gitHead":"2894a5ec043834c3f140bf330f8fd4d681ee4c02","_nodeVersion":"23.3.0","_npmVersion":"10.9.0","dist":{"integrity":"sha512-RFrgE+nHI3khW4kyRb+iBAl/AhccRy2fZ1SnoLKKFFCr+/B+7euwg9PajTtl1Q94ahehXVrnL8LIg5wUE3u/3A==","shasum":"6bed2766ded589a0ebf61b4f885aa8eeaf28baa1","tarball":"https://registry.npmjs.org/@aurracloud/hyperliquid-mcp/-/hyperliquid-mcp-1.0.2.tgz","fileCount":15,"unpackedSize":82308,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEUCIQC+jq2vwfRu8yZF3TiwOUpECOevxyEAK+2EKBJwSY21nQIgF7euNkvjQwiRXE31WNQurXDcWeXucure/F5VrJbrx5s="}]},"_npmUser":{"name":"yahya_aurracloud","email":"yahya@aurracloud.com"},"directories":{},"maintainers":[{"name":"yahya_aurracloud","email":"yahya@aurracloud.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/hyperliquid-mcp_1.0.2_1749374871362_0.5726260278109943"},"_hasShrinkwrap":false}},"time":{"created":"2025-06-04T14:58:53.585Z","modified":"2025-06-08T09:27:51.802Z","1.0.0":"2025-06-04T14:58:53.910Z","1.0.1":"2025-06-04T15:15:10.937Z","1.0.2":"2025-06-08T09:27:51.582Z"},"bugs":{"url":"https://github.com/aurracloud/hyperliquid-mcp/issues"},"author":{"name":"Aura"},"license":"MIT","homepage":"https://github.com/aurracloud/hyperliquid-mcp#readme","keywords":["mcp","model-context-protocol","hyperliquid","defi","perpetuals","trading","blockchain","web3","api","tools","claude","ai"],"repository":{"type":"git","url":"git+https://github.com/aurracloud/hyperliquid-mcp.git"},"description":"Model Context Protocol (MCP) server for Hyperliquid API integration. Provides tools for querying Hyperliquid data including balances, positions, trades, vaults, and real-time market data.","maintainers":[{"name":"yahya_aurracloud","email":"yahya@aurracloud.com"}],"readme":"# Hyperliquid MCP Server\n\nA Model Context Protocol (MCP) server for Hyperliquid API integration. This server provides tools for querying Hyperliquid perpetual trading data including positions, trades, vaults, funding rates, and real-time market information.\n\n## Features\n\n### Trader & Position Tools\n- **Get Trader Positions**: Retrieve all positions for a specific trader\n- **Get Position for Market**: Get a trader's position for a specific market/coin\n- **Get Open Orders**: Retrieve open orders for a trader\n- **Get User Fills**: Get trading history (fills) for a user\n\n### Market Data Tools\n- **Get Markets**: List all available markets/assets on Hyperliquid\n- **Get Market Price**: Get current price for a specific market\n- **Get Meta Information**: Retrieve meta information about the exchange\n- **Get All Mid Prices**: Get all current mid prices\n\n### Funding Rate Tools\n- **Get Funding Rates**: Retrieve funding rates for all markets\n- **Get Predicted Fundings**: Get predicted funding rates\n- **Get Market Funding Rate**: Get funding rate for a specific market\n- **Get Next Funding Time**: Get next funding time for a specific market\n\n### Vault Tools\n- **Get Vault Details**: Get detailed information about a specific vault\n- **Get User Vault Equities**: Get a user's vault equities/deposits\n- **Get User Sub Accounts**: Get user's subaccounts\n- **Calculate Vault Metrics**: Calculate performance metrics for a vault\n- **Get Vault Portfolio Data**: Get portfolio performance data for a vault\n- **Validate Vault Address**: Check if an address is a valid vault address\n- **Get Vault Strategies**: Get vault strategies (child addresses) for a vault\n\n## Installation\n\n\n\n```bash\n# with mcp-cli installed\nmcp install -g @aurracloud/hyperliquid-mcp\n\n# direct install\nnpx -y @aurracloud/mcp-cli install @aurracloud/hyperliquid-mcp -c cursor\n```\n\n## Usage\n\n### With Claude Desktop\n\nAdd to your Claude Desktop configuration:\n\n```json\n{\n  \"mcpServers\": {\n    \"hyperliquid\": {\n      \"command\": \"npx\",\n      \"args\": [\"-y\", \"@aurracloud/hyperliquid-mcp\"],\n      \"env\": {\n        \"HYPERLIQUID_TESTNET\": \"false\"\n      }\n    }\n  }\n}\n```\n\n### Environment Variables\n\n- `HYPERLIQUID_TESTNET`: Set to `\"true\"` to use Hyperliquid testnet instead of mainnet (optional, default: `false`)\n- `DEBUG`: Set to `\"true\"` to enable debug logging (optional, default: `false`)\n\n## Available Tools\n\n### Trader Position Tools\n\n#### HYPERLIQUID_getTraderPositions\nGet all positions for a specific trader on Hyperliquid.\n\n**Parameters:**\n- `userAddress` (string): The trader's wallet address (0x format)\n\n#### HYPERLIQUID_getTraderPositionForMarket\nGet a trader's position for a specific market/coin on Hyperliquid.\n\n**Parameters:**\n- `userAddress` (string): The trader's wallet address (0x format)\n- `coin` (string): The market/coin symbol (e.g., 'BTC', 'ETH')\n\n#### HYPERLIQUID_getOpenOrders\nGet open orders for a trader on Hyperliquid.\n\n**Parameters:**\n- `userAddress` (string): The trader's wallet address (0x format)\n\n#### HYPERLIQUID_getUserFills\nGet trading history (fills) for a user on Hyperliquid.\n\n**Parameters:**\n- `userAddress` (string): The trader's wallet address (0x format)\n\n### Market Data Tools\n\n#### HYPERLIQUID_getMarkets\nGet all available markets/assets on Hyperliquid.\n\n**Parameters:** None\n\n#### HYPERLIQUID_getMarketPrice\nGet current price for a specific market on Hyperliquid.\n\n**Parameters:**\n- `coin` (string): The market/coin symbol (e.g., 'BTC', 'ETH')\n\n#### HYPERLIQUID_getMeta\nGet meta information about the Hyperliquid exchange.\n\n**Parameters:** None\n\n#### HYPERLIQUID_getAllMids\nGet all current mid prices on Hyperliquid.\n\n**Parameters:** None\n\n### Funding Rate Tools\n\n#### HYPERLIQUID_getFundingRates\nGet funding rates for all markets on Hyperliquid.\n\n**Parameters:** None\n\n#### HYPERLIQUID_getPredictedFundings\nGet predicted funding rates for all markets on Hyperliquid.\n\n**Parameters:** None\n\n#### HYPERLIQUID_getMarketFundingRate\nGet funding rate for a specific market on Hyperliquid.\n\n**Parameters:**\n- `coin` (string): The market/coin symbol (e.g., 'BTC', 'ETH')\n\n#### HYPERLIQUID_getNextFundingTime\nGet next funding time for a specific market on Hyperliquid.\n\n**Parameters:**\n- `coin` (string): The market/coin symbol (e.g., 'BTC', 'ETH')\n\n### Vault Tools\n\n#### HYPERLIQUID_getVaultDetails\nGet detailed information about a specific vault on Hyperliquid.\n\n**Parameters:**\n- `vaultAddress` (string): The vault address (0x format)\n- `userAddress` (string, optional): Optional user address to get user-specific vault data\n\n#### HYPERLIQUID_getUserVaultEquities\nGet a user's vault equities/deposits on Hyperliquid.\n\n**Parameters:**\n- `userAddress` (string): The user's wallet address (0x format)\n\n#### HYPERLIQUID_getUserSubAccounts\nGet user's subaccounts on Hyperliquid.\n\n**Parameters:**\n- `userAddress` (string): The user's wallet address (0x format)\n\n#### HYPERLIQUID_calculateVaultMetrics\nCalculate performance metrics for a vault on Hyperliquid.\n\n**Parameters:**\n- `vaultAddress` (string): The vault address (0x format)\n\n#### HYPERLIQUID_getVaultPortfolioData\nGet portfolio performance data for a vault on Hyperliquid.\n\n**Parameters:**\n- `vaultAddress` (string): The vault address (0x format)\n\n#### HYPERLIQUID_isValidVaultAddress\nCheck if an address is a valid vault address on Hyperliquid.\n\n**Parameters:**\n- `address` (string): The address to validate as a vault address\n\n#### HYPERLIQUID_getVaultStrategies\nGet vault strategies (child addresses) for a vault on Hyperliquid.\n\n**Parameters:**\n- `vaultAddress` (string): The vault address (0x format)\n\n## Development\n\n### Building\n\n```bash\nnpm run build\n```\n\n### Running in Development\n\n```bash\nnpm run dev\n```\n\n## Examples\n\n### Get BTC Market Price\n```typescript\n// Using the HYPERLIQUID_getMarketPrice tool\n{\n  \"coin\": \"BTC\"\n}\n```\n\n### Get Trader Positions\n```typescript\n// Using the HYPERLIQUID_getTraderPositions tool\n{\n  \"userAddress\": \"0x1234567890123456789012345678901234567890\"\n}\n```\n\n### Get Vault Details\n```typescript\n// Using the HYPERLIQUID_getVaultDetails tool\n{\n  \"vaultAddress\": \"0xdfc24b077bc1425ad1dea75bcb6f8158e10df303\"\n}\n```\n\n### Get Funding Rate for ETH\n```typescript\n// Using the HYPERLIQUID_getMarketFundingRate tool\n{\n  \"coin\": \"ETH\"\n}\n```\n\n## Error Handling\n\nAll tools include comprehensive error handling and will return structured error messages if:\n- Invalid address formats are provided\n- Network requests fail\n- Invalid market symbols are used\n- Vault addresses don't exist\n\n## License\n\nMIT\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## Support\n\nFor issues and questions, please open an issue on the GitHub repository. ","readmeFilename":"README.md"}