# HyperSignal — Hyperliquid Whale & Risk Signals (`johnsmithjz/hypersignal-hyperliquid-signals`) Actor Pay-per-event access to HyperSignal's premium Hyperliquid analytics: whale flow alerts, funding screener, and portfolio risk. - **URL**: https://apify.com/johnsmithjz/hypersignal-hyperliquid-signals.md - **Developed by:** [John Smith](https://apify.com/johnsmithjz) (community) - **Categories:** AI, Automation, MCP servers - **Stats:** 1 total users, 0 monthly users, 0.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing Pay per usage This Actor is paid per platform usage. The Actor is free to use, and you only pay for the Apify platform usage, which gets cheaper the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-usage ## What's an Apify Actor? Actors are web data automations that power AI and operations. They run on the Apify platform to scrape websites, process data, connect APIs, and automate workflows. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## HyperSignal — Apify Actor Thin **pay-per-event** proxy to a deployed HyperSignal MCP server. It forwards a tool call to your server (with a server-side PRO key) and charges one `premium-call` event per successful result. The analytics run on your server — this Actor is just the Apify storefront/billing adapter. ### Setup (once) In the Actor's **Settings → Environment variables** on Apify, add: | Variable | Value | |---|---| | `MCP_SERVER_URL` | your server, e.g. `https://hypersmash.fly.dev/mcp` | | `MCP_API_KEY` | a PRO key on your server (kept server-side; users never see it) | Then in **Monetization**, enable pay-per-event and set the price of the `premium-call` event. ### Exposed tools (input `tool`) `hl_funding_screener`, `hl_whale_positions`, `hl_whale_flow_alerts`, `hl_smart_money_score`, `hl_portfolio_risk`, `hl_polymarket_divergence`. ### Input ```json { "tool": "hl_portfolio_risk", "arguments": { "address": "0xYOUR_ADDRESS" } } ```` ### Output Pushed to the default dataset and the `OUTPUT` key-value record: ```json { "tool": "hl_portfolio_risk", "summary": "...", "data": { /* structuredContent */ } } ``` ### Deploy ```bash apify push ``` (run from this `apify-actor/` folder) # Actor input Schema ## `tool` (type: `string`): Which premium signal to run. ## `arguments` (type: `object`): Tool arguments. E.g. {"address":"0x..."} for portfolio risk, {"coin":"BTC"} for Polymarket divergence. ## `mcpServerUrl` (type: `string`): Your deployed HyperSignal MCP endpoint (leave default unless self-hosting elsewhere). ## `mcpApiKey` (type: `string`): A PRO key on your server. Stored encrypted. (Or set MCP\_API\_KEY as an env var instead to hide it from public runs.) ## Actor input object example ```json { "tool": "hl_funding_screener", "arguments": {}, "mcpServerUrl": "https://hypersmash.fly.dev/mcp" } ``` # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = {}; // Run the Actor and wait for it to finish const run = await client.actor("johnsmithjz/hypersignal-hyperliquid-signals").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = {} # Run the Actor and wait for it to finish run = client.actor("johnsmithjz/hypersignal-hyperliquid-signals").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{}' | apify call johnsmithjz/hypersignal-hyperliquid-signals --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=johnsmithjz/hypersignal-hyperliquid-signals", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "HyperSignal — Hyperliquid Whale & Risk Signals", "description": "Pay-per-event access to HyperSignal's premium Hyperliquid analytics: whale flow alerts, funding screener, and portfolio risk.", "version": "0.1", "x-build-id": "48DIwSBHqR6Ml7xW5" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/johnsmithjz~hypersignal-hyperliquid-signals/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-johnsmithjz-hypersignal-hyperliquid-signals", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/johnsmithjz~hypersignal-hyperliquid-signals/runs": { "post": { "operationId": "runs-sync-johnsmithjz-hypersignal-hyperliquid-signals", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/johnsmithjz~hypersignal-hyperliquid-signals/run-sync": { "post": { "operationId": "run-sync-johnsmithjz-hypersignal-hyperliquid-signals", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "tool" ], "properties": { "tool": { "title": "Tool", "enum": [ "hl_funding_screener", "hl_whale_positions", "hl_whale_flow_alerts", "hl_smart_money_score", "hl_portfolio_risk", "hl_polymarket_divergence" ], "type": "string", "description": "Which premium signal to run.", "default": "hl_funding_screener" }, "arguments": { "title": "Arguments", "type": "object", "description": "Tool arguments. E.g. {\"address\":\"0x...\"} for portfolio risk, {\"coin\":\"BTC\"} for Polymarket divergence.", "default": {} }, "mcpServerUrl": { "title": "MCP server URL", "type": "string", "description": "Your deployed HyperSignal MCP endpoint (leave default unless self-hosting elsewhere).", "default": "https://hypersmash.fly.dev/mcp" }, "mcpApiKey": { "title": "MCP API key (PRO)", "type": "string", "description": "A PRO key on your server. Stored encrypted. (Or set MCP_API_KEY as an env var instead to hide it from public runs.)" } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```