{ "openapi": "3.0.3", "info": { "title": "Implyra Developer API", "description": "Trader intelligence, positions, markets and events. Customer keys authenticate to the Implyra gateway. Self-service access is being connected; disabled deployments return 503. Response schemas are generated from the data service; operations without a response schema require runtime validation. See /docs/developer-accounts for credit costs and plan limits.", "version": "2.0.0" }, "components": { "schemas": { "MarketFilterGroup": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ] }, "conditions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price" ] }, "operator": { "type": "string", "enum": [ "gt", "gte", "lt", "lte", "eq", "neq" ] }, "value": { "type": "number" }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric", "operator", "value" ] }, { "$ref": "#/components/schemas/MarketFilterGroup" } ] } } }, "required": [ "operator", "conditions" ] }, "EventFilterGroup": { "type": "object", "properties": { "operator": { "type": "string", "enum": [ "AND", "OR" ] }, "conditions": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "market_count", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price_movement" ] }, "operator": { "type": "string", "enum": [ "gt", "gte", "lt", "lte", "eq", "neq" ] }, "value": { "type": "number" }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric", "operator", "value" ] }, { "$ref": "#/components/schemas/EventFilterGroup" } ] } } }, "required": [ "operator", "conditions" ] }, "FundingTraceNode": { "type": "object", "properties": { "address": { "type": "string" }, "label": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "additionalProperties": false }, "depth": { "type": "number" }, "total_amount": { "type": "string" }, "tx_count": { "type": "number" }, "funding_sources": { "type": "array", "items": { "$ref": "#/components/schemas/FundingTraceNode" } } }, "required": [ "address", "depth" ], "additionalProperties": false } }, "securitySchemes": { "ImplyraApiKey": { "type": "http", "scheme": "bearer", "bearerFormat": "imp_ API key", "description": "A scoped customer key issued from the developer console. Keep it on your server." } } }, "paths": { "/users/{address}": { "get": { "summary": "Get comprehensive user details including balance, PNL, and profile", "tags": [ "Users" ], "parameters": [ { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "profile": { "nullable": true, "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "pseudonym": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "profileImage": { "nullable": true, "type": "string" }, "xUsername": { "nullable": true, "type": "string" }, "verifiedBadge": { "type": "boolean" }, "createdAt": { "nullable": true, "type": "string" } }, "required": [ "name", "pseudonym", "displayName", "profileImage", "xUsername", "verifiedBadge", "createdAt" ], "additionalProperties": {} }, "portfolioValueUsd": { "type": "number" }, "availableBalanceUsd": { "nullable": true, "type": "number" }, "unrealizedPnlUsd": { "type": "number" }, "totalRealizedPnlUsd": { "type": "number" }, "totalGainsUsd": { "type": "number" }, "totalLossesUsd": { "type": "number" }, "winRatePct": { "type": "number" }, "totalClosedPositions": { "type": "number" }, "totalActivePositions": { "type": "number" }, "isPortfolioWhale": { "type": "boolean" }, "isSmartMoney": { "type": "boolean" }, "isInsider": { "type": "boolean" }, "proxyWallet": { "nullable": true, "type": "string" } }, "required": [ "address", "profile", "portfolioValueUsd", "availableBalanceUsd", "unrealizedPnlUsd", "totalRealizedPnlUsd", "totalGainsUsd", "totalLossesUsd", "winRatePct", "totalClosedPositions", "totalActivePositions", "isPortfolioWhale", "isSmartMoney", "isInsider", "proxyWallet" ], "additionalProperties": {} } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/users/{address}/positions": { "get": { "summary": "Get aggregated positions for a trader", "tags": [ "Users" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "positions": { "type": "array", "items": { "type": "object", "properties": { "tokenId": { "type": "string" }, "eventTitle": { "type": "string" }, "marketQuestion": { "type": "string" }, "outcomeTitle": { "type": "string" }, "iconUrl": { "nullable": true, "type": "string" }, "currentPrice": { "nullable": true, "type": "number" } }, "required": [ "tokenId", "eventTitle", "marketQuestion", "outcomeTitle", "iconUrl", "currentPrice" ], "additionalProperties": {} } }, "pagination": { "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "nextOffset": { "nullable": true, "type": "number" } }, "required": [ "limit", "offset", "nextOffset" ], "additionalProperties": false } }, "required": [ "address", "positions", "pagination" ], "additionalProperties": {} } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/users/{address}/closed-positions": { "get": { "summary": "Get closed (settled) positions for a trader", "tags": [ "Users" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "positions": { "type": "array", "items": { "type": "object", "properties": { "tokenId": { "type": "string" }, "eventTitle": { "type": "string" }, "marketQuestion": { "type": "string" }, "outcomeTitle": { "type": "string" }, "iconUrl": { "nullable": true, "type": "string" }, "currentPrice": { "nullable": true, "type": "number" } }, "required": [ "tokenId", "eventTitle", "marketQuestion", "outcomeTitle", "iconUrl", "currentPrice" ], "additionalProperties": {} } }, "pagination": { "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "nextOffset": { "nullable": true, "type": "number" } }, "required": [ "limit", "offset", "nextOffset" ], "additionalProperties": false } }, "required": [ "address", "positions", "pagination" ], "additionalProperties": {} } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/users/{address}/trades": { "get": { "summary": "Get executed trades for a trader from Polymarket activity", "tags": [ "Users" ], "description": "Returns recent trades sourced from the Polymarket Data API activity feed.", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "trades": { "type": "array", "items": { "type": "object", "properties": { "txHash": { "nullable": true, "type": "string" }, "tradeDttm": { "type": "string" }, "tokenId": { "type": "string" }, "marketId": { "nullable": true, "type": "string" }, "side": { "nullable": true, "type": "string" }, "amount": { "type": "number" }, "price": { "nullable": true, "type": "number" }, "eventTitle": { "type": "string" }, "marketQuestion": { "type": "string" }, "outcomeTitle": { "type": "string" }, "iconUrl": { "nullable": true, "type": "string" } }, "required": [ "txHash", "tradeDttm", "tokenId", "marketId", "side", "amount", "price", "eventTitle", "marketQuestion", "outcomeTitle", "iconUrl" ], "additionalProperties": {} } }, "pagination": { "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "nextOffset": { "nullable": true, "type": "number" } }, "required": [ "limit", "offset", "nextOffset" ], "additionalProperties": false } }, "required": [ "address", "trades", "pagination" ], "additionalProperties": {} } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/users/{address}/pnl-history": { "get": { "summary": "Get historic account PnL time series", "tags": [ "Users" ], "description": "Returns cumulative profit-and-loss data points over time for a user. Proxied from Polymarket PnL API.", "parameters": [ { "schema": { "default": "all", "type": "string", "enum": [ "1d", "1w", "1m", "all" ] }, "in": "query", "name": "interval", "required": false }, { "schema": { "default": "1d", "type": "string", "enum": [ "1h", "3h", "12h", "18h", "1d" ] }, "in": "query", "name": "fidelity", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "interval": { "type": "string" }, "fidelity": { "type": "string" }, "history": { "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "number" }, "pnl": { "type": "number" } }, "required": [ "timestamp", "pnl" ], "additionalProperties": {} } } }, "required": [ "address", "interval", "fidelity", "history" ], "additionalProperties": {} } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/users/{address}/category-performance": { "get": { "summary": "Get per-category performance breakdown for a trader", "tags": [ "Users" ], "description": "Returns P&L, volume, position count, and win rate broken down by market category (tag). Data from wallet_tag_stats.", "parameters": [ { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "pnl": { "type": "number" }, "volume": { "type": "number" }, "positionCount": { "type": "number" }, "winRate": { "type": "number" } }, "required": [ "tag", "pnl", "volume", "positionCount", "winRate" ], "additionalProperties": false } }, "updatedAt": { "nullable": true, "type": "string" } }, "required": [ "address", "categories", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/markets/recently-started": { "get": { "summary": "Get recently started markets", "tags": [ "Markets" ], "description": "Returns active markets sorted by creation date (newest first).", "parameters": [ { "schema": { "default": 10, "type": "integer", "minimum": 1, "maximum": 50 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/markets/ending-soon": { "get": { "summary": "Get markets ending soon", "tags": [ "Markets" ], "description": "Returns active markets sorted by end date (soonest first).", "parameters": [ { "schema": { "default": 10, "type": "integer", "minimum": 1, "maximum": 50 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/markets/{slug}/holders": { "get": { "summary": "Get paginated holders for a market", "tags": [ "Markets" ], "description": "Returns holder positions with classification (whale, smart money, insider), optional profile enrichment, and cursor-based pagination.", "parameters": [ { "schema": { "type": "string", "pattern": "^\\d+$" }, "in": "query", "name": "limit", "required": false, "description": "The gateway accepts a numeric value up to 1000." }, { "schema": { "type": "string", "pattern": "^\\d+$" }, "in": "query", "name": "offset", "required": false, "description": "The gateway accepts a numeric value up to 10000." }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "string", "enum": [ "size" ] }, "in": "query", "name": "sortBy", "required": false, "description": "Holder ordering. Only size is currently supported." }, { "schema": { "type": "string", "enum": [ "desc" ] }, "in": "query", "name": "sortDirection", "required": false, "description": "Holder ordering direction. Only descending is currently supported." }, { "schema": { "type": "string" }, "in": "query", "name": "includeProfiles", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "isPortfolioWhale": { "type": "boolean" }, "isSmartMoney": { "type": "boolean" }, "isInsider": { "type": "boolean" }, "winRatePct": { "nullable": true, "type": "number" }, "totalRealizedPnlUsd": { "nullable": true, "type": "number" }, "closedPositions": { "nullable": true, "type": "number" }, "portfolioValueUsd": { "nullable": true, "type": "number" }, "ageHours": { "nullable": true, "type": "number" }, "address": { "type": "string" }, "profile": { "nullable": true, "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "pseudonym": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "profileImage": { "nullable": true, "type": "string" }, "xUsername": { "nullable": true, "type": "string" }, "verifiedBadge": { "type": "boolean" }, "createdAt": { "nullable": true, "type": "string" } }, "required": [ "name", "pseudonym", "displayName", "profileImage", "xUsername", "verifiedBadge", "createdAt" ], "additionalProperties": {} }, "remainingShares": { "type": "number" }, "boughtShares": { "nullable": true, "type": "number" }, "soldShares": { "nullable": true, "type": "number" }, "avgEntryPriceUsd": { "nullable": true, "type": "number" }, "realizedPnlUsd": { "nullable": true, "type": "number" }, "tokenId": { "nullable": true, "type": "string" }, "priceUsd": { "nullable": true, "type": "number" }, "unrealizedPnlUsd": { "nullable": true, "type": "number" }, "remainingValueUsd": { "nullable": true, "type": "number" }, "marketsTradedCount": { "nullable": true, "type": "number" } }, "required": [ "isPortfolioWhale", "isSmartMoney", "isInsider", "winRatePct", "totalRealizedPnlUsd", "closedPositions", "portfolioValueUsd", "ageHours", "address", "profile", "remainingShares", "boughtShares", "soldShares", "avgEntryPriceUsd", "realizedPnlUsd", "tokenId", "priceUsd", "unrealizedPnlUsd", "remainingValueUsd" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "marketId": { "type": "string" }, "slug": { "type": "string" }, "count": { "type": "number" }, "limit": { "type": "number" }, "hasMore": { "type": "boolean" }, "nextCursor": { "nullable": true, "type": "string" }, "eventTitle": { "nullable": true, "type": "string" }, "marketQuestion": { "nullable": true, "type": "string" }, "iconUrl": { "nullable": true, "type": "string" } }, "required": [ "marketId", "slug", "count", "limit", "hasMore", "nextCursor", "eventTitle", "marketQuestion", "iconUrl" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/markets/{slug}/whales": { "get": { "summary": "Get portfolio whales for a market", "tags": [ "Markets" ], "description": "Returns participants classified as portfolio whales (large portfolio value) for the given market.", "parameters": [ { "schema": { "type": "string", "pattern": "^\\d+$" }, "in": "query", "name": "lookbackHours", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "isPortfolioWhale": { "type": "boolean" }, "isSmartMoney": { "type": "boolean" }, "isInsider": { "type": "boolean" }, "winRatePct": { "nullable": true, "type": "number" }, "totalRealizedPnlUsd": { "nullable": true, "type": "number" }, "closedPositions": { "nullable": true, "type": "number" }, "portfolioValueUsd": { "nullable": true, "type": "number" }, "ageHours": { "nullable": true, "type": "number" }, "address": { "type": "string" }, "profile": { "nullable": true, "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "pseudonym": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "profileImage": { "nullable": true, "type": "string" }, "xUsername": { "nullable": true, "type": "string" }, "verifiedBadge": { "type": "boolean" }, "createdAt": { "nullable": true, "type": "string" } }, "required": [ "name", "pseudonym", "displayName", "profileImage", "xUsername", "verifiedBadge", "createdAt" ], "additionalProperties": {} }, "shares": { "type": "number" }, "positionValueUsd": { "nullable": true, "type": "number" }, "walletAgeHours": { "nullable": true, "type": "number" } }, "required": [ "isPortfolioWhale", "isSmartMoney", "isInsider", "winRatePct", "totalRealizedPnlUsd", "closedPositions", "portfolioValueUsd", "ageHours", "address", "profile", "shares", "positionValueUsd", "walletAgeHours" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "marketId": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "marketId", "slug" ], "additionalProperties": {} } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/markets/{slug}/insiders": { "get": { "summary": "Get insider-flagged participants for a market", "tags": [ "Markets" ], "description": "Returns participants classified as insiders (new accounts with large early positions).", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "isPortfolioWhale": { "type": "boolean" }, "isSmartMoney": { "type": "boolean" }, "isInsider": { "type": "boolean" }, "winRatePct": { "nullable": true, "type": "number" }, "totalRealizedPnlUsd": { "nullable": true, "type": "number" }, "closedPositions": { "nullable": true, "type": "number" }, "portfolioValueUsd": { "nullable": true, "type": "number" }, "ageHours": { "nullable": true, "type": "number" }, "address": { "type": "string" }, "profile": { "nullable": true, "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "pseudonym": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "profileImage": { "nullable": true, "type": "string" }, "xUsername": { "nullable": true, "type": "string" }, "verifiedBadge": { "type": "boolean" }, "createdAt": { "nullable": true, "type": "string" } }, "required": [ "name", "pseudonym", "displayName", "profileImage", "xUsername", "verifiedBadge", "createdAt" ], "additionalProperties": {} }, "shares": { "type": "number" }, "positionValueUsd": { "nullable": true, "type": "number" }, "walletAgeHours": { "nullable": true, "type": "number" } }, "required": [ "isPortfolioWhale", "isSmartMoney", "isInsider", "winRatePct", "totalRealizedPnlUsd", "closedPositions", "portfolioValueUsd", "ageHours", "address", "profile", "shares", "positionValueUsd", "walletAgeHours" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "marketId": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "marketId", "slug" ], "additionalProperties": {} } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/markets/{slug}/smartmoney": { "get": { "summary": "Get smart money participants for a market", "tags": [ "Markets" ], "description": "Returns participants classified as smart money (high win rate, high PnL, many closed positions).", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "isPortfolioWhale": { "type": "boolean" }, "isSmartMoney": { "type": "boolean" }, "isInsider": { "type": "boolean" }, "winRatePct": { "nullable": true, "type": "number" }, "totalRealizedPnlUsd": { "nullable": true, "type": "number" }, "closedPositions": { "nullable": true, "type": "number" }, "portfolioValueUsd": { "nullable": true, "type": "number" }, "ageHours": { "nullable": true, "type": "number" }, "address": { "type": "string" }, "profile": { "nullable": true, "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "pseudonym": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "profileImage": { "nullable": true, "type": "string" }, "xUsername": { "nullable": true, "type": "string" }, "verifiedBadge": { "type": "boolean" }, "createdAt": { "nullable": true, "type": "string" } }, "required": [ "name", "pseudonym", "displayName", "profileImage", "xUsername", "verifiedBadge", "createdAt" ], "additionalProperties": {} }, "shares": { "type": "number" }, "positionValueUsd": { "nullable": true, "type": "number" }, "walletAgeHours": { "nullable": true, "type": "number" } }, "required": [ "isPortfolioWhale", "isSmartMoney", "isInsider", "winRatePct", "totalRealizedPnlUsd", "closedPositions", "portfolioValueUsd", "ageHours", "address", "profile", "shares", "positionValueUsd", "walletAgeHours" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "marketId": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "marketId", "slug" ], "additionalProperties": {} } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/markets/{slug}/analytics": { "get": { "summary": "Get market analytics aggregate", "tags": [ "Markets" ], "description": "Returns aggregated analytics including exact holder counts when certified, PnL breakdown, and nullable trader type distribution.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "holders": { "type": "object", "properties": { "yes_holders": { "nullable": true, "type": "number" }, "no_holders": { "nullable": true, "type": "number" }, "total_holders": { "nullable": true, "type": "number" } }, "required": [ "yes_holders", "no_holders", "total_holders" ], "additionalProperties": false }, "pnl": { "type": "object", "properties": { "yes_holders_total_pnl": { "type": "number" }, "no_holders_total_pnl": { "type": "number" }, "total_pnl": { "type": "number" } }, "required": [ "yes_holders_total_pnl", "no_holders_total_pnl", "total_pnl" ], "additionalProperties": false }, "trader_types": { "type": "object", "properties": { "yes": { "type": "object", "properties": { "insider_holders": { "nullable": true, "type": "number" }, "smart_money_holders": { "nullable": true, "type": "number" }, "whale_holders": { "nullable": true, "type": "number" } }, "required": [ "insider_holders", "smart_money_holders", "whale_holders" ], "additionalProperties": false }, "no": { "type": "object", "properties": { "insider_holders": { "nullable": true, "type": "number" }, "smart_money_holders": { "nullable": true, "type": "number" }, "whale_holders": { "nullable": true, "type": "number" } }, "required": [ "insider_holders", "smart_money_holders", "whale_holders" ], "additionalProperties": false } }, "required": [ "yes", "no" ], "additionalProperties": false }, "meta": { "type": "object", "properties": { "marketId": { "type": "string" }, "slug": { "type": "string" } }, "required": [ "marketId", "slug" ], "additionalProperties": false } }, "required": [ "holders", "pnl", "trader_types", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/markets/{slug}/trades": { "get": { "summary": "Get recent trades for a market", "tags": [ "Markets" ], "description": "Returns paginated trades with trader classification enrichment and optional profile data.", "parameters": [ { "schema": { "type": "string", "pattern": "^\\d+$" }, "in": "query", "name": "limit", "required": false, "description": "Maximum trades to return (1-100, default 25) The gateway accepts a numeric value up to 1000." }, { "schema": { "type": "string", "pattern": "^\\d+$" }, "in": "query", "name": "offset", "required": false, "description": "Offset for pagination The gateway accepts a numeric value up to 10000." }, { "schema": { "type": "string" }, "in": "query", "name": "includeProfiles", "required": false, "description": "Include Polymarket profile data" }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "isPortfolioWhale": { "type": "boolean" }, "isSmartMoney": { "type": "boolean" }, "isInsider": { "type": "boolean" }, "winRatePct": { "nullable": true, "type": "number" }, "totalRealizedPnlUsd": { "nullable": true, "type": "number" }, "closedPositions": { "nullable": true, "type": "number" }, "portfolioValueUsd": { "nullable": true, "type": "number" }, "ageHours": { "nullable": true, "type": "number" }, "id": { "type": "string" }, "address": { "type": "string" }, "profile": { "nullable": true, "type": "object", "properties": { "name": { "nullable": true, "type": "string" }, "pseudonym": { "nullable": true, "type": "string" }, "displayName": { "nullable": true, "type": "string" }, "profileImage": { "nullable": true, "type": "string" }, "xUsername": { "nullable": true, "type": "string" }, "verifiedBadge": { "type": "boolean" }, "createdAt": { "nullable": true, "type": "string" } }, "required": [ "name", "pseudonym", "displayName", "profileImage", "xUsername", "verifiedBadge", "createdAt" ], "additionalProperties": {} }, "priceUsd": { "type": "number" }, "shares": { "type": "number" }, "valueUsd": { "type": "number" }, "timestamp": { "type": "string" }, "conditionId": { "type": "string" }, "marketSlug": { "nullable": true, "type": "string" }, "eventTitle": { "nullable": true, "type": "string" }, "marketQuestion": { "nullable": true, "type": "string" }, "outcomeTitle": { "nullable": true, "type": "string" }, "iconUrl": { "nullable": true, "type": "string" } }, "required": [ "isPortfolioWhale", "isSmartMoney", "isInsider", "winRatePct", "totalRealizedPnlUsd", "closedPositions", "portfolioValueUsd", "ageHours", "id", "address", "profile", "priceUsd", "shares", "valueUsd", "timestamp", "conditionId", "marketSlug", "eventTitle", "marketQuestion", "outcomeTitle", "iconUrl" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "marketId": { "type": "string" }, "slug": { "nullable": true, "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" }, "hasMore": { "type": "boolean" } }, "required": [ "marketId", "slug", "limit", "offset", "hasMore" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/markets/discover": { "post": { "summary": "Discover markets with filters, deltas, and cursor pagination", "tags": [ "Markets" ], "description": "Query the pre-computed discovery serving table with metric filters, delta calculations, tag filters, and cursor-based pagination. Use explain=true in non-production for SQL debugging.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "string", "enum": [ "volume", "liquidity", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price" ] } }, "deltas": { "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "since": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric", "compare" ] } }, "filters": { "$ref": "#/components/schemas/MarketFilterGroup" }, "sort": { "anyOf": [ { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price", "end_date", "created_at" ] }, "direction": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric" ] }, { "type": "object", "properties": { "primary": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price", "end_date", "created_at" ] }, "direction": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric" ] }, "fallback": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price", "end_date", "created_at" ] }, "direction": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric" ] } }, "required": [ "primary" ] } ] }, "pagination": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "default": 20, "type": "number", "minimum": 1, "maximum": 100 } } }, "options": { "type": "object", "properties": { "minVolume": { "default": 0, "type": "number", "minimum": 0 }, "search": { "type": "string", "maxLength": 200 }, "createdAfter": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endingBefore": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "endingAfter": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" } } }, "require": { "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "holders_total" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric", "window", "compare" ] } }, "min_age_seconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nulls": { "type": "string", "enum": [ "exclude", "last", "zero" ] }, "as_of": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "tags_any": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 200 } }, "tags_all": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 200 } }, "tags_none": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 200 } }, "price_min": { "type": "number", "minimum": 0, "maximum": 1 }, "price_max": { "type": "number", "minimum": 0, "maximum": 1 }, "end_date_min": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end_date_max": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "created_at_min": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "created_at_max": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "stages": { "minItems": 1, "maxItems": 5, "type": "array", "items": { "type": "string", "enum": [ "new", "building", "peak", "settling", "resolving" ] } }, "search": { "type": "string", "maxLength": 200 }, "explain": { "default": false, "type": "boolean" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "markets": { "type": "array", "items": { "type": "object", "properties": { "market_id": { "type": "string" }, "condition_id": { "type": "string" }, "slug": { "type": "string" }, "question": { "type": "string" }, "category": { "type": "string" }, "active": { "type": "boolean" }, "closed": { "type": "boolean" }, "end_date": { "nullable": true, "type": "string" }, "created_at": { "nullable": true, "type": "string" }, "price": { "type": "number" }, "age_seconds": { "type": "number" }, "available_windows": { "type": "array", "items": { "type": "string" } }, "stage": { "type": "string", "enum": [ "new", "building", "peak", "settling", "resolving" ] }, "metrics": { "type": "object", "properties": { "volume": { "type": "number" }, "liquidity": { "type": "number" }, "price": { "type": "number" }, "holders_total": { "type": "number" }, "holders_yes": { "type": "number" }, "holders_no": { "type": "number" }, "holders_whale": { "type": "number" }, "holders_smart_money": { "type": "number" }, "holders_insider": { "type": "number" } }, "additionalProperties": false }, "deltas": { "type": "object", "additionalProperties": { "type": "object", "properties": { "abs": { "nullable": true, "type": "number" }, "pct": { "nullable": true, "type": "number" }, "status": { "type": "string", "enum": [ "ok", "too_new", "missing_history", "div0" ] } }, "required": [ "status" ], "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "string" } }, "outcomePrices": { "type": "array", "items": { "type": "string" } }, "clobTokenIds": { "type": "array", "items": { "type": "string" } }, "event_id": { "type": "string" } }, "required": [ "market_id", "condition_id", "slug", "question", "category", "active", "closed", "age_seconds", "available_windows", "stage", "metrics", "deltas" ], "additionalProperties": {} } }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "type": "string" } }, "required": [ "has_more" ], "additionalProperties": false }, "explain": { "type": "object", "properties": { "phase1_sql": { "type": "string" }, "phase2_sql": { "type": "string" } }, "additionalProperties": false } }, "required": [ "markets", "pagination" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "markets:read" } }, "/markets/{slug}/volume-profile": { "get": { "summary": "Get volume profile for a market", "tags": [ "Markets" ], "description": "Returns hourly volume buckets showing when trading activity occurred throughout market lifetime.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "hour": { "type": "string" }, "volumeUsd": { "type": "number" }, "tradeCount": { "type": "number" }, "buyVolumeUsd": { "type": "number" }, "sellVolumeUsd": { "type": "number" }, "uniqueTraders": { "type": "number" } }, "required": [ "hour", "volumeUsd", "tradeCount", "buyVolumeUsd", "sellVolumeUsd", "uniqueTraders" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "conditionId": { "type": "string" }, "slug": { "type": "string" }, "totalVolumeUsd": { "type": "number" }, "totalTrades": { "type": "number" }, "firstTradeAt": { "nullable": true, "type": "string" }, "lastTradeAt": { "nullable": true, "type": "string" } }, "required": [ "conditionId", "slug", "totalVolumeUsd", "totalTrades", "firstTradeAt", "lastTradeAt" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/markets/{slug}/entry-timing": { "get": { "summary": "Get entry timing analysis for a market", "tags": [ "Markets" ], "description": "Returns volume over time with cumulative totals, showing optimal entry windows.", "parameters": [ { "schema": { "default": "hourly", "type": "string", "enum": [ "hourly", "daily" ] }, "in": "query", "name": "granularity", "required": false }, { "schema": { "default": 90, "type": "integer", "minimum": 1, "maximum": 365 }, "in": "query", "name": "days", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "volumeUsd": { "type": "number" }, "tradeCount": { "type": "number" }, "cumulativeVolumeUsd": { "type": "number" } }, "required": [ "bucket", "volumeUsd", "tradeCount", "cumulativeVolumeUsd" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "conditionId": { "type": "string" }, "slug": { "type": "string" }, "granularity": { "type": "string", "enum": [ "hourly", "daily" ] }, "totalVolumeUsd": { "type": "number" } }, "required": [ "conditionId", "slug", "granularity", "totalVolumeUsd" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/markets/{slug}/top-traders": { "get": { "summary": "Get top traders for a market", "tags": [ "Markets" ], "description": "Returns per-market trader leaderboard ranked by volume, with buy/sell direction.", "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "trader": { "type": "string" }, "volumeUsd": { "type": "number" }, "buyVolumeUsd": { "type": "number" }, "sellVolumeUsd": { "type": "number" }, "tradeCount": { "type": "number" }, "firstTradeAt": { "type": "string" }, "lastTradeAt": { "type": "string" }, "netDirection": { "type": "string", "enum": [ "buyer", "seller", "neutral" ] } }, "required": [ "trader", "volumeUsd", "buyVolumeUsd", "sellVolumeUsd", "tradeCount", "firstTradeAt", "lastTradeAt", "netDirection" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "conditionId": { "type": "string" }, "slug": { "type": "string" }, "limit": { "type": "number" }, "offset": { "type": "number" }, "hasMore": { "type": "boolean" } }, "required": [ "conditionId", "slug", "limit", "offset", "hasMore" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/events/trending-tags": { "get": { "summary": "Get trending tags ranked by volume activity", "tags": [ "Events" ], "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 50 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": "24h", "type": "string", "enum": [ "5m", "1h", "24h" ] }, "in": "query", "name": "window", "required": false }, { "schema": { "default": 0, "type": "number", "minimum": 0 }, "in": "query", "name": "min_volume", "required": false }, { "schema": { "default": 1, "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "query", "name": "min_events", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "tag": { "type": "string" }, "total_volume": { "type": "number" }, "volume_change_abs": { "nullable": true, "type": "number" }, "volume_change_pct": { "nullable": true, "type": "number" }, "event_count": { "type": "number" }, "total_liquidity": { "type": "number" } }, "required": [ "tag", "total_volume", "volume_change_abs", "volume_change_pct", "event_count", "total_liquidity" ], "additionalProperties": false } }, "window": { "type": "string" }, "cached_at": { "nullable": true, "type": "string" } }, "required": [ "tags", "window", "cached_at" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/events/discover": { "post": { "summary": "Discover events with filters, deltas, and cursor pagination", "tags": [ "Events" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "metrics": { "type": "array", "items": { "type": "string", "enum": [ "volume", "liquidity", "market_count", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price_movement" ] } }, "deltas": { "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "market_count", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price_movement" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "since": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric", "compare" ] } }, "filters": { "$ref": "#/components/schemas/EventFilterGroup" }, "sort": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "market_count", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price_movement", "end_date", "creation_date" ] }, "direction": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric" ] }, "pagination": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "default": 20, "type": "number", "minimum": 1, "maximum": 100 } } }, "options": { "type": "object", "properties": { "minVolume": { "default": 0, "type": "number", "minimum": 0 } } }, "require": { "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "liquidity", "market_count", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "holders_insider", "price_movement" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric", "window", "compare" ] } }, "min_age_seconds": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "nulls": { "type": "string", "enum": [ "exclude", "last", "zero" ] }, "as_of": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "tags_any": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 200 } }, "tags_all": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 200 } }, "tags_none": { "maxItems": 50, "type": "array", "items": { "type": "string", "maxLength": 200 } }, "end_date_min": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "end_date_max": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "created_at_min": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "created_at_max": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "search": { "type": "string", "maxLength": 200 }, "include_markets": { "default": "top", "description": "Controls which markets are included in each event. \"all\": every market (explicit legacy/full-payload mode). \"real\": only markets with real activity — keeps markets where active=true OR volume > 0 OR liquidity > 0, strips zero-volume zero-liquidity placeholder markets (e.g. \"Will Person XY...\" with no trading history). \"top\": the default featured subset — real markets ranked live-first, then yes-price desc, then volume (matches the browse-card display rule), capped at markets_limit per event (default 3). Events still carry market_count for \"+N more\" UI; fetch the full list on demand via GET /events/:slug. A 20-event page drops from ~3.8MB (all) to ~0.3MB (top) — use this for browse feeds. \"none\": no markets array (fastest, use when only event-level data is needed).", "type": "string", "enum": [ "all", "real", "top", "none" ] }, "markets_limit": { "description": "Max markets per event for include_markets: \"top\" (default 3). Ignored otherwise.", "type": "integer", "minimum": 1, "maximum": 10 }, "explain": { "default": false, "type": "boolean" } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "event_id": { "type": "string" }, "id": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "subcategory": { "type": "string" }, "image": { "type": "string" }, "icon": { "type": "string" }, "active": { "type": "boolean" }, "closed": { "type": "boolean" }, "end_date": { "nullable": true, "type": "string" }, "creation_date": { "nullable": true, "type": "string" }, "neg_risk": { "type": "boolean" }, "enable_neg_risk": { "type": "boolean" }, "parent_event_id": { "nullable": true, "type": "string" }, "age_seconds": { "type": "number" }, "available_windows": { "type": "array", "items": { "type": "string" } }, "metrics": { "type": "object", "properties": { "volume": { "type": "number" }, "liquidity": { "type": "number" }, "market_count": { "type": "number" }, "price_movement": { "type": "number" }, "holders_total": { "type": "number" }, "holders_yes": { "type": "number" }, "holders_no": { "type": "number" }, "holders_whale": { "type": "number" }, "holders_smart_money": { "type": "number" }, "holders_insider": { "type": "number" } }, "additionalProperties": false }, "deltas": { "type": "object", "additionalProperties": { "type": "object", "properties": { "abs": { "nullable": true, "type": "number" }, "pct": { "nullable": true, "type": "number" }, "status": { "type": "string", "enum": [ "ok", "too_new", "missing_history", "div0" ] } }, "required": [ "status" ], "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "string" } }, "market_count": { "type": "number" }, "markets": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "event_id", "id", "slug", "title", "subtitle", "description", "category", "subcategory", "image", "icon", "active", "closed", "neg_risk", "enable_neg_risk", "age_seconds", "available_windows", "metrics", "deltas", "tags", "market_count" ], "additionalProperties": {} } }, "pagination": { "type": "object", "properties": { "has_more": { "type": "boolean" }, "next_cursor": { "type": "string" } }, "required": [ "has_more" ], "additionalProperties": false }, "explain": { "type": "object", "properties": { "phase1_sql": { "type": "string" }, "phase2_sql": { "type": "string" } }, "additionalProperties": false } }, "required": [ "events", "pagination" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "markets:read" } }, "/events/{slug}": { "get": { "summary": "Get a single event by slug or ID with full metrics and deltas", "tags": [ "Events" ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "event_id": { "type": "string" }, "id": { "type": "string" }, "slug": { "type": "string" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "subcategory": { "type": "string" }, "image": { "type": "string" }, "icon": { "type": "string" }, "active": { "type": "boolean" }, "closed": { "type": "boolean" }, "end_date": { "nullable": true, "type": "string" }, "creation_date": { "nullable": true, "type": "string" }, "neg_risk": { "type": "boolean" }, "enable_neg_risk": { "type": "boolean" }, "parent_event_id": { "nullable": true, "type": "string" }, "age_seconds": { "type": "number" }, "available_windows": { "type": "array", "items": { "type": "string" } }, "metrics": { "type": "object", "properties": { "volume": { "type": "number" }, "liquidity": { "type": "number" }, "market_count": { "type": "number" }, "price_movement": { "type": "number" }, "holders_total": { "type": "number" }, "holders_yes": { "type": "number" }, "holders_no": { "type": "number" }, "holders_whale": { "type": "number" }, "holders_smart_money": { "type": "number" }, "holders_insider": { "type": "number" } }, "additionalProperties": false }, "deltas": { "type": "object", "additionalProperties": { "type": "object", "properties": { "abs": { "nullable": true, "type": "number" }, "pct": { "nullable": true, "type": "number" }, "status": { "type": "string", "enum": [ "ok", "too_new", "missing_history", "div0" ] } }, "required": [ "status" ], "additionalProperties": false } }, "tags": { "type": "array", "items": { "type": "string" } }, "market_count": { "type": "number" }, "markets": { "type": "array", "items": { "type": "object", "additionalProperties": {} } } }, "required": [ "event_id", "id", "slug", "title", "subtitle", "description", "category", "subcategory", "image", "icon", "active", "closed", "neg_risk", "enable_neg_risk", "age_seconds", "available_windows", "metrics", "deltas", "tags", "market_count" ], "additionalProperties": {} } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/leaderboard/global": { "get": { "summary": "Get the global leaderboard snapshot", "tags": [ "Leaderboard" ], "description": "Returns top traders ranked by P&L. Use advanced=true to include risk-adjusted metrics (Sharpe, Sortino, Calmar, max drawdown, Kelly criterion, etc.). Supports sorting by any metric, filtering, and cursor-based pagination.", "parameters": [ { "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": "pnl", "type": "string", "enum": [ "pnl", "total_pnl", "overall_pnl", "realized_pnl", "win_rate", "winRate", "total_wins", "totalWins", "total_losses", "totalLosses", "current_value", "currentValue", "active_positions", "activePositions", "total_closed_positions", "totalClosedPositions", "volume", "total_volume", "totalVolume", "position_count", "positionCount", "sharpe_ratio", "sharpeRatio", "sharpe", "sortino_ratio", "sortinoRatio", "sortino", "calmar_ratio", "calmarRatio", "calmar", "max_drawdown", "maxDrawdown", "roi", "smart_score", "smartScore", "score", "confidence_score", "confidenceScore", "win_rate_weighted", "winRateWeighted" ] }, "in": "query", "name": "sortBy", "required": false, "description": "Sort field. pnl/total_pnl = total PnL, realized_pnl = realized only" }, { "schema": { "default": "DESC", "type": "string", "enum": [ "ASC", "DESC" ] }, "in": "query", "name": "sortOrder", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "true" ] }, { "type": "string", "enum": [ "false" ] }, { "type": "boolean" } ] }, "in": "query", "name": "advanced", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "minVolume", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "maxVolume", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "minPnl", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "maxPnl", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "minSmartScore", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "maxSmartScore", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "minWinRate", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "maxWinRate", "required": false }, { "schema": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "minPositions", "required": false }, { "schema": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "in": "query", "name": "maxPositions", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "true" ] }, { "type": "string", "enum": [ "false" ] }, { "type": "boolean" } ] }, "in": "query", "name": "isActive", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string", "description": "Wallet address" }, "displayName": { "description": "Polymarket display name", "type": "string" }, "avatarUrl": { "description": "Polymarket avatar URL", "type": "string" }, "overallPnl": { "type": "number", "description": "Total PnL = realized + unrealized (matches Polymarket display)" }, "winRate": { "type": "number", "description": "Win rate (0-1) from closed positions" }, "totalWins": { "type": "number", "description": "Sum of positive realized PnL from closed positions" }, "totalLosses": { "type": "number", "description": "Sum of absolute negative realized PnL from closed positions" }, "currentValue": { "type": "number", "description": "Current portfolio value in USD" }, "activePositions": { "type": "number", "description": "Number of active positions" }, "totalClosedPositions": { "description": "Number of closed positions", "type": "number" }, "updatedAt": { "description": "Last update timestamp", "type": "string" }, "totalVolume": { "type": "number" }, "positionCount": { "type": "number" }, "avgPositionSize": { "type": "number" }, "advanced": { "type": "object", "properties": { "sharpeRatio": { "nullable": true, "type": "number" }, "sortinoRatio": { "nullable": true, "type": "number" }, "calmarRatio": { "nullable": true, "type": "number" }, "maxDrawdown": { "nullable": true, "type": "number" }, "currentStreak": { "nullable": true, "type": "number" }, "bestStreak": { "nullable": true, "type": "number" }, "worstStreak": { "nullable": true, "type": "number" }, "roi": { "nullable": true, "type": "number" }, "kellyFraction": { "nullable": true, "type": "number" }, "avgEdge": { "nullable": true, "type": "number" }, "winRateWeighted": { "nullable": true, "type": "number" }, "bestTag": { "nullable": true, "type": "string" }, "bestTagPnl": { "nullable": true, "type": "number" }, "smartScore": { "nullable": true, "type": "number" }, "profitabilityScore": { "nullable": true, "type": "number" }, "riskEfficiencyScore": { "nullable": true, "type": "number" }, "confidenceScore": { "nullable": true, "type": "number" }, "isActive": { "type": "boolean" }, "lastTradeAt": { "nullable": true, "type": "string" } }, "required": [ "sharpeRatio", "sortinoRatio", "calmarRatio", "maxDrawdown", "currentStreak", "bestStreak", "worstStreak", "roi", "kellyFraction", "avgEdge", "winRateWeighted", "bestTag", "bestTagPnl", "smartScore", "profitabilityScore", "riskEfficiencyScore", "confidenceScore", "isActive", "lastTradeAt" ], "additionalProperties": false } }, "required": [ "address", "overallPnl", "winRate", "totalWins", "totalLosses", "currentValue", "activePositions" ], "additionalProperties": false } }, "total": { "type": "number" }, "updatedAt": { "type": "string" }, "nextCursor": { "nullable": true, "type": "string" } }, "required": [ "rows", "total", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/leaderboard/biggest-movers": { "get": { "summary": "Get biggest PnL movers (winners and losers)", "tags": [ "Leaderboard" ], "description": "Returns traders with the largest PnL gains and losses over a time window (1d, 1w, 1m).", "parameters": [ { "schema": { "default": "1d", "type": "string", "enum": [ "1d", "1w", "1m" ] }, "in": "query", "name": "window", "required": false }, { "schema": { "default": 10, "type": "integer", "minimum": 1, "maximum": 50 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": "both", "type": "string", "enum": [ "winners", "losers", "both" ] }, "in": "query", "name": "type", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "window": { "type": "string" }, "winners": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "pnlChange": { "type": "number" }, "currentPnl": { "type": "number" }, "previousPnl": { "type": "number" } }, "required": [ "address", "pnlChange", "currentPnl", "previousPnl" ], "additionalProperties": false } }, "losers": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "pnlChange": { "type": "number" }, "currentPnl": { "type": "number" }, "previousPnl": { "type": "number" } }, "required": [ "address", "pnlChange", "currentPnl", "previousPnl" ], "additionalProperties": false } }, "updatedAt": { "type": "string" } }, "required": [ "window", "winners", "losers", "updatedAt" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/wallets/{address}/similar": { "get": { "summary": "Get similar wallets for an address", "tags": [ "Clusters" ], "description": "Returns wallets with similar trading behavior based on hybrid similarity (60% behavioral/Jaccard + 40% funding/shared sources).", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minSimilarity", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "wallet": { "type": "string" }, "cluster": { "type": "object", "properties": { "id": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "size": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "size" ], "additionalProperties": false }, "similarWallets": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "jaccard": { "type": "number" }, "sharedMarkets": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "score": { "type": "number" }, "hybridScore": { "type": "number" }, "fundingLink": { "type": "object", "properties": { "sharedSources": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sharedVolume": { "type": "number" }, "fundingScore": { "type": "number" } }, "required": [ "sharedSources", "sharedVolume", "fundingScore" ], "additionalProperties": false } }, "required": [ "address", "jaccard", "sharedMarkets", "score" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "minSimilarity": { "type": "number" }, "totalSimilar": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "returnedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "limit", "minSimilarity", "totalSimilar", "returnedCount" ], "additionalProperties": false } }, "required": [ "wallet", "cluster", "similarWallets", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/wallets/{address}/similar/behavioral": { "get": { "summary": "Get behaviorally similar wallets", "tags": [ "Clusters" ], "description": "Returns wallets with similar trading behavior based purely on Jaccard similarity of traded markets. No funding data.", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minSimilarity", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "wallet": { "type": "string" }, "type": { "type": "string", "enum": [ "behavioral" ] }, "similarWallets": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "jaccard": { "type": "number" }, "sharedMarkets": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "score": { "type": "number" } }, "required": [ "address", "jaccard", "sharedMarkets", "score" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "minSimilarity": { "type": "number" }, "returnedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "description": { "type": "string" } }, "required": [ "limit", "minSimilarity", "returnedCount", "description" ], "additionalProperties": false } }, "required": [ "wallet", "type", "similarWallets", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/wallets/{address}/similar/funding": { "get": { "summary": "Get funding-linked wallets", "tags": [ "Clusters" ], "description": "Returns wallets that share the same funding sources (external addresses that deposited to both wallets).", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minSharedVolume", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "wallet": { "type": "string" }, "type": { "type": "string", "enum": [ "funding" ] }, "linkedWallets": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "sharedSources": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sharedVolume": { "type": "number" }, "fundingScore": { "type": "number" }, "firstSharedAt": { "type": "string" }, "lastSharedAt": { "type": "string" } }, "required": [ "address", "sharedSources", "sharedVolume", "fundingScore", "firstSharedAt", "lastSharedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "minSharedVolume": { "type": "number" }, "returnedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "description": { "type": "string" } }, "required": [ "limit", "minSharedVolume", "returnedCount", "description" ], "additionalProperties": false } }, "required": [ "wallet", "type", "linkedWallets", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/markets/{slug}/clusters": { "get": { "summary": "Get cluster distribution for a market", "tags": [ "Clusters" ], "description": "Returns wallet clusters holding positions in this market, suitable for Bubblemaps visualization.", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minClusterSize", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "in": "query", "name": "includeEdges", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "marketId": { "type": "string" }, "slug": { "type": "string" }, "clusters": { "type": "array", "items": { "type": "object", "properties": { "clusterId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "walletCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalValue": { "type": "number" }, "yesValue": { "type": "number" }, "noValue": { "type": "number" }, "yesPct": { "type": "number" }, "topWallets": { "type": "array", "items": { "type": "string" } } }, "required": [ "clusterId", "walletCount", "totalValue", "yesValue", "noValue", "yesPct", "topWallets" ], "additionalProperties": false } }, "edges": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "target": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "weight": { "type": "number" } }, "required": [ "source", "target", "weight" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "totalClusters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalHolders": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "returnedClusters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "minClusterSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "totalClusters", "totalHolders", "returnedClusters", "minClusterSize" ], "additionalProperties": false } }, "required": [ "marketId", "slug", "clusters", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/clusters/cross-market-activity": { "get": { "summary": "Get cross-market cluster activity", "tags": [ "Clusters" ], "description": "Detects clusters simultaneously active across many markets — a coordinated manipulation signal.", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minClusterSize", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minMarkets", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minConcentration", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 1000 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "clusters": { "type": "array", "items": { "type": "object", "properties": { "clusterId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "marketCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "avgMemberCount": { "type": "number" }, "avgConcentration": { "type": "number" }, "totalValue": { "type": "number" }, "markets": { "type": "array", "items": { "type": "object", "properties": { "marketId": { "type": "string" }, "question": { "type": "string" }, "slug": { "type": "string" }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalValue": { "type": "number" }, "dominantSide": { "type": "string" }, "concentration": { "type": "number" } }, "required": [ "marketId", "question", "slug", "memberCount", "totalValue", "dominantSide", "concentration" ], "additionalProperties": false } } }, "required": [ "clusterId", "marketCount", "avgMemberCount", "avgConcentration", "totalValue", "markets" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "minClusterSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "minMarkets": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "minConcentration": { "type": "number" }, "limit": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "returnedCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "minClusterSize", "minMarkets", "minConcentration", "limit", "returnedCount" ], "additionalProperties": false } }, "required": [ "clusters", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/clusters/{id}": { "get": { "summary": "Get cluster details", "tags": [ "Clusters" ], "description": "Returns metadata and optionally member wallets for a cluster.", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "in": "query", "name": "includeMembers", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ], "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "clusterId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "avgInternalSimilarity": { "type": "number" }, "suspiciousnessScore": { "type": "number" }, "behavioralProfile": { "type": "object", "properties": { "topMarkets": { "type": "array", "items": { "type": "string" } }, "dominantTags": { "type": "array", "items": { "type": "string" } }, "totalVolume": { "type": "number" }, "avgWinRate": { "type": "number" } }, "required": [ "topMarkets", "dominantTags", "totalVolume", "avgWinRate" ], "additionalProperties": false }, "representativeWallets": { "type": "array", "items": { "type": "string" } }, "members": { "type": "array", "items": { "type": "string" } } }, "required": [ "clusterId", "memberCount", "avgInternalSimilarity", "suspiciousnessScore", "behavioralProfile", "representativeWallets" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/clusters/{id}/evidence": { "get": { "summary": "Get cluster evidence", "tags": [ "Clusters" ], "description": "Returns evidence for why wallets are clustered: shared markets, funding links, same-side betting, temporal patterns, and internal similarity.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "clusterId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sampledMembers": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "evidence": { "type": "object", "properties": { "sharedMarkets": { "type": "array", "items": { "type": "object", "properties": { "marketId": { "type": "string" }, "question": { "nullable": true, "type": "string" }, "slug": { "nullable": true, "type": "string" }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "memberPct": { "type": "number" }, "dominantSide": { "type": "string" }, "yesCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "noCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "marketId", "question", "slug", "memberCount", "memberPct", "dominantSide", "yesCount", "noCount" ], "additionalProperties": false } }, "fundingLinks": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalVolume": { "type": "number" } }, "required": [ "source", "memberCount", "totalVolume" ], "additionalProperties": false } }, "sameSideBetting": { "type": "array", "items": { "type": "object", "properties": { "marketId": { "type": "string" }, "question": { "nullable": true, "type": "string" }, "side": { "type": "string" }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "memberPct": { "type": "number" } }, "required": [ "marketId", "question", "side", "memberCount", "memberPct" ], "additionalProperties": false } }, "temporalPatterns": { "type": "object", "properties": { "avgFundingGapHours": { "nullable": true, "type": "number" }, "minFundingGapHours": { "nullable": true, "type": "number" }, "pairsWithin24h": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pairsTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "avgFundingGapHours", "minFundingGapHours", "pairsWithin24h", "pairsTotal" ], "additionalProperties": false }, "internalSimilarity": { "type": "object", "properties": { "pairs": { "type": "array", "items": { "type": "object", "properties": { "walletA": { "type": "string" }, "walletB": { "type": "string" }, "jaccard": { "type": "number" }, "volumeWeightedJaccard": { "type": "number" }, "sharedMarkets": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sameSideMarkets": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "oppositeSideMarkets": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "walletA", "walletB", "jaccard", "volumeWeightedJaccard", "sharedMarkets", "sameSideMarkets", "oppositeSideMarkets" ], "additionalProperties": false } }, "avgJaccard": { "type": "number" }, "avgSameSide": { "type": "number" } }, "required": [ "pairs", "avgJaccard", "avgSameSide" ], "additionalProperties": false } }, "required": [ "sharedMarkets", "fundingLinks", "sameSideBetting", "temporalPatterns", "internalSimilarity" ], "additionalProperties": false } }, "required": [ "clusterId", "memberCount", "evidence" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/markets/{slug}/clusters/explore": { "get": { "summary": "Explore market clusters with tunable parameters", "tags": [ "Clusters" ], "description": "Computes clusters on-the-fly for a market. Supports presets (conservative/balanced/aggressive) or individual parameter tuning. Rate limited — use pre-computed /markets/:slug/clusters for high-frequency access.", "parameters": [ { "schema": { "type": "string", "enum": [ "conservative", "balanced", "aggressive" ] }, "in": "query", "name": "preset", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minJaccard", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minSharedMarkets", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "in": "query", "name": "sameSide", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "resolution", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "number" } ] }, "in": "query", "name": "minClusterSize", "required": false }, { "schema": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "in": "query", "name": "useIHF", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "marketId": { "type": "string" }, "slug": { "type": "string" }, "clusters": { "type": "array", "items": { "type": "object", "properties": { "clusterId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "walletCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalValue": { "type": "number" }, "yesValue": { "type": "number" }, "noValue": { "type": "number" }, "yesPct": { "type": "number" }, "topWallets": { "type": "array", "items": { "type": "string" } }, "avgJaccard": { "type": "number" }, "avgSameSidePct": { "type": "number" } }, "required": [ "clusterId", "walletCount", "totalValue", "yesValue", "noValue", "yesPct", "topWallets", "avgJaccard", "avgSameSidePct" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "params": { "type": "object", "properties": { "minJaccard": { "type": "number" }, "minSharedMarkets": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "sameSide": { "type": "boolean" }, "resolution": { "type": "number" }, "minClusterSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "useIHF": { "type": "boolean" }, "preset": { "nullable": true, "type": "string" } }, "required": [ "minJaccard", "minSharedMarkets", "sameSide", "resolution", "minClusterSize", "useIHF", "preset" ], "additionalProperties": false }, "totalHolders": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "totalClusters": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "clusteredHolders": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "edgeCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "computedInMs": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "params", "totalHolders", "totalClusters", "clusteredHolders", "edgeCount", "computedInMs" ], "additionalProperties": false } }, "required": [ "marketId", "slug", "clusters", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/funding/wallet/{address}": { "get": { "summary": "Get funding sources for a wallet", "tags": [ "Funding" ], "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "wallet": { "type": "string" }, "funding_sources": { "type": "array", "items": { "type": "object", "properties": { "polymarket_wallet": { "type": "string" }, "funding_source": { "type": "string" }, "first_funding_at": { "type": "string" }, "last_funding_at": { "type": "string" }, "total_deposited": { "type": "string" }, "total_withdrawn": { "type": "string" }, "deposit_count": { "type": "number" }, "withdrawal_count": { "type": "number" }, "net_flow": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "polymarket_wallet", "funding_source", "first_funding_at", "last_funding_at", "total_deposited", "total_withdrawn", "deposit_count", "withdrawal_count", "net_flow", "updated_at" ], "additionalProperties": false } }, "total_deposited": { "type": "string" }, "total_withdrawn": { "type": "string" }, "net_flow": { "type": "string" }, "unique_sources": { "type": "number" } }, "required": [ "wallet", "funding_sources", "total_deposited", "total_withdrawn", "net_flow", "unique_sources" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/funding/source/{address}": { "get": { "summary": "Get wallets funded by a source address", "tags": [ "Funding" ], "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string" }, "funded_wallets": { "type": "array", "items": { "type": "object", "properties": { "polymarket_wallet": { "type": "string" }, "funding_source": { "type": "string" }, "first_funding_at": { "type": "string" }, "last_funding_at": { "type": "string" }, "total_deposited": { "type": "string" }, "total_withdrawn": { "type": "string" }, "deposit_count": { "type": "number" }, "withdrawal_count": { "type": "number" }, "net_flow": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "polymarket_wallet", "funding_source", "first_funding_at", "last_funding_at", "total_deposited", "total_withdrawn", "deposit_count", "withdrawal_count", "net_flow", "updated_at" ], "additionalProperties": false } }, "total_deposited": { "type": "string" }, "total_withdrawn": { "type": "string" }, "net_flow": { "type": "string" }, "unique_wallets": { "type": "number" } }, "required": [ "source", "funded_wallets", "total_deposited", "total_withdrawn", "net_flow", "unique_wallets" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/funding/transfers": { "get": { "summary": "Get recent USDC transfers", "tags": [ "Funding" ], "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "default": "all", "type": "string", "enum": [ "external_deposit", "external_withdrawal", "all" ] }, "in": "query", "name": "type", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "wallet", "required": false }, { "schema": {}, "in": "query", "name": "since", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "transfers": { "type": "array", "items": { "type": "object", "properties": { "tx_hash": { "type": "string" }, "log_index": { "type": "number" }, "block_number": { "type": "number" }, "block_timestamp": { "type": "string" }, "from_address": { "type": "string" }, "to_address": { "type": "string" }, "amount": { "type": "string" }, "transfer_type": { "type": "string", "enum": [ "external_deposit", "external_withdrawal" ] }, "external_address": { "type": "string" }, "polymarket_wallet": { "type": "string" } }, "required": [ "tx_hash", "log_index", "block_number", "block_timestamp", "from_address", "to_address", "amount", "transfer_type", "external_address", "polymarket_wallet" ], "additionalProperties": false } }, "pagination": { "type": "object", "properties": { "limit": { "type": "number" }, "offset": { "type": "number" }, "hasMore": { "type": "boolean" } }, "required": [ "limit", "offset", "hasMore" ], "additionalProperties": false } }, "required": [ "transfers", "pagination" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/funding/stats": { "get": { "summary": "Get overall funding statistics", "tags": [ "Funding" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total_deposits": { "type": "string" }, "total_withdrawals": { "type": "string" }, "net_flow": { "type": "string" }, "deposit_count": { "type": "number" }, "withdrawal_count": { "type": "number" }, "unique_wallets": { "type": "number" }, "unique_sources": { "type": "number" }, "latest_block": { "type": "number" } }, "required": [ "total_deposits", "total_withdrawals", "net_flow", "deposit_count", "withdrawal_count", "unique_wallets", "unique_sources", "latest_block" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/funding/label/{address}": { "get": { "summary": "Get label for an address", "tags": [ "Funding" ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "label": { "nullable": true, "type": "string" }, "entity_type": { "type": "string" }, "fetched_at": { "nullable": true, "type": "string" } }, "required": [ "address", "label", "entity_type", "fetched_at" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/funding/trace/{address}": { "get": { "summary": "Multi-hop fund tracing", "tags": [ "Funding" ], "parameters": [ { "schema": { "default": 2, "type": "integer", "minimum": 1, "maximum": 5 }, "in": "query", "name": "depth", "required": false }, { "schema": { "default": "in", "type": "string", "enum": [ "in", "out", "both" ] }, "in": "query", "name": "direction", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "min_amount", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FundingTraceNode" } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/funding/shared-source": { "get": { "summary": "Find wallets sharing a funding source", "tags": [ "Funding" ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "source", "required": true }, { "schema": { "type": "number" }, "in": "query", "name": "min_amount", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string" }, "funded_wallets": { "type": "array", "items": { "type": "object", "properties": { "wallet": { "type": "string" }, "total_deposited": { "type": "string" }, "first_deposit_at": { "type": "string" }, "last_deposit_at": { "type": "string" } }, "required": [ "wallet", "total_deposited", "first_deposit_at", "last_deposit_at" ], "additionalProperties": false } }, "label": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "additionalProperties": false } }, "required": [ "source", "funded_wallets" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/kalshi/markets": { "get": { "summary": "List Kalshi markets", "tags": [ "Kalshi" ], "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "active", "closed", "determined", "finalized", "settled" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "eventTicker", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "search", "required": false }, { "schema": { "default": "volume", "type": "string", "enum": [ "volume", "volume_24h", "open_interest", "last_price", "close_time" ] }, "in": "query", "name": "sortBy", "required": false }, { "schema": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "sortOrder", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/kalshi/markets/{ticker}": { "get": { "summary": "Get Kalshi market detail", "tags": [ "Kalshi" ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "ticker", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/kalshi/markets/{ticker}/trades": { "get": { "summary": "Get Kalshi market trades", "tags": [ "Kalshi" ], "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": {}, "in": "query", "name": "since", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "ticker", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/kalshi/markets/{ticker}/candlesticks": { "get": { "summary": "Get Kalshi market candlesticks", "tags": [ "Kalshi" ], "parameters": [ { "schema": { "default": 60, "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "query", "name": "interval", "required": false }, { "schema": {}, "in": "query", "name": "since", "required": false }, { "schema": { "default": 200, "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "ticker", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/kalshi/markets/{ticker}/orderbook": { "get": { "summary": "Get Kalshi market orderbook", "tags": [ "Kalshi" ], "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "query", "name": "depth", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "ticker", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/kalshi/events": { "get": { "summary": "List Kalshi events", "tags": [ "Kalshi" ], "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "seriesTicker", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "search", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/kalshi/events/{eventTicker}": { "get": { "summary": "Get Kalshi event detail with markets", "tags": [ "Kalshi" ], "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "eventTicker", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/kalshi/series": { "get": { "summary": "List Kalshi series", "tags": [ "Kalshi" ], "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "category", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/wallets/{address}/identity": { "get": { "summary": "Resolve cross-venue trader identity for an HL wallet", "tags": [ "Hyperliquid" ], "description": "Returns the unified trader_id and any linked Polymarket / Kalshi addresses, with the confidence score and supporting evidence. Returns a stub response with confidenceScore=0 if the wallet is not yet linked.", "parameters": [ { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "traderId": { "type": "string" }, "addresses": { "type": "object", "properties": { "polymarket": { "nullable": true, "type": "string" }, "hyperliquid": { "nullable": true, "type": "string" }, "kalshi": { "nullable": true, "type": "string" } }, "required": [ "polymarket", "hyperliquid", "kalshi" ], "additionalProperties": false }, "confidenceScore": { "type": "number" }, "evidenceMethod": { "type": "string" }, "evidenceCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "firstLinkedAt": { "nullable": true, "type": "string" }, "lastSyncedAt": { "nullable": true, "type": "string" }, "evidence": { "type": "array", "items": { "type": "object", "properties": { "evidenceType": { "type": "string" }, "fundingSource": { "type": "string" }, "pmEventAt": { "nullable": true, "type": "string" }, "hlEventAt": { "nullable": true, "type": "string" }, "amount": { "type": "number" }, "confidenceContribution": { "type": "number" }, "computedAt": { "type": "string" } }, "required": [ "evidenceType", "fundingSource", "pmEventAt", "hlEventAt", "amount", "confidenceContribution", "computedAt" ], "additionalProperties": false } } }, "required": [ "traderId", "addresses", "confidenceScore", "evidenceMethod", "evidenceCount", "firstLinkedAt", "lastSyncedAt", "evidence" ], "additionalProperties": false }, { "type": "object", "properties": { "traderId": { "type": "string", "nullable": true, "enum": [ null ] }, "addresses": { "type": "object", "properties": { "polymarket": { "type": "string", "nullable": true, "enum": [ null ] }, "hyperliquid": { "type": "string" }, "kalshi": { "type": "string", "nullable": true, "enum": [ null ] } }, "required": [ "polymarket", "hyperliquid", "kalshi" ], "additionalProperties": false }, "confidenceScore": { "type": "number", "enum": [ 0 ] }, "evidence": { "maxItems": 0, "type": "array", "items": { "not": {} } } }, "required": [ "traderId", "addresses", "confidenceScore", "evidence" ], "additionalProperties": false } ] } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/perps/assets": { "get": { "summary": "List Hyperliquid perpetual assets", "tags": [ "Hyperliquid Perps" ], "description": "Returns active perp assets with current mark/oracle/mid prices, funding rate, open interest, and 24h volume. Supports search, category filter, and sorting.", "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "maxLength": 32 }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "string", "enum": [ "majors", "alts", "memes", "other" ] }, "in": "query", "name": "category", "required": false }, { "schema": { "default": "volume_24h", "type": "string", "enum": [ "volume_24h", "open_interest", "mark_px", "funding", "first_seen_at" ] }, "in": "query", "name": "sortBy", "required": false }, { "schema": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "sortOrder", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/perps/discover": { "post": { "summary": "Discover perp assets with filters, deltas, and stage classification", "tags": [ "Hyperliquid Perps" ], "description": "Cursor-paginated perp asset discovery with per-window deltas (volume/trades/funding/OI/mark) and lifecycle stage. Single-phase query against the precomputed serving table.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "search": { "type": "string", "maxLength": 32 }, "category": { "type": "string", "enum": [ "majors", "alts", "memes", "other" ] }, "holdersMin": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "holdersMax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "volumeMin": { "type": "number", "minimum": 0 }, "volumeMax": { "type": "number", "minimum": 0 }, "openInterestMin": { "type": "number", "minimum": 0 }, "openInterestMax": { "type": "number", "minimum": 0 }, "stages": { "minItems": 1, "maxItems": 4, "type": "array", "items": { "type": "string", "enum": [ "new", "building", "peak", "quiet" ] } }, "deltas": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "trades", "open_interest", "mark_px", "funding" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric", "window", "compare" ] } }, "sort": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume_24h", "trades_24h", "open_interest", "mark_px", "funding", "holders_total", "holders_long", "holders_short", "holders_whale", "holders_smart_money", "first_seen_at" ] }, "direction": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric" ] }, "pagination": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 } } } } } } } }, "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "markets:read" } }, "/hyperliquid/perps/assets/{coin}": { "get": { "summary": "Get a perp asset detail", "tags": [ "Hyperliquid Perps" ], "description": "Returns asset metadata, current mark/oracle/mid prices, funding rate, open interest, and 24h volume + trade counts.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 32, "pattern": "^[A-Za-z0-9_-]+$" }, "in": "path", "name": "coin", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/perps/assets/{coin}/holders": { "get": { "summary": "Top holders of a perp asset (by side)", "tags": [ "Hyperliquid Perps" ], "description": "Returns the top N addresses with open positions on this perp, sorted by absolute size. Side filter: long/short/both. Includes whale/insider/smart-money classification badges.", "parameters": [ { "schema": { "default": "both", "type": "string", "enum": [ "both", "long", "short" ] }, "in": "query", "name": "side", "required": false }, { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 32, "pattern": "^[A-Za-z0-9_-]+$" }, "in": "path", "name": "coin", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/perps/assets/{coin}/whales": { "get": { "summary": "Whales currently holding a perp", "tags": [ "Hyperliquid Perps" ], "description": "Addresses with portfolio_value >= threshold OR per-asset notional >= threshold. Sorted by per-asset notional desc.", "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 32, "pattern": "^[A-Za-z0-9_-]+$" }, "in": "path", "name": "coin", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/perps/assets/{coin}/insiders": { "get": { "summary": "Insider-flagged holders of a perp", "tags": [ "Hyperliquid Perps" ], "description": "Addresses with account_age_hours <= threshold AND open position notional >= threshold. Insider position threshold is 5x HIP-4 due to leverage available on perps.", "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 32, "pattern": "^[A-Za-z0-9_-]+$" }, "in": "path", "name": "coin", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/perps/assets/{coin}/smartmoney": { "get": { "summary": "Smart-money holders of a perp", "tags": [ "Hyperliquid Perps" ], "description": "Addresses with closed_position_count >= threshold, win_rate >= threshold, realized_pnl >= threshold. Sorted by smart_score desc.", "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 32, "pattern": "^[A-Za-z0-9_-]+$" }, "in": "path", "name": "coin", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/perps/assets/{coin}/trades": { "get": { "summary": "Recent CLOB trades for a perp", "tags": [ "Hyperliquid Perps" ], "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": {}, "in": "query", "name": "since", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 32, "pattern": "^[A-Za-z0-9_-]+$" }, "in": "path", "name": "coin", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/perps/users/{address}/fills": { "get": { "summary": "Recent perp fills for a user", "tags": [ "Hyperliquid Perps" ], "description": "Returns the most recent perp fills for an address. Includes Open Long/Close Long/Open Short/Close Short/Funding/Liquidation directions with funding_rate and liquidation_px where applicable.", "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/perps/users/{address}/positions": { "get": { "summary": "Open perp positions for a user (with mark prices + unrealized PnL)", "tags": [ "Hyperliquid Perps" ], "description": "Returns the user's open perp positions joined with the latest mark price per coin. Unrealized PnL is computed at query time as szi * (mark_px - entry_px).", "parameters": [ { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/perps/leaderboard": { "get": { "summary": "Global perp trader leaderboard", "tags": [ "Hyperliquid Perps" ], "description": "Top perp traders ranked by realized + open + funding PnL. Cursor-based pagination for stable scroll. Reads from hl_perp_leaderboard_serving (refresh every 5 min).", "parameters": [ { "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": "overall_pnl", "type": "string", "enum": [ "pnl", "total_pnl", "totalPnl", "overall_pnl", "overallPnl", "realized_pnl", "realizedPnl", "open_pnl", "openPnl", "funding_pnl", "fundingPnl", "volume", "total_volume", "totalVolume", "win_rate", "winRate", "active_positions", "activePositions", "long_count", "longCount", "short_count", "shortCount", "liquidation_count", "liquidationCount", "portfolio_value", "portfolioValue", "largest_position_usd", "largestPositionUsd", "smart_score", "smartScore", "score" ] }, "in": "query", "name": "sortBy", "required": false }, { "schema": { "default": "DESC", "type": "string", "enum": [ "ASC", "DESC", "asc", "desc" ] }, "in": "query", "name": "sortOrder", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "true" ] }, { "type": "string", "enum": [ "false" ] }, { "type": "boolean" } ] }, "in": "query", "name": "advanced", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/perps/cohorts": { "get": { "summary": "Perp trader cohort distribution", "tags": [ "Hyperliquid Perps" ], "description": "Returns trader buckets for the requested cohort type (pnl_tier | size_tier | win_rate_tier) with member counts, total volume, total PnL, average win rate, and cohort share.", "parameters": [ { "schema": { "default": "pnl_tier", "type": "string", "enum": [ "pnl_tier", "size_tier", "win_rate_tier" ] }, "in": "query", "name": "cohort_type", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/outcomes": { "get": { "summary": "List HIP-4 outcome markets", "tags": [ "Hyperliquid" ], "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 10000 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "enum": [ "active", "resolved" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "maxLength": 20 }, "in": "query", "name": "underlying", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "search", "required": false }, { "schema": { "default": "first_seen_at", "type": "string", "enum": [ "volume_24h", "expiry_at", "first_seen_at", "outcome_id" ] }, "in": "query", "name": "sortBy", "required": false }, { "schema": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "sortOrder", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/outcomes/discover": { "post": { "summary": "Discover HIP-4 markets with filters, deltas, and stage classification", "tags": [ "Hyperliquid" ], "description": "Cursor-paginated market discovery with per-window deltas (volume/trades/mid prices), holder breakdowns (whale + smart money), and lifecycle stage. Single-phase query against the precomputed serving table; tolerates empty upstream tables.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "default": "active", "type": "string", "enum": [ "active", "resolved", "all" ] }, "underlying": { "type": "string", "maxLength": 20 }, "search": { "type": "string", "maxLength": 200 }, "classes": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 50 } }, "excludeClasses": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 50 } }, "categories": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 50 } }, "holdersMin": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "holdersMax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "volumeMin": { "type": "number", "minimum": 0 }, "volumeMax": { "type": "number", "minimum": 0 }, "endingWithin": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "expiryBefore": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "expiryAfter": { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$" }, "stages": { "minItems": 1, "maxItems": 5, "type": "array", "items": { "type": "string", "enum": [ "new", "building", "peak", "resolving", "quiet" ] } }, "deltas": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "trades", "yes_mid_px", "no_mid_px", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric", "window", "compare" ] } }, "conditions": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume_24h", "trades_24h", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "yes_mid_px", "no_mid_px", "expiry_at", "first_seen_at" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] }, "op": { "type": "string", "enum": [ "gt", "gte", "lt", "lte", "eq" ] }, "value": { "type": "number" } }, "required": [ "metric", "op", "value" ] } }, "conditionLogic": { "default": "and", "type": "string", "enum": [ "and", "or" ] }, "require": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "trades", "yes_mid_px", "no_mid_px", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] } }, "required": [ "metric", "window" ] } }, "sort": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume_24h", "trades_24h", "holders_total", "holders_yes", "holders_no", "holders_whale", "holders_smart_money", "yes_mid_px", "no_mid_px", "expiry_at", "first_seen_at" ] }, "direction": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] }, "nulls": { "default": "last", "type": "string", "enum": [ "exclude", "last", "zero" ] } }, "required": [ "metric" ] }, "pagination": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 } } } } } } } }, "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "markets:read" } }, "/hyperliquid/questions/discover": { "post": { "summary": "Discover HIP-4 questions (with embedded outcomes), deltas, and stage classification", "tags": [ "Hyperliquid" ], "description": "Cursor-paginated question discovery. A question groups N outcomes (named_outcome_ids); standalone outcomes appear as single-outcome cards (isStandalone) so the feed is unified. Returns question-level aggregated volume/trades, distinct holders (total / whale / smart money), price_movement, per-window deltas, threshold conditions, lifecycle stage, and (by default) the full embedded outcome objects. Single-phase query against the precomputed serving table.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "default": "active", "type": "string", "enum": [ "active", "resolved", "all" ] }, "search": { "type": "string", "maxLength": 200 }, "classes": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 50 } }, "excludeClasses": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 50 } }, "categories": { "minItems": 1, "maxItems": 20, "type": "array", "items": { "type": "string", "maxLength": 50 } }, "holdersMin": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "holdersMax": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "volumeMin": { "type": "number", "minimum": 0 }, "volumeMax": { "type": "number", "minimum": 0 }, "stages": { "minItems": 1, "maxItems": 5, "type": "array", "items": { "type": "string", "enum": [ "new", "building", "peak", "resolving", "quiet" ] } }, "deltas": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "trades", "holders_total", "holders_whale", "holders_smart_money", "price_movement" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] } }, "required": [ "metric", "window", "compare" ] } }, "conditions": { "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume_24h", "trades_24h", "holders_total", "holders_whale", "holders_smart_money", "price_movement", "first_seen_at" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] }, "op": { "type": "string", "enum": [ "gt", "gte", "lt", "lte", "eq" ] }, "value": { "type": "number" } }, "required": [ "metric", "op", "value" ] } }, "conditionLogic": { "default": "and", "type": "string", "enum": [ "and", "or" ] }, "require": { "minItems": 1, "maxItems": 10, "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume", "trades", "holders_total", "holders_whale", "holders_smart_money", "price_movement" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] } }, "required": [ "metric", "window" ] } }, "includeOutcomes": { "default": true, "type": "boolean" }, "includeStandalone": { "default": true, "type": "boolean" }, "sort": { "type": "object", "properties": { "metric": { "type": "string", "enum": [ "volume_24h", "trades_24h", "holders_total", "holders_whale", "holders_smart_money", "price_movement", "first_seen_at" ] }, "direction": { "default": "desc", "type": "string", "enum": [ "asc", "desc" ] }, "window": { "type": "string", "enum": [ "5m", "15m", "30m", "1h", "4h", "24h", "7d", "30d" ] }, "compare": { "type": "string", "enum": [ "delta_abs", "delta_pct" ] }, "nulls": { "default": "last", "type": "string", "enum": [ "exclude", "last", "zero" ] } }, "required": [ "metric" ] }, "pagination": { "type": "object", "properties": { "cursor": { "type": "string" }, "limit": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 } } } } } } } }, "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "markets:read" } }, "/hyperliquid/questions/{questionId}": { "get": { "summary": "Get HIP-4 question detail with embedded outcomes", "tags": [ "Hyperliquid" ], "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "path", "name": "questionId", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/outcomes/{outcomeId}": { "get": { "summary": "Get HIP-4 market detail", "tags": [ "Hyperliquid" ], "parameters": [ { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/outcomes/{outcomeId}/holders": { "get": { "summary": "Top holders of a HIP-4 market (by side)", "tags": [ "Hyperliquid" ], "parameters": [ { "schema": { "default": "both", "type": "string", "enum": [ "both", "yes", "no" ] }, "in": "query", "name": "side", "required": false }, { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/outcomes/{outcomeId}/whales": { "get": { "summary": "Whales currently holding a HIP-4 market", "tags": [ "Hyperliquid" ], "description": "Addresses with gross_notional (money at risk) >= threshold OR per-market notional >= threshold. Sorted by per-market notional desc.", "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/outcomes/{outcomeId}/insiders": { "get": { "summary": "Insider-flagged holders of a HIP-4 market", "tags": [ "Hyperliquid" ], "description": "Addresses with account_age_hours <= threshold AND open notional >= threshold. If the market is resolved, response includes winningSide flag per row.", "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/outcomes/{outcomeId}/smartmoney": { "get": { "summary": "Smart-money holders of a HIP-4 market", "tags": [ "Hyperliquid" ], "description": "Addresses with closed_position_count >= threshold, win_rate >= threshold, and realized_pnl >= threshold. Sorted by smart_score desc.", "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/outcomes/{outcomeId}/trades": { "get": { "summary": "Recent trades for a HIP-4 market", "tags": [ "Hyperliquid" ], "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": {}, "in": "query", "name": "since", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/users/{address}/fills": { "get": { "summary": "Recent HIP-4 fills for a user", "tags": [ "Hyperliquid" ], "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/users/{address}/trades": { "get": { "summary": "Recent HIP-4 trades (fills) for a user", "tags": [ "Hyperliquid" ], "description": "Reverse-chronological HIP-4 fills for the address from hl_user_fills_raw. Alias of /users/:address/fills exposed under the Polymarket-parity `/trades` name. Returns empty `data` when the wallet has no tracked fills.", "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/users/{address}/positions": { "get": { "summary": "Open HIP-4 positions for a user (derived live from fills)", "tags": [ "Hyperliquid" ], "parameters": [ { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/clusters/{id}": { "get": { "summary": "Get HIP-4 wallet cluster details", "tags": [ "Hyperliquid" ], "description": "Returns metadata for a HL wallet cluster (member_count, total_volume, avg_pnl, dominant_markets, modularity). Optionally includes member addresses.", "parameters": [ { "schema": { "default": false, "type": "boolean" }, "in": "query", "name": "includeMembers", "required": false }, { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 500 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/wallets/{address}/cluster": { "get": { "summary": "Get the HIP-4 cluster a wallet belongs to (if any)", "tags": [ "Hyperliquid" ], "description": "Resolves the wallet to its cluster_id from hl_wallet_clusters, then returns the same metadata shape as GET /hyperliquid/clusters/:id. Returns 404 if the wallet has no cluster assignment.", "parameters": [ { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/leaderboard": { "get": { "summary": "Global HIP-4 trader leaderboard", "tags": [ "Hyperliquid" ], "description": "Top HL traders ranked by realized + open PnL. Use advanced=true to include risk-adjusted metrics (Sharpe, Sortino, Calmar, max drawdown). Cursor-based pagination for stable scroll.", "parameters": [ { "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": "overall_pnl", "type": "string", "enum": [ "pnl", "total_pnl", "totalPnl", "overall_pnl", "overallPnl", "realized_pnl", "realizedPnl", "open_pnl", "openPnl", "volume", "total_volume", "totalVolume", "win_rate", "winRate", "active_positions", "activePositions", "closed_positions", "closedPositions", "total_closed_positions", "totalClosedPositions", "current_value", "currentValue", "portfolio_value", "portfolioValue", "net_exposure", "netExposure", "roi", "smart_score", "smartScore", "score", "sharpe", "sharpe_ratio", "sharpeRatio", "sortino", "sortino_ratio", "sortinoRatio", "calmar", "calmar_ratio", "calmarRatio", "max_drawdown", "maxDrawdown" ] }, "in": "query", "name": "sortBy", "required": false }, { "schema": { "default": "DESC", "type": "string", "enum": [ "ASC", "DESC", "asc", "desc" ] }, "in": "query", "name": "sortOrder", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "true" ] }, { "type": "string", "enum": [ "false" ] }, { "type": "boolean" } ] }, "in": "query", "name": "advanced", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/users/{address}": { "get": { "summary": "Composed HIP-4 user view (identity + PnL + cluster + cross-venue)", "tags": [ "Hyperliquid" ], "description": "Single-call dashboard payload for a HL wallet: identity, PnL summary, classification badges (whale/insider/smart money), optional risk-adjusted metrics (advanced=true), cluster assignment, cross-venue identity, and recent activity counts. Returns null/zero defaults when the wallet has no activity.", "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "true" ] }, { "type": "string", "enum": [ "false" ] }, { "type": "boolean" } ] }, "in": "query", "name": "advanced", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "identity": { "type": "object", "properties": { "accountAgeHours": { "type": "number" }, "firstSeenAt": { "nullable": true, "type": "string" }, "lastActiveAt": { "nullable": true, "type": "string" } }, "required": [ "accountAgeHours", "firstSeenAt", "lastActiveAt" ], "additionalProperties": false }, "pnl": { "type": "object", "properties": { "realizedPnl": { "type": "number" }, "openPnl": { "type": "number" }, "totalPnl": { "type": "number" }, "totalVolume": { "type": "number" }, "roi": { "type": "number" }, "winRate": { "type": "number" }, "closedPositionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activePositionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "portfolioValue": { "type": "number" }, "netExposure": { "type": "number" }, "grossNotional": { "type": "number" }, "equity": { "type": "number" }, "smartScore": { "type": "number" } }, "required": [ "realizedPnl", "openPnl", "totalPnl", "totalVolume", "roi", "winRate", "closedPositionCount", "activePositionCount", "portfolioValue", "netExposure", "grossNotional", "equity", "smartScore" ], "additionalProperties": false }, "classifications": { "type": "object", "properties": { "isWhale": { "type": "boolean" }, "isInsider": { "type": "boolean" }, "isSmartMoney": { "type": "boolean" } }, "required": [ "isWhale", "isInsider", "isSmartMoney" ], "additionalProperties": false }, "advanced": { "nullable": true, "type": "object", "properties": { "sharpe": { "nullable": true, "type": "number" }, "sortino": { "nullable": true, "type": "number" }, "calmar": { "nullable": true, "type": "number" }, "maxDrawdown": { "nullable": true, "type": "number" } }, "required": [ "sharpe", "sortino", "calmar", "maxDrawdown" ], "additionalProperties": false }, "cluster": { "nullable": true, "type": "object", "properties": { "clusterId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "clusterSize": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "memberCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "clusterId", "clusterSize", "memberCount" ], "additionalProperties": false }, "crossVenue": { "nullable": true, "type": "object", "properties": { "traderId": { "type": "string" }, "polymarketAddress": { "nullable": true, "type": "string" }, "kalshiUser": { "nullable": true, "type": "string" }, "confidenceScore": { "type": "number" } }, "required": [ "traderId", "polymarketAddress", "kalshiUser", "confidenceScore" ], "additionalProperties": false }, "recentActivity": { "type": "object", "properties": { "lastFillTs": { "nullable": true, "type": "string" }, "recentFillsCount24h": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recentFillsCount7d": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "lastFillTs", "recentFillsCount24h", "recentFillsCount7d" ], "additionalProperties": false }, "perps": { "type": "object", "properties": { "realizedPnl": { "type": "number" }, "openPnl": { "type": "number" }, "fundingPnl": { "type": "number" }, "totalPnl": { "type": "number" }, "totalVolume": { "type": "number" }, "winRate": { "type": "number" }, "activePositions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "closedPositions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "longCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "shortCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "liquidationCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "portfolioValue": { "type": "number" }, "largestPositionUsd": { "type": "number" }, "smartScore": { "type": "number" } }, "required": [ "realizedPnl", "openPnl", "fundingPnl", "totalPnl", "totalVolume", "winRate", "activePositions", "closedPositions", "longCount", "shortCount", "liquidationCount", "portfolioValue", "largestPositionUsd", "smartScore" ], "additionalProperties": false }, "combined": { "type": "object", "properties": { "totalPnl": { "type": "number" }, "realizedPnl": { "type": "number" }, "openPnl": { "type": "number" }, "totalVolume": { "type": "number" }, "portfolioValue": { "type": "number" }, "netExposure": { "type": "number" } }, "required": [ "totalPnl", "realizedPnl", "openPnl", "totalVolume", "portfolioValue", "netExposure" ], "additionalProperties": false } }, "required": [ "address", "identity", "pnl", "classifications", "advanced", "cluster", "crossVenue", "recentActivity", "perps", "combined" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/leaderboard/combined": { "get": { "summary": "Cross-product (HIP-4 + perps) trader leaderboard", "tags": [ "Hyperliquid" ], "description": "Top HL traders ranked by combined HIP-4 + perps PnL. Each row breaks out HIP-4 stats, perp stats, and the combined totals. Supports filters on minPnl / minVolume / address and cursor-based pagination. Reads from the pre-aggregated RMV `hl_combined_leaderboard_serving` (refreshed every 5 min).", "parameters": [ { "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 500 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "cursor", "required": false }, { "schema": { "default": "combinedPnl", "type": "string", "enum": [ "hip4Pnl", "perpPnl", "combinedPnl", "combinedVolume" ] }, "in": "query", "name": "sortBy", "required": false }, { "schema": { "default": "DESC", "type": "string", "enum": [ "ASC", "DESC", "asc", "desc" ] }, "in": "query", "name": "sortOrder", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "minPnl", "required": false }, { "schema": { "type": "number", "minimum": 0 }, "in": "query", "name": "minVolume", "required": false }, { "schema": { "type": "string", "pattern": "^0x[0-9a-fA-F]{40}$" }, "in": "query", "name": "address", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "rank": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "combined": { "type": "object", "properties": { "totalPnl": { "type": "number" }, "realizedPnl": { "type": "number" }, "openPnl": { "type": "number" }, "totalVolume": { "type": "number" }, "portfolioValue": { "type": "number" } }, "required": [ "totalPnl", "realizedPnl", "openPnl", "totalVolume", "portfolioValue" ], "additionalProperties": false }, "hip4": { "type": "object", "properties": { "realizedPnl": { "type": "number" }, "openPnl": { "type": "number" }, "totalPnl": { "type": "number" }, "totalVolume": { "type": "number" }, "winRate": { "type": "number" }, "closedPositions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activePositions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "portfolioValue": { "type": "number" }, "smartScore": { "type": "number" } }, "required": [ "realizedPnl", "openPnl", "totalPnl", "totalVolume", "winRate", "closedPositions", "activePositions", "portfolioValue", "smartScore" ], "additionalProperties": false }, "perps": { "type": "object", "properties": { "realizedPnl": { "type": "number" }, "openPnl": { "type": "number" }, "fundingPnl": { "type": "number" }, "totalPnl": { "type": "number" }, "totalVolume": { "type": "number" }, "winRate": { "type": "number" }, "closedPositions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activePositions": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "longCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "shortCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "liquidationCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "portfolioValue": { "type": "number" }, "largestPositionUsd": { "type": "number" }, "smartScore": { "type": "number" } }, "required": [ "realizedPnl", "openPnl", "fundingPnl", "totalPnl", "totalVolume", "winRate", "closedPositions", "activePositions", "longCount", "shortCount", "liquidationCount", "portfolioValue", "largestPositionUsd", "smartScore" ], "additionalProperties": false }, "accountAgeHours": { "type": "number" }, "lastActiveAt": { "nullable": true, "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "address", "rank", "combined", "hip4", "perps", "accountAgeHours", "lastActiveAt", "updatedAt" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "updatedAt": { "type": "string" }, "nextCursor": { "nullable": true, "type": "string" } }, "required": [ "rows", "total", "updatedAt", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/outcomes/{outcomeId}/analytics": { "get": { "summary": "Aggregate analytics for a HIP-4 market", "tags": [ "Hyperliquid" ], "description": "Composes per-market metadata, 24h/7d volume + trade counts, holder breakdown (yes/no/whale/smart money/insider), top 5 holders, last 10 trades, optional settlement metadata, and the count of distinct clusters with positions on the market.", "parameters": [ { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "outcome": { "type": "object", "properties": { "outcomeId": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "underlying": { "type": "string" }, "expiryAt": { "nullable": true, "type": "string" }, "isResolved": { "type": "boolean" }, "winningSide": { "nullable": true, "type": "integer", "minimum": 0, "maximum": 1 }, "yesMidPx": { "nullable": true, "type": "number" }, "noMidPx": { "nullable": true, "type": "number" }, "firstSeenAt": { "type": "string" } }, "required": [ "outcomeId", "name", "underlying", "expiryAt", "isResolved", "winningSide", "yesMidPx", "noMidPx", "firstSeenAt" ], "additionalProperties": false }, "volume": { "type": "object", "properties": { "volume24h": { "type": "number" }, "volume7d": { "type": "number" }, "trades24h": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trades7d": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "volume24h", "volume7d", "trades24h", "trades7d" ], "additionalProperties": false }, "holders": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "yes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "no": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "whale": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "smartMoney": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "insider": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "total", "yes", "no", "whale", "smartMoney", "insider" ], "additionalProperties": false }, "pnl": { "type": "object", "properties": { "total": { "type": "number" }, "yes": { "type": "number" }, "no": { "type": "number" } }, "required": [ "total", "yes", "no" ], "additionalProperties": false }, "traderTypes": { "type": "object", "properties": { "yes": { "type": "object", "properties": { "whales": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "smartMoney": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "whales", "smartMoney" ], "additionalProperties": false }, "no": { "type": "object", "properties": { "whales": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "smartMoney": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "whales", "smartMoney" ], "additionalProperties": false } }, "required": [ "yes", "no" ], "additionalProperties": false }, "topHolders": { "type": "array", "items": { "type": "object", "properties": { "address": { "type": "string" }, "side": { "type": "string", "enum": [ "YES", "NO" ] }, "netSize": { "type": "number" }, "notional": { "type": "number" } }, "required": [ "address", "side", "netSize", "notional" ], "additionalProperties": false } }, "recentTrades": { "type": "array", "items": { "type": "object", "properties": { "tid": { "type": "number" }, "side": { "type": "string", "enum": [ "YES", "NO" ] }, "aggressorSide": { "type": "string" }, "px": { "type": "number" }, "sz": { "type": "number" }, "notional": { "type": "number" }, "fillTs": { "type": "string" }, "txHash": { "type": "string" } }, "required": [ "tid", "side", "aggressorSide", "px", "sz", "notional", "fillTs", "txHash" ], "additionalProperties": false } }, "settlement": { "nullable": true, "type": "object", "properties": { "resolvedAt": { "type": "string" }, "winningSide": { "type": "integer", "minimum": 0, "maximum": 1 }, "settlementPrice": { "type": "number" } }, "required": [ "resolvedAt", "winningSide", "settlementPrice" ], "additionalProperties": false }, "clusterActivity": { "type": "object", "properties": { "distinctClusters": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "distinctClusters" ], "additionalProperties": false } }, "required": [ "outcome", "volume", "holders", "pnl", "traderTypes", "topHolders", "recentTrades", "settlement", "clusterActivity" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/outcomes/{outcomeId}/history": { "get": { "summary": "Outcome price history", "tags": [ "Hyperliquid" ], "description": "Per-outcome time series of the YES-side mid price (= implied probability, 0–1), downsampled from the 15s snapshot capture. `interval` picks the lookback window (1d / 1w / 1m / max ≈ 90d — snapshot TTL); `fidelity` sets the bucket width in minutes (per-interval defaults and floors keep point counts bounded). Each point is the last mid observed in its bucket. Unknown outcomes return an empty series.", "parameters": [ { "schema": { "default": "1d", "type": "string", "enum": [ "1d", "1w", "1m", "max" ] }, "in": "query", "name": "interval", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 1440 }, "in": "query", "name": "fidelity", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "history": { "type": "array", "items": { "type": "object", "properties": { "t": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "p": { "type": "number" } }, "required": [ "t", "p" ], "additionalProperties": false } } }, "required": [ "history" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/outcomes/mids": { "post": { "summary": "Current mids for a batch of outcomes", "tags": [ "Hyperliquid" ], "description": "Freshest captured YES/NO mid prices (15s capture cadence) for up to 200 outcome ids in one request. Outcomes with no snapshot in the last hour are omitted from the map — keep the last-known odds for those. When only one side has a recent snapshot the other is complemented (sides sum to ~1).", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "outcomeIds": { "minItems": 1, "maxItems": 200, "type": "array", "items": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } } }, "required": [ "outcomeIds" ] } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "mids": { "type": "object", "additionalProperties": { "type": "object", "properties": { "yes": { "type": "number" }, "no": { "type": "number" } }, "required": [ "yes", "no" ], "additionalProperties": false } } }, "required": [ "mids" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "markets:read" } }, "/hyperliquid/categories": { "get": { "summary": "Available derived categories", "tags": [ "Hyperliquid" ], "description": "Distinct derived categories across active cards in the question feed, with subCategories and card counts. Derived from the metadata tail on prose descriptions (metadata=category:…|subCategory:…) and instrument class (priceBucket/priceBinary → crypto). Values are lowercased and match the `category`/`subCategory` card fields and the `categories` discover filter.", "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "categories": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string" }, "subCategories": { "type": "array", "items": { "type": "string" } }, "cardCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "category", "subCategories", "cardCount" ], "additionalProperties": false } } }, "required": [ "categories" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/users/{address}/pnl-history": { "get": { "summary": "HIP-4 user daily PnL history", "tags": [ "Hyperliquid" ], "description": "Daily cumulative PnL snapshots for a HL wallet over the last N days. Reads from hl_wallet_stats_daily (one row per address per day, written at 00:30 UTC). Returns an empty history array when the wallet has no snapshots in the requested window.", "parameters": [ { "schema": { "default": 30, "type": "integer", "minimum": 1, "maximum": 365 }, "in": "query", "name": "days", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "days": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 }, "history": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string" }, "realizedPnl": { "type": "number" }, "openPnl": { "type": "number" }, "totalPnl": { "type": "number" }, "totalVolume": { "type": "number" }, "winRate": { "type": "number" }, "portfolioValue": { "type": "number" }, "closedPositionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "activePositionCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "day", "realizedPnl", "openPnl", "totalPnl", "totalVolume", "winRate", "portfolioValue", "closedPositionCount", "activePositionCount" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count" ], "additionalProperties": false } }, "required": [ "address", "days", "history", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 5, "x-required-scope": "traders:read" } }, "/hyperliquid/wallets/{address}/similar": { "get": { "summary": "Behaviorally similar HIP-4 wallets", "tags": [ "Hyperliquid" ], "description": "Top-K HL wallets with the highest Jaccard similarity on shared traded outcome_ids. Reads from hl_wallet_similarity (LSH + exact Jaccard, recomputed daily). Returns an empty list if the wallet has no similarity data yet.", "parameters": [ { "schema": { "default": 20, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "pattern": "^0x[a-fA-F0-9]{40}$" }, "in": "path", "name": "address", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string" }, "similarWallets": { "type": "array", "items": { "type": "object", "properties": { "otherAddress": { "type": "string" }, "jaccardSimilarity": { "type": "number" }, "sharedOutcomes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "computedAt": { "type": "string" } }, "required": [ "otherAddress", "jaccardSimilarity", "sharedOutcomes", "computedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 } }, "required": [ "count", "limit" ], "additionalProperties": false } }, "required": [ "address", "similarWallets", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/questions/trending-tags": { "get": { "summary": "Trending HIP-4 tags (underlying / class / period)", "tags": [ "Hyperliquid" ], "description": "Returns trending HIP-4 metadata tags ranked by 24h volume. HL has no free-form tag list — the taxonomy is the parsed structured outcome metadata (underlying / class / period). Each tag is annotated with its dimension (`type`) and includes outcome counts + 24h volume.", "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "type": { "type": "string", "enum": [ "underlying", "class", "period" ] }, "outcomeCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "volume24h": { "type": "number" }, "uniqueOutcomes": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "name", "type", "outcomeCount", "volume24h", "uniqueOutcomes" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 } }, "required": [ "count", "limit" ], "additionalProperties": false } }, "required": [ "tags", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/cohorts": { "get": { "summary": "HIP-4 trader cohort distribution", "tags": [ "Hyperliquid" ], "description": "Returns trader buckets for the requested cohort type (pnl_tier | size_tier | win_rate_tier) with member counts, total volume, total PnL, average win rate, and cohort share.", "parameters": [ { "schema": { "default": "pnl_tier", "type": "string", "enum": [ "pnl_tier", "size_tier", "win_rate_tier" ] }, "in": "query", "name": "cohort_type", "required": false } ], "responses": { "200": { "description": "Default Response" }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/outcomes/anomalies": { "get": { "summary": "Recent HIP-4 market anomalies", "tags": [ "Hyperliquid" ], "description": "Returns recent anomalies (volume_spike / holder_surge / price_swing) detected by the sync job. Append-only with a 30-day TTL.", "parameters": [ { "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "outcomeId", "required": false }, { "schema": { "type": "string", "enum": [ "volume_spike", "holder_surge", "price_swing" ] }, "in": "query", "name": "anomalyType", "required": false }, { "schema": { "type": "string", "enum": [ "low", "medium", "high" ] }, "in": "query", "name": "severity", "required": false }, { "schema": {}, "in": "query", "name": "since", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "anomalyId": { "type": "string" }, "outcomeId": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "anomalyType": { "type": "string", "enum": [ "volume_spike", "holder_surge", "price_swing" ] }, "severity": { "type": "string", "enum": [ "low", "medium", "high" ] }, "score": { "type": "number" }, "metricName": { "type": "string" }, "baselineValue": { "type": "number" }, "actualValue": { "type": "number" }, "description": { "type": "string" }, "detectedAt": { "type": "string" } }, "required": [ "anomalyId", "outcomeId", "anomalyType", "severity", "score", "metricName", "baselineValue", "actualValue", "description", "detectedAt" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "count", "limit" ], "additionalProperties": false } }, "required": [ "data", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/outcomes/search": { "get": { "summary": "Keyword search across HIP-4 markets", "tags": [ "Hyperliquid" ], "description": "Case-insensitive substring match over active outcome name, question name, and underlying. Ranked by name-prefix match, then earliest match position, then name.", "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 500 }, "in": "query", "name": "q", "required": true }, { "schema": { "default": 10, "type": "integer", "minimum": 1, "maximum": 50 }, "in": "query", "name": "limit", "required": false } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "outcomeId": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" }, "underlying": { "type": "string" }, "similarity": { "type": "number" } }, "required": [ "outcomeId", "name", "underlying", "similarity" ], "additionalProperties": false } }, "query": { "type": "string" }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "data", "query", "count" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 1, "x-required-scope": "markets:read" } }, "/hyperliquid/outcomes/{outcomeId}/intelligence": { "get": { "summary": "AI intelligence summary for a HIP-4 market", "tags": [ "Hyperliquid" ], "description": "Returns the latest LLM-generated summary for an outcome (model, summary, headline, confidence, generation timestamp). Returns 404 when no summary exists yet.", "parameters": [ { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "outcomeId": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "summary": { "type": "string" }, "headline": { "type": "string" }, "confidence": { "type": "number" }, "tokensUsed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "model": { "type": "string" }, "generatedAt": { "type": "string" } }, "required": [ "outcomeId", "summary", "headline", "confidence", "tokensUsed", "model", "generatedAt" ], "additionalProperties": false } }, "required": [ "data" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/outcomes/{outcomeId}/correlated": { "get": { "summary": "Top-K correlated HIP-4 markets", "tags": [ "Hyperliquid" ], "description": "Returns the top-K outcomes whose yes_mid_px is correlated with the given outcome (Pearson, 7-day window). Sorted by |correlation| DESC.", "parameters": [ { "schema": { "default": 10, "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "default": 0.3, "type": "number", "minimum": 0, "maximum": 1 }, "in": "query", "name": "minCorrelation", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "path", "name": "outcomeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "outcomeId": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "correlatedOutcomes": { "type": "array", "items": { "type": "object", "properties": { "outcomeId": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "name": { "type": "string" }, "underlying": { "type": "string" }, "correlation": { "type": "number" }, "sampleCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "windowDays": { "type": "integer", "minimum": 0, "exclusiveMinimum": true, "maximum": 9007199254740991 } }, "required": [ "outcomeId", "name", "underlying", "correlation", "sampleCount", "windowDays" ], "additionalProperties": false } }, "meta": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "limit": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "minCorrelation": { "type": "number" } }, "required": [ "count", "limit", "minCorrelation" ], "additionalProperties": false } }, "required": [ "outcomeId", "correlatedOutcomes", "meta" ], "additionalProperties": false } } } }, "401": { "description": "API key missing, invalid, expired or revoked." }, "403": { "description": "Required key permission is missing or the workspace is disabled." }, "429": { "description": "Workspace credit allowance or request rate exceeded. No overage charges." }, "502": { "description": "The data service could not complete the request. Reserved credits are refunded." }, "503": { "description": "The developer API is not enabled or is temporarily unavailable." } }, "security": [ { "ImplyraApiKey": [] } ], "x-credit-cost": 10, "x-required-scope": "analytics:read" } }, "/hyperliquid/correlations/matrix": { "get": { "summary": "Pairwise correlation matrix for HIP-4 outcomes", "tags": [ "Hyperliquid" ], "description": "Returns canonical-ordered (a