{ "openapi": "3.0.1", "info": { "title": "Hyperliquid Whale Tracker - Top Perp Trader Positions API", "description": "Monitor top Hyperliquid perpetual traders' live positions, unrealized PnL, entry prices, and recent fills. Powered by Hyperliquid's public API.", "version": "0.1", "x-build-id": "xA7FocO7qdcTCUEax" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/gochujang~hyperliquid-whale-tracker/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-gochujang-hyperliquid-whale-tracker", "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/gochujang~hyperliquid-whale-tracker/runs": { "post": { "operationId": "runs-sync-gochujang-hyperliquid-whale-tracker", "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/gochujang~hyperliquid-whale-tracker/run-sync": { "post": { "operationId": "run-sync-gochujang-hyperliquid-whale-tracker", "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", "properties": { "traders": { "title": "Trader Addresses", "type": "array", "description": "Hyperliquid trader wallet addresses to monitor (0x... format). Empty = use the bundled seed list of known public whales.", "default": [], "items": { "type": "string" } }, "vaults": { "title": "Vault Addresses (optional)", "type": "array", "description": "Hyperliquid public vault addresses to track. Each emits a vault_summary row (name/leader/APR/followers/TVL) plus all its positions. Empty + includeSeedVaults=true uses bundled seed.", "default": [], "items": { "type": "string" } }, "includeSeedVaults": { "title": "Include Seed Vaults (HLP etc.)", "type": "boolean", "description": "When vaults list is empty, use bundled seed list of well-known public HL vaults (currently HLP).", "default": true }, "minPositionUsd": { "title": "Min Position Size (USD)", "minimum": 0, "type": "integer", "description": "Only return positions whose notional value exceeds this. 0 = include all.", "default": 10000 }, "includeRecentFills": { "title": "Include Recent Fills", "type": "boolean", "description": "Also fetch and emit each trader's recent fills (last 100). Adds detail but doubles API calls per trader.", "default": true }, "fillsLookbackHours": { "title": "Fills Lookback Hours", "minimum": 1, "maximum": 720, "type": "integer", "description": "When recent fills enabled, only return fills from the last N hours.", "default": 24 }, "sortBy": { "title": "Sort Positions By", "enum": [ "size_desc", "pnl_desc", "pnl_asc", "leverage_desc", "distance_to_liq_asc" ], "type": "string", "description": "Sort order for position rows.", "default": "size_desc" }, "alertPnlUsd": { "title": "Telegram Alert: |PnL| Threshold (USD)", "minimum": 0, "type": "integer", "description": "Alert when any tracked trader has a position with |unrealized PnL| above this. 0 = disabled.", "default": 0 }, "telegramBotToken": { "title": "Telegram Bot Token", "type": "string", "description": "Telegram bot token for alerts. Leave empty to disable." }, "telegramChatId": { "title": "Telegram Chat ID", "type": "string", "description": "Chat ID to receive alerts.", "default": "" } } }, "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 } } } } } } } } } }