{"openapi":"3.1.0","info":{"title":"Nansen API","description":"Nansen API v1 endpoints","version":"1.0.0"},"paths":{"/api/v1/account":{"get":{"tags":["Account"],"summary":"Get account info","description":"Verify your API key is working and retrieve your account details.\n\nReturns your current subscription plan and total remaining credits. This endpoint does not consume any credits.\n\nUse this to:\n- Confirm your API key is valid and active\n- Check your remaining credit balance before making calls\n- Verify your subscription plan","operationId":"get_account_api_v1_account_get","responses":{"200":{"description":"Account information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":0,"pro":0}}},"/api/v1/smart-money/netflow":{"post":{"tags":["Smart Money"],"summary":"Get Smart Money Netflow Data","description":"Analyze net capital flows (inflows vs outflows) from smart traders and funds across different time periods. This endpoint helps identify which tokens are experiencing net accumulation or distribution by smart money.\n\nWhat are Net Flows?\nNet flows represent the difference between smart money inflows and outflows for a token. This includes:\n\n- DEX Trading Activity: Tokens bought vs sold on decentralized exchanges\n- CEX Transfers: Tokens sent to or received from centralized exchanges\n- Positive Net Flow: Smart money is accumulating (buying more than selling, or withdrawing from CEXs)\n- Negative Net Flow: Smart money is distributing (selling more than buying, or depositing to CEXs)\n\nKey Features:\n\n- Aggregated net flow calculations across all smart money activity\n- Multiple time period analysis (1h, 24h, 7d, 30d)\n- Sortable results by volume metrics\n- Includes both DEX trades and CEX transfers","operationId":"get_smart_money_netflow_api_v1_smart_money_netflow_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyNetflowRequest"}}},"required":true},"responses":{"200":{"description":"Smart money netflow data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyNetflowResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/smart-money/dex-trades":{"post":{"tags":["Smart Money"],"summary":"Get Smart Money DEX Trades Data","description":"Access real-time DEX trading activity from smart traders and funds over the last 24 hours. This endpoint provides granular transaction-level data showing exactly what sophisticated traders are buying and selling on decentralized exchanges.","operationId":"get_smart_money_dex_trades_api_v1_smart_money_dex_trades_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyDexTradesRequest"}}},"required":true},"responses":{"200":{"description":"Smart money DEX trades data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyDexTradesResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/smart-money/perp-trades":{"post":{"tags":["Smart Money"],"summary":"Get Smart Money Perpetual Trades Data","description":"Access real-time perpetual trading activity from smart traders and funds on Hyperliquid. This endpoint provides granular transaction-level data showing exactly what sophisticated traders are trading on perpetual contracts.\n\nKey Features:\n- Hyperliquid perpetual contracts only (no chain field needed)\n- Real-time trading data from smart money wallets\n- Detailed trade information including coin, amount, price, action, and type\n- Smart money filtering capabilities\n- Type filtering (Market/Limit)\n- Only new positions filter to show only position opening trades (defaults to false - shows all trades)","operationId":"get_smart_money_perp_trades_api_v1_smart_money_perp_trades_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyPerpTradesRequest"}}},"required":true},"responses":{"200":{"description":"Smart money perpetual trades data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyPerpTradesResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/smart-money/dcas":{"post":{"tags":["Smart Money"],"summary":"Get Smart Money DCAs Data","description":"Monitor DCA strategies employed by smart money on Solana through Jupiter DCA. This endpoint reveals systematic accumulation strategies used by smart money.","operationId":"get_smart_money_dcas_api_v1_smart_money_dcas_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyDcasRequest"}}},"required":true},"responses":{"200":{"description":"Smart money DCAs data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyDcasResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/smart-money/holdings":{"post":{"tags":["Smart Money"],"summary":"Get Smart Money Holdings Data","description":"Retrieve aggregated token balances held by smart traders and funds across multiple blockchains. This endpoint provides insights into what tokens are being accumulated by sophisticated market participants, excluding whales, large holders, and influencers to focus specifically on trading expertise.\n\nKey Features:\n\n- Aggregated balances (not per-wallet breakdowns)\n- 24-hour balance change tracking updated in realtime\n- Sector categorization for tokens","operationId":"get_smart_money_holdings_api_v1_smart_money_holdings_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyHoldingsRequest"}}},"required":true},"responses":{"200":{"description":"Smart money holdings data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyHoldingsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/smart-money/historical-holdings":{"post":{"tags":["Smart Money"],"summary":"Get Smart Money Historical Holdings Data","description":"Retrieve historical snapshots of aggregated token balances held by smart traders and funds. This endpoint provides time-series data for trend analysis, backtesting, and performance attribution.\n\nKey Features:\n\n- Daily snapshots of smart money holdings\n- Date range filtering (max 4 years lookback)\n- Point-in-time pricing and market cap data\n- Balance change tracking between snapshots\n- Same filtering options as current holdings endpoint\n\nUse Cases:\n\n- Trend Analysis: Track how smart money rotates between assets over time\n- Performance Attribution: Combine with price data to estimate ROI\n- Backtesting: Validate trading strategies based on historical smart money behavior","operationId":"get_smart_money_historical_holdings_api_v1_smart_money_historical_holdings_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyHistoricalHoldingsRequest"}}},"required":true},"responses":{"200":{"description":"Smart money historical holdings data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartMoneyHistoricalHoldingsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/profiler/address/transactions":{"post":{"tags":["Profiler"],"summary":"Get Address Transactions Data","description":"Retrieve recent blockchain transactions for an address including token transfers, native currency movements, and contract interactions.","operationId":"get_profiler_address_transactions_api_v1_profiler_address_transactions_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressTransactionsRequest"}}},"required":true},"responses":{"200":{"description":"Address transaction data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressTransactionsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/transaction-with-token-transfer-lookup":{"post":{"tags":["Profiler"],"summary":"Get Transaction with Token Transfer Lookup Data","description":"Get comprehensive transaction information including token transfers and NFT transfers.\n        This endpoint provides detailed information about a specific transaction including\n        native cryptocurrency movements, token transfers, and NFT transfers with USD values.","operationId":"get_transaction_with_token_transfer_lookup_api_v1_transaction_with_token_transfer_lookup_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionLookupRequest"}}},"required":true},"responses":{"200":{"description":"Transaction lookup data with token and NFT transfer information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionLookupListResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/profiler/address/pnl-summary":{"post":{"tags":["Profiler"],"summary":"Get Address PnL Summary Data","description":"Get aggregate PnL statistics and top profitable tokens for a specific wallet address.\nThis endpoint provides comprehensive profit and loss analysis including realized PnL, win rate, and top performing tokens.","operationId":"get_profiler_address_pnl_summary_api_v1_profiler_address_pnl_summary_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressPnlSummaryRequest"}}},"required":true},"responses":{"200":{"description":"Address PnL summary data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressPnlSummaryResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/profiler/address/current-balance":{"post":{"tags":["Profiler"],"summary":"Get Address Current Balance Data","description":"Retrieve current token holdings for addresses or entities. Returns detailed balance information across specified chains.\n\nWhat it helps to answer:\n\n- Current token holdings with quantities and USD valuations\n- Asset distribution across different blockchain networks\n- Native token versus token balances\n- Stablecoin holdings and percentages\n- Cross-chain portfolio composition\n\nNote: The address field in the response will be empty if entity_name is provided.","operationId":"get_profiler_address_current_balance_api_v1_profiler_address_current_balance_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressBalancesRequest"}}},"required":true},"responses":{"200":{"description":"Address current balance data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressBalancesResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/profiler/address/counterparties":{"post":{"tags":["Profiler"],"summary":"Get Address Counterparties Data","description":"Get top counterparties that wallet addresses have interacted with, supporting different\ngrouping options (wallet or entity) and source filtering (Combined, Tokens, ETH).\nReturns interaction statistics including volume, frequency, and timing data.\n\nWhat it helps to answer:\n\n- Most frequent transaction partners by count and volume\n- Net value flows between addresses (inflows vs outflows)\n- Exchange and protocol interaction patterns\n- DeFi protocol usage and DEX trading counterparties\n- High-value transfer relationships and funding sources","operationId":"get_profiler_address_counterparties_api_v1_profiler_address_counterparties_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressCounterpartiesRequest"}}},"required":true},"responses":{"200":{"description":"Address counterparties data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressCounterpartiesResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/profiler/address/historical-balances":{"post":{"tags":["Profiler"],"summary":"Get Address Historical Balances Data","description":"Track token and native coin balance changes over time for addresses or entities. Provides snapshots at configurable intervals to analyze holding patterns, transaction activity, and portfolio evolution across multiple blockchains.\n\nWhat it helps to answer:\n\n- Portfolio value changes across different time periods\n- Token accumulation and distribution patterns over selected timeframes\n- New positions entered and exited during specific periods","operationId":"get_profiler_address_historical_balances_api_v1_profiler_address_historical_balances_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressHistoricalBalancesRequest"}}},"required":true},"responses":{"200":{"description":"Address historical balances data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressHistoricalBalancesResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/profiler/address/related-wallets":{"post":{"tags":["Profiler"],"summary":"Get Address Related Wallets Data","description":"Get wallets that are related to the input address through various types\nof blockchain interactions and relationships. Returns detailed information\nabout each related wallet including the relationship type, transaction details, and timing information.","operationId":"get_profiler_address_related_wallets_api_v1_profiler_address_related_wallets_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressRelatedWalletsRequest"}}},"required":true},"responses":{"200":{"description":"Address related wallets data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressRelatedWalletsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/profiler/address/pnl":{"post":{"tags":["Profiler"],"summary":"Get Address PnL Data","description":"Calculate profit and loss metrics for a specific address and token. Provides detailed trading performance including realized gains from sales and unrealized gains from current holdings.\n\nWhat it helps to answer:\n\n- Realized profits or losses from completed token sales\n- Unrealized gains or losses on current token holdings\n- Average purchase and sale prices for the token\n- Total return on investment","operationId":"get_profiler_address_pnl_api_v1_profiler_address_pnl_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressPnlRequest"}}},"required":true},"responses":{"200":{"description":"Address PnL data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressPnlResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/profiler/address/labels":{"post":{"tags":["Profiler"],"summary":"Get Address Labels","description":"Get labels for a wallet address. Returns non-premium labels only.\n\nLabels include ENS domains, behavioral labels, DeFi labels, CEX labels, and more.\nPremium labels (smart money, alpha trader) are excluded from this endpoint.\n\nUse /api/v1/profiler/address/premium-labels to get all labels including premium ones.","operationId":"get_profiler_address_labels_api_v1_profiler_address_labels_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressLabelsRequest"}}},"required":true},"responses":{"200":{"description":"Address labels data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressLabelsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":300,"pro":100}}},"/api/v1/profiler/address/premium-labels":{"post":{"tags":["Profiler"],"summary":"Get Address Premium Labels","description":"Get all labels for a wallet address, including premium labels.\n\nReturns all labels including smart money labels, alpha trader labels, and public figure tags\nthat are excluded from the standard /labels endpoint.","operationId":"get_profiler_address_premium_labels_api_v1_profiler_address_premium_labels_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressLabelsRequest"}}},"required":true},"responses":{"200":{"description":"Address labels data (including premium)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProfilerAddressLabelsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":1500,"pro":500}}},"/api/v1/profiler/perp-positions":{"post":{"tags":["Profiler"],"summary":"Get Perpetual Positions Data","description":"Get perpetual positions data for a user by calling the Hyperliquid API directly. This endpoint provides real-time position information including entry price, mark price, PnL, leverage, and other position details.\n\n**What it helps to answer:**\n\n1. **What are the current perpetual positions for a specific user address?**\n2. **What is the unrealized PnL and performance of each position?**\n3. **What are the leverage levels and margin requirements for each position?**\n4. **What are the liquidation prices and risk levels for each position?**","operationId":"get_perp_positions_api_v1_profiler_perp_positions_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpPositionsRequest"}}},"required":true},"responses":{"200":{"description":"Perpetual positions data for the user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpPositionsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/profiler/perp-trades":{"post":{"tags":["Profiler"],"summary":"Get Perpetual Trade Data","description":"Get perpetual trade data for a user. This endpoint provides trade information including trade price, size, side, fees, and other trade details.\n\n**What it helps to answer:**\n\n1. **What are the perpetual trades for a specific user address within a date range?**\n2. **What are the trade prices, sizes, and directions for each trade?**\n3. **What are the trading fees and closed PnL for each trade?**\n4. **What are the order IDs and transaction hashes for trade tracking?**","operationId":"get_perp_trades_api_v1_profiler_perp_trades_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpTradeRequest"}}},"required":true},"responses":{"200":{"description":"Perpetual trade data for the user","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpTradeResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/flows":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Flows Data","description":"Analyze aggregated token flows by holder category over time. Shows hourly snapshots of balances, inflows, and outflows for specific holder groups: smart money, public figures, whales, and exchanges.","operationId":"get_tgm_flows_api_v1_tgm_flows_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMFlowsRequest"}}},"required":true},"responses":{"200":{"description":"TGM flows data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMFlowsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/who-bought-sold":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Who Bought/Sold Data","description":"This endpoint provides an aggregated summary of trade volumes in USD for addresses. It can be used to identify addresses that are net buyers or sellers of a token within a time period.","operationId":"get_tgm_who_bought_sold_api_v1_tgm_who_bought_sold_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMWhoBoughtSoldRequest"}}},"required":true},"responses":{"200":{"description":"TGM who bought/sold data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMWhoBoughtSoldResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/dex-trades":{"post":{"tags":["Token God Mode"],"summary":"Get TGM DEX Trades Data","description":"Access individual DEX trading transactions for a specific token. Shows detailed trade-by-trade data including trader labels, amounts, and prices.","operationId":"get_tgm_dex_trades_api_v1_tgm_dex_trades_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMDexTradesRequest"}}},"required":true},"responses":{"200":{"description":"TGM DEX trades data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMDexTradesResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/transfers":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Transfers Data","description":"Track all token transfer activity including direct transfers, DEX trades, and CEX movements. This endpoint is particularly useful for monitoring exchange flows - both centralized (CEX) and decentralized (DEX) - to identify accumulation or distribution patterns.","operationId":"get_tgm_transfers_api_v1_tgm_transfers_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMTransfersRequest"}}},"required":true},"responses":{"200":{"description":"TGM transfers data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMTransfersResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/holders":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Holders Data","description":"Retrieve the top token holders with their current balances, historical activity, and recent balance changes. Provides insights into token distribution, smart money and fund holdings.\n\n**Performance Optimization for Native Tokens:**\nWhen querying native tokens with `label_type: \"all_holders\"`, this endpoint uses an optimized model to prevent timeouts. This optimization has the following limitations:\n- **Ordering**: Only `token_amount` field is supported\n- **Filters**: Limited to: `token_amount`, `total_outflow`, `total_inflow`, `address`, `include_smart_money_labels`, `exclude_smart_money_labels`\n\nTo use advanced filters and ordering on native tokens, specify a `label_type` other than \"all_holders\" (e.g., \"smart_money\", \"whale\", \"exchange\").\n\n**Label Tier Control (`premium_labels`):**\nThe `premium_labels` parameter is now available to all users. When omitted, it defaults to `true` (premium labels). In a future release, the default will change to `false`. Pass `premium_labels=true` explicitly to preserve premium label behavior.","operationId":"get_tgm_holders_api_v1_tgm_holders_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMHoldersRequest"}}},"required":true},"responses":{"200":{"description":"TGM holders data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMHoldersResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-credit-cost-variants":{"premium_labels=false (default)":{"free":50,"pro":5},"premium_labels=true":{"pro":150}},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/tgm/pnl-leaderboard":{"post":{"tags":["Token God Mode"],"summary":"Get TGM PnL Leaderboard Data","description":"Rank traders by their profit/loss performance for a specific token. Shows both realized profits (from completed trades) and unrealized profits (from current holdings), along with ROI percentages and trading patterns. This endpoint can be used to analyze the realized and unrealized profit for each trader who traded the input token.\n\n**Label Tier Control (`premium_labels`):**\nThe `premium_labels` parameter is now available to all users. When omitted, it defaults to `true` (premium labels). In a future release, the default will change to `false`. Pass `premium_labels=true` explicitly to preserve premium label behavior.","operationId":"get_tgm_pnl_leaderboard_api_v1_tgm_pnl_leaderboard_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPnlLeaderboardRequest"}}},"required":true},"responses":{"200":{"description":"TGM PnL leaderboard data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPnlLeaderboardResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-credit-cost-variants":{"premium_labels=false (default)":{"free":50,"pro":5},"premium_labels=true":{"pro":150}},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/tgm/perp-pnl-leaderboard":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Perp PnL Leaderboard Data","description":"Rank traders by their profit/loss performance for a specific perpetual contract on Hyperliquid. Shows both realized profits (from completed trades) and unrealized profits (from current holdings), along with ROI percentages and trading patterns. This endpoint can be used to analyze the realized and unrealized profit for each trader who traded the input perpetual contract.\n\n**Key Features:**\n- Hyperliquid perpetual contracts only (no chain field needed)\n- Realized and unrealized PnL tracking\n- ROI calculations and trading patterns\n- Position size and balance tracking\n\n**Request Format:**\n- `token_symbol`: Perpetual contract symbol (e.g., \"BTC\", \"ETH\", \"SOL\")\n- `date`: Date range for analysis\n- `filters`: Optional filters for trader addresses, PnL ranges, etc.\n- `pagination`: Page and per_page parameters\n\n**Label Tier Control (`premium_labels`):**\nThe `premium_labels` parameter is now available to all users. When omitted, it defaults to `true` (premium labels). In a future release, the default will change to `false`. Pass `premium_labels=true` explicitly to preserve premium label behavior.","operationId":"get_tgm_perp_pnl_leaderboard_api_v1_tgm_perp_pnl_leaderboard_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPerpPnlLeaderboardRequest"}}},"required":true},"responses":{"200":{"description":"TGM Perp PnL leaderboard data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPerpPnlLeaderboardResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-credit-cost-variants":{"premium_labels=false (default)":{"free":50,"pro":5},"premium_labels=true":{"pro":150}},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/tgm/perp-positions":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Perp Positions Data","description":"Retrieve current perpetual positions for a specific token on Hyperliquid. Shows active positions with detailed metrics including entry price, mark price, leverage, PnL, and liquidation price.\n\n**Key Features:**\n- Hyperliquid perpetual contracts only (no chain field needed)\n- Real-time position tracking with live PnL calculations\n- Leverage and margin information\n- Smart money filtering capabilities\n- Support for both Long and Short positions\n\n**What it helps to answer:**\n\n1. **What are the current perp positions for a specific token?**\n2. **Which addresses have the largest positions by value?**\n3. **What are the unrealized gains/losses on current positions?**\n4. **What leverage levels are traders using?**\n5. **Which smart money wallets are holding positions?**","operationId":"get_tgm_perp_positions_api_v1_tgm_perp_positions_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPerpPositionsRequest"}}},"required":true},"responses":{"200":{"description":"TGM perp positions data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPerpPositionsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/tgm/perp-trades":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Perp Trades Data","description":"Retrieve perpetual trade data for a specific token on Hyperliquid. Shows individual trades with detailed information including trader address, trade side (Long/Short), action type (Add/Reduce/Open/Close), order type (Market/Limit), and trade metrics.\n\n**Key Features:**\n- Hyperliquid perpetual contracts only\n- Smart money filtering capabilities\n- Detailed trade breakdown with parsed action fields\n- Support for both Long and Short position trading\n- Market and Limit order types\n\n**Request Parameters:**\n- `token_symbol`: Token symbol to fetch trades for (e.g., \"BTC\", \"ETH\")\n- `date`: Date range for the trades\n- `filters`: Additional filters for side, action, order_type, etc.\n- `pagination`: Page and per_page parameters","operationId":"get_tgm_perp_trades_api_v1_tgm_perp_trades_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPerpTradesRequest"}}},"required":true},"responses":{"200":{"description":"TGM perp trades data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPerpTradesResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/flow-intelligence":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Flow Intelligence Data","description":"This endpoint provides comprehensive flow intelligence analytics, including inflows, outflows, and net flows for a specific token, broken down by various holder segments (Exchanges, Smart Money, Public Figures, Whales) with time-based statistics and trends. It can be used for identifying accumulation/distribution patterns across different holder segments.","operationId":"get_tgm_flow_intelligence_api_v1_tgm_flow_intelligence_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMFlowIntelligenceRequest"}}},"required":true},"responses":{"200":{"description":"TGM flow intelligence data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMFlowIntelligenceResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/position-intelligence":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Position Intelligence Data","description":"This endpoint provides position intelligence analytics for perpetual contracts on Hyperliquid, showing aggregated position sizes (longs, shorts, and totals) broken down by various trader cohorts (Smart Money, Whales, Top PnL, Public Figures). It can be used for analyzing position distributions and sentiment across different trader segments.","operationId":"get_tgm_position_intelligence_api_v1_tgm_position_intelligence_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPositionIntelligenceRequest"}}},"required":true},"responses":{"200":{"description":"TGM position intelligence data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMPositionIntelligenceResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/token-information":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Token Information Data","description":"Get comprehensive token information including basic details (name, symbol, contract address, logo), token details (deployment date, social links, market metrics like market cap and FDV), and spot trading metrics (volume, buys/sells, unique traders, liquidity, holders).\n\nThis endpoint provides a complete overview of a token's metadata, market position, and trading activity for a specific date range.","operationId":"get_tgm_token_information_api_v1_tgm_token_information_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMTokenInformationRequest"}}},"required":true},"responses":{"200":{"description":"TGM token information data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMTokenInformationResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/indicators":{"post":{"tags":["Token God Mode"],"summary":"Get Nansen Score Indicators","description":"Get risk and reward indicators for a specific token.\n\nReturns two groups of indicators:\n- **risk_indicators**: Metrics for assessing token risk (btc-reflexivity, liquidity-risk, concentration-risk, token-supply-inflation)\n- **reward_indicators**: Metrics for assessing alpha potential (chain-tvl, trading-range, price-momentum, chain-fees, protocol-fees, cex-flows, funding-rate)\n\nEach indicator includes:\n- **score**: Summary assessment ('low'/'medium'/'high' for risk, 'bearish'/'neutral'/'bullish' for reward)\n- **signal**: Raw metric value\n- **signal_percentile**: Percentile rank (0-100) vs tokens in same market cap group\n- **last_trigger_on**: When the indicator last changed state","operationId":"get_tgm_indicators_api_v1_tgm_indicators_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMIndicatorsRequest"}}},"required":true},"responses":{"200":{"description":"Nansen score indicators data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMIndicatorsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/tgm/token-ohlcv":{"post":{"tags":["Token God Mode"],"summary":"Get Token OHLCV Data","description":"Get unified OHLCV (Open, High, Low, Close, Volume) data for tokens across supported chains.\n\nThis endpoint unifies the legacy TGM prices endpoints (`/tgm/prices/low-timeframe` and `/tgm/prices/high-timeframe`)\ninto a single endpoint with support for multiple timeframes:\n\n**Low timeframes** (sub-hourly): `1m`, `5m`, `15m`, `30m`, `1h`\n**High timeframes** (multi-hour): `4h`, `1d`, `1w`, `1M`\n\nReturns OHLCV candle data including:\n- **Price data**: open, high, low, close prices\n- **Volume data**: trading volume in token units and USD\n- **Market cap data**: market capitalization at each time point\n\nDate range defaults to the last 30 days if not specified.","operationId":"get_token_ohlcv_api_v1_tgm_token_ohlcv_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenOHLCVRequest"}}},"required":true},"responses":{"200":{"description":"Token OHLCV data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenOHLCVResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/tgm/jup-dca":{"post":{"tags":["Token God Mode"],"summary":"Get TGM Jupiter DCA Data","description":"This endpoint provides Jupiter DCA orders with stats per vault for a specific token.\nJupiter DCA (Dollar Cost Averaging) is only available on Solana and allows users to automate token purchases over time. Returns comprehensive data about DCA vaults including deposit amounts, redemption status, and trader information.","operationId":"get_tgm_jup_dca_api_v1_tgm_jup_dca_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMJupDcaRequest"}}},"required":true},"responses":{"200":{"description":"TGM Jupiter DCA data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TGMJupDcaResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/token-screener":{"post":{"tags":["Token Screener"],"summary":"Get Token Screening Data","description":"Discover and screen tokens across multiple blockchains with advanced filtering capabilities. This endpoint helps identify trending tokens, new launches, and smart money movements by combining metrics like volume, liquidity, market cap, and trading activity.\n\n**What it helps to answer:**\n\n1. **Which tokens are experiencing significant smart money activity across different chains?**\n2. **How do market metrics (price, volume, liquidity) correlate with holder behavior and smart money movements?**\n3. **What tokens show strong fundamentals in terms of holder distribution and trading patterns?**\n4. **Which emerging tokens are attracting fresh wallet inflows while maintaining healthy smart money participation?**","operationId":"get_token_screener_api_v1_token_screener_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenScreenerRequest"}}},"required":true},"responses":{"200":{"description":"Token screening data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenScreenerResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/perp-screener":{"post":{"tags":["Token Screener"],"summary":"Get Perpetual Contract Screening Data","description":"Discover and screen perpetual contracts on Hyperliquid with advanced filtering capabilities. This endpoint helps identify trending perpetual contracts, trading activity, funding rates, and smart money movements by combining metrics like volume, open interest, funding rates, and position data.\n\n**What it helps to answer:**\n\n1. **Which perpetual contracts are experiencing significant trading volume and activity?**\n2. **How do funding rates correlate with trading patterns and smart money positions?**\n3. **What perpetual contracts show strong fundamentals in terms of open interest and trading patterns?**\n4. **Which perpetual contracts are attracting smart money participation with long/short positions?**","operationId":"get_perp_screener_api_v1_perp_screener_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpScreenerRequest"}}},"required":true},"responses":{"200":{"description":"Perpetual contract screening data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpScreenerResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/portfolio/defi-holdings":{"post":{"tags":["Portfolio"],"summary":"Get Portfolio DeFi Holdings Data","description":"Get simplified DeFi holdings for a wallet address with aggregated tokens\n        and protocol summaries in a user-friendly format.","operationId":"portfolio_defi_holdings_v1_api_v1_portfolio_defi_holdings_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioDefiHoldingsRequest"}}},"required":true},"responses":{"200":{"description":"Portfolio DeFi holdings data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortfolioDefiHoldingsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1}}},"/api/v1/search/token-sectors":{"get":{"tags":["Search"],"summary":"Get Available Token Sectors","description":"Get all available token sectors that can be used to filter tokens in the token-screener and other endpoints.\n\nThis endpoint returns the list of valid sector values that can be used in the `token_sector` filter parameter. Sectors are categories that describe a token's primary use case or market segment (e.g., \"Artificial Intelligence\", \"DeFi Lending\", \"Memecoin\").\n\n**Key Features:**\n- Returns all sectors with 50+ tokens (filters out niche/one-off AI-generated sectors)\n- Results are ordered alphabetically\n- No parameters required\n- Free endpoint (0 credits)\n\n**Example Response:**\n```json\n{\n  \"data\": [\n    {\"sector\": \"AI Agents\"},\n    {\"sector\": \"Artificial Intelligence\"},\n    {\"sector\": \"DeFi Lending (Money Markets)\"},\n    {\"sector\": \"GameFi\"},\n    {\"sector\": \"Memecoin\"}\n  ]\n}\n```\n\n**Use Cases:**\n1. **Discover filter options**: Get valid sector values before calling token-screener\n2. **Build UI filters**: Populate dropdown menus with available sectors\n3. **Validate input**: Check if a sector value is valid before making API calls","operationId":"get_token_sectors_api_v1_search_token_sectors_get","responses":{"200":{"description":"List of available token sectors","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenSectorsResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":0}}},"/api/v1/search/general":{"post":{"tags":["Search"],"summary":"General Search","description":"Search for tokens and entities by name, symbol, or contract address. This endpoint provides a unified search experience across all Nansen data.\n\n**Use Cases:**\n1. **Find token addresses**: Search by name or symbol to get contract addresses (e.g., \"AAVE\", \"Uniswap\")\n2. **Discover entities**: Find known entities like exchanges, funds, and public figures (e.g., \"vitalik\", \"Binance\")\n3. **Resolve addresses**: Search by contract address to identify tokens\n4. **Filter by chain**: Narrow down results to specific blockchains\n\n**Search Parameters:**\n- `search_query`: Token name, symbol, contract address, or entity name\n- `result_type`: Filter by \"token\", \"entity\", or \"any\" (default: \"any\")\n- `chain`: Optional blockchain filter (e.g., \"ethereum\", \"solana\", \"base\")\n- `limit`: Maximum results (1-50, default: 25)\n\n**Example Request:**\n```json\n{\n  \"search_query\": \"AAVE\",\n  \"result_type\": \"token\",\n  \"chain\": \"ethereum\"\n}\n```\n\n**Example Response:**\n```json\n{\n  \"tokens\": [\n    {\n      \"name\": \"Aave\",\n      \"symbol\": \"AAVE\",\n      \"chain\": \"ethereum\",\n      \"address\": \"0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9\",\n      \"price\": 123.45,\n      \"volume_24h\": 50000000,\n      \"market_cap\": 1500000000,\n      \"rank\": 25\n    }\n  ],\n  \"entities\": [],\n  \"total_results\": 1\n}\n```\n\n**Important Notes:**\n- Prices may be delayed; use token OHLCV endpoints for real-time prices\n- Results are sorted by relevance/popularity rank\n- Use the `chain` parameter (not the query string) to filter by blockchain","operationId":"general_search_api_v1_search_general_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSearchRequest"}}},"required":true},"responses":{"200":{"description":"Search results with tokens and entities","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GeneralSearchResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":0,"pro":0}}},"/api/v1/perp-leaderboard":{"post":{"tags":["Perp Leaderboard"],"summary":"Get Perpetual Trading Leaderboard Data","description":"Get perpetual trading leaderboard data showing the most profitable traders within a given date range. This endpoint provides trader performance metrics including total PnL, ROI, and account values.\n\n**What it helps to answer:**\n\n1. **Who are the most profitable perpetual traders in a given timeframe?**\n2. **What are the ROI percentages for top performing traders?**\n3. **What are the account values of successful perpetual traders?**\n4. **How do trader addresses and labels correlate with performance?**\n\n**Key Features:**\n- Trader address and label information\n- Total PnL tracking in USD\n- ROI calculations as percentages\n- Account value tracking\n- Flexible filtering and sorting options","operationId":"get_perp_leaderboard_api_v1_perp_leaderboard_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpLeaderboardRequest"}}},"required":true},"responses":{"200":{"description":"Perpetual trading leaderboard data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PerpLeaderboardResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-credit-cost-variants":{"premium_labels=false (default)":{"free":50,"pro":5},"premium_labels=true":{"pro":150}},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/prediction-market/ohlcv":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market OHLCV Candles","description":"Get 1-hour OHLCV (Open, High, Low, Close, Volume) candles for a Polymarket\nprediction market. Candles are computed from on-chain OrderFilled events on Polygon.\n\n**What it helps to answer:**\n\n1. **What is the price history of a prediction market outcome?**\n2. **How has trading volume changed over time?**\n3. **What were the high and low prices in each time period?**","operationId":"get_prediction_market_ohlcv_api_v1_prediction_market_ohlcv_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OhlcvRequest"}}},"required":true},"responses":{"200":{"description":"OHLCV candle data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OhlcvResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/prediction-market/orderbook":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market Orderbook","description":"Get the full bid/ask orderbook for a Polymarket prediction market. Data is\npolled from the Polymarket CLOB API every ~60 seconds with MD5 change detection.\n\n**What it helps to answer:**\n\n1. **What is the current bid/ask depth for a prediction market?**\n2. **How much liquidity is available at each price level?**\n3. **What is the current spread?**","operationId":"get_prediction_market_orderbook_api_v1_prediction_market_orderbook_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderbookRequest"}}},"required":true},"responses":{"200":{"description":"Orderbook data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderbookResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/prediction-market/top-holders":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market Top Holders","description":"Get the largest position holders for a Polymarket prediction market. Positions are\ncomputed from on-chain ERC-1155 token transfers on Polygon, with SAFE proxy wallet\nresolution to identify actual users.\n\n**What it helps to answer:**\n\n1. **Who are the biggest holders in this prediction market?**\n2. **What are the position sizes and entry prices of top holders?**\n3. **What is the unrealized PnL of major positions?**\n4. **Are whales positioned Yes or No?**","operationId":"get_prediction_market_top_holders_api_v1_prediction_market_top_holders_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopHoldersRequest"}}},"required":true},"responses":{"200":{"description":"Top holder data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TopHoldersResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/prediction-market/trades-by-market":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market Trades by Market","description":"Get recent trades for a Polymarket prediction market. Trades are decoded from\non-chain OrderFilled events on Polygon, joined with market metadata.\n\n**What it helps to answer:**\n\n1. **What are the most recent trades in this market?**\n2. **Who is buying and selling, and at what prices?**\n3. **What is the trade size distribution?**","operationId":"get_prediction_market_trades_by_market_api_v1_prediction_market_trades_by_market_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TradesByMarketRequest"}}},"required":true},"responses":{"200":{"description":"Trade data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TradesByMarketResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/prediction-market/market-screener":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market Screener","description":"Browse and filter all Polymarket prediction markets. Supports sorting by volume,\nliquidity, price change, and more. Filter by search query and active/closed status.\n\n**What it helps to answer:**\n\n1. **What are the most active prediction markets right now?**\n2. **Which markets have the highest volume or liquidity?**\n3. **What new markets have been created recently?**","operationId":"get_prediction_market_screener_api_v1_prediction_market_market_screener_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketScreenerRequest"}}},"required":true},"responses":{"200":{"description":"Market screener data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketScreenerResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/prediction-market/event-screener":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market Event Screener","description":"Browse and filter Polymarket events (groups of related markets). Includes aggregated\nvolume, liquidity, and trader counts across all markets in each event.\n\n**What it helps to answer:**\n\n1. **What are the most popular prediction market events?**\n2. **How much total volume does an event have across all its markets?**\n3. **Which events have the most active trading?**","operationId":"get_prediction_market_event_screener_api_v1_prediction_market_event_screener_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventScreenerRequest"}}},"required":true},"responses":{"200":{"description":"Event screener data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventScreenerResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/prediction-market/pnl-by-market":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market PnL by Market","description":"Get profit and loss breakdown for all traders in a specific prediction market.\nIncludes buy cost, sell proceeds, redemption values, and unrealized positions.\n\n**What it helps to answer:**\n\n1. **Who are the biggest winners and losers in this market?**\n2. **What is the PnL distribution across traders?**\n3. **How much unrealized value exists in open positions?**","operationId":"get_prediction_market_pnl_by_market_api_v1_prediction_market_pnl_by_market_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PnlByMarketRequest"}}},"required":true},"responses":{"200":{"description":"PnL by market data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PnlByMarketResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/prediction-market/pnl-by-address":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market PnL by Address","description":"Get profit and loss across all prediction markets for a specific wallet address.\nShows per-market PnL including buy costs, sell proceeds, and redemption values.\n\n**What it helps to answer:**\n\n1. **What is a trader's total PnL across all prediction markets?**\n2. **Which markets has this address traded, and what were the results?**\n3. **Does this trader have unrealized positions?**","operationId":"get_prediction_market_pnl_by_address_api_v1_prediction_market_pnl_by_address_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PnlByAddressRequest"}}},"required":true},"responses":{"200":{"description":"PnL by address data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PnlByAddressResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/prediction-market/position-detail":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market Position Detail","description":"Get detailed per-token position data for all holders in a specific prediction market.\nIncludes token balances, entry prices, current prices, and per-token PnL.\n\n**What it helps to answer:**\n\n1. **What are the exact positions of each holder in this market?**\n2. **What is the average entry price vs current price for each position?**\n3. **How much has each token position gained or lost?**","operationId":"get_prediction_market_position_detail_api_v1_prediction_market_position_detail_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositionDetailRequest"}}},"required":true},"responses":{"200":{"description":"Position detail data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PositionDetailResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":50,"pro":5},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.05"}}},"/api/v1/prediction-market/trades-by-address":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market Trades by Address","description":"Get all trades for a specific wallet address across all prediction markets.\nTrades are decoded from on-chain OrderFilled events on Polygon.\n\n**What it helps to answer:**\n\n1. **What trades has this address made on Polymarket?**\n2. **When did this trader buy or sell, and at what prices?**\n3. **What markets has this address been active in?**","operationId":"get_prediction_market_trades_by_address_api_v1_prediction_market_trades_by_address_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TradesByAddressRequest"}}},"required":true},"responses":{"200":{"description":"Trade data by address","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TradesByAddressResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/prediction-market/categories":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market Categories","description":"Get aggregated statistics for all prediction market categories. Shows volume,\nopen interest, and top markets per category.\n\n**What it helps to answer:**\n\n1. **Which prediction market categories have the most activity?**\n2. **What is the volume breakdown by category?**\n3. **What are the top markets in each category?**","operationId":"get_prediction_market_categories_api_v1_prediction_market_categories_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesRequest"}}},"required":true},"responses":{"200":{"description":"Category data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoriesResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/prediction-market/address-summary":{"post":{"tags":["Prediction Markets"],"summary":"Get Prediction Market Address Summary","description":"Get wallet-level PnL summary for a single Polymarket trader.\nReturns realized PnL, unrealized PnL, win rate, and wallet age.\n\n**What it helps to answer:**\n\n1. **What is this trader's overall Polymarket performance?**\n2. **How many markets has this trader won vs traded?**\n3. **How old is this wallet and when did it start trading?**","operationId":"get_prediction_market_address_summary_api_v1_prediction_market_address_summary_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressSummaryRequest"}}},"required":true},"responses":{"200":{"description":"Address summary data","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddressSummaryResponse"}}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":10,"pro":1},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$0.01"}}},"/api/v1/agent/fast":{"post":{"tags":["Agent"],"summary":"Fast Research Agent","description":"Ask the Nansen AI agent a research question and receive a streamed answer backed by on-chain data. The **fast** variant uses a lighter model optimised for low-latency responses.\n\n**What it helps to answer:**\n\n1. **Which tokens are smart money accumulating right now?**\n2. **What is the current narrative driving activity in DeFi?**\n3. **Which wallets are connected to a specific address?**\n4. **What is the on-chain story behind a recent price move?**\n\n**SSE event types:**\n\nThe response is a `text/event-stream` with the following JSON event types:\n\n| type | payload | description |\n|---|---|---|\n| `delta` | `{\"type\": \"delta\", \"text\": \"…\"}` | Incremental text chunk of the agent's answer. |\n| `tool_call` | `{\"type\": \"tool_call\", \"name\": \"…\"}` | Emitted once per unique Nansen tool the agent invokes. |\n| `finish` | `{\"type\": \"finish\", \"conversation_id\": \"…\", \"tool_calls\": [...]}` | Final event. Contains the `conversation_id` for follow-up requests and the full list of tools used. |\n| `error` | `{\"type\": \"error\", \"error\": \"…\", \"status_code\": …}` | Emitted if the upstream agent service is unavailable or times out. |\n\nThe stream terminates with a `data: [DONE]` sentinel.\n\n**Fast vs Expert:** Use `/agent/fast` for quick factual lookups and simple questions. Use `/agent/expert` when you need deeper multi-step analysis or synthesis across multiple data sources.","operationId":"agent_fast_api_v1_agent_fast_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentResearchRequest"}}},"required":true},"responses":{"200":{"description":"Server-Sent Events stream. Each event is a `data: {json}` line. See endpoint description for event schema.","content":{"application/json":{"schema":{}},"text/event-stream":{}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":2000,"pro":200},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$2.00"}}},"/api/v1/agent/expert":{"post":{"tags":["Agent"],"summary":"Expert Research Agent","description":"Ask the Nansen AI agent a research question and receive a streamed answer backed by on-chain data. The **expert** variant uses a more capable model for deeper, multi-step analysis.\n\n**What it helps to answer:**\n\n1. **Which tokens are smart money accumulating right now?**\n2. **What is the current narrative driving activity in DeFi?**\n3. **Which wallets are connected to a specific address?**\n4. **What is the on-chain story behind a recent price move?**\n\n**SSE event types:**\n\nThe response is a `text/event-stream` with the following JSON event types:\n\n| type | payload | description |\n|---|---|---|\n| `delta` | `{\"type\": \"delta\", \"text\": \"…\"}` | Incremental text chunk of the agent's answer. |\n| `tool_call` | `{\"type\": \"tool_call\", \"name\": \"…\"}` | Emitted once per unique Nansen tool the agent invokes. |\n| `finish` | `{\"type\": \"finish\", \"conversation_id\": \"…\", \"tool_calls\": [...]}` | Final event. Contains the `conversation_id` for follow-up requests and the full list of tools used. |\n| `error` | `{\"type\": \"error\", \"error\": \"…\", \"status_code\": …}` | Emitted if the upstream agent service is unavailable or times out. |\n\nThe stream terminates with a `data: [DONE]` sentinel.\n\n**Fast vs Expert:** Use `/agent/fast` for quick factual lookups and simple questions. Use `/agent/expert` when you need deeper multi-step analysis or synthesis across multiple data sources.","operationId":"agent_expert_api_v1_agent_expert_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentResearchRequest"}}},"required":true},"responses":{"200":{"description":"Server-Sent Events stream. Each event is a `data: {json}` line. See endpoint description for event schema.","content":{"application/json":{"schema":{}},"text/event-stream":{}},"headers":{"X-Nansen-Credits-Used":{"$ref":"#/components/headers/XNansenCreditsUsed"},"X-Nansen-Credits-Remaining":{"$ref":"#/components/headers/XNansenCreditsRemaining"},"RateLimit-Limit":{"$ref":"#/components/headers/RateLimitLimit"},"RateLimit-Remaining":{"$ref":"#/components/headers/RateLimitRemaining"},"RateLimit-Reset":{"$ref":"#/components/headers/RateLimitReset"},"X-RateLimit-Limit-Second":{"$ref":"#/components/headers/XRateLimitLimitSecond"},"X-RateLimit-Remaining-Second":{"$ref":"#/components/headers/XRateLimitRemainingSecond"},"X-RateLimit-Limit-Minute":{"$ref":"#/components/headers/XRateLimitLimitMinute"},"X-RateLimit-Remaining-Minute":{"$ref":"#/components/headers/XRateLimitRemainingMinute"}}},"400":{"description":"Bad Request","$ref":"#/components/responses/BadRequestError"},"401":{"description":"Unauthorized","$ref":"#/components/responses/UnauthorizedError"},"402":{"description":"Payment Required","$ref":"#/components/responses/PaymentRequiredError"},"403":{"description":"Forbidden","$ref":"#/components/responses/ForbiddenError"},"404":{"description":"Not Found","$ref":"#/components/responses/NotFoundError"},"429":{"description":"Too Many Requests","$ref":"#/components/responses/TooManyRequestsError"},"422":{"description":"Unprocessable Entity","$ref":"#/components/responses/ValidationError"},"500":{"description":"Internal Server Error","$ref":"#/components/responses/InternalServerError"}},"x-credit-cost":{"free":7500,"pro":750},"x-payment-info":{"protocols":["x402"],"pricingMode":"fixed","price":"$7.50"}}}},"components":{"schemas":{"AccountResponse":{"properties":{"plan":{"type":"string","title":"Plan"},"credits_remaining":{"type":"integer","title":"Credits Remaining"}},"type":"object","required":["plan","credits_remaining"],"title":"AccountResponse"},"AddressSummaryItem":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Trader address (hex)"},"first_seen":{"anyOf":[{"type":"string","format":"date"}],"title":"First Seen","description":"Date of first on-chain activity on Polygon"},"wallet_age_days":{"anyOf":[{"type":"integer"}],"title":"Wallet Age Days","description":"Days since first on-chain activity"},"realized_pnl_usd":{"anyOf":[{"type":"number"}],"title":"Realized Pnl Usd","description":"Realized PnL in USD"},"unrealized_pnl_usd":{"anyOf":[{"type":"number"}],"title":"Unrealized Pnl Usd","description":"Unrealized PnL from open positions in USD"},"total_pnl_usd":{"anyOf":[{"type":"number"}],"title":"Total Pnl Usd","description":"Total PnL (realized + unrealized) in USD"},"markets_won":{"anyOf":[{"type":"integer"}],"title":"Markets Won","description":"Number of markets with positive total PnL"},"markets_traded":{"anyOf":[{"type":"integer"}],"title":"Markets Traded","description":"Total number of markets with fills"},"win_rate":{"anyOf":[{"type":"number"}],"title":"Win Rate","description":"Win rate (markets_won / markets_traded, 0-1)"},"p2p_tokens_sent":{"anyOf":[{"type":"number"}],"title":"P2P Tokens Sent","description":"Total tokens sent via P2P transfers"},"p2p_tokens_received":{"anyOf":[{"type":"number"}],"title":"P2P Tokens Received","description":"Total tokens received via P2P transfers"}},"type":"object","title":"AddressSummaryItem","description":"Address summary data from ch_api_pm_address_summary."},"AddressSummaryRequest":{"properties":{"address":{"type":"string","maxLength":100,"minLength":1,"title":"Address","description":"Wallet address (hex, with or without 0x prefix)","examples":["0x1234567890abcdef1234567890abcdef12345678"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"}},"additionalProperties":false,"type":"object","required":["address"],"title":"AddressSummaryRequest","description":"Request for address summary endpoint."},"AddressSummaryResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/AddressSummaryItem"},"type":"array","title":"Data","description":"Address summary (single row)"}},"type":"object","required":["data"],"title":"AddressSummaryResponse","description":"Response for address summary endpoint."},"AgentResearchRequest":{"properties":{"text":{"type":"string","minLength":1,"title":"Text","description":"Research query or question for the Nansen AI agent.","examples":["Which tokens are whales accumulating on Ethereum this week?"]},"conversation_id":{"anyOf":[{"type":"string"}],"title":"Conversation Id","description":"Optional conversation ID for multi-turn interactions. Returned in the finish event of a previous response. Omit to start a new conversation.","examples":["conv_abc123"]}},"type":"object","required":["text"],"title":"AgentResearchRequest","description":"Request model for Agent Research endpoints (fast and expert)."},"AssetPosition":{"properties":{"position":{"anyOf":[{"$ref":"#/components/schemas/Position"}],"description":"Position data"},"position_type":{"anyOf":[{"type":"string"}],"title":"Position Type","description":"Position type","examples":["oneWay"]}},"additionalProperties":false,"type":"object","title":"AssetPosition","description":"Asset position wrapper."},"BaseNansenScoreTopTokensRequest":{"properties":{"limit":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Limit","description":"Maximum number of tokens to return (1-1000)","default":25,"examples":[25,50,10]},"market_cap_group":{"anyOf":[{"$ref":"#/components/schemas/MarketCapGroup"}],"description":"Filter by market cap category: lowcap (<100M), midcap (100M-1B), largecap (>1B)","examples":["largecap","midcap","lowcap"]}},"additionalProperties":false,"type":"object","title":"BaseNansenScoreTopTokensRequest","description":"Shared request model for Nansen Score Top Tokens endpoints."},"CategoriesRequest":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationRequest"}},"additionalProperties":false,"type":"object","title":"CategoriesRequest","description":"Request for categories endpoint (pagination only).","examples":[{"pagination":{"page":1,"per_page":10}}]},"CategoriesResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/CategoryItem"},"type":"array","title":"Data","description":"List of category records"}},"type":"object","required":["data"],"title":"CategoriesResponse","description":"Response for categories endpoint."},"CategoryItem":{"properties":{"category":{"type":"string","title":"Category","description":"Category name","examples":["Politics"]},"active_markets":{"anyOf":[{"type":"integer"}],"title":"Active Markets","description":"Number of active markets"},"total_open_interest":{"anyOf":[{"type":"number"}],"title":"Total Open Interest","description":"Total open interest (USD)"},"total_volume":{"anyOf":[{"type":"number"}],"title":"Total Volume","description":"Total volume (USD)"},"total_volume_24hr":{"anyOf":[{"type":"number"}],"title":"Total Volume 24Hr","description":"Total 24h volume (USD)"},"total_volume_1wk":{"anyOf":[{"type":"number"}],"title":"Total Volume 1Wk","description":"Total 1 week volume (USD)"},"total_traders_24h":{"anyOf":[{"type":"integer"}],"title":"Total Traders 24H","description":"Total unique traders in 24h"},"top_market_id":{"anyOf":[{"type":"string"}],"title":"Top Market Id","description":"Top market by 24h volume"},"top_market_question":{"anyOf":[{"type":"string"}],"title":"Top Market Question","description":"Top market question"},"top_market_volume_24hr":{"anyOf":[{"type":"number"}],"title":"Top Market Volume 24Hr","description":"Top market 24h volume"}},"type":"object","required":["category"],"title":"CategoryItem","description":"Category data from ch_api_pm_categories."},"CreateCreditBalanceRequest":{"properties":{"user_id":{"type":"string","title":"User Id"},"purchase_id":{"type":"string","title":"Purchase Id"},"credits":{"type":"integer","exclusiveMinimum":0.0,"title":"Credits"},"expiry_date":{"anyOf":[{"type":"string","format":"date-time"}],"title":"Expiry Date"}},"type":"object","required":["user_id","purchase_id","credits"],"title":"CreateCreditBalanceRequest"},"CreateCreditBalanceResponse":{"properties":{"balance_id":{"type":"string","title":"Balance Id"},"user_id":{"type":"string","title":"User Id"},"credits":{"type":"integer","title":"Credits"},"expiry_date":{"type":"string","title":"Expiry Date"}},"type":"object","required":["balance_id","user_id","credits","expiry_date"],"title":"CreateCreditBalanceResponse"},"DateOnlyRange":{"properties":{"from":{"anyOf":[{"type":"string"}],"title":"From","description":"Start date in YYYY-MM-DD format","examples":["2025-01-01"]},"to":{"anyOf":[{"type":"string"}],"title":"To","description":"End date in YYYY-MM-DD format","examples":["2025-01-31"]}},"type":"object","title":"DateOnlyRange","description":"Date range model that only accepts YYYY-MM-DD format (no time components)."},"DateRange":{"properties":{"from":{"anyOf":[{"type":"string"}],"title":"From","description":"Start date in ISO 8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01)","examples":["2025-01-01T00:00:00Z"]},"to":{"anyOf":[{"type":"string"}],"title":"To","description":"End date in ISO 8601 format (e.g., 2025-01-31T23:59:59Z or 2025-01-31)","examples":["2025-01-31T23:59:59Z"]}},"type":"object","title":"DateRange","description":"Date range model matching the API schema."},"DateRangeFilter":{"properties":{"from":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"From","description":"Start date (inclusive), ISO 8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01)","examples":["2025-01-01T00:00:00Z"]},"to":{"anyOf":[{"type":"string","format":"date-time"},{"type":"string"},{"type":"null"}],"title":"To","description":"End date (inclusive), ISO 8601 format (e.g., 2025-01-31T23:59:59Z or 2025-01-31)","examples":["2025-01-31T23:59:59Z"]}},"type":"object","title":"DateRangeFilter","description":"Filter for date ranges with optional from/to bounds. - Date range"},"DateRangeMaxOneYear":{"properties":{"from":{"anyOf":[{"type":"string"}],"title":"From","description":"Start date in ISO 8601 format (e.g., 2025-01-01T00:00:00Z or 2025-01-01)","examples":["2025-01-01T00:00:00Z"]},"to":{"anyOf":[{"type":"string"}],"title":"To","description":"End date in ISO 8601 format (e.g., 2025-01-31T23:59:59Z or 2025-01-31)","examples":["2025-01-31T23:59:59Z"]}},"type":"object","title":"DateRangeMaxOneYear","description":"Date range model with a maximum duration of 1 year.\n\nInherits all functionality from DateRange but adds validation to ensure\nthe date range does not exceed 366 days (to account for leap years).\n\nThis limit ensures optimal query performance."},"EntitySearchResult":{"properties":{"name":{"type":"string","title":"Name","description":"Entity name"},"tags":{"items":{"type":"string"},"type":"array","title":"Tags","description":"Category tags for the entity","default":[]},"rank":{"anyOf":[{"type":"integer"}],"title":"Rank","description":"Popularity/relevance rank (lower is better)"}},"type":"object","required":["name"],"title":"EntitySearchResult","description":"An entity result from general search."},"EventScreenerItem":{"properties":{"event_id":{"type":"string","title":"Event Id","description":"Event ID"},"event_title":{"anyOf":[{"type":"string"}],"title":"Event Title","description":"Event title"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"}],"title":"Tags","description":"Event tags"},"neg_risk":{"anyOf":[{"type":"boolean"}],"title":"Neg Risk","description":"Uses neg-risk framework"},"market_count":{"anyOf":[{"type":"integer"}],"title":"Market Count","description":"Number of markets"},"total_volume":{"anyOf":[{"type":"number"}],"title":"Total Volume","description":"Total volume (USD)"},"total_volume_24hr":{"anyOf":[{"type":"number"}],"title":"Total Volume 24Hr","description":"Total 24h volume (USD)"},"total_volume_1wk":{"anyOf":[{"type":"number"}],"title":"Total Volume 1Wk","description":"Total 1 week volume (USD)"},"total_volume_1mo":{"anyOf":[{"type":"number"}],"title":"Total Volume 1Mo","description":"Total 1 month volume (USD)"},"total_liquidity":{"anyOf":[{"type":"number"}],"title":"Total Liquidity","description":"Total liquidity (USD)"},"total_open_interest":{"anyOf":[{"type":"number"}],"title":"Total Open Interest","description":"Total open interest (USD)"},"total_volume_change_pct":{"anyOf":[{"type":"number"}],"title":"Total Volume Change Pct","description":"Total volume change percentage"},"total_traders_24h":{"anyOf":[{"type":"integer"}],"title":"Total Traders 24H","description":"Total unique traders in 24h"},"max_age_hours":{"anyOf":[{"type":"number"}],"title":"Max Age Hours","description":"Max market age in hours"},"top_market_id":{"anyOf":[{"type":"string"}],"title":"Top Market Id","description":"Top market by 24h volume"},"top_market_question":{"anyOf":[{"type":"string"}],"title":"Top Market Question","description":"Top market question"},"top_market_volume_24hr":{"anyOf":[{"type":"number"}],"title":"Top Market Volume 24Hr","description":"Top market 24h volume"},"markets":{"anyOf":[{"items":{"$ref":"#/components/schemas/EventScreenerMarket"},"type":"array"}],"title":"Markets","description":"Nested market data"}},"type":"object","required":["event_id"],"title":"EventScreenerItem","description":"Event screener data from ch_api_pm_event_screener."},"EventScreenerMarket":{"properties":{"market_id":{"type":"string","title":"Market Id"},"question":{"type":"string","title":"Question"},"volume_24hr":{"anyOf":[{"type":"number"}],"title":"Volume 24Hr"},"open_interest":{"anyOf":[{"type":"number"}],"title":"Open Interest"},"best_bid":{"anyOf":[{"type":"number"}],"title":"Best Bid"},"best_ask":{"anyOf":[{"type":"number"}],"title":"Best Ask"},"last_trade_price":{"anyOf":[{"type":"number"}],"title":"Last Trade Price"},"one_day_price_change":{"anyOf":[{"type":"number"}],"title":"One Day Price Change"},"volume_change_pct":{"anyOf":[{"type":"number"}],"title":"Volume Change Pct"},"unique_traders_24h":{"anyOf":[{"type":"integer"}],"title":"Unique Traders 24H"},"end_date":{"anyOf":[{"type":"string","format":"date-time"}],"title":"End Date"}},"type":"object","required":["market_id","question"],"title":"EventScreenerMarket","description":"Single market within an event screener row."},"EventScreenerRequest":{"properties":{"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_ScreenerSortField_"},"type":"array"}],"title":"Order By","description":"Sort order","examples":[[{"direction":"DESC","field":"volume_24hr"}]]},"sort_by":{"$ref":"#/components/schemas/ScreenerSortField","description":"Deprecated: use 'order_by' instead.","default":"volume_24hr"},"query":{"type":"string","maxLength":200,"title":"Query","description":"Search query to filter results","default":"","examples":["bitcoin","election"]},"status":{"$ref":"#/components/schemas/MarketStatus","description":"Filter by status (active, closed, or empty for all)","default":"","examples":["active","closed",""]},"tags":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Tags","description":"Filter by tags","examples":[["Crypto","Bitcoin"]]},"min_liquidity":{"type":"number","minimum":-1.0,"title":"Min Liquidity","description":"Minimum liquidity filter (-1 = no filter)","default":-1.0},"max_liquidity":{"type":"number","minimum":-1.0,"title":"Max Liquidity","description":"Maximum liquidity filter (-1 = no limit)","default":-1.0},"max_unique_traders_24h":{"type":"integer","minimum":-1.0,"title":"Max Unique Traders 24H","description":"Maximum unique traders in 24h (-1 = no limit)","default":-1},"min_volume_24hr":{"type":"number","minimum":-1.0,"title":"Min Volume 24Hr","description":"Minimum 24h volume filter (-1 = no filter)","default":-1.0},"neg_risk":{"anyOf":[{"type":"boolean"}],"title":"Neg Risk","description":"Filter by neg-risk framework (null = no filter)"},"min_open_interest":{"type":"number","minimum":-1.0,"title":"Min Open Interest","description":"Minimum open interest filter (-1 = no filter)","default":-1.0},"max_open_interest":{"type":"number","minimum":-1.0,"title":"Max Open Interest","description":"Maximum open interest filter (-1 = no limit)","default":-1.0},"end_date_before":{"type":"string","maxLength":100,"title":"End Date Before","description":"Filter markets ending before this datetime (ISO 8601)","default":"","examples":["2025-12-31T23:59:59Z"]},"end_date_after":{"type":"string","maxLength":100,"title":"End Date After","description":"Filter markets ending after this datetime (ISO 8601)","default":"","examples":["2025-01-01T00:00:00Z"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"}},"additionalProperties":false,"type":"object","title":"EventScreenerRequest","description":"Request for event screener endpoint."},"EventScreenerResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/EventScreenerItem"},"type":"array","title":"Data","description":"List of event screener records"}},"type":"object","required":["data"],"title":"EventScreenerResponse","description":"Response for event screener endpoint."},"GeneralSearchRequest":{"properties":{"search_query":{"type":"string","maxLength":200,"minLength":1,"title":"Search Query","description":"Search query - token name, symbol, contract address, or entity name.","examples":["AAVE","vitalik","0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9"]},"result_type":{"type":"string","enum":["token","entity","any"],"title":"Result Type","description":"Type filter - 'token' for tokens only, 'entity' for entities only, 'any' for both.","default":"any"},"chain":{"anyOf":[{"type":"string"}],"title":"Chain","description":"Optional chain filter to narrow down token results (e.g., 'ethereum', 'solana', 'base').","examples":["ethereum","solana","base","bnb","polygon"]},"limit":{"type":"integer","maximum":50.0,"minimum":1.0,"title":"Limit","description":"Maximum number of results to return (default: 25, max: 50).","default":25}},"additionalProperties":false,"type":"object","required":["search_query"],"title":"GeneralSearchRequest","description":"Request model for general search endpoint.\n\nThis endpoint searches for tokens and entities by name, symbol, or address."},"GeneralSearchResponse":{"properties":{"tokens":{"items":{"$ref":"#/components/schemas/TokenSearchResult"},"type":"array","title":"Tokens","description":"List of matching tokens","default":[]},"entities":{"items":{"$ref":"#/components/schemas/EntitySearchResult"},"type":"array","title":"Entities","description":"List of matching entities","default":[]},"total_results":{"type":"integer","title":"Total Results","description":"Total number of results returned"}},"type":"object","required":["total_results"],"title":"GeneralSearchResponse","description":"Response model for general search endpoint.\n\nReturns separate lists for tokens and entities, allowing clients to handle\neach type appropriately."},"GroupBy":{"type":"string","enum":["wallet","entity"],"title":"GroupBy","description":"Enum for grouping types in counterparties endpoint."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HoldingsSummary":{"properties":{"total_value_usd":{"type":"number","title":"Total Value Usd","description":"Total USD value of all holdings"},"total_assets_usd":{"type":"number","title":"Total Assets Usd","description":"Total USD value of all assets"},"total_debts_usd":{"type":"number","title":"Total Debts Usd","description":"Total USD value of all debts"},"total_rewards_usd":{"type":"number","title":"Total Rewards Usd","description":"Total USD value of all rewards"},"token_count":{"type":"integer","title":"Token Count","description":"Total number of unique tokens"},"protocol_count":{"type":"integer","title":"Protocol Count","description":"Total number of protocols"}},"type":"object","required":["total_value_usd","total_assets_usd","total_debts_usd","total_rewards_usd","token_count","protocol_count"],"title":"HoldingsSummary","description":"Summary statistics for DeFi holdings."},"IntegerRangeFilter":{"properties":{"min":{"anyOf":[{"type":"integer"}],"title":"Min","description":"Minimum value (inclusive)","examples":[10,100,1000]},"max":{"anyOf":[{"type":"integer"}],"title":"Max","description":"Maximum value (inclusive)","examples":[100,1000,10000]}},"type":"object","title":"IntegerRangeFilter","description":"Filter for integer values with optional min/max bounds.\nUse for counts, numbers of items, and other whole number values. - Values between 5 and 100"},"LabelType":{"type":"string","enum":["30D Smart Trader","90D Smart Trader","180D Smart Trader","Fund","Smart Trader","Public Figure","Exchange","Whale","BananaGun Bot User","Top Maestro Bot User","Top BananaGun Bot User","Maestro Bot User","Early MAGIC Miner","First Mover LP","First Mover Staking","Profitable LP","Smart HL Perps Trader"],"title":"LabelType","description":"Enum for label filter options."},"MarketCapData":{"properties":{"open":{"anyOf":[{"type":"number"}],"title":"Open","description":"Market cap at candle open","examples":[1500000000.0]},"high":{"anyOf":[{"type":"number"}],"title":"High","description":"Highest market cap in the candle","examples":[1600000000.0]},"low":{"anyOf":[{"type":"number"}],"title":"Low","description":"Lowest market cap in the candle","examples":[1400000000.0]},"close":{"anyOf":[{"type":"number"}],"title":"Close","description":"Market cap at candle close","examples":[1550000000.0]}},"type":"object","title":"MarketCapData","description":"Market capitalization data for OHLCV candles."},"MarketCapGroup":{"type":"string","enum":["lowcap","midcap","largecap"],"title":"MarketCapGroup","description":"Enum for market cap groups."},"MarketScreenerItem":{"properties":{"market_id":{"type":"string","title":"Market Id","description":"Market ID","examples":["654412"]},"question":{"anyOf":[{"type":"string"}],"title":"Question","description":"Market question"},"slug":{"anyOf":[{"type":"string"}],"title":"Slug","description":"URL slug"},"event_id":{"anyOf":[{"type":"string"}],"title":"Event Id","description":"Parent event ID"},"event_title":{"anyOf":[{"type":"string"}],"title":"Event Title","description":"Parent event title"},"active":{"anyOf":[{"type":"boolean"}],"title":"Active","description":"Whether market is active"},"closed":{"anyOf":[{"type":"boolean"}],"title":"Closed","description":"Whether market is closed"},"end_date":{"anyOf":[{"type":"string","format":"date-time"}],"title":"End Date","description":"Market end date"},"neg_risk":{"anyOf":[{"type":"boolean"}],"title":"Neg Risk","description":"Uses neg-risk framework"},"tags":{"anyOf":[{"items":{"type":"string"},"type":"array"}],"title":"Tags","description":"Market tags"},"volume":{"anyOf":[{"type":"number"}],"title":"Volume","description":"Total volume (USD)"},"volume_24hr":{"anyOf":[{"type":"number"}],"title":"Volume 24Hr","description":"24h volume (USD)"},"volume_1wk":{"anyOf":[{"type":"number"}],"title":"Volume 1Wk","description":"1 week volume (USD)"},"volume_1mo":{"anyOf":[{"type":"number"}],"title":"Volume 1Mo","description":"1 month volume (USD)"},"liquidity":{"anyOf":[{"type":"number"}],"title":"Liquidity","description":"Current liquidity (USD)"},"volume_change_pct":{"anyOf":[{"type":"number"}],"title":"Volume Change Pct","description":"Volume change percentage"},"open_interest":{"anyOf":[{"type":"number"}],"title":"Open Interest","description":"Open interest (USD)"},"best_bid":{"anyOf":[{"type":"number"}],"title":"Best Bid","description":"Best bid price"},"best_ask":{"anyOf":[{"type":"number"}],"title":"Best Ask","description":"Best ask price"},"last_trade_price":{"anyOf":[{"type":"number"}],"title":"Last Trade Price","description":"Last trade price"},"one_day_price_change":{"anyOf":[{"type":"number"}],"title":"One Day Price Change","description":"24h price change"},"unique_traders_24h":{"anyOf":[{"type":"integer"}],"title":"Unique Traders 24H","description":"Unique traders in 24h"},"created_at":{"anyOf":[{"type":"string","format":"date-time"}],"title":"Created At","description":"Market creation time"},"age_hours":{"anyOf":[{"type":"number"}],"title":"Age Hours","description":"Market age in hours"}},"type":"object","required":["market_id"],"title":"MarketScreenerItem","description":"Market screener data from ch_api_pm_market_screener."},"MarketScreenerRequest":{"properties":{"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_ScreenerSortField_"},"type":"array"}],"title":"Order By","description":"Sort order","examples":[[{"direction":"DESC","field":"volume_24hr"}]]},"sort_by":{"$ref":"#/components/schemas/ScreenerSortField","description":"Deprecated: use 'order_by' instead.","default":"volume_24hr"},"query":{"type":"string","maxLength":200,"title":"Query","description":"Search query to filter results","default":"","examples":["bitcoin","election"]},"status":{"$ref":"#/components/schemas/MarketStatus","description":"Filter by status (active, closed, or empty for all)","default":"","examples":["active","closed",""]},"tags":{"items":{"type":"string"},"type":"array","maxItems":50,"title":"Tags","description":"Filter by tags","examples":[["Crypto","Bitcoin"]]},"min_liquidity":{"type":"number","minimum":-1.0,"title":"Min Liquidity","description":"Minimum liquidity filter (-1 = no filter)","default":-1.0},"max_liquidity":{"type":"number","minimum":-1.0,"title":"Max Liquidity","description":"Maximum liquidity filter (-1 = no limit)","default":-1.0},"max_unique_traders_24h":{"type":"integer","minimum":-1.0,"title":"Max Unique Traders 24H","description":"Maximum unique traders in 24h (-1 = no limit)","default":-1},"min_volume_24hr":{"type":"number","minimum":-1.0,"title":"Min Volume 24Hr","description":"Minimum 24h volume filter (-1 = no filter)","default":-1.0},"neg_risk":{"anyOf":[{"type":"boolean"}],"title":"Neg Risk","description":"Filter by neg-risk framework (null = no filter)"},"min_open_interest":{"type":"number","minimum":-1.0,"title":"Min Open Interest","description":"Minimum open interest filter (-1 = no filter)","default":-1.0},"max_open_interest":{"type":"number","minimum":-1.0,"title":"Max Open Interest","description":"Maximum open interest filter (-1 = no limit)","default":-1.0},"end_date_before":{"type":"string","maxLength":100,"title":"End Date Before","description":"Filter markets ending before this datetime (ISO 8601)","default":"","examples":["2025-12-31T23:59:59Z"]},"end_date_after":{"type":"string","maxLength":100,"title":"End Date After","description":"Filter markets ending after this datetime (ISO 8601)","default":"","examples":["2025-01-01T00:00:00Z"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"},"min_price":{"type":"number","minimum":-1.0,"title":"Min Price","description":"Minimum price filter (-1 = no filter)","default":-1.0},"max_price":{"type":"number","minimum":-1.0,"title":"Max Price","description":"Maximum price filter (-1 = no limit)","default":-1.0}},"additionalProperties":false,"type":"object","title":"MarketScreenerRequest","description":"Request for market screener endpoint."},"MarketScreenerResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/MarketScreenerItem"},"type":"array","title":"Data","description":"List of market screener records"}},"type":"object","required":["data"],"title":"MarketScreenerResponse","description":"Response for market screener endpoint."},"MarketStatus":{"type":"string","enum":["active","closed",""],"title":"MarketStatus","description":"Valid status filters for screener endpoints."},"NFTTransfer":{"properties":{"from_address":{"type":"string","title":"From Address","description":"From address"},"from_address_label":{"type":"string","title":"From Address Label","description":"From address label"},"to_address":{"type":"string","title":"To Address","description":"To address"},"to_address_label":{"type":"string","title":"To Address Label","description":"To address label"},"project_id":{"type":"string","title":"Project Id","description":"Project ID"},"collection_name":{"type":"string","title":"Collection Name","description":"Collection name"},"nft_id":{"type":"string","title":"Nft Id","description":"NFT ID"}},"type":"object","required":["from_address","from_address_label","to_address","to_address_label","project_id","collection_name","nft_id"],"title":"NFTTransfer","description":"Model for NFT transfer information."},"NansenScoreTopTokensChain":{"type":"string","enum":["arbitrum","avalanche","base","bitcoin","bnb","chiliz","ethereum","hyperevm","injective","linea","mantle","monad","near","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","stacks","sui","tron","viction"],"title":"NansenScoreTopTokensChain","description":"Chains supported for the Nansen Score top-tokens endpoint."},"NumericRangeFilter":{"properties":{"min":{"anyOf":[{"type":"number"}],"title":"Min","description":"Minimum value (inclusive)","examples":[1000.0,1000000.0,-50.0,0.0]},"max":{"anyOf":[{"type":"number"}],"title":"Max","description":"Maximum value (inclusive)","examples":[50000.0,10000000.0,100.0]}},"type":"object","title":"NumericRangeFilter","description":"Filter for numeric values (floats) with optional min/max bounds.\nUse for prices, volumes, ratios, and other decimal values. - Values between -10.5 and 100.75"},"OHLCVCandle":{"properties":{"interval_start":{"type":"string","title":"Interval Start","description":"Start time of the candle interval (ISO datetime string)","examples":["2025-01-15T12:00:00Z"]},"open":{"anyOf":[{"type":"number"}],"title":"Open","description":"Opening price","examples":[100.5]},"high":{"anyOf":[{"type":"number"}],"title":"High","description":"Highest price in the interval","examples":[105.25]},"low":{"anyOf":[{"type":"number"}],"title":"Low","description":"Lowest price in the interval","examples":[98.75]},"close":{"anyOf":[{"type":"number"}],"title":"Close","description":"Closing price","examples":[103.0]},"volume":{"anyOf":[{"type":"number"}],"title":"Volume","description":"Trading volume in token units","examples":[1000000.0]},"volume_usd":{"anyOf":[{"type":"number"}],"title":"Volume Usd","description":"Trading volume in USD","examples":[100000000.0]},"market_cap":{"$ref":"#/components/schemas/MarketCapData","description":"Market capitalization data for the candle"}},"type":"object","required":["interval_start","market_cap"],"title":"OHLCVCandle","description":"Individual OHLCV candle data point."},"OhlcvCandle":{"properties":{"market_id":{"type":"string","title":"Market Id","description":"Market ID","examples":["654412"]},"token_id":{"anyOf":[{"type":"string"}],"title":"Token Id","description":"CLOB token ID","examples":["71321045679252212"]},"side":{"anyOf":[{"type":"string"}],"title":"Side","description":"Side label (Yes/No)","examples":["Yes"]},"outcome_index":{"anyOf":[{"type":"integer"}],"title":"Outcome Index","description":"Outcome index (1/2)","examples":[1]},"period_start":{"anyOf":[{"type":"string","format":"date-time"}],"title":"Period Start","description":"Candle period start (ISO format)","examples":["2024-11-01T00:00:00"]},"open":{"anyOf":[{"type":"number"}],"title":"Open","description":"Open price","examples":[0.5]},"high":{"anyOf":[{"type":"number"}],"title":"High","description":"High price","examples":[0.55]},"low":{"anyOf":[{"type":"number"}],"title":"Low","description":"Low price","examples":[0.48]},"close":{"anyOf":[{"type":"number"}],"title":"Close","description":"Close price","examples":[0.53]},"volume_usd":{"anyOf":[{"type":"number"}],"title":"Volume Usd","description":"Volume in USD","examples":[12500.0]},"trade_count":{"anyOf":[{"type":"integer"}],"title":"Trade Count","description":"Number of trades","examples":[150]},"unique_traders":{"anyOf":[{"type":"integer"}],"title":"Unique Traders","description":"Unique traders in period","examples":[25]}},"type":"object","required":["market_id"],"title":"OhlcvCandle","description":"OHLCV candle data from ch_api_pm_ohlcv."},"OhlcvRequest":{"properties":{"market_id":{"type":"string","maxLength":100,"minLength":1,"title":"Market Id","description":"Polymarket market ID","examples":["654412"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"},"date":{"anyOf":[{"$ref":"#/components/schemas/DateRange"}],"description":"Date range filter (ISO 8601 date-time)","examples":[{"from":"2024-01-01T00:00:00Z","to":"2024-12-31T23:59:59Z"}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_OhlcvSortField_"},"type":"array"}],"title":"Order By","description":"Sort order","examples":[[{"direction":"DESC","field":"period_start"}]]},"sort":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_OhlcvSortField_"},"type":"array"}],"title":"Sort","description":"Deprecated: use 'order_by' instead."}},"additionalProperties":false,"type":"object","required":["market_id"],"title":"OhlcvRequest","description":"Request for OHLCV endpoint."},"OhlcvResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/OhlcvCandle"},"type":"array","title":"Data","description":"List of OHLCV candle records"}},"type":"object","required":["data"],"title":"OhlcvResponse","description":"Response for OHLCV endpoint."},"OhlcvSortField":{"type":"string","enum":["period_start","volume_usd","trade_count"],"title":"OhlcvSortField","description":"Sortable fields for OHLCV endpoint."},"OrderType":{"type":"string","enum":["MARKET","LIMIT"],"title":"OrderType","description":"Order type."},"OrderbookLevel":{"properties":{"market_id":{"type":"string","title":"Market Id","description":"Market ID","examples":["654412"]},"event_id":{"anyOf":[{"type":"string"}],"title":"Event Id","description":"Event ID"},"outcome":{"anyOf":[{"type":"string"}],"title":"Outcome","description":"Outcome label","examples":["Yes"]},"outcome_index":{"anyOf":[{"type":"integer"}],"title":"Outcome Index","description":"Outcome index","examples":[1]},"asset_id":{"anyOf":[{"type":"string"}],"title":"Asset Id","description":"CLOB token ID","examples":["71321045679252212"]},"side":{"anyOf":[{"type":"string"}],"title":"Side","description":"buy or sell","examples":["buy"]},"price":{"anyOf":[{"type":"number"}],"title":"Price","description":"Price level","examples":[0.52]},"size":{"anyOf":[{"type":"number"}],"title":"Size","description":"Size at level","examples":[1000.0]},"cumulative_size":{"anyOf":[{"type":"number"}],"title":"Cumulative Size","description":"Cumulative size","examples":[5000.0]},"snapshot_timestamp":{"anyOf":[{"type":"string","format":"date-time"}],"title":"Snapshot Timestamp","description":"Snapshot timestamp","examples":["2024-11-01T12:00:00"]}},"type":"object","required":["market_id"],"title":"OrderbookLevel","description":"Orderbook level from ch_api_pm_orderbook."},"OrderbookRequest":{"properties":{"market_id":{"type":"string","maxLength":100,"minLength":1,"title":"Market Id","description":"Polymarket market ID","examples":["654412"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"}},"additionalProperties":false,"type":"object","required":["market_id"],"title":"OrderbookRequest","description":"Request for orderbook endpoint."},"OrderbookResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/OrderbookLevel"},"type":"array","title":"Data","description":"List of orderbook level records"}},"type":"object","required":["data"],"title":"OrderbookResponse","description":"Response for orderbook endpoint."},"PaginationInfo":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","description":"Current page number","default":1},"per_page":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Per Page","description":"Number of records per page","default":10},"is_last_page":{"type":"boolean","title":"Is Last Page","description":"Whether this is the last page","default":true}},"type":"object","title":"PaginationInfo","description":"Pagination information for API responses."},"PaginationRequest":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","description":"Page number (1-based)","default":1},"per_page":{"type":"integer","maximum":1000.0,"minimum":1.0,"title":"Per Page","description":"Number of records per page (max 1000)","default":10}},"type":"object","title":"PaginationRequest","description":"Pagination parameters for API requests."},"PerpActionType":{"type":"string","enum":["Buy - Add Long","Buy - Reduce Short","Buy - Open Long","Buy - Close Short","Sell - Add Short","Sell - Reduce Long","Sell - Open Short","Sell - Close Long"],"title":"PerpActionType","description":"Shared enum for perpetual trade action types (combined buy/sell with position actions)."},"PerpLeaderboard":{"properties":{"trader_address":{"type":"string","title":"Trader Address","description":"The Ethereum wallet address of the trader.","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"}],"title":"Trader Address Label","description":"The name associated with the address, derived using Nansen's multichain label function for Ethereum.","examples":["🏦 Binance 14 [0x28c6c0]"]},"total_pnl":{"anyOf":[{"type":"number"}],"title":"Total Pnl","description":"Profit and loss for the selected timeframe in USD.","examples":[1250.5]},"roi":{"anyOf":[{"type":"number"}],"title":"Roi","description":"Return on investment for the selected timeframe as percentage.","examples":[15.5]},"account_value":{"anyOf":[{"type":"number"}],"title":"Account Value","description":"Current total account value in USD. Note: Account value data is only available for the top 500K traders due to upstream data limitations. Traders outside the top 500K may show 0 or null values.","examples":[10000.0]}},"type":"object","required":["trader_address"],"title":"PerpLeaderboard","description":"Individual Perp Leaderboard record.\nRepresents a single trader's perpetual trading performance."},"PerpLeaderboardFilters":{"properties":{"trader_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address Label","description":"Filter by wallet display name. Use LIKE patterns (%) for partial matching. Note: This filters by the wallet's display name, not by label category. To filter by smart money labels, use include_smart_money_labels instead.","examples":["%Smart HL Perps Trader%","%Binance%","%.eth%"]},"total_pnl":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total PnL range filter in USD","examples":[{"min":1000}]},"roi":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"ROI range filter as percentage","examples":[{"max":100.0,"min":10.0}]},"account_value":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Account value range filter in USD. Note: Only the top 500K traders have account value data available.","examples":[{"min":10000}]},"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Filter to include only traders with these smart money labels. For Hyperliquid, use 'Smart HL Perps Trader'. See SmartMoneyFilterType enum for valid values.","examples":[["Smart HL Perps Trader"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels","examples":[["30D Smart Trader"]]}},"additionalProperties":false,"type":"object","title":"PerpLeaderboardFilters","description":"Filters for Perp Leaderboard endpoint.\n\nThese filters control which traders are included in the leaderboard."},"PerpLeaderboardRequest":{"properties":{"date":{"$ref":"#/components/schemas/DateOnlyRange","description":"Date range object with optional from and to fields in YYYY-MM-DD format","examples":[{"from":"2025-10-14","to":"2025-10-15"}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/PerpLeaderboardFilters"}],"description":"Additional filters to apply to the query.","examples":[{"account_value":{"min":10000},"total_pnl":{"min":1000}}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted (default), returns labels as per subscription plan (existing behavior). When false, returns free-tier labels for all users. When true, returns premium labels. Note: In a future release, the default will change from true to false — pass premium_labels=true explicitly to preserve premium label behavior."},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_PerpLeaderboardSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering"}},"additionalProperties":false,"type":"object","required":["date"],"title":"PerpLeaderboardRequest","description":"Request model for Perp Leaderboard endpoint.\nThis endpoint provides a perpetual trading leaderboard showing the most profitable\ntraders within a given date range."},"PerpLeaderboardResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PerpLeaderboard"},"type":"array","title":"Data","description":"List of Perp Leaderboard records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"PerpLeaderboardResponse","description":"Response model for Perp Leaderboard endpoint.\nContains a list of leaderboard records with pagination and metadata."},"PerpLeaderboardSortField":{"type":"string","enum":["total_pnl","roi","account_value"],"title":"PerpLeaderboardSortField","description":"Enum for sortable fields in Perp Leaderboard."},"PerpPositionsData":{"properties":{"assetPositions":{"anyOf":[{"items":{"$ref":"#/components/schemas/AssetPosition"},"type":"array"}],"title":"Assetpositions","description":"List of asset positions"},"crossMaintenanceMarginUsed":{"anyOf":[{"type":"string"}],"title":"Crossmaintenancemarginused","description":"Cross maintenance margin used USD","examples":["722948.2832910001"]},"cross_margin_summary_account_value_usd":{"anyOf":[{"type":"string"}],"title":"Cross Margin Summary Account Value Usd","description":"Cross margin summary account value USD","examples":["4643143.4382309997"]},"cross_margin_summary_total_margin_used_usd":{"anyOf":[{"type":"string"}],"title":"Cross Margin Summary Total Margin Used Usd","description":"Cross margin summary total margin used USD","examples":["1456365.231985"]},"cross_margin_summary_total_net_liquidation_position_on_usd":{"anyOf":[{"type":"string"}],"title":"Cross Margin Summary Total Net Liquidation Position On Usd","description":"Cross margin summary total net liquidation position on USD","examples":["13339928.690684"]},"cross_margin_summary_total_raw_usd":{"anyOf":[{"type":"string"}],"title":"Cross Margin Summary Total Raw Usd","description":"Cross margin summary total raw USD","examples":["13987445.0243870001"]},"margin_summary_account_value_usd":{"anyOf":[{"type":"string"}],"title":"Margin Summary Account Value Usd","description":"Margin summary account value USD","examples":["4643143.4382309997"]},"margin_summary_total_margin_used_usd":{"anyOf":[{"type":"string"}],"title":"Margin Summary Total Margin Used Usd","description":"Margin summary total margin used USD","examples":["1456365.231985"]},"margin_summary_total_net_liquidation_position_usd":{"anyOf":[{"type":"string"}],"title":"Margin Summary Total Net Liquidation Position Usd","description":"Margin summary total net liquidation position USD","examples":["13339928.690684"]},"margin_summary_total_raw_usd":{"anyOf":[{"type":"string"}],"title":"Margin Summary Total Raw Usd","description":"Margin summary total raw USD","examples":["13987445.0243870001"]},"time":{"anyOf":[{"type":"integer"}],"title":"Time","description":"Timestamp","examples":[1761283435707]},"withdrawable":{"anyOf":[{"type":"string"}],"title":"Withdrawable","description":"Withdrawable USD","examples":["2933647.2403759998"]}},"additionalProperties":false,"type":"object","title":"PerpPositionsData","description":"Data model for Hyperliquid clearinghouse state response."},"PerpPositionsFilters":{"properties":{"token_symbol":{"anyOf":[{"type":"string"}],"title":"Token Symbol","description":"Filter by token symbol","examples":["BTC","ETH","SOL"]},"position_value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Filter by position value in USD","examples":[{"min":1000},{"max":100000},{"max":100000,"min":1000}]},"position_type":{"anyOf":[{"type":"string"}],"title":"Position Type","description":"Filter by position type","examples":["oneWay"]},"unrealized_pnl_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Filter by unrealized PnL in USD","examples":[{"min":-1000},{"max":0},{"max":1000,"min":-1000}]}},"additionalProperties":false,"type":"object","title":"PerpPositionsFilters","description":"Filters for perp positions endpoint."},"PerpPositionsRequest":{"properties":{"address":{"type":"string","maxLength":42,"minLength":42,"title":"Address","description":"User's Hyperliquid address in 42-character hexadecimal format","examples":["0xa312114b5795dff9b8db50474dd57701aa78ad1e"]},"filters":{"anyOf":[{"$ref":"#/components/schemas/PerpPositionsFilters"}],"description":"Additional filters to apply to the query.","examples":[{"position_value_usd":{"min":1000},"unrealized_pnl_usd":{"max":0}}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_PerpPositionsSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"position_value_usd\", \"direction\": \"DESC\"}] - Sort by position value descending\n- [{\"field\": \"unrealized_pnl_usd\", \"direction\": \"ASC\"}] - Sort by unrealized PnL ascending\n\nIf not provided, positions are sorted by position value descending.","examples":[[{"direction":"DESC","field":"position_value_usd"}]]}},"additionalProperties":false,"type":"object","required":["address"],"title":"PerpPositionsRequest","description":"Request model for Perp Positions endpoint."},"PerpPositionsResponse":{"properties":{"data":{"$ref":"#/components/schemas/PerpPositionsData","description":"Hyperliquid clearinghouse state data","examples":[{"asset_positions":[{"position":{"cumulative_funding_all_time_usd":"-623.219722","cumulative_funding_since_change_usd":"-618.925976","cumulative_funding_since_open_usd":"-623.219722","entry_price_usd":"0.43499","leverage_type":"cross","leverage_value":3,"liquidation_price_usd":"66.817537196","margin_used_usd":"1743.87343","max_leverage_value":3,"position_value_usd":"5231.62029","return_on_equity":"2.2836393396","size":"-50367.0","token_symbol":"STBL","unrealized_pnl_usd":"16677.54047"},"position_type":"oneWay"},{"position":{"cumulative_funding_all_time_usd":"200.361581","cumulative_funding_since_change_usd":"201.157877","cumulative_funding_since_open_usd":"200.361581","entry_price_usd":"0.311285","leverage_type":"cross","leverage_value":5,"liquidation_price_usd":"39.6872752647","margin_used_usd":"2020.946984","max_leverage_value":5,"position_value_usd":"10104.73492","return_on_equity":"3.1976362269","size":"-90052.0","token_symbol":"MOODENG","unrealized_pnl_usd":"17927.1615"},"position_type":"oneWay"}],"cross_maintenance_margin_used_usd":"722948.2832910001","cross_margin_summary_account_value_usd":"4643143.4382309997","cross_margin_summary_total_margin_used_usd":"1456365.231985","cross_margin_summary_total_net_liquidation_position_on_usd":"13339928.690684","cross_margin_summary_total_raw_usd":"13987445.0243870001","margin_summary_account_value_usd":"4643143.4382309997","margin_summary_total_margin_used_usd":"1456365.231985","margin_summary_total_net_liquidation_position_usd":"13339928.690684","margin_summary_total_raw_usd":"13987445.0243870001","timestamp":1761283435707,"withdrawable_usd":"2933647.2403759998"}]}},"additionalProperties":false,"type":"object","required":["data"],"title":"PerpPositionsResponse","description":"Response model for perp positions endpoint."},"PerpPositionsSortField":{"type":"string","enum":["leverage_value","position_value_usd","entry_price_usd","liquidation_price_usd","unrealized_pnl_usd","size","token_symbol","position_type"],"title":"PerpPositionsSortField","description":"Enum for perp positions sort fields."},"PerpScreenerDataDefault":{"properties":{"volume":{"anyOf":[{"type":"number"}],"title":"Volume","description":"Total traded notional in USD over the recent window.","examples":[427486.75766,1250000.45,2500000.0,500000.0,750000.0]},"buy_volume":{"anyOf":[{"type":"number"}],"title":"Buy Volume","description":"Total USD value of market buy trades over the recent window.","examples":[216502.59923,625000.25,1250000.0,250000.0,375000.0]},"sell_volume":{"anyOf":[{"type":"number"}],"title":"Sell Volume","description":"Total USD value of market sell trades over the recent window.","examples":[210984.15843,625000.2,1250000.0,250000.0,375000.0]},"buy_sell_pressure":{"anyOf":[{"type":"number"}],"title":"Buy Sell Pressure","description":"Changes in position by Market Orders. Buys and sells through market orders (top of orderbook) indicate a rush into adjusting the position.","examples":[5518.4408,25000.0,-15000.0,50000.0,-25000.0]},"trader_count":{"anyOf":[{"type":"integer"}],"title":"Trader Count","description":"Number of unique traders active over the recent window.","examples":[109,250,500,1000,1500]},"token_symbol":{"type":"string","title":"Token Symbol","description":"Asset symbol (e.g., BTC, ETH) on Hyperliquid.","examples":["ARK","BTC","ETH","SOL","AVAX","MATIC","DOT","LINK","UNI","AAVE"]},"mark_price":{"anyOf":[{"type":"number"}],"title":"Mark Price","description":"Latest mark price for the coin.","examples":[0.3301,45000.0,3000.0,100.0,25.0,0.5,0.01,15.0,8.0,150.0]},"funding":{"anyOf":[{"type":"number"}],"title":"Funding","description":"Latest funding rate/value for the coin.","examples":[1.25e-05,0.0001,-0.0001,0.0005,-0.0005,0.001,-0.001,0.0002,-0.0002,0.0003]},"open_interest":{"anyOf":[{"type":"number"}],"title":"Open Interest","description":"Latest open interest for the coin.","examples":[261310.461,1000000.0,5000000.0,2500000.0,7500000.0,10000000.0,15000000.0,20000000.0,30000000.0,50000000.0]},"previous_price_usd":{"anyOf":[{"type":"number"}],"title":"Previous Price Usd","description":"First price in the time window.","examples":[0.4155,44000.0,2900.0,95.0,24.0,0.48,0.009,14.5,7.8,145.0]}},"type":"object","required":["token_symbol"],"title":"PerpScreenerDataDefault","description":"Data model for perp screener results when only_smart_money is False."},"PerpScreenerDataSmartMoney":{"properties":{"smart_money_volume":{"anyOf":[{"type":"number"}],"title":"Smart Money Volume","description":"Total traded notional in USD by Smart Money over the window.","examples":[150000.0,500000.0,1000000.0,2000000.0,5000000.0]},"smart_money_buy_volume":{"anyOf":[{"type":"number"}],"title":"Smart Money Buy Volume","description":"Total USD value of Smart Money market buy trades over the window.","examples":[75000.0,250000.0,500000.0,1000000.0,2500000.0]},"smart_money_sell_volume":{"anyOf":[{"type":"number"}],"title":"Smart Money Sell Volume","description":"Total USD value of Smart Money market sell trades over the window.","examples":[75000.0,250000.0,500000.0,1000000.0,2500000.0]},"net_position_change":{"anyOf":[{"type":"number"}],"title":"Net Position Change","description":"Net USD flow (buy_market_vol - sell_market_vol) over the window.","examples":[25000.0,-15000.0,100000.0,-50000.0,200000.0,-100000.0]},"trader_count":{"anyOf":[{"type":"integer"}],"title":"Trader Count","description":"Number of unique Smart Money traders active over the window.","examples":[15,25,50,100,200]},"token_symbol":{"type":"string","title":"Token Symbol","description":"Asset symbol (e.g., BTC, ETH) on Hyperliquid.","examples":["ARK","BTC","ETH","SOL","AVAX","MATIC","DOT","LINK","UNI","AAVE"]},"mark_price":{"anyOf":[{"type":"number"}],"title":"Mark Price","description":"Latest mark price for the coin.","examples":[0.3301,45000.0,3000.0,100.0,25.0,0.5,0.01,15.0,8.0,150.0]},"funding":{"anyOf":[{"type":"number"}],"title":"Funding","description":"Latest funding rate/value for the coin.","examples":[1.25e-05,0.0001,-0.0001,0.0005,-0.0005,0.001,-0.001,0.0002,-0.0002,0.0003]},"previous_price_usd":{"anyOf":[{"type":"number"}],"title":"Previous Price Usd","description":"First observed price within the time window.","examples":[0.4155,44000.0,2900.0,95.0,24.0,0.48,0.009,14.5,7.8,145.0]},"open_interest":{"anyOf":[{"type":"number"}],"title":"Open Interest","description":"Latest open interest in USD (open_interest × mark_price).","examples":[261310.461,1000000.0,5000000.0,2500000.0,7500000.0,10000000.0,15000000.0,20000000.0,30000000.0,50000000.0]},"current_smart_money_position_longs_usd":{"anyOf":[{"type":"number"}],"title":"Current Smart Money Position Longs Usd","description":"Aggregate USD value of Smart Money long positions for the coin.","examples":[500000.0,1000000.0,2000000.0,5000000.0,10000000.0]},"current_smart_money_position_shorts_usd":{"anyOf":[{"type":"number"}],"title":"Current Smart Money Position Shorts Usd","description":"Aggregate USD value of Smart Money short positions for the coin (negative).","examples":[-500000.0,-1000000.0,-2000000.0,-5000000.0,-10000000.0]},"smart_money_longs_count":{"anyOf":[{"type":"integer"}],"title":"Smart Money Longs Count","description":"Number of Smart Money accounts with a net long position.","examples":[5,10,20,50,100]},"smart_money_shorts_count":{"anyOf":[{"type":"integer"}],"title":"Smart Money Shorts Count","description":"Number of Smart Money accounts with a net short position.","examples":[5,10,20,50,100]}},"type":"object","required":["token_symbol"],"title":"PerpScreenerDataSmartMoney","description":"Data model for perp screener results when only_smart_money is True."},"PerpScreenerFilters":{"properties":{"only_smart_money":{"anyOf":[{"type":"boolean"}],"title":"Only Smart Money","description":"Whether to only include smart money data","default":false,"examples":[true]},"token_symbol":{"anyOf":[{"type":"string"}],"title":"Token Symbol","description":"Asset symbol filter (e.g., BTC, ETH)","examples":["BTC","ETH"]},"volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total traded notional in USD range filter","examples":[{"min":1000000}]},"buy_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total USD value of market buy trades range filter","examples":[{"min":500000}]},"sell_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total USD value of market sell trades range filter","examples":[{"min":500000}]},"buy_sell_pressure":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Net USD flow range filter","examples":[{"max":1000000,"min":-1000000}]},"trader_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of unique traders range filter","examples":[{"min":10}]},"mark_price":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Latest mark price range filter","examples":[{"max":100000,"min":0.01}]},"funding":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Latest funding rate range filter","examples":[{"max":0.01,"min":-0.01}]},"previous_price_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"First price in the time window range filter","examples":[{"max":100000,"min":0.01}]},"open_interest":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Latest open interest range filter","examples":[{"min":1000000}]},"smart_money_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total traded notional in USD by Smart Money range filter","examples":[{"min":100000}]},"smart_money_buy_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total USD value of Smart Money market buy trades range filter","examples":[{"min":50000}]},"smart_money_sell_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total USD value of Smart Money market sell trades range filter","examples":[{"min":50000}]},"net_position_change":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Net USD flow (buy_market_vol - sell_market_vol) range filter","examples":[{"max":1000000,"min":-1000000}]},"current_smart_money_position_longs_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Aggregate USD value of Smart Money long positions range filter","examples":[{"min":0}]},"current_smart_money_position_shorts_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Aggregate USD value of Smart Money short positions range filter","examples":[{"min":0}]},"smart_money_longs_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of Smart Money accounts with net long position range filter","examples":[{"min":0}]},"smart_money_shorts_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of Smart Money accounts with net short position range filter","examples":[{"min":0}]}},"additionalProperties":false,"type":"object","title":"PerpScreenerFilters","description":"Filters for perp screener endpoints.\n\nThese filters control which perpetual contracts are included in the screening\nresults based on various criteria."},"PerpScreenerRequest":{"properties":{"date":{"$ref":"#/components/schemas/DateRange","description":"Date range for the perp screener","examples":[{"from":"2025-10-01T00:00:00Z","to":"2025-10-06T23:59:59Z"}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/PerpScreenerFilters"}],"description":"Additional filters to apply","examples":[{"token_symbol":"BTC","volume":{"min":10000}}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_Union_PerpScreenerSortFieldDefault__PerpScreenerSortFieldSmartMoney__"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"volume\", \"direction\": \"DESC\"}] - Sort by volume descending\n- [{\"field\": \"net_positionz_change\", \"direction\": \"DESC\"}] - Sort by net_position_change descending\n- [{\"field\": \"buy_sell_pressure\", \"direction\": \"DESC\"}] - Sort by buy/sell pressure descending (smart money)\n\nDefault behavior:\n- When only_smart_money is False: sorts by buy_sell_pressure DESC\n- When only_smart_money is True: sorts by net_position_change DESC","examples":[[{"direction":"DESC","field":"buy_sell_pressure"}]]}},"additionalProperties":false,"type":"object","required":["date"],"title":"PerpScreenerRequest","description":"Request model for Perp Screener endpoint."},"PerpScreenerResponse":{"properties":{"data":{"items":{"anyOf":[{"$ref":"#/components/schemas/PerpScreenerDataDefault"},{"$ref":"#/components/schemas/PerpScreenerDataSmartMoney"}]},"type":"array","title":"Data","description":"List of perp screening results","examples":[[{"buy_sell_pressure":5518.4408,"buy_volume":216502.59923,"funding":1.25e-05,"mark_price":0.3301,"open_interest":261310.461,"previous_price_usd":0.4155,"sell_volume":210984.15843,"token_symbol":"ARK","trader_count":109,"volume":427486.75766},{"buy_sell_pressure":25000.0,"buy_volume":1250000.0,"funding":0.0001,"mark_price":45000.0,"open_interest":5000000.0,"previous_price_usd":44000.0,"sell_volume":1250000.0,"token_symbol":"BTC","trader_count":500,"volume":2500000.0},{"current_smart_money_position_longs_usd":500000.0,"current_smart_money_position_shorts_usd":-500000.0,"funding":-0.0001,"mark_price":3000.0,"net_position_change":25000.0,"open_interest":2000000.0,"previous_price_usd":2900.0,"smart_money_buy_volume":75000.0,"smart_money_longs_count":5,"smart_money_sell_volume":75000.0,"smart_money_shorts_count":5,"smart_money_volume":150000.0,"token_symbol":"ETH","trader_count":15}]]},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"PerpScreenerResponse","description":"Response model for perp screener endpoint."},"PerpScreenerSortFieldDefault":{"type":"string","enum":["token_symbol","volume","buy_volume","sell_volume","buy_sell_pressure","trader_count","mark_price","funding","previous_price_usd","open_interest"],"title":"PerpScreenerSortFieldDefault","description":"Sort fields available for default perp screener data (only_smart_money=False)."},"PerpScreenerSortFieldSmartMoney":{"type":"string","enum":["token_symbol","smart_money_volume","smart_money_buy_volume","smart_money_sell_volume","net_position_change","trader_count","mark_price","funding","previous_price_usd","open_interest","current_smart_money_position_longs_usd","current_smart_money_position_shorts_usd","smart_money_longs_count","smart_money_shorts_count"],"title":"PerpScreenerSortFieldSmartMoney","description":"Sort fields available for smart money perp screener data (only_smart_money=True)."},"PerpTrade":{"properties":{"timestamp":{"type":"string","title":"Timestamp","description":"Timestamp of the trade","examples":["2025-10-08T18:46:11.452000","2025-10-08T15:30:22.123000","2025-10-08T12:15:33.789000","2025-10-08T09:45:44.456000","2025-10-08T06:20:55.234000"]},"side":{"anyOf":[{"$ref":"#/components/schemas/PerpTradeType"}],"description":"Position side (Long or Short)","examples":["Long","Short"]},"action":{"type":"string","title":"Action","description":"Action taken (Open, Add, Close, Reduce, etc.)","examples":["Add","Open","Close","Reduce","Liquidation"]},"block_number":{"type":"integer","title":"Block Number","description":"Block number of the trade","examples":[756553592,756553593,756553594,756553595,756553596]},"token_symbol":{"type":"string","title":"Token Symbol","description":"Symbol of the token","examples":["DOGE","BTC","ETH","SOL","AVAX","MATIC","DOT","LINK","UNI","AAVE"]},"price":{"anyOf":[{"type":"number"}],"title":"Price","description":"Average price of the trade (averaged across fills)","examples":[0.25884,45000.0,3000.0,100.0,25.0,0.5,0.01,15.0,8.0,150.0]},"size":{"type":"number","title":"Size","description":"Total size of the trade (sum of all fills)","examples":[6000.0,0.1,1.5,100.0,50.0,1000.0,0.001,10.0,5.0,200.0]},"value_usd":{"type":"number","title":"Value Usd","description":"Total value in USD of the trade","examples":[1553.04,4500.0,4500.0,10000.0,1250.0,500.0,0.01,150.0,40.0,30000.0]},"start_position":{"type":"number","title":"Start Position","description":"Start position of the trade in token units","examples":[-7788000.0,0.0,1000.0,-500.0,2500.0,-100.0,0.0,50.0,-25.0,2000.0]},"closed_pnl":{"type":"number","title":"Closed Pnl","description":"Total closed PnL of the trade (sum of all fills)","examples":[0.0,150.0,-75.0,500.0,-200.0,1000.0,-50.0,25.0,-10.0,750.0]},"crossed":{"type":"boolean","title":"Crossed","description":"Crossed of the trade","examples":[true,false]},"fee_usd":{"type":"number","title":"Fee Usd","description":"Total fee in USD of the trade (sum of all fills)","examples":[0.434851,2.25,2.25,5.0,0.625,0.25,0.005,0.075,0.02,15.0]},"fee_token_symbol":{"type":"string","title":"Fee Token Symbol","description":"Fee in token of the trade","examples":["USDC","HYPE","USDT"]},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"Transaction hash of the trade","examples":["0x50cea34e7464d3055248042d1817780203b600340f67f1d7f4974ea13368acef","0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890","0x9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba","0xfedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210"]},"user":{"type":"string","title":"User","description":"User of the trade","examples":["0x45d26f28196d226497130c4bac709d808fed4029","0x1234567890abcdef1234567890abcdef12345678","0xabcdef1234567890abcdef1234567890abcdef12","0x9876543210fedcba9876543210fedcba98765432","0xfedcba9876543210fedcba9876543210fedcba98"]},"oid":{"type":"integer","title":"Oid","description":"Order ID of the trade","examples":[191284609448,191284609449,191284609450,191284609451,191284609452]}},"additionalProperties":false,"type":"object","required":["timestamp","side","action","block_number","token_symbol","price","size","value_usd","start_position","closed_pnl","crossed","fee_usd","fee_token_symbol","transaction_hash","user","oid"],"title":"PerpTrade","description":"Perpetual trade with computed type and action fields for client response."},"PerpTradeActionFilter":{"type":"string","enum":["Open/Add","Close/Reduce","Liquidation"],"title":"PerpTradeActionFilter","description":"Enum for perp trade action filters (grouped)."},"PerpTradeFilters":{"properties":{"token_symbol":{"anyOf":[{"type":"string"}],"title":"Token Symbol","description":"Token symbol filter","examples":["BTC","ETH","@107"]},"side":{"anyOf":[{"$ref":"#/components/schemas/PerpTradeType"}],"description":"Position side filter (Long or Short)","examples":["Long","Short"]},"action":{"anyOf":[{"$ref":"#/components/schemas/PerpTradeActionFilter"}],"description":"Action filter (Open/Add, Close/Reduce, Liquidation)","examples":["Open/Add","Close/Reduce","Liquidation"]},"crossed":{"anyOf":[{"type":"boolean"}],"title":"Crossed","description":"Whether the trade was crossed","examples":[true,false]},"size":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Trade size range filter","examples":[{"max":1000,"min":0.001}]},"start_position":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Start position range filter","examples":[{"max":1000,"min":-1000}]},"closed_pnl":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Closed PnL range filter","examples":[{"max":10000,"min":-10000}]},"fee_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Fee in USD range filter","examples":[{"max":1000,"min":0.001}]},"fee_token_symbol":{"anyOf":[{"type":"string"}],"title":"Fee Token Symbol","description":"Fee token filter","examples":["HYPE","USDC"]},"oid":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Order ID range filter","examples":[{"min":100000000000}]},"price":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Price range filter","examples":[{"max":1000,"min":0.001}]},"value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Value in USD range filter","examples":[{"max":1000000,"min":0.001}]}},"additionalProperties":false,"type":"object","title":"PerpTradeFilters","description":"Filters for perp trades endpoint.\n\nThese filters control which perpetual trades are included in the results\nbased on various trade criteria."},"PerpTradeRequest":{"properties":{"address":{"type":"string","maxLength":42,"minLength":42,"title":"Address","description":"User's Hyperliquid address in 42-character hexadecimal format","examples":["0x45d26f28196d226497130c4bac709d808fed4029"]},"date":{"$ref":"#/components/schemas/DateRange","description":"Date range for the trades (ISO 8601 date-time)","examples":[{"from":"2025-10-01T00:00:00Z","to":"2025-10-10T23:59:59Z"}]},"filters":{"anyOf":[{"$ref":"#/components/schemas/PerpTradeFilters"}],"description":"Additional filters for the trades","examples":[{"size":{"max":1000,"min":0.001}}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_PerpTradeSortField_"},"type":"array"}],"title":"Order By","description":"Sort order for the trades","examples":[[{"direction":"DESC","field":"timestamp"}]]}},"additionalProperties":false,"type":"object","required":["address","date"],"title":"PerpTradeRequest","description":"Request model for Perp Trades endpoint."},"PerpTradeResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"data":{"items":{"$ref":"#/components/schemas/PerpTrade"},"type":"array","title":"Data","description":"List of perpetual trades","examples":[[{"action":"Add","block_number":756553592,"closed_pnl":0.0,"crossed":true,"fee_token_symbol":"USDC","fee_usd":0.434851,"oid":191284609448,"price":0.25884,"side":"Short","size":6000.0,"start_position":-7788000.0,"timestamp":"2025-10-08T18:46:11.452000","token_symbol":"DOGE","transaction_hash":"0x50cea34e7464d3055248042d1817780203b600340f67f1d7f4974ea13368acef","user":"0x45d26f28196d226497130c4bac709d808fed4029","value_usd":1553.04},{"action":"Open","block_number":756553593,"closed_pnl":0.0,"crossed":false,"fee_token_symbol":"USDC","fee_usd":2.25,"oid":191284609449,"price":45000.0,"side":"Long","size":0.1,"start_position":0.0,"timestamp":"2025-10-08T15:30:22.123000","token_symbol":"BTC","transaction_hash":"0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef","user":"0x45d26f28196d226497130c4bac709d808fed4029","value_usd":4500.0},{"action":"Close","block_number":756553594,"closed_pnl":150.0,"crossed":true,"fee_token_symbol":"USDC","fee_usd":2.25,"oid":191284609450,"price":3000.0,"side":"Long","size":1.5,"start_position":1000.0,"timestamp":"2025-10-08T12:15:33.789000","token_symbol":"ETH","transaction_hash":"0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890","user":"0x45d26f28196d226497130c4bac709d808fed4029","value_usd":4500.0}]]}},"additionalProperties":false,"type":"object","required":["pagination","data"],"title":"PerpTradeResponse","description":"Response model for perp trades endpoint."},"PerpTradeSortField":{"type":"string","enum":["timestamp","size","fee_usd","closed_pnl","price","value_usd"],"title":"PerpTradeSortField","description":"Enum for perp trade sort fields."},"PerpTradeType":{"type":"string","enum":["Long","Short"],"title":"PerpTradeType","description":"Enum for perp trade position types."},"PnlByAddressItem":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Trader address (hex)"},"market_id":{"anyOf":[{"type":"string"}],"title":"Market Id","description":"Market ID"},"question":{"anyOf":[{"type":"string"}],"title":"Question","description":"Market question"},"event_id":{"anyOf":[{"type":"string"}],"title":"Event Id","description":"Parent event ID"},"event_title":{"anyOf":[{"type":"string"}],"title":"Event Title","description":"Parent event title"},"side_held":{"anyOf":[{"type":"string"}],"title":"Side Held","description":"Side held (Yes/No)","examples":["Yes"]},"net_buy_cost_usd":{"anyOf":[{"type":"number"}],"title":"Net Buy Cost Usd","description":"Net buy cost in USD"},"net_sell_proceeds_usd":{"anyOf":[{"type":"number"}],"title":"Net Sell Proceeds Usd","description":"Net sell proceeds in USD"},"redemption_value_usd":{"anyOf":[{"type":"number"}],"title":"Redemption Value Usd","description":"Redemption value in USD"},"unrealized_value_usd":{"anyOf":[{"type":"number"}],"title":"Unrealized Value Usd","description":"Unrealized value in USD"},"total_pnl_usd":{"anyOf":[{"type":"number"}],"title":"Total Pnl Usd","description":"Total PnL in USD"},"market_resolved":{"anyOf":[{"type":"boolean"}],"title":"Market Resolved","description":"Whether market is resolved"}},"type":"object","title":"PnlByAddressItem","description":"PnL by address data from ch_api_pm_pnl_by_address."},"PnlByAddressRequest":{"properties":{"address":{"type":"string","maxLength":100,"minLength":1,"title":"Address","description":"Wallet address (hex, with or without 0x prefix)","examples":["0x1234567890abcdef1234567890abcdef12345678"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_PnlByAddressSortField_"},"type":"array"}],"title":"Order By","description":"Sort order","examples":[[{"direction":"DESC","field":"total_pnl_usd"}]]}},"additionalProperties":false,"type":"object","required":["address"],"title":"PnlByAddressRequest","description":"Request for PnL by address endpoint."},"PnlByAddressResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/PnlByAddressItem"},"type":"array","title":"Data","description":"List of PnL by address records"}},"type":"object","required":["data"],"title":"PnlByAddressResponse","description":"Response for PnL by address endpoint."},"PnlByAddressSortField":{"type":"string","enum":["total_pnl_usd"],"title":"PnlByAddressSortField","description":"Sortable fields for PnL by address endpoint."},"PnlByMarketItem":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Trader address (hex)"},"owner_address":{"anyOf":[{"type":"string"}],"title":"Owner Address","description":"SAFE proxy owner address (hex)"},"side_held":{"anyOf":[{"type":"string"}],"title":"Side Held","description":"Side held: Yes, No, or Both. Reflects last known position even if fully exited (unrealized_value_usd = 0). Null only if no buy activity on record.","examples":["Yes"]},"net_buy_cost_usd":{"anyOf":[{"type":"number"}],"title":"Net Buy Cost Usd","description":"Net buy cost in USD"},"net_sell_proceeds_usd":{"anyOf":[{"type":"number"}],"title":"Net Sell Proceeds Usd","description":"Net sell proceeds in USD"},"redemption_value_usd":{"anyOf":[{"type":"number"}],"title":"Redemption Value Usd","description":"Redemption value in USD"},"unrealized_value_usd":{"anyOf":[{"type":"number"}],"title":"Unrealized Value Usd","description":"Unrealized value in USD"},"total_pnl_usd":{"anyOf":[{"type":"number"}],"title":"Total Pnl Usd","description":"Total PnL in USD"},"question":{"anyOf":[{"type":"string"}],"title":"Question","description":"Market question"},"event_id":{"anyOf":[{"type":"string"}],"title":"Event Id","description":"Parent event ID"},"event_title":{"anyOf":[{"type":"string"}],"title":"Event Title","description":"Parent event title"},"market_resolved":{"anyOf":[{"type":"boolean"}],"title":"Market Resolved","description":"Whether market is resolved"},"market_id":{"type":"string","title":"Market Id","description":"Market ID","examples":["654412"]}},"type":"object","required":["market_id"],"title":"PnlByMarketItem","description":"PnL by market data from ch_api_pm_pnl_by_market."},"PnlByMarketRequest":{"properties":{"market_id":{"type":"string","maxLength":100,"minLength":1,"title":"Market Id","description":"Polymarket market ID","examples":["654412"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_PnlByMarketSortField_"},"type":"array"}],"title":"Order By","description":"Sort order","examples":[[{"direction":"DESC","field":"total_pnl_usd"}]]}},"additionalProperties":false,"type":"object","required":["market_id"],"title":"PnlByMarketRequest","description":"Request for PnL by market endpoint."},"PnlByMarketResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/PnlByMarketItem"},"type":"array","title":"Data","description":"List of PnL by market records"}},"type":"object","required":["data"],"title":"PnlByMarketResponse","description":"Response for PnL by market endpoint."},"PnlByMarketSortField":{"type":"string","enum":["total_pnl_usd"],"title":"PnlByMarketSortField","description":"Sortable fields for PnL by market endpoint."},"PortfolioDefiHoldingsRequest":{"properties":{"wallet_address":{"type":"string","title":"Wallet Address","description":"Wallet address to get DeFi holdings for","examples":["0x4062b997279de7213731dbe00485722a26718892"]}},"type":"object","required":["wallet_address"],"title":"PortfolioDefiHoldingsRequest","description":"Request model for portfolio DeFi holdings endpoint."},"PortfolioDefiHoldingsResponse":{"properties":{"summary":{"$ref":"#/components/schemas/HoldingsSummary","description":"Overall portfolio summary"},"protocols":{"items":{"$ref":"#/components/schemas/ProtocolHolding"},"type":"array","title":"Protocols","description":"Protocol-specific holdings with token breakdown"}},"type":"object","required":["summary","protocols"],"title":"PortfolioDefiHoldingsResponse","description":"Response model for portfolio DeFi holdings endpoint."},"Position":{"properties":{"token_symbol":{"anyOf":[{"type":"string"}],"title":"Token Symbol","description":"Asset symbol (e.g., BTC, ETH)","examples":["STBL","MOODENG","LINEA","MNT","XPL","POPCAT","ASTER","APEX","CAKE","kBONK","PUMP","AAVE","XRP","FARTCOIN","LTC","HYPE"]},"size":{"anyOf":[{"type":"string"}],"title":"Size","description":"Size","examples":["-50367.0","-90052.0","886844.0","-41216.0","287285.0","-830625.0","115318.0","-233414.0","-130696.2","32988760.0","-138651214.0","-4166.24","518189.0","-4118049.1000000001","-25519.5","-124203.88"]},"position_value_usd":{"anyOf":[{"type":"string"}],"title":"Position Value Usd","description":"Position value USD","examples":["5231.62029","10104.73492","13911.034984","70372.1984","104686.654","128140.51875","131727.7514","278672.9746","361388.06262","484868.79448","544899.27102","972650.3904","1262619.3174000001","1538503.1437599999","2428971.5295000002","5003180.6941600004"]},"entry_price_usd":{"anyOf":[{"type":"string"}],"title":"Entry Price Usd","description":"Entry price USD","examples":["0.43499","0.311285","0.017539","2.1451","0.44781","0.482312","1.237829","2.479248","3.16566","0.014817","0.004011","321.1503","2.342915","0.37513","118.4436","35.668"]},"liquidation_price_usd":{"anyOf":[{"type":"string"}],"title":"Liquidation Price Usd","description":"Liquidation price USD","examples":["66.817537196","39.6872752647",null,"88.1741550761",null,"4.6491012357",null,"15.5896400827","28.4748549559",null,"0.030857418","1129.5963712078",null,"1.2802232831","241.4816404977","70.341601964"]},"leverage_value":{"anyOf":[{"type":"integer"}],"title":"Leverage Value","description":"Leverage value","examples":[3,5,3,5,5,10,5,3,3,10,10,10,20,10,10,10]},"leverage_type":{"anyOf":[{"type":"string"}],"title":"Leverage Type","description":"Leverage type: 'cross' or 'isolated'","examples":["cross"]},"leverage_raw_usd":{"anyOf":[{"type":"string"}],"title":"Leverage Raw Usd","description":"Raw USD leverage","examples":[null]},"margin_used_usd":{"anyOf":[{"type":"string"}],"title":"Margin Used Usd","description":"Margin used USD","examples":["1743.87343","2020.946984","4637.011661","14074.43968","20937.3308","12814.051875","26345.55028","92890.991533","120462.68754","48486.879448","54489.927102","97265.03904","63130.96587","153850.314376","242897.15295","500318.069416"]},"max_leverage_value":{"anyOf":[{"type":"integer"}],"title":"Max Leverage Value","description":"Maximum allowed leverage value","examples":[3,5,3,5,10,10,5,3,3,10,10,10,20,10,10,10]},"return_on_equity":{"anyOf":[{"type":"string"}],"title":"Return On Equity","description":"Return on equity","examples":["2.2836393396","3.1976362269","-0.3170037358","1.0202464952","-0.9313170654","6.8014503681","-0.3858741712","1.5553280999","0.3796063748","-0.080518889","0.2043833759","2.7305072757","0.7997260024","0.041030577","1.964028551","-1.2935847889"]},"unrealized_pnl_usd":{"anyOf":[{"type":"string"}],"title":"Unrealized Pnl Usd","description":"Unrealized PnL USD","examples":["16677.54047","17927.1615","-1643.628848","18040.56173","-23962.660389","272480.17968","-11016.244199","300018.231156","52352.90264","-3935.800291","11369.202859","365338.967716","48546.2885","6338.574704","593651.864457","-573072.1080069999"]},"cumulative_funding_all_time_usd":{"anyOf":[{"type":"string"}],"title":"Cumulative Funding All Time Usd","description":"Cumulative funding all time USD","examples":["-623.219722","200.361581","-15661.118983","-466.549455","-155941.595089","-16804.812127","-2876.845095","-12548.049802","-6725.753686","-452415.305019","-307981.22475","-63943.533792","-696541.895053","-657117.164294","-46208.789883","-1259220.3467659999"]},"cumulative_funding_since_change_usd":{"anyOf":[{"type":"string"}],"title":"Cumulative Funding Since Change Usd","description":"Cumulative funding since change USD","examples":["-618.925976","201.157877","-9.879445","-466.549455","16.315207","-12489.274666","116.714407","-1114.494347","-368.120106","-1188.763562","-84.174005","-3559.657636","226.120835","-6098.770749","-1905.722385","-1336.356934"]},"cumulative_funding_since_open_usd":{"anyOf":[{"type":"string"}],"title":"Cumulative Funding Since Open Usd","description":"Cumulative funding since open USD","examples":["-623.219722","200.361581","-10.321013","-466.549455","-18163.202938","-16804.812127","-573.275815","-12548.049802","-888.686872","-1201.699085","-878.996853","-63943.533792","323.728772","-6111.589925","-46208.789883","-1259220.3467659999"]}},"additionalProperties":false,"type":"object","title":"Position","description":"Individual perpetual position."},"PositionDetailItem":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Holder address (hex)"},"owner_address":{"anyOf":[{"type":"string"}],"title":"Owner Address","description":"SAFE proxy owner address (hex)"},"outcome":{"anyOf":[{"type":"string"}],"title":"Outcome","description":"Outcome label","examples":["Yes"]},"outcome_index":{"anyOf":[{"type":"integer"}],"title":"Outcome Index","description":"Outcome index","examples":[1]},"token_id":{"anyOf":[{"type":"string"}],"title":"Token Id","description":"CLOB token ID"},"balance":{"anyOf":[{"type":"number"}],"title":"Balance","description":"Token balance"},"buy_cost_usd":{"anyOf":[{"type":"number"}],"title":"Buy Cost Usd","description":"Total buy cost in USD"},"buy_tokens":{"anyOf":[{"type":"number"}],"title":"Buy Tokens","description":"Total tokens bought"},"sell_proceeds_usd":{"anyOf":[{"type":"number"}],"title":"Sell Proceeds Usd","description":"Total sell proceeds in USD"},"sell_tokens":{"anyOf":[{"type":"number"}],"title":"Sell Tokens","description":"Total tokens sold"},"avg_entry_price":{"anyOf":[{"type":"number"}],"title":"Avg Entry Price","description":"Average entry price"},"current_price":{"anyOf":[{"type":"number"}],"title":"Current Price","description":"Current price"},"unrealized_value_usd":{"anyOf":[{"type":"number"}],"title":"Unrealized Value Usd","description":"Unrealized value in USD"},"redemption_value_usd":{"anyOf":[{"type":"number"}],"title":"Redemption Value Usd","description":"Redemption value in USD"},"token_pnl_usd":{"anyOf":[{"type":"number"}],"title":"Token Pnl Usd","description":"Token PnL in USD"},"event_id":{"anyOf":[{"type":"string"}],"title":"Event Id","description":"Parent event ID"},"event_title":{"anyOf":[{"type":"string"}],"title":"Event Title","description":"Parent event title"},"market_resolved":{"anyOf":[{"type":"boolean"}],"title":"Market Resolved","description":"Whether market is resolved"},"market_id":{"type":"string","title":"Market Id","description":"Market ID","examples":["654412"]}},"type":"object","required":["market_id"],"title":"PositionDetailItem","description":"Position detail data from ch_api_pm_position_detail."},"PositionDetailRequest":{"properties":{"market_id":{"type":"string","maxLength":100,"minLength":1,"title":"Market Id","description":"Polymarket market ID","examples":["654412"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"}},"additionalProperties":false,"type":"object","required":["market_id"],"title":"PositionDetailRequest","description":"Request for position detail endpoint."},"PositionDetailResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/PositionDetailItem"},"type":"array","title":"Data","description":"List of position detail records"}},"type":"object","required":["data"],"title":"PositionDetailResponse","description":"Response for position detail endpoint."},"PositionSide":{"type":"string","enum":["Long","Short"],"title":"PositionSide","description":"Shared enum for position side direction."},"ProfilerAddressBalancesFilters":{"properties":{"value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Balance range filter in USD","examples":[{"max":100000,"min":10}]},"price_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token price range filter in USD","examples":[{"max":1000,"min":0.01}]},"token_amount":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Token amount range filter","examples":[{"max":1000000,"min":1}]},"token_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Symbol","description":"Token symbol filter","examples":["USDC","%ETH%"]},"token_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Address","description":"Token address filter","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"token_name":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Name","description":"Token name filter","examples":["USD Coin","%Ethereum%"]}},"additionalProperties":false,"type":"object","title":"ProfilerAddressBalancesFilters","description":"Filters for profiler address current balance endpoint.\n\nThese filters control which token balances are included."},"ProfilerAddressBalancesRequest":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Address to get balances for","examples":["0x28c6c06298d514db089934071355e5743bf21d60","8zFZHuSRuDpuAR7J6FzwyF3vKNx4CVW3DFHJerQhc7Zd"]},"entity_name":{"anyOf":[{"type":"string"}],"title":"Entity Name","description":"Entity name to get balances for","examples":["Vitalik Buterin","Binance"]},"chain":{"$ref":"#/components/schemas/ProfilerChain","description":"Blockchain chain for the balances","examples":["ethereum"]},"hide_spam_token":{"type":"boolean","title":"Hide Spam Token","description":"Removes suspicious tokens from the balance list","default":true,"examples":[true]},"filters":{"anyOf":[{"$ref":"#/components/schemas/ProfilerAddressBalancesFilters"}],"description":"Additional filters to apply. Only filters for columns that are being selected will be applied.","examples":[{"token_symbol":"USDC","value_usd":{"min":10}}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_ProfilerAddressBalancesSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering"}},"additionalProperties":false,"type":"object","required":["chain"],"title":"ProfilerAddressBalancesRequest","description":"","examples":[{"address":"0x28c6c06298d514db089934071355e5743bf21d60","chain":"ethereum","hide_spam_token":true,"pagination":{"page":1,"per_page":10}},{"chain":"ethereum","entity_name":"Vitalik Buterin","hide_spam_token":true,"pagination":{"page":1,"per_page":10}}]},"ProfilerAddressBalancesResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"data":{"items":{"$ref":"#/components/schemas/ProfilerBalance"},"type":"array","title":"Data","description":"List of balance records"}},"type":"object","required":["pagination","data"],"title":"ProfilerAddressBalancesResponse","description":"Response model for profiler address current-balance endpoint.\n\nContains the filtered balance data with metadata."},"ProfilerAddressBalancesSortField":{"type":"string","enum":["value_usd","token_symbol"],"title":"ProfilerAddressBalancesSortField","description":"Enum for sortable fields in profiler address balances."},"ProfilerAddressCounterpartiesFilters":{"properties":{"interaction_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Interaction count range filter","examples":[{"max":1000,"min":5}]},"total_volume_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total volume range filter in USD","examples":[{"max":1000000,"min":1000}]},"volume_in_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Volume in USD range filter","examples":[{"max":1000000,"min":1000}]},"volume_out_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Volume out USD range filter","examples":[{"max":1000000,"min":1000}]},"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels for counterparties","examples":[["Public Figure"],["Exchange"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels for counterparties","examples":[["Public Figure"],["Exchange"]]}},"additionalProperties":false,"type":"object","title":"ProfilerAddressCounterpartiesFilters","description":"Filters for profiler address counterparties endpoint.\n\nThese filters control which counterparties and interactions are included."},"ProfilerAddressCounterpartiesRequest":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Address to get counterparties for","examples":["0x28c6c06298d514db089934071355e5743bf21d60","8zFZHuSRuDpuAR7J6FzwyF3vKNx4CVW3DFHJerQhc7Zd"]},"entity_name":{"anyOf":[{"type":"string"}],"title":"Entity Name","description":"Entity name to get counterparties for","examples":["Vitalik Buterin","Binance"]},"chain":{"$ref":"#/components/schemas/ProfilerChain","description":"Blockchain chain for the counterparties data","examples":["ethereum"]},"date":{"$ref":"#/components/schemas/DateRange","description":"Date range for the counterparties data. Note: High-volume addresses (e.g., WETH on Base) are limited to 180 days.","examples":[{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"}]},"source_input":{"$ref":"#/components/schemas/SourceInput","description":"Type of interactions to include","default":"Combined"},"group_by":{"$ref":"#/components/schemas/GroupBy","description":"Group counterparties by wallet or entity","default":"wallet"},"filters":{"anyOf":[{"$ref":"#/components/schemas/ProfilerAddressCounterpartiesFilters"}],"description":"Additional filters to apply. Only filters for columns that are being selected will be applied.","examples":[{"include_smart_money_labels":["Exchange"],"interaction_count":{"min":5},"total_volume_usd":{"min":1000}}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted (default), returns labels as per subscription plan (existing behavior). When false, returns free-tier labels for all users. When true, returns premium labels (20 credits, currently available to internal users only)."},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_ProfilerAddressCounterpartiesSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"total_volume_usd\", \"direction\": \"DESC\"}] - Sort by total volume descending\n- [{\"field\": \"interaction_count\", \"direction\": \"ASC\"}] - Sort by interaction count ascending\n- [{\"field\": \"last_interaction_date\", \"direction\": \"DESC\"}] - Sort by last interaction date descending\n- [{\"field\": \"volume_in_usd\", \"direction\": \"DESC\"}] - Sort by incoming volume descending"}},"additionalProperties":false,"type":"object","required":["chain","date"],"title":"ProfilerAddressCounterpartiesRequest","description":"","examples":[{"address":"0x28c6c06298d514db089934071355e5743bf21d60","chain":"ethereum","date":{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"},"group_by":"wallet","pagination":{"page":1,"per_page":10},"source_input":"Combined"},{"chain":"ethereum","date":{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"},"entity_name":"Vitalik Buterin","group_by":"entity","pagination":{"page":1,"per_page":10},"source_input":"Combined"}]},"ProfilerAddressCounterpartiesResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"data":{"items":{"$ref":"#/components/schemas/ProfilerCounterparty"},"type":"array","title":"Data","description":"List of counterparty records"}},"type":"object","required":["pagination","data"],"title":"ProfilerAddressCounterpartiesResponse","description":"Response model for profiler address counterparties endpoint.\n\nContains the filtered counterparties data with metadata."},"ProfilerAddressCounterpartiesSortField":{"type":"string","enum":["interaction_count","total_volume_usd","last_interaction_date","volume_in_usd","volume_out_usd"],"title":"ProfilerAddressCounterpartiesSortField","description":"Enum for sortable fields in profiler address counterparties."},"ProfilerAddressHistoricalBalancesFilters":{"properties":{"value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Balance range filter in USD","examples":[{"max":100000,"min":10}]},"token_amount":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Token balance count range filter","examples":[{"max":1000000,"min":1}]},"token_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Symbol","description":"Token symbol filter","examples":["USDC","%ETH%"]},"token_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Address","description":"Token address filter","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"hide_spam_tokens":{"anyOf":[{"type":"boolean"}],"title":"Hide Spam Tokens","description":"Whether to hide spam tokens from results","default":true}},"additionalProperties":false,"type":"object","title":"ProfilerAddressHistoricalBalancesFilters","description":"Filters for profiler address historical balances endpoint.\n\nThese filters control which historical balance data is included."},"ProfilerAddressHistoricalBalancesRequest":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Address to get historical balances for","examples":["0x28c6c06298d514db089934071355e5743bf21d60","8zFZHuSRuDpuAR7J6FzwyF3vKNx4CVW3DFHJerQhc7Zd"]},"entity_name":{"anyOf":[{"type":"string"}],"title":"Entity Name","description":"Entity name to get historical balances for","examples":["Vitalik Buterin","Binance"]},"chain":{"$ref":"#/components/schemas/ProfilerChain","description":"Blockchain chain for the historical balances","examples":["ethereum"]},"date":{"$ref":"#/components/schemas/DateRange","description":"Date range for historical data","examples":[{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"}]},"filters":{"anyOf":[{"$ref":"#/components/schemas/ProfilerAddressHistoricalBalancesFilters"}],"description":"Additional filters to apply. Only filters for columns that are being selected will be applied.","examples":[{"hide_spam_tokens":true,"token_symbol":"USDC","value_usd":{"min":10}}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_ProfilerAddressHistoricalBalancesSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering"}},"additionalProperties":false,"type":"object","required":["chain","date"],"title":"ProfilerAddressHistoricalBalancesRequest","description":"","examples":[{"address":"0x28c6c06298d514db089934071355e5743bf21d60","chain":"ethereum","date":{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"},"pagination":{"page":1,"per_page":10}},{"chain":"ethereum","date":{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"},"entity_name":"Vitalik Buterin","pagination":{"page":1,"per_page":10}}]},"ProfilerAddressHistoricalBalancesResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"data":{"items":{"$ref":"#/components/schemas/ProfilerHistoricalBalance"},"type":"array","title":"Data","description":"List of historical balance records"}},"type":"object","required":["pagination","data"],"title":"ProfilerAddressHistoricalBalancesResponse","description":"Response model for profiler address historical-balances endpoint.\n\nContains the filtered historical balance data with metadata."},"ProfilerAddressHistoricalBalancesSortField":{"type":"string","enum":["block_timestamp","value_usd","token_symbol"],"title":"ProfilerAddressHistoricalBalancesSortField","description":"Enum for sortable fields in profiler address historical balances."},"ProfilerAddressLabel":{"properties":{"label":{"type":"string","title":"Label","description":"The label name","examples":["Token Millionaire","nansen.eth","30D Smart Trader"]},"category":{"anyOf":[{"type":"string"}],"title":"Category","description":"Label category (smart_money, behavioral, defi, social, cefi, nft, others)","examples":["behavioral","social","smart_money"]}},"type":"object","required":["label"],"title":"ProfilerAddressLabel","description":"A single label for a wallet address."},"ProfilerAddressLabelsRequest":{"properties":{"address":{"type":"string","title":"Address","description":"Wallet address to get labels for","examples":["0x4a7c6899cdcb379e284fbfd045462e751da4c7ce","HuB5nXrX3AY1eCw688hXGdDgNcfWmZL74kXs7VUxLZFw"]},"chain":{"$ref":"#/components/schemas/ProfilerLabelsChain","description":"Blockchain chain. Use 'all' to search all chains compatible with the address format.","examples":["ethereum","solana","all"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters (default: 100 per page)"}},"additionalProperties":false,"type":"object","required":["address","chain"],"title":"ProfilerAddressLabelsRequest","description":"Request model for Address Labels endpoint.","examples":[{"address":"0x4a7c6899cdcb379e284fbfd045462e751da4c7ce","chain":"ethereum","pagination":{"page":1,"per_page":100}},{"address":"HuB5nXrX3AY1eCw688hXGdDgNcfWmZL74kXs7VUxLZFw","chain":"solana","pagination":{"page":1,"per_page":100}}]},"ProfilerAddressLabelsResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"data":{"items":{"$ref":"#/components/schemas/ProfilerAddressLabel"},"type":"array","title":"Data","description":"List of labels for the address"}},"type":"object","required":["pagination","data"],"title":"ProfilerAddressLabelsResponse","description":"Response model for Address Labels endpoint."},"ProfilerAddressPnl":{"properties":{"token_address":{"type":"string","title":"Token Address","description":"Hexadecimal representation of the token's address"},"token_symbol":{"type":"string","title":"Token Symbol","description":"Symbol of the token"},"token_price":{"anyOf":[{"type":"number"}],"title":"Token Price","description":"Price of the token on date_to"},"roi_percent_realised":{"anyOf":[{"type":"number"}],"title":"Roi Percent Realised","description":"Realised return on investment for only realised gains (not multiplied by 100)"},"pnl_usd_realised":{"anyOf":[{"type":"number"}],"title":"Pnl Usd Realised","description":"Realised profit and loss in USD"},"pnl_usd_unrealised":{"anyOf":[{"type":"number"}],"title":"Pnl Usd Unrealised","description":"Unrealised profit and loss in USD"},"roi_percent_unrealised":{"anyOf":[{"type":"number"}],"title":"Roi Percent Unrealised","description":"Unrealised return on investment for only unrealised gains (not multiplied by 100)"},"bought_amount":{"anyOf":[{"type":"number"}],"title":"Bought Amount","description":"Amount of tokens bought from date_from to date_to"},"bought_usd":{"anyOf":[{"type":"number"}],"title":"Bought Usd","description":"USD value of bought tokens"},"cost_basis_usd":{"anyOf":[{"type":"number"}],"title":"Cost Basis Usd","description":"Cost basis of tokens in USD as of date_to"},"sold_amount":{"anyOf":[{"type":"number"}],"title":"Sold Amount","description":"Amount of tokens sold from date_from to date_to"},"sold_usd":{"anyOf":[{"type":"number"}],"title":"Sold Usd","description":"USD value of sold tokens"},"avg_sold_price_usd":{"anyOf":[{"type":"number"}],"title":"Avg Sold Price Usd","description":"Average sale price of tokens sold in USD"},"holding_amount":{"anyOf":[{"type":"number"}],"title":"Holding Amount","description":"Current token balance"},"holding_usd":{"anyOf":[{"type":"number"}],"title":"Holding Usd","description":"USD value of token balance"},"nof_buys":{"type":"string","title":"Nof Buys","description":"Number of buys (either inflow or dex buy)"},"nof_sells":{"type":"string","title":"Nof Sells","description":"Number of sells (either outflow or dex sell)"},"max_balance_held":{"anyOf":[{"type":"number"}],"title":"Max Balance Held","description":"Maximum amount of tokens held at some point in time"},"max_balance_held_usd":{"anyOf":[{"type":"number"}],"title":"Max Balance Held Usd","description":"Maximum amount of tokens in current USD value, held at some point in time"}},"type":"object","required":["token_address","token_symbol","nof_buys","nof_sells"],"title":"ProfilerAddressPnl","description":"Individual profiler address PnL record.\n\nRepresents PnL data for a token traded by the wallet."},"ProfilerAddressPnlFilters":{"properties":{"show_realized":{"anyOf":[{"type":"boolean"}],"title":"Show Realized","description":"Include realized profit/loss in results","default":false,"examples":[true,false]},"token_address":{"anyOf":[{"type":"string"}],"title":"Token Address","description":"Token address filter for specific token PnL","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]}},"additionalProperties":false,"type":"object","title":"ProfilerAddressPnlFilters","description":"Filters for profiler address PnL endpoint.\n\nThese filters control token filtering and realized PnL options for analysis."},"ProfilerAddressPnlRequest":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Wallet address to get PnL for","examples":["0x39d52da6beec991f075eebe577474fd105c5caec","8zFZHuSRuDpuAR7J6FzwyF3vKNx4CVW3DFHJerQhc7Zd"]},"entity_name":{"anyOf":[{"type":"string"}],"title":"Entity Name","description":"Entity name to get PnL for","examples":["Vitalik Buterin","Binance"]},"chain":{"$ref":"#/components/schemas/ProfilerPnLChain","description":"Blockchain chain for the PnL data","examples":["ethereum"]},"date":{"anyOf":[{"$ref":"#/components/schemas/DateRange"}],"description":"Date range for PnL analysis (ISO 8601 date-time)","examples":[{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"}]},"filters":{"anyOf":[{"$ref":"#/components/schemas/ProfilerAddressPnlFilters"}],"description":"Additional filters to apply.","examples":[{"show_realized":false}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_ProfilerAddressPnlSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering (default: pnl_usd_realised DESC).\n\nIf the parameter show_realized is false, the default sort order is pnl_usd_unrealised DESC."}},"additionalProperties":false,"type":"object","required":["chain"],"title":"ProfilerAddressPnlRequest","description":"","examples":[{"address":"0x39d52da6beec991f075eebe577474fd105c5caec","chain":"ethereum","date":{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"},"pagination":{"page":1,"per_page":10}},{"chain":"ethereum","date":{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"},"entity_name":"Vitalik Buterin","pagination":{"page":1,"per_page":10}}]},"ProfilerAddressPnlResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"data":{"items":{"$ref":"#/components/schemas/ProfilerAddressPnl"},"type":"array","title":"Data","description":"List of PnL records"}},"type":"object","required":["pagination","data"],"title":"ProfilerAddressPnlResponse","description":"Response model for profiler address pnl endpoint.\n\nContains the filtered PnL data with metadata."},"ProfilerAddressPnlSortField":{"type":"string","enum":["pnl_usd_realised","roi_percent_realised","pnl_usd_unrealised","roi_percent_unrealised","bought_usd","sold_usd","holding_usd"],"title":"ProfilerAddressPnlSortField","description":"Enum for sortable fields in profiler address PnL."},"ProfilerAddressPnlSummaryRequest":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Address to get PnL summary for","examples":["0x39d52da6beec991f075eebe577474fd105c5caec","8zFZHuSRuDpuAR7J6FzwyF3vKNx4CVW3DFHJerQhc7Zd"]},"entity_name":{"anyOf":[{"type":"string"}],"title":"Entity Name","description":"Entity name to get PnL summary for","examples":["Vitalik Buterin","Binance"]},"chain":{"$ref":"#/components/schemas/ProfilerPnLChain","description":"Blockchain chain for the PnL data","examples":["ethereum"]},"date":{"$ref":"#/components/schemas/DateRange","description":"Date range for the PnL data","examples":[{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"}]}},"additionalProperties":false,"type":"object","required":["chain","date"],"title":"ProfilerAddressPnlSummaryRequest","description":"","examples":[{"address":"0x39d52da6beec991f075eebe577474fd105c5caec","chain":"ethereum","date":{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"}},{"chain":"ethereum","date":{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"},"entity_name":"Vitalik Buterin"}]},"ProfilerAddressPnlSummaryResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"top5_tokens":{"items":{"$ref":"#/components/schemas/ProfilerTopToken"},"type":"array","title":"Top5 Tokens","description":"Top 5 tokens by realized profit"},"traded_token_count":{"type":"integer","title":"Traded Token Count","description":"Total number of different tokens that have been bought or sold"},"traded_times":{"type":"integer","title":"Traded Times","description":"Total number of sales (outflow or dex sell)"},"realized_pnl_usd":{"type":"number","title":"Realized Pnl Usd","description":"Total realized profit and loss in USD"},"realized_pnl_percent":{"type":"number","title":"Realized Pnl Percent","description":"Realized profit and loss as a percentage (not multiplied by 100)"},"win_rate":{"type":"number","title":"Win Rate","description":"Number of sales where price of the token was higher than cost basis"}},"type":"object","required":["pagination","top5_tokens","traded_token_count","traded_times","realized_pnl_usd","realized_pnl_percent","win_rate"],"title":"ProfilerAddressPnlSummaryResponse","description":"Response model for profiler address pnl-summary endpoint.\n\nContains aggregate PnL statistics and top profitable tokens."},"ProfilerAddressRelatedWalletsChain":{"type":"string","enum":["arbitrum","avalanche","base","bitcoin","bnb","ethereum","injective","iotaevm","linea","mantle","monad","near","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","starknet","sui","ton","tron"],"title":"ProfilerAddressRelatedWalletsChain","description":"Chains supported in profiler related wallets analysis."},"ProfilerAddressRelatedWalletsRequest":{"properties":{"address":{"type":"string","title":"Address","description":"Address to get related wallets for","examples":["0x28c6c06298d514db089934071355e5743bf21d60","8zFZHuSRuDpuAR7J6FzwyF3vKNx4CVW3DFHJerQhc7Zd"]},"chain":{"$ref":"#/components/schemas/ProfilerAddressRelatedWalletsChain","description":"Blockchain chain for the related wallets data","examples":["ethereum"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_ProfilerAddressRelatedWalletsSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering"}},"additionalProperties":false,"type":"object","required":["address","chain"],"title":"ProfilerAddressRelatedWalletsRequest","description":""},"ProfilerAddressRelatedWalletsResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"data":{"items":{"$ref":"#/components/schemas/ProfilerRelatedWallet"},"type":"array","title":"Data","description":"List of related wallet records"}},"type":"object","required":["pagination","data"],"title":"ProfilerAddressRelatedWalletsResponse","description":"Response model for profiler address related wallets endpoint.\n\nContains the related wallets data with metadata."},"ProfilerAddressRelatedWalletsSortField":{"type":"string","enum":["order"],"title":"ProfilerAddressRelatedWalletsSortField","description":"Enum for sortable fields in profiler address related wallets."},"ProfilerAddressTransactionsFilters":{"properties":{"token_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Symbol","description":"Token symbol filter","examples":["USDC","%ETH%"]},"token_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Address","description":"Token address filter","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"counterparty_name":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Counterparty Name","description":"Counterparty name filter","examples":["Uniswap","%DEX%"]},"counterparty_address":{"anyOf":[{"type":"string"}],"title":"Counterparty Address","description":"Counterparty address filter","examples":["0x7a250d5630b4cf539739df2c5dacb4c659f2488d"]},"volume_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Transaction volume range filter in USD","examples":[{"max":10000,"min":100}]},"method":{"anyOf":[{"type":"string"}],"title":"Method","description":"Transaction method filter","examples":["sent","received"]},"source_type":{"anyOf":[{"type":"string"}],"title":"Source Type","description":"Transaction source type filter","examples":["dex","transfer"]}},"additionalProperties":false,"type":"object","title":"ProfilerAddressTransactionsFilters","description":"Filters for profiler address transactions endpoint.\n\nThese filters control which transactions are included\nin the wallet transaction history."},"ProfilerAddressTransactionsRequest":{"properties":{"address":{"type":"string","title":"Address","description":"Address to get transactions for","examples":["0x28c6c06298d514db089934071355e5743bf21d60","8zFZHuSRuDpuAR7J6FzwyF3vKNx4CVW3DFHJerQhc7Zd"]},"chain":{"$ref":"#/components/schemas/ProfilerTransactionsChain","description":"Blockchain chain for the transactions","examples":["ethereum"]},"date":{"$ref":"#/components/schemas/DateRange","description":"Date range for the transactions","examples":[{"from":"2025-08-01T00:00:00Z","to":"2025-08-10T23:59:59Z"}]},"hide_spam_token":{"type":"boolean","title":"Hide Spam Token","description":"Removes suspicious tokens from the transaction list","default":true,"examples":[true]},"filters":{"anyOf":[{"$ref":"#/components/schemas/ProfilerAddressTransactionsFilters"}],"description":"Additional filters to apply. Only filters for columns that are being selected will be applied.","examples":[{"volume_usd":{"min":100}}]},"pagination":{"$ref":"#/components/schemas/ProfilerPaginationRequest","description":"Pagination parameters (max 100 records per page for performance)"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_ProfilerAddressTransactionsSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering"}},"additionalProperties":false,"type":"object","required":["address","chain","date"],"title":"ProfilerAddressTransactionsRequest","description":""},"ProfilerAddressTransactionsResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"data":{"items":{"$ref":"#/components/schemas/ProfilerTransaction"},"type":"array","title":"Data","description":"List of transaction records"}},"type":"object","required":["pagination","data"],"title":"ProfilerAddressTransactionsResponse","description":"Response model for profiler address transactions endpoint.\n\nContains the filtered transaction data with metadata."},"ProfilerAddressTransactionsSortField":{"type":"string","enum":["block_timestamp"],"title":"ProfilerAddressTransactionsSortField","description":"Enum for sortable fields in smart money inflows."},"ProfilerBalance":{"properties":{"chain":{"type":"string","title":"Chain","description":"Chain"},"address":{"type":"string","title":"Address","description":"Address of the wallet. Empty if entity_name is provided."},"token_address":{"type":"string","title":"Token Address","description":"Address of token"},"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol"},"token_name":{"anyOf":[{"type":"string"}],"title":"Token Name","description":"Token name"},"token_amount":{"anyOf":[{"type":"number"}],"title":"Token Amount","description":"Token balance"},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Price of the token"},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"Token balance value in USD"}},"type":"object","required":["chain","address","token_address","token_symbol"],"title":"ProfilerBalance","description":"Individual profiler balance record.\n\nRepresents a single token balance from the wallet profiler."},"ProfilerChain":{"type":"string","enum":["all","arbitrum","avalanche","base","bitcoin","bnb","ethereum","hyperevm","injective","iotaevm","linea","mantle","monad","near","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","starknet","sui","ton","tron"],"title":"ProfilerChain","description":"Chains supported in profiler analysis."},"ProfilerCounterparty":{"properties":{"counterparty_address":{"type":"string","title":"Counterparty Address","description":"Counterparty address in hex format"},"counterparty_address_label":{"anyOf":[{"items":{"type":"string"},"type":"array"}],"title":"Counterparty Address Label","description":"List of labels associated with this counterparty"},"interaction_count":{"type":"integer","title":"Interaction Count","description":"Total number of interactions with this counterparty"},"total_volume_usd":{"anyOf":[{"type":"number"}],"title":"Total Volume Usd","description":"Total transaction volume in USD"},"volume_in_usd":{"anyOf":[{"type":"number"}],"title":"Volume In Usd","description":"Incoming transaction volume in USD"},"volume_out_usd":{"anyOf":[{"type":"number"}],"title":"Volume Out Usd","description":"Outgoing transaction volume in USD"},"tokens_info":{"anyOf":[{"items":{"$ref":"#/components/schemas/TokenInfo"},"type":"array"}],"title":"Tokens Info","description":"Information about tokens transferred with this counterparty"}},"type":"object","required":["counterparty_address","interaction_count"],"title":"ProfilerCounterparty","description":"Individual profiler counterparty record.\n\nRepresents a counterparty that a wallet has interacted with."},"ProfilerHistoricalBalance":{"properties":{"block_timestamp":{"type":"string","title":"Block Timestamp","description":"The block timestamp as date"},"token_address":{"type":"string","title":"Token Address","description":"Token Address"},"chain":{"type":"string","title":"Chain","description":"Chain"},"token_amount":{"anyOf":[{"type":"number"}],"title":"Token Amount","description":"Token amount"},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"Usd balance of the holdings"},"token_symbol":{"type":"string","title":"Token Symbol","description":"Symbol of the token"}},"type":"object","required":["block_timestamp","token_address","chain","token_symbol"],"title":"ProfilerHistoricalBalance","description":"Individual profiler historical balance record.\n\nRepresents a single historical token balance from the wallet profiler."},"ProfilerLabelsChain":{"type":"string","enum":["all","arbitrum","avalanche","base","bnb","ethereum","hyperevm","hyperliquid","iotaevm","linea","mantle","monad","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","tron"],"title":"ProfilerLabelsChain","description":"Chains supported for Profiler Address Labels endpoint."},"ProfilerPaginationRequest":{"properties":{"page":{"type":"integer","minimum":1.0,"title":"Page","description":"Page number (1-based)","default":1},"per_page":{"type":"integer","maximum":100.0,"minimum":1.0,"title":"Per Page","description":"Number of records per page (max 100 for performance)","default":20}},"type":"object","title":"ProfilerPaginationRequest","description":"Pagination parameters for profiler endpoints with performance constraints."},"ProfilerPnLChain":{"type":"string","enum":["all","arbitrum","avalanche","base","bnb","ethereum","linea","mantle","monad","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic"],"title":"ProfilerPnLChain","description":"Chains supported in profiler PnL analysis."},"ProfilerRelatedWallet":{"properties":{"address":{"type":"string","title":"Address","description":"Hexadecimal representation of the related address"},"address_label":{"anyOf":[{"type":"string"}],"title":"Address Label","description":"The label of the address"},"relation":{"type":"string","title":"Relation","description":"The type of relation between the address and the input address"},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"Hexadecimal representation of the transaction hash"},"block_timestamp":{"type":"string","title":"Block Timestamp","description":"The timestamp of the transaction"},"order":{"type":"integer","title":"Order","description":"The order of the relation"},"chain":{"type":"string","title":"Chain","description":"The chain of the relation"}},"type":"object","required":["address","relation","transaction_hash","block_timestamp","order","chain"],"title":"ProfilerRelatedWallet","description":"Individual profiler related wallet record.\n\nRepresents a wallet that is related to the input address."},"ProfilerTokenInfo":{"properties":{"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol"},"token_amount":{"type":"number","title":"Token Amount","description":"Token amount"},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Token price in USD"},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"Token value in USD"},"token_address":{"type":"string","title":"Token Address","description":"Token contract address"},"chain":{"type":"string","title":"Chain","description":"Blockchain chain"},"from_address":{"type":"string","title":"From Address","description":"Source address"},"to_address":{"type":"string","title":"To Address","description":"Destination address"},"from_address_label":{"anyOf":[{"type":"string"}],"title":"From Address Label","description":"Source address label"},"to_address_label":{"anyOf":[{"type":"string"}],"title":"To Address Label","description":"Destination address label"}},"type":"object","required":["token_symbol","token_amount","token_address","chain","from_address","to_address"],"title":"ProfilerTokenInfo","description":"Token information for profiler transactions.\n\nRepresents detailed information about a token in a transaction."},"ProfilerTopToken":{"properties":{"realized_pnl":{"anyOf":[{"type":"number"}],"title":"Realized Pnl","description":"Realized profit and loss in USD"},"realized_roi":{"anyOf":[{"type":"number"}],"title":"Realized Roi","description":"Realized return on investment as percentage"},"token_address":{"type":"string","title":"Token Address","description":"Token contract address"},"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol"},"chain":{"type":"string","title":"Chain","description":"Blockchain chain"}},"type":"object","required":["realized_pnl","realized_roi","token_address","token_symbol","chain"],"title":"ProfilerTopToken","description":"Individual top token record for PnL summary.\n\nRepresents a top profitable token from the wallet's trading history."},"ProfilerTransaction":{"properties":{"chain":{"type":"string","title":"Chain","description":"Blockchain chain"},"method":{"type":"string","title":"Method","description":"Transaction method (sent/received)"},"tokens_sent":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProfilerTokenInfo"},"type":"array"}],"title":"Tokens Sent","description":"Tokens sent in the transaction"},"tokens_received":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProfilerTokenInfo"},"type":"array"}],"title":"Tokens Received","description":"Tokens received in the transaction"},"volume_usd":{"anyOf":[{"type":"number"}],"title":"Volume Usd","description":"Transaction volume in USD"},"block_timestamp":{"type":"string","title":"Block Timestamp","description":"Block timestamp in ISO format"},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"Transaction hash in hex format"},"source_type":{"type":"string","title":"Source Type","description":"Transaction source type"}},"type":"object","required":["chain","method","block_timestamp","transaction_hash","source_type"],"title":"ProfilerTransaction","description":"Individual profiler transaction record.\n\nRepresents a single transaction from the wallet profiler."},"ProfilerTransactionsChain":{"type":"string","enum":["all","arbitrum","avalanche","base","bitcoin","bnb","ethereum","injective","iotaevm","linea","mantle","monad","near","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","starknet","sui","ton","tron"],"title":"ProfilerTransactionsChain","description":"Chains supported in profiler transactions analysis."},"ProtocolHolding":{"properties":{"protocol_name":{"type":"string","title":"Protocol Name","description":"User-friendly protocol name"},"chain":{"type":"string","title":"Chain","description":"Blockchain network"},"total_value_usd":{"type":"number","title":"Total Value Usd","description":"Total USD value in this protocol"},"total_assets_usd":{"type":"number","title":"Total Assets Usd","description":"Total USD value of assets in this protocol"},"total_debts_usd":{"type":"number","title":"Total Debts Usd","description":"Total USD value of debts in this protocol"},"total_rewards_usd":{"type":"number","title":"Total Rewards Usd","description":"Total USD value of rewards in this protocol"},"tokens":{"items":{"$ref":"#/components/schemas/ProtocolToken"},"type":"array","title":"Tokens","description":"Token holdings in this protocol"}},"type":"object","required":["protocol_name","chain","total_value_usd","total_assets_usd","total_debts_usd","total_rewards_usd","tokens"],"title":"ProtocolHolding","description":"Holdings summary for a specific protocol."},"ProtocolToken":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Token contract address (null for native tokens)"},"symbol":{"anyOf":[{"type":"string"}],"title":"Symbol","description":"Token symbol"},"amount":{"anyOf":[{"type":"number"}],"title":"Amount","description":"Token amount"},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"USD value"},"position_type":{"type":"string","title":"Position Type","description":"Position type: deposit, stake, borrow, or mixed"}},"type":"object","required":["symbol","amount","value_usd","position_type"],"title":"ProtocolToken","description":"Individual token holding within a protocol."},"PublicNansenScoreToken":{"properties":{"chain":{"$ref":"#/components/schemas/NansenScoreTopTokensChain","description":"Blockchain network identifier","examples":["ethereum","solana","bnb"]},"token_address":{"type":"string","title":"Token Address","description":"Token contract address","examples":["0xeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee"]},"token_symbol":{"anyOf":[{"type":"string"}],"title":"Token Symbol","description":"Token ticker symbol","examples":["ETH"]},"performance_score":{"type":"integer","title":"Performance Score","description":"Alpha score (-60 to +75). Sum of performance indicator contributions. Buying threshold: >= 15","examples":[45,30,15]},"risk_score":{"type":"integer","title":"Risk Score","description":"Safety score (-60 to +80). Sum of risk indicator contributions. Safety threshold: > 0","examples":[70,40,10]},"price_momentum_performance":{"type":"integer","title":"Price Momentum Performance","description":"Points from price_momentum indicator (0 or +30 if bullish)","examples":[30,0]},"chain_fees_performance":{"type":"integer","title":"Chain Fees Performance","description":"Points from chain_fees indicator (0 or +30 if bullish)","examples":[30,0]},"trading_range_performance":{"type":"integer","title":"Trading Range Performance","description":"Points from trading_range_detection indicator (0 or +15 if bullish)","examples":[15,0]},"chain_tvl_performance":{"type":"integer","title":"Chain Tvl Performance","description":"Points from chain_tvl indicator (0 or -35 if bearish)","examples":[0,-35]},"protocol_fees_performance":{"type":"integer","title":"Protocol Fees Performance","description":"Points from protocol_fees indicator (0 or -25 if bearish)","examples":[0,-25]},"btc_reflexivity_risk":{"type":"integer","title":"Btc Reflexivity Risk","description":"Points from btc_reflexivity indicator (+40 if low, -20 if high, 0 otherwise)","examples":[40,-20,0]},"liquidity_risk":{"type":"integer","title":"Liquidity Risk","description":"Points from liquidity_risk indicator (+20 if low, -20 if high, 0 otherwise)","examples":[20,-20,0]},"concentration_risk":{"type":"integer","title":"Concentration Risk","description":"Points from concentration_risk indicator (+10 if low, -10 if high, 0 otherwise)","examples":[10,-10,0]},"inflation_risk":{"type":"integer","title":"Inflation Risk","description":"Points from token_supply_inflation_ema indicator (+10 if low, -10 if high, 0 otherwise)","examples":[10,-10,0]},"market_cap":{"anyOf":[{"type":"number"}],"title":"Market Cap","description":"Token market cap in USD (with FDV fallback)","examples":[1500000000.0,468266714.0]},"market_cap_group":{"anyOf":[{"type":"string"}],"title":"Market Cap Group","description":"Market cap category: lowcap (<100M), midcap (100M-1B), largecap (>1B)","examples":["largecap","midcap","lowcap"]},"latest_date":{"anyOf":[{"type":"string","format":"date-time"}],"title":"Latest Date","description":"Most recent calendar date for this token's indicators","examples":["2025-12-16T00:00:00Z"]},"last_trigger_on":{"anyOf":[{"type":"string","format":"date-time"}],"title":"Last Trigger On","description":"Most recent signal trigger datetime across all indicators","examples":["2025-12-16T10:30:00Z"]}},"type":"object","required":["chain","token_address","performance_score","risk_score","price_momentum_performance","chain_fees_performance","trading_range_performance","chain_tvl_performance","protocol_fees_performance","btc_reflexivity_risk","liquidity_risk","concentration_risk","inflation_risk"],"title":"PublicNansenScoreToken","description":"Public-facing token score record (coin_id excluded)."},"PublicNansenScoreTopTokensResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PublicNansenScoreToken"},"type":"array","title":"Data","description":"List of token score records meeting the thresholds (performance_score >= 15)"}},"type":"object","required":["data"],"title":"PublicNansenScoreTopTokensResponse","description":"Public response model (coin_id excluded from each token)."},"ResolutionEnum":{"type":"string","enum":["1m","5m","15m","30m","1h","4h","1d","1w","1M"],"title":"ResolutionEnum","description":"Supported OHLCV resolution values."},"ScreenerSortField":{"type":"string","enum":["volume_24hr","volume","volume_1wk","volume_1mo","liquidity","open_interest","unique_traders_24h","age_hours"],"title":"ScreenerSortField","description":"Valid sort fields for screener endpoints."},"SmartMoneyChain":{"type":"string","enum":["all","arbitrum","avalanche","base","bnb","ethereum","hyperevm","iotaevm","linea","mantle","monad","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic"],"title":"SmartMoneyChain","description":"Chains supported in smart money analysis."},"SmartMoneyDca":{"properties":{"dca_created_at":{"type":"string","title":"Dca Created At","description":"The timestamp of the earliest transaction"},"dca_updated_at":{"type":"string","title":"Dca Updated At","description":"The timestamp of the latest transaction"},"trader_address":{"type":"string","title":"Trader Address","description":"The address of the trader"},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"The transaction hash at the time of creation"},"trader_address_label":{"type":"string","title":"Trader Address Label","description":"Label associated with the address"},"dca_vault_address":{"type":"string","title":"Dca Vault Address","description":"The address of the DCA vault"},"input_token_address":{"type":"string","title":"Input Token Address","description":"Address of token"},"output_token_address":{"type":"string","title":"Output Token Address","description":"Address of token"},"deposit_token_amount":{"anyOf":[{"type":"number"}],"title":"Deposit Token Amount","description":"The amount deposited into the DCA vault"},"token_spent_amount":{"anyOf":[{"type":"number"}],"title":"Token Spent Amount","description":"The amount spent from the deposit"},"output_token_redeemed_amount":{"anyOf":[{"type":"number"}],"title":"Output Token Redeemed Amount","description":"The amount of other tokens redeemed"},"dca_status":{"type":"string","title":"Dca Status","description":"Indicates if the account was closed or active"},"input_token_symbol":{"type":"string","title":"Input Token Symbol","description":"The symbol of the input token"},"output_token_symbol":{"type":"string","title":"Output Token Symbol","description":"The symbol of the output token"},"deposit_value_usd":{"anyOf":[{"type":"number"}],"title":"Deposit Value Usd","description":"The USD value of the deposit"}},"type":"object","required":["dca_created_at","dca_updated_at","trader_address","transaction_hash","trader_address_label","dca_vault_address","input_token_address","output_token_address","dca_status","input_token_symbol","output_token_symbol"],"title":"SmartMoneyDca","description":"Individual smart money DCA record.\n\nRepresents a single DCA (Dollar Cost Averaging) order made by smart money wallets."},"SmartMoneyDcasFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Smart money category filters","examples":[["Fund","Smart Trader"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Smart money category filters","examples":[["30D Smart Trader"]]},"dca_created_at":{"anyOf":[{"$ref":"#/components/schemas/DateRangeFilter"}],"description":"Date range filter for DCA creation timestamps","examples":[{"from":"2025-01-01T00:00:00Z","to":"2025-01-31T23:59:59Z"}]},"transaction_hash":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Transaction Hash","description":"Transaction hash filter","examples":["0x61adb6da30853c5988f0204dd9f6e4abbc878e02c34030a4f707cf4ec3124bcb"]},"trader_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address Label","description":"Trader name or label filter","examples":["Smart Money","%Fund%"]},"input_token_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Input Token Symbol","description":"Symbol filter for input tokens","examples":["SOL","%SOL%"]},"output_token_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Output Token Symbol","description":"Symbol filter for output tokens","examples":["USDC"]},"deposit_token_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Deposit amount range filter","examples":[{"max":1000,"min":100}]},"token_spent_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token spent amount range filter","examples":[{"max":10000,"min":1000}]},"output_token_redeemed_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Output token redeemed amount range filter","examples":[{"max":10000,"min":1000}]}},"additionalProperties":false,"type":"object","title":"SmartMoneyDcasFilters","description":"Filters for smart money DCAs endpoint.\n\nThese filters control which DCA orders, tokens, and traders\nare included in the DCA analysis."},"SmartMoneyDcasRequest":{"properties":{"filters":{"anyOf":[{"$ref":"#/components/schemas/SmartMoneyDcasFilters"}],"description":"Additional filters to apply. Only filters for columns that are being selected will be applied.","examples":[{"exclude_smart_money_labels":["30D Smart Trader"],"include_smart_money_labels":["Fund","Smart Trader"]}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted (default), returns labels as per subscription plan (existing behavior). When false, returns free-tier labels for all users. When true, returns premium labels (20 credits, currently available to internal users only)."},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_SmartMoneyDcasSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"dca_created_at\", \"direction\": \"DESC\"}] - Sort by DCA created timestamp descending\n- [{\"field\": \"dca_updated_at\", \"direction\": \"ASC\"}] - Sort by DCA updated timestamp ascending\n- [{\"field\": \"deposit_token_amount\", \"direction\": \"DESC\"}, {\"field\": \"token_spent_amount\", \"direction\": \"ASC\"}] - Sort by deposit token amount descending, then token spent amount ascending"}},"additionalProperties":false,"type":"object","title":"SmartMoneyDcasRequest","description":""},"SmartMoneyDcasResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SmartMoneyDca"},"type":"array","title":"Data","description":"List of smart money DCA records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"SmartMoneyDcasResponse","description":"Response model for smart money DCAs endpoint.\n\nContains the filtered smart money DCAs data with metadata."},"SmartMoneyDcasSortField":{"type":"string","enum":["dca_created_at","dca_updated_at","input_token_symbol","output_token_symbol","deposit_token_amount","token_spent_amount","deposit_value_usd","output_token_redeemed_amount"],"title":"SmartMoneyDcasSortField","description":"Enum for sortable fields in smart money DCAs."},"SmartMoneyDexTrade":{"properties":{"chain":{"type":"string","title":"Chain","description":"Blockchain chain"},"block_timestamp":{"type":"string","title":"Block Timestamp","description":"Block timestamp of the trade"},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"Transaction hash"},"trader_address":{"type":"string","title":"Trader Address","description":"Hexadecimal representation of the trader's address, i.e. the signer of the transaction"},"trader_address_label":{"type":"string","title":"Trader Address Label","description":"Name of the trader, based on nansen_label"},"token_bought_address":{"type":"string","title":"Token Bought Address","description":"Hexadecimal representation of the bought token's address"},"token_sold_address":{"type":"string","title":"Token Sold Address","description":"Hexadecimal representation of the sold token's address"},"token_bought_amount":{"anyOf":[{"type":"number"}],"title":"Token Bought Amount","description":"Amount of token bought in decimal amount"},"token_sold_amount":{"anyOf":[{"type":"number"}],"title":"Token Sold Amount","description":"Amount of token sold  in decimal amount"},"token_bought_symbol":{"type":"string","title":"Token Bought Symbol","description":"Symbol of the bought token"},"token_sold_symbol":{"type":"string","title":"Token Sold Symbol","description":"Symbol of the sold token"},"token_bought_age_days":{"type":"integer","title":"Token Bought Age Days","description":"Age of bought token's address in days"},"token_sold_age_days":{"type":"integer","title":"Token Sold Age Days","description":"Age of sold token's address in days"},"token_bought_market_cap":{"anyOf":[{"type":"number"}],"title":"Token Bought Market Cap","description":"Circulating market cap of bought token in USD. Returns NULL when circulating supply data is unavailable."},"token_sold_market_cap":{"anyOf":[{"type":"number"}],"title":"Token Sold Market Cap","description":"Circulating market cap of sold token in USD. Returns NULL when circulating supply data is unavailable."},"token_bought_fdv":{"anyOf":[{"type":"number"}],"title":"Token Bought Fdv","description":"Fully Diluted Valuation of bought token in USD (total_supply x price). May be very large for tokens with no circulating supply data."},"token_sold_fdv":{"anyOf":[{"type":"number"}],"title":"Token Sold Fdv","description":"Fully Diluted Valuation of sold token in USD (total_supply x price). May be very large for tokens with no circulating supply data."},"trade_value_usd":{"anyOf":[{"type":"number"}],"title":"Trade Value Usd","description":"Either token_bought_in_usd or token_sold_in_usd, if token_bought_in_usd is 0"}},"type":"object","required":["chain","block_timestamp","transaction_hash","trader_address","trader_address_label","token_bought_address","token_sold_address","token_bought_symbol","token_sold_symbol","token_bought_age_days","token_sold_age_days"],"title":"SmartMoneyDexTrade","description":"Individual smart money dex trade record.\n\nRepresents a single DEX trade made by smart money wallets."},"SmartMoneyDexTradesFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Smart money category filters","examples":[["Fund","Smart Trader"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Smart money category filters","examples":[["30D Smart Trader"]]},"chain":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Chain","description":"Blockchain network filter","examples":["ethereum",["ethereum","solana"]]},"transaction_hash":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Transaction Hash","description":"Transaction hash filter","examples":["0x61adb6da30853c5988f0204dd9f6e4abbc878e02c34030a4f707cf4ec3124bcb"]},"trader_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address Label","description":"Trader name or label filter","examples":["Smart Money","%Fund%"]},"token_bought_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Bought Address","description":"Token address filter for bought tokens","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"token_sold_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Sold Address","description":"Token address filter for sold tokens","examples":["0x1234...","%DAI%"]},"token_bought_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Amount range filter for bought tokens","examples":[{"max":1000,"min":100}]},"token_sold_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Amount range filter for sold tokens","examples":[{"max":500,"min":50}]},"token_bought_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Bought Symbol","description":"Symbol filter for bought tokens","examples":["USDC"]},"token_sold_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Sold Symbol","description":"Symbol filter for sold tokens","examples":["DAI","%DAI%"]},"token_bought_age_days":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Age range filter for bought tokens in days","examples":[{"max":365,"min":1}]},"token_sold_age_days":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Age range filter for sold tokens in days","examples":[{"max":365,"min":1}]},"token_bought_market_cap":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Market cap range filter for bought tokens","examples":[{"max":10000000,"min":1000000}]},"token_sold_market_cap":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Market cap range filter for sold tokens","examples":[{"max":10000000,"min":1000000}]},"token_bought_fdv":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"FDV range filter for bought tokens","examples":[{"max":10000000,"min":1000000}]},"token_sold_fdv":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"FDV range filter for sold tokens","examples":[{"max":10000000,"min":1000000}]},"trade_value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Trade value range filter in USD","examples":[{"max":10000,"min":1000}]}},"additionalProperties":false,"type":"object","title":"SmartMoneyDexTradesFilters","description":"Filters for smart money DEX trades endpoint.\n\nThese filters control which DEX trades, tokens, and traders\nare included in the trades analysis."},"SmartMoneyDexTradesRequest":{"properties":{"chains":{"items":{"$ref":"#/components/schemas/SmartMoneyChain"},"type":"array","title":"Chains","description":"Chains to include in the analysis (only smart money supported chains). Use 'all' to include all available chains.","examples":[["ethereum","solana"]]},"filters":{"anyOf":[{"$ref":"#/components/schemas/SmartMoneyDexTradesFilters"}],"description":"Additional filters to apply. Only filters for columns that are being selected will be applied.","examples":[{"exclude_smart_money_labels":["30D Smart Trader"],"include_smart_money_labels":["Fund","Smart Trader"],"token_bought_age_days":{"max":30,"min":1},"trade_value_usd":{"max":10000,"min":1000}}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted (default), returns labels as per subscription plan (existing behavior). When false, returns free-tier labels for all users. When true, returns premium labels (20 credits, currently available to internal users only)."},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_SmartMoneyDexTradesSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"trade_value_in_usd\", \"direction\": \"DESC\"}] - Sort by trade value descending\n- [{\"field\": \"block_timestamp\", \"direction\": \"ASC\"}] - Sort by timestamp ascending\n- [{\"field\": \"token_bought_amount\", \"direction\": \"DESC\"}, {\"field\": \"block_timestamp\", \"direction\": \"ASC\"}] - Sort by bought amount descending, then timestamp ascending"}},"additionalProperties":false,"type":"object","required":["chains"],"title":"SmartMoneyDexTradesRequest","description":""},"SmartMoneyDexTradesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SmartMoneyDexTrade"},"type":"array","title":"Data","description":"List of smart money dex trade records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"SmartMoneyDexTradesResponse","description":"Response model for smart money dex trades endpoint.\n\nContains the filtered smart money dex trades data with metadata."},"SmartMoneyDexTradesSortField":{"type":"string","enum":["chain","block_timestamp","transaction_hash","trader_address","trader_address_label","token_bought_address","token_sold_address","token_bought_amount","token_sold_amount","token_bought_symbol","token_sold_symbol","token_bought_age_days","token_sold_age_days","token_bought_market_cap","token_sold_market_cap","token_bought_fdv","token_sold_fdv","trade_value_usd"],"title":"SmartMoneyDexTradesSortField","description":"Enum for sortable fields in smart money dex trades."},"SmartMoneyFilterType":{"type":"string","enum":["Fund","Smart Trader","30D Smart Trader","90D Smart Trader","180D Smart Trader","Smart HL Perps Trader"],"title":"SmartMoneyFilterType","description":"Enum for smart money filter options."},"SmartMoneyHistoricalHolding":{"properties":{"date":{"type":"string","title":"Date","description":"Snapshot date (YYYY-MM-DD)"},"chain":{"$ref":"#/components/schemas/SmartMoneyHistoricalHoldingsChain","description":"Chain name"},"token_address":{"type":"string","title":"Token Address","description":"Address of token"},"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol"},"token_sectors":{"items":{"type":"string"},"type":"array","title":"Token Sectors","description":"Token sectors"},"smart_money_labels":{"items":{"type":"string"},"type":"array","title":"Smart Money Labels","description":"Array of unique smart money labels present in the aggregated holdings for this token"},"balance":{"anyOf":[{"type":"number"}],"title":"Balance","description":"Token balance in human-readable units (accounting for decimals)"},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"Value of token held by Smart Money at snapshot date"},"balance_24h_percent_change":{"anyOf":[{"type":"number"}],"title":"Balance 24H Percent Change","description":"Balance change of Smart Money for token during the 24 hours prior to snapshot"},"holders_count":{"type":"integer","title":"Holders Count","description":"Number of Smart Money holders of token at snapshot date"},"share_of_holdings_percent":{"anyOf":[{"type":"number"}],"title":"Share Of Holdings Percent","description":"Share of Smart Money total USD balance at snapshot date"},"token_age_days":{"type":"integer","title":"Token Age Days","description":"Number of days since token was deployed, relative to snapshot date"},"market_cap_usd":{"anyOf":[{"type":"number"}],"title":"Market Cap Usd","description":"Market cap of token at snapshot date"}},"type":"object","required":["date","chain","token_address","token_symbol","token_sectors","smart_money_labels","holders_count","token_age_days"],"title":"SmartMoneyHistoricalHolding","description":"Individual smart money historical holding record."},"SmartMoneyHistoricalHoldingsChain":{"type":"string","enum":["base","bnb","ethereum","monad","solana"],"title":"SmartMoneyHistoricalHoldingsChain","description":"Chains supported for smart money historical holdings endpoint."},"SmartMoneyHistoricalHoldingsFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Smart money category filters","examples":[["Fund","Smart Trader"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Smart money category filters","examples":[["30D Smart Trader"]]},"include_stablecoins":{"anyOf":[{"type":"boolean"}],"title":"Include Stablecoins","description":"Whether to include stablecoins in the results","default":false},"include_native_tokens":{"anyOf":[{"type":"boolean"}],"title":"Include Native Tokens","description":"Whether to include native tokens (e.g., ETH, SOL) in the results","default":false},"balance":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token balance range filter in human-readable units","examples":[{"max":10000,"min":100}]},"value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Value range filter in USD","examples":[{"max":100000,"min":1000}]},"balance_24h_percent_change":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"24-hour balance change percentage range filter","examples":[{"max":0.5,"min":-0.5}]},"holders_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of holders range filter","examples":[{"max":1000,"min":10}]},"share_of_holdings_percent":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Share of holdings percentage range filter","examples":[{"max":0.1,"min":0.01}]},"token_age_days":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token age range filter in days","examples":[{"max":365,"min":1}]},"market_cap_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Market cap range filter in USD","examples":[{"max":10000000,"min":1000000}]},"token_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Address","description":"Token address filter","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"token_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Symbol","description":"Token symbol filter","examples":["USDC"]}},"additionalProperties":false,"type":"object","title":"SmartMoneyHistoricalHoldingsFilters","description":"Filters for smart money historical holdings endpoint."},"SmartMoneyHistoricalHoldingsRequest":{"properties":{"date_range":{"$ref":"#/components/schemas/DateOnlyRange","description":"Date range for historical data (YYYY-MM-DD format). If 'to' is omitted, defaults to today. Maximum lookback is 4 years.","examples":[{"from":"2025-10-01","to":"2025-10-31"}]},"chains":{"items":{"$ref":"#/components/schemas/SmartMoneyHistoricalHoldingsChain"},"type":"array","title":"Chains","description":"Chains to include in the analysis. Supports ethereum, base, bnb, monad, and solana.","examples":[["ethereum"],["base"],["bnb"],["monad"],["solana"]]},"filters":{"anyOf":[{"$ref":"#/components/schemas/SmartMoneyHistoricalHoldingsFilters"}],"description":"Additional filters to apply","examples":[{"balance_24h_percent_change":{"max":0.1,"min":-0.1},"exclude_smart_money_labels":["30D Smart Trader"],"include_native_tokens":false,"include_smart_money_labels":["Fund","Smart Trader"],"include_stablecoins":false,"token_age_days":{"max":30},"value_usd":{"max":100000,"min":1000}}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted (default), returns labels as per subscription plan (existing behavior). When false, returns free-tier labels for all users. When true, returns premium labels (20 credits, currently available to internal users only)."},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_SmartMoneyHistoricalHoldingsSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order. Defaults to sorting by date DESC, value_usd DESC, token_address ASC, chain ASC for stable pagination."}},"additionalProperties":false,"type":"object","required":["date_range","chains"],"title":"SmartMoneyHistoricalHoldingsRequest","description":"Request model for smart money historical holdings endpoint."},"SmartMoneyHistoricalHoldingsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SmartMoneyHistoricalHolding"},"type":"array","title":"Data","description":"List of smart money historical holding records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"SmartMoneyHistoricalHoldingsResponse","description":"Response model for smart money historical holdings endpoint."},"SmartMoneyHistoricalHoldingsSortField":{"type":"string","enum":["date","chain","token_address","token_symbol","balance","value_usd","balance_24h_percent_change","holders_count","share_of_holdings_percent","token_age_days","market_cap_usd"],"title":"SmartMoneyHistoricalHoldingsSortField","description":"Enum for sortable fields in smart money historical holdings."},"SmartMoneyHistoricalTokenBalancesFilters":{"properties":{"sm_filter":{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array","title":"Sm Filter","description":"SM label filter. Empty list includes all SM labels.","default":[],"examples":[["Fund","Smart Trader"]]},"include_stablecoins":{"type":"boolean","title":"Include Stablecoins","description":"Whether to include stablecoin tokens","default":true},"include_native_tokens":{"type":"boolean","title":"Include Native Tokens","description":"Whether to include native tokens and LSTs/LRTs","default":true}},"additionalProperties":false,"type":"object","title":"SmartMoneyHistoricalTokenBalancesFilters","description":"Filters for the historical SM token balances endpoint."},"SmartMoneyHolding":{"properties":{"chain":{"$ref":"#/components/schemas/SmartMoneyChain","description":"Chain name"},"token_address":{"type":"string","title":"Token Address","description":"Address of token"},"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol"},"token_sectors":{"items":{"type":"string"},"type":"array","title":"Token Sectors","description":"Token sectors"},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"Value of token held by Smart Money."},"balance_24h_percent_change":{"anyOf":[{"type":"number"}],"title":"Balance 24H Percent Change","description":"Balance change of Smart Money for token during the last 24 hours"},"holders_count":{"type":"integer","title":"Holders Count","description":"Number of Smart Money holders of token."},"share_of_holdings_percent":{"anyOf":[{"type":"number"}],"title":"Share Of Holdings Percent","description":"Share of Smart Money total USD balance."},"token_age_days":{"type":"integer","title":"Token Age Days","description":"Number of days since token was deployed."},"market_cap_usd":{"anyOf":[{"type":"number"}],"title":"Market Cap Usd","description":"Market cap of token."}},"type":"object","required":["chain","token_address","token_symbol","token_sectors","holders_count","token_age_days"],"title":"SmartMoneyHolding","description":"Individual smart money holding record.\n\nRepresents a single token's smart money holding data."},"SmartMoneyHoldingsFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Smart money category filters","examples":[["Fund","Smart Trader"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Smart money category filters","examples":[["30D Smart Trader"]]},"include_stablecoins":{"anyOf":[{"type":"boolean"}],"title":"Include Stablecoins","description":"Whether to include stablecoins in the results","default":false},"include_native_tokens":{"anyOf":[{"type":"boolean"}],"title":"Include Native Tokens","description":"Whether to include native tokens (e.g., ETH, SOL) in the results","default":false},"value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Value range filter in USD","examples":[{"max":100000,"min":1000}]},"balance_24h_percent_change":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"24-hour balance change percentage range filter","examples":[{"max":0.5,"min":-0.5}]},"holders_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of holders range filter","examples":[{"max":1000,"min":10}]},"share_of_holdings_percent":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Share of holdings percentage range filter","examples":[{"max":0.1,"min":0.01}]},"token_age_days":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token age range filter in days","examples":[{"max":365,"min":1}]},"market_cap_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Market cap range filter in USD","examples":[{"max":10000000,"min":1000000}]},"token_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Address","description":"Token address filter","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"token_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Symbol","description":"Token symbol filter","examples":["USDC"]},"token_sectors":{"anyOf":[{"items":{"type":"string"},"type":"array"}],"title":"Token Sectors","description":"Token sectors filter","examples":[["DeFi","Gaming"]]}},"additionalProperties":false,"type":"object","title":"SmartMoneyHoldingsFilters","description":"Filters for smart money holdings endpoint.\n\nThese filters control which token holdings, smart money categories,\nand data are included in the holdings analysis."},"SmartMoneyHoldingsRequest":{"properties":{"chains":{"items":{"$ref":"#/components/schemas/SmartMoneyChain"},"type":"array","title":"Chains","description":"Chains to include in the analysis (only smart money supported chains). Use 'all' to include all available chains.","examples":[["ethereum","solana"]]},"filters":{"anyOf":[{"$ref":"#/components/schemas/SmartMoneyHoldingsFilters"}],"description":"Additional filters to apply. Only filters for columns that are being selected will be applied.","examples":[{"balance_24h_percent_change":{"max":0.1,"min":-0.1},"exclude_smart_money_labels":["30D Smart Trader"],"include_native_tokens":false,"include_smart_money_labels":["Fund","Smart Trader"],"include_stablecoins":false,"token_age_days":{"max":30},"value_usd":{"max":100000,"min":1000}}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted (default), returns labels as per subscription plan (existing behavior). When false, returns free-tier labels for all users. When true, returns premium labels (20 credits, currently available to internal users only)."},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_SmartMoneyHoldingsSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"value_usd\", \"direction\": \"DESC\"}] - Sort by value USD descending\n- [{\"field\": \"holders_count\", \"direction\": \"ASC\"}] - Sort by number of holders ascending\n- [{\"field\": \"value_usd\", \"direction\": \"DESC\"}, {\"field\": \"holders_count\", \"direction\": \"ASC\"}] - Sort by value USD descending, then number of holders ascending"}},"additionalProperties":false,"type":"object","required":["chains"],"title":"SmartMoneyHoldingsRequest","description":""},"SmartMoneyHoldingsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SmartMoneyHolding"},"type":"array","title":"Data","description":"List of smart money holding records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"SmartMoneyHoldingsResponse","description":"Response model for smart money holdings endpoint.\n\nContains the filtered smart money holdings data with metadata."},"SmartMoneyHoldingsSortField":{"type":"string","enum":["chain","token_address","token_symbol","value_usd","balance_24h_percent_change","holders_count","share_of_holdings_percent","token_age_days","market_cap_usd"],"title":"SmartMoneyHoldingsSortField","description":"Enum for sortable fields in smart money holdings."},"SmartMoneyNetflow":{"properties":{"token_address":{"type":"string","title":"Token Address","description":"Token contract address"},"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol"},"net_flow_1h_usd":{"type":"number","title":"Net Flow 1H Usd","description":"Net flow bought/sold of token by Smart Money in the past 1 hour."},"net_flow_24h_usd":{"type":"number","title":"Net Flow 24H Usd","description":"Net flow bought/sold of token by Smart Money in the past 24 hours."},"net_flow_7d_usd":{"type":"number","title":"Net Flow 7D Usd","description":"Net flow bought/sold of token by Smart Money in the past 7 days."},"net_flow_30d_usd":{"type":"number","title":"Net Flow 30D Usd","description":"Net flow bought/sold of token by Smart Money in the past 30 days."},"chain":{"type":"string","title":"Chain","description":"Blockchain chain"},"token_sectors":{"items":{"type":"string"},"type":"array","title":"Token Sectors","description":"Token sectors"},"trader_count":{"type":"integer","title":"Trader Count","description":"Number of Smart Money traders of token in the past 30 days."},"token_age_days":{"type":"integer","title":"Token Age Days","description":"Number of days since token was deployed."},"market_cap_usd":{"anyOf":[{"type":"number"}],"title":"Market Cap Usd","description":"Market cap of token."}},"type":"object","required":["token_address","token_symbol","net_flow_1h_usd","net_flow_24h_usd","net_flow_7d_usd","net_flow_30d_usd","chain","token_sectors","trader_count","token_age_days"],"title":"SmartMoneyNetflow","description":"Individual smart money netflow record.\n\nRepresents a single token's smart money netflow data."},"SmartMoneyNetflowFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Smart money category filters","examples":[["Fund","Smart Trader"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Smart money category filters","examples":[["30D Smart Trader"]]},"token_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Address","description":"Token address or symbol filter","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"include_stablecoins":{"anyOf":[{"type":"boolean"}],"title":"Include Stablecoins","description":"Whether to include stablecoins in the results","default":false},"include_native_tokens":{"anyOf":[{"type":"boolean"}],"title":"Include Native Tokens","description":"Whether to include native tokens (e.g., ETH, SOL) in the results","default":false},"token_sector":{"anyOf":[{"items":{"type":"string"},"type":"array"}],"title":"Token Sector","description":"Token sector filter","examples":[["DeFi","NFT","Gaming"]]},"trader_count":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Trader count range filter","examples":[{"max":100,"min":1}]},"token_age_days":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token age range filter in days","examples":[{"max":365,"min":1}]},"market_cap_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Market cap range filter in USD","examples":[{"max":1000000000,"min":1000000}]}},"additionalProperties":false,"type":"object","title":"SmartMoneyNetflowFilters","description":"Filters for smart money netflow endpoint.\n\nThese filters control which smart money categories, tokens, and data\nare included in the netflow analysis."},"SmartMoneyNetflowRequest":{"properties":{"chains":{"items":{"$ref":"#/components/schemas/SmartMoneyChain"},"type":"array","title":"Chains","description":"Chains to include in the analysis (only smart money supported chains). Use 'all' to include all available chains.","examples":[["ethereum","solana"]]},"filters":{"anyOf":[{"$ref":"#/components/schemas/SmartMoneyNetflowFilters"}],"description":"Additional filters to apply. Only filters for columns that are being selected will be applied.","examples":[{"exclude_smart_money_labels":["30D Smart Trader"],"include_native_tokens":false,"include_smart_money_labels":["Fund","Smart Trader"],"include_stablecoins":false}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted (default), returns labels as per subscription plan (existing behavior). When false, returns free-tier labels for all users. When true, returns premium labels (20 credits, currently available to internal users only)."},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_SmartMoneyNetflowSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"market_cap_usd\", \"direction\": \"DESC\"}] - Sort by market cap descending\n- [{\"field\": \"net_flow_24h_usd\", \"direction\": \"ASC\"}] - Sort by 24h flow ascending\n- [{\"field\": \"market_cap_usd\", \"direction\": \"DESC\"}, {\"field\": \"net_flow_24h_usd\", \"direction\": \"ASC\"}] - Sort by market cap descending, then 24h flow ascending","examples":[[{"direction":"DESC","field":"net_flow_24h_usd"}]]}},"additionalProperties":false,"type":"object","required":["chains"],"title":"SmartMoneyNetflowRequest","description":""},"SmartMoneyNetflowResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SmartMoneyNetflow"},"type":"array","title":"Data","description":"List of smart money netflow records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"SmartMoneyNetflowResponse","description":"Response model for smart money netflow endpoint.\n\nContains the filtered smart money netflow data with metadata."},"SmartMoneyNetflowSortField":{"type":"string","enum":["chain","token_address","token_symbol","net_flow_1h_usd","net_flow_24h_usd","net_flow_7d_usd","net_flow_30d_usd","token_sectors","trader_count","token_age_days","market_cap_usd"],"title":"SmartMoneyNetflowSortField","description":"Enum for sortable fields in smart money netflow."},"SmartMoneyPerpTrade":{"properties":{"trader_address_label":{"type":"string","title":"Trader Address Label","description":"Name of the trader, based on Nansen labels"},"trader_address":{"type":"string","title":"Trader Address","description":"Hexadecimal representation of the trader's address, i.e. the signer of the transaction"},"token_symbol":{"type":"string","title":"Token Symbol","description":"The token symbol"},"side":{"anyOf":[{"$ref":"#/components/schemas/PositionSide"}],"description":"The side of the position (Long or Short)","examples":["Long","Short"]},"action":{"type":"string","title":"Action","description":"The action taken by the trader (Add, Reduce, Open, Close)","examples":["Add","Reduce","Open","Close"]},"token_amount":{"anyOf":[{"type":"number"}],"title":"Token Amount","description":"Trade size in contract units"},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Trade price in USD"},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"Notional trade value in USD"},"type":{"$ref":"#/components/schemas/TradeType","description":"The trade type (Market or Limit)"},"block_timestamp":{"type":"string","title":"Block Timestamp","description":"The timestamp of the block"},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"Hexadecimal representation of the transaction hash"}},"type":"object","required":["trader_address_label","trader_address","token_symbol","action","type","block_timestamp","transaction_hash"],"title":"SmartMoneyPerpTrade","description":"Individual smart money perpetual trade record.\n\nRepresents a single perpetual trade made by smart money wallets on Hyperliquid."},"SmartMoneyPerpTradesFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels for traders","examples":[["Smart HL Perps Trader"],["Fund"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels for traders","examples":[["Smart HL Perps Trader"],["Fund"]]},"trader_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address Label","description":"Trader name or label filter","examples":["Smart Money","%Fund%"]},"token_symbol":{"anyOf":[{"type":"string"}],"title":"Token Symbol","description":"Token symbol filter","examples":["BTC","ETH","SOL"]},"type":{"anyOf":[{"$ref":"#/components/schemas/TradeType"}],"description":"Trade type filter - Market or Limit","examples":["Market","Limit"]},"token_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token amount range filter","examples":[{"max":1000,"min":100}]},"price_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Price range filter in USD","examples":[{"max":10000,"min":1000}]},"value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Trade value range filter in USD","examples":[{"max":10000,"min":1000}]},"side":{"anyOf":[{"$ref":"#/components/schemas/PositionSide"},{"items":{"$ref":"#/components/schemas/PositionSide"},"type":"array"},{"type":"null"}],"title":"Side","description":"Position side filter - Long or Short","examples":["Long","Short"]},"action":{"anyOf":[{"$ref":"#/components/schemas/PerpActionType"},{"items":{"$ref":"#/components/schemas/PerpActionType"},"type":"array"},{"type":"null"}],"title":"Action","description":"Action filter - combined buy/sell with position action (e.g., 'Buy - Add Long', 'Sell - Open Short')","examples":["Buy - Add Long","Sell - Open Short"]}},"additionalProperties":false,"type":"object","title":"SmartMoneyPerpTradesFilters","description":"Filters for smart money perpetual trades endpoint.\n\nThese filters control which perpetual trades and traders\nare included in the trades analysis."},"SmartMoneyPerpTradesRequest":{"properties":{"filters":{"anyOf":[{"$ref":"#/components/schemas/SmartMoneyPerpTradesFilters"}],"description":"Additional filters to apply. Only filters for columns that are being selected will be applied.","examples":[{"action":"Buy - Add Long","side":"Long","token_symbol":"BTC","type":"Limit","value_usd":{"max":10000,"min":1000}}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted (default), returns labels as per subscription plan (existing behavior). When false, returns free-tier labels for all users. When true, returns premium labels (20 credits, currently available to internal users only)."},"only_new_positions":{"anyOf":[{"type":"boolean"}],"title":"Only New Positions","description":"When True, includes 'Open' position actions (Open Long, Open Short). Can be combined with other action filters using OR logic (union). When False (default), returns all trades.","default":false,"examples":[true,false]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_SmartMoneyPerpTradesSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"value_usd\", \"direction\": \"DESC\"}] - Sort by trade value descending\n- [{\"field\": \"block_timestamp\", \"direction\": \"ASC\"}] - Sort by timestamp ascending\n- [{\"field\": \"token_amount\", \"direction\": \"DESC\"}, {\"field\": \"block_timestamp\", \"direction\": \"ASC\"}] - Sort by token amount descending, then timestamp ascending"}},"additionalProperties":false,"type":"object","title":"SmartMoneyPerpTradesRequest","description":""},"SmartMoneyPerpTradesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/SmartMoneyPerpTrade"},"type":"array","title":"Data","description":"List of smart money perpetual trade records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"SmartMoneyPerpTradesResponse","description":"Response model for smart money perpetual trades endpoint.\n\nContains the filtered smart money perpetual trades data with metadata."},"SmartMoneyPerpTradesSortField":{"type":"string","enum":["block_timestamp","token_amount","price_usd","value_usd"],"title":"SmartMoneyPerpTradesSortField","description":"Enum for sortable fields in smart money perp trades."},"SortDirection":{"type":"string","enum":["ASC","DESC"],"title":"SortDirection","description":"Enum for sort directions."},"SortOrder_OhlcvSortField_":{"properties":{"field":{"$ref":"#/components/schemas/OhlcvSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[OhlcvSortField]"},"SortOrder_PerpLeaderboardSortField_":{"properties":{"field":{"$ref":"#/components/schemas/PerpLeaderboardSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[PerpLeaderboardSortField]"},"SortOrder_PerpPositionsSortField_":{"properties":{"field":{"$ref":"#/components/schemas/PerpPositionsSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[PerpPositionsSortField]"},"SortOrder_PerpTradeSortField_":{"properties":{"field":{"$ref":"#/components/schemas/PerpTradeSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[PerpTradeSortField]"},"SortOrder_PnlByAddressSortField_":{"properties":{"field":{"$ref":"#/components/schemas/PnlByAddressSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[PnlByAddressSortField]"},"SortOrder_PnlByMarketSortField_":{"properties":{"field":{"$ref":"#/components/schemas/PnlByMarketSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[PnlByMarketSortField]"},"SortOrder_ProfilerAddressBalancesSortField_":{"properties":{"field":{"$ref":"#/components/schemas/ProfilerAddressBalancesSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[ProfilerAddressBalancesSortField]"},"SortOrder_ProfilerAddressCounterpartiesSortField_":{"properties":{"field":{"$ref":"#/components/schemas/ProfilerAddressCounterpartiesSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[ProfilerAddressCounterpartiesSortField]"},"SortOrder_ProfilerAddressHistoricalBalancesSortField_":{"properties":{"field":{"$ref":"#/components/schemas/ProfilerAddressHistoricalBalancesSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[ProfilerAddressHistoricalBalancesSortField]"},"SortOrder_ProfilerAddressPnlSortField_":{"properties":{"field":{"$ref":"#/components/schemas/ProfilerAddressPnlSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[ProfilerAddressPnlSortField]"},"SortOrder_ProfilerAddressRelatedWalletsSortField_":{"properties":{"field":{"$ref":"#/components/schemas/ProfilerAddressRelatedWalletsSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[ProfilerAddressRelatedWalletsSortField]"},"SortOrder_ProfilerAddressTransactionsSortField_":{"properties":{"field":{"$ref":"#/components/schemas/ProfilerAddressTransactionsSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[ProfilerAddressTransactionsSortField]"},"SortOrder_ScreenerSortField_":{"properties":{"field":{"$ref":"#/components/schemas/ScreenerSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[ScreenerSortField]"},"SortOrder_SmartMoneyDcasSortField_":{"properties":{"field":{"$ref":"#/components/schemas/SmartMoneyDcasSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[SmartMoneyDcasSortField]"},"SortOrder_SmartMoneyDexTradesSortField_":{"properties":{"field":{"$ref":"#/components/schemas/SmartMoneyDexTradesSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[SmartMoneyDexTradesSortField]"},"SortOrder_SmartMoneyHistoricalHoldingsSortField_":{"properties":{"field":{"$ref":"#/components/schemas/SmartMoneyHistoricalHoldingsSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[SmartMoneyHistoricalHoldingsSortField]"},"SortOrder_SmartMoneyHoldingsSortField_":{"properties":{"field":{"$ref":"#/components/schemas/SmartMoneyHoldingsSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[SmartMoneyHoldingsSortField]"},"SortOrder_SmartMoneyNetflowSortField_":{"properties":{"field":{"$ref":"#/components/schemas/SmartMoneyNetflowSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[SmartMoneyNetflowSortField]"},"SortOrder_SmartMoneyPerpTradesSortField_":{"properties":{"field":{"$ref":"#/components/schemas/SmartMoneyPerpTradesSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[SmartMoneyPerpTradesSortField]"},"SortOrder_TGMDexTradesSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TGMDexTradesSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TGMDexTradesSortField]"},"SortOrder_TGMFlowsSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TGMFlowsSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TGMFlowsSortField]"},"SortOrder_TGMHoldersSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TGMHoldersSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TGMHoldersSortField]"},"SortOrder_TGMPerpPnlLeaderboardSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TGMPerpPnlLeaderboardSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TGMPerpPnlLeaderboardSortField]"},"SortOrder_TGMPerpPositionsSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TGMPerpPositionsSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TGMPerpPositionsSortField]"},"SortOrder_TGMPerpTradesSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TGMPerpTradesSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TGMPerpTradesSortField]"},"SortOrder_TGMPnlLeaderboardSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TGMPnlLeaderboardSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TGMPnlLeaderboardSortField]"},"SortOrder_TGMTransfersSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TGMTransfersSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TGMTransfersSortField]"},"SortOrder_TGMWhoBoughtSoldSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TGMWhoBoughtSoldSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TGMWhoBoughtSoldSortField]"},"SortOrder_TokenScreenerSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TokenScreenerSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TokenScreenerSortField]"},"SortOrder_TopHolderSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TopHolderSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TopHolderSortField]"},"SortOrder_TradesByAddressSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TradesByAddressSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TradesByAddressSortField]"},"SortOrder_TradesByMarketSortField_":{"properties":{"field":{"$ref":"#/components/schemas/TradesByMarketSortField","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[TradesByMarketSortField]"},"SortOrder_Union_PerpScreenerSortFieldDefault__PerpScreenerSortFieldSmartMoney__":{"properties":{"field":{"anyOf":[{"$ref":"#/components/schemas/PerpScreenerSortFieldDefault"},{"$ref":"#/components/schemas/PerpScreenerSortFieldSmartMoney"}],"title":"Field","description":"Field to sort by"},"direction":{"$ref":"#/components/schemas/SortDirection","description":"Sort direction (ASC or DESC)"}},"type":"object","required":["field","direction"],"title":"SortOrder[Union[PerpScreenerSortFieldDefault, PerpScreenerSortFieldSmartMoney]]"},"SourceInput":{"type":"string","enum":["Combined","Tokens","ETH"],"title":"SourceInput","description":"Enum for source input types in counterparties endpoint."},"SpotMetrics":{"properties":{"volume_total_usd":{"anyOf":[{"type":"number"}],"title":"Volume Total Usd","description":"Total trading volume in USD","examples":[8850000]},"buy_volume_usd":{"anyOf":[{"type":"number"}],"title":"Buy Volume Usd","description":"Total buy volume in USD","examples":[4520000]},"sell_volume_usd":{"anyOf":[{"type":"number"}],"title":"Sell Volume Usd","description":"Total sell volume in USD","examples":[4330000]},"total_buys":{"anyOf":[{"type":"integer"}],"title":"Total Buys","description":"Total number of buy transactions","examples":[666]},"total_sells":{"anyOf":[{"type":"integer"}],"title":"Total Sells","description":"Total number of sell transactions","examples":[499]},"unique_buyers":{"anyOf":[{"type":"integer"}],"title":"Unique Buyers","description":"Number of unique buyers","examples":[106]},"unique_sellers":{"anyOf":[{"type":"integer"}],"title":"Unique Sellers","description":"Number of unique sellers","examples":[132]},"liquidity_usd":{"anyOf":[{"type":"number"}],"title":"Liquidity Usd","description":"Liquidity in USD","examples":[153420000]},"total_holders":{"anyOf":[{"type":"integer"}],"title":"Total Holders","description":"Total number of token holders","examples":[165299]}},"type":"object","title":"SpotMetrics","description":"Spot trading metrics for the token."},"TGMChain":{"type":"string","enum":["arbitrum","avalanche","base","bnb","ethereum","hyperevm","injective","iotaevm","linea","mantle","monad","near","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","starknet","sui","ton","tron"],"title":"TGMChain","description":"Chains supported in TGM (Token God Mode) endpoints."},"TGMDexTrade":{"properties":{"block_timestamp":{"type":"string","title":"Block Timestamp","description":"Block timestamp of the trade","examples":["2025-05-01T12:00:00Z"]},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"Transaction hash","examples":["0x61adb6da30853c5988f0204dd9f6e4abbc878e02c34030a4f707cf4ec3124bcb"]},"trader_address":{"type":"string","title":"Trader Address","description":"Trader's address","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"}],"title":"Trader Address Label","description":"Name of the trader, based on nansen_label","examples":["High Gas Consumer"]},"action":{"$ref":"#/components/schemas/TGMWhoBoughtSoldType","description":"The action taken by the trader. Either 'BUY' or 'SELL'","examples":["BUY"]},"token_address":{"type":"string","title":"Token Address","description":"Address of token","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"token_name":{"type":"string","title":"Token Name","description":"The name of the token","examples":["USDC"]},"token_amount":{"anyOf":[{"type":"number"}],"title":"Token Amount","description":"The amount of the specified token traded","examples":[1000.0]},"traded_token_address":{"type":"string","title":"Traded Token Address","description":"Address of token","examples":["0x6b175474e89094c44da98b954eedeac495271d0f"]},"traded_token_name":{"type":"string","title":"Traded Token Name","description":"The name of the token traded for the specified token","examples":["DAI"]},"traded_token_amount":{"anyOf":[{"type":"number"}],"title":"Traded Token Amount","description":"The amount of the token traded for the specified token","examples":[500.0]},"estimated_swap_price_usd":{"anyOf":[{"type":"number"}],"title":"Estimated Swap Price Usd","description":"Estimated swap price in USD, derived from the counterpart token's USD value. Falls back to the daily median token price if the counterpart price is unavailable.","examples":[1.0]},"estimated_value_usd":{"anyOf":[{"type":"number"}],"title":"Estimated Value Usd","description":"The estimated value of the trade in USD","examples":[1500.5]}},"type":"object","required":["block_timestamp","transaction_hash","trader_address","action","token_address","token_name","token_amount","traded_token_address","traded_token_name","traded_token_amount","estimated_swap_price_usd","estimated_value_usd"],"title":"TGMDexTrade","description":"Individual TGM dex trade record.\n\nRepresents a single DEX trade for a specific token."},"TGMDexTradesFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels for counterparties","examples":[["Public Figure"],["Exchange"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels for counterparties","examples":[["Public Figure"],["Exchange"]]},"block_timestamp":{"anyOf":[{"$ref":"#/components/schemas/DateRangeFilter"}],"description":"Date range filter for trade timestamps","examples":[{"from":"2025-01-01T00:00:00Z","to":"2025-01-31T23:59:59Z"}]},"transaction_hash":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Transaction Hash","description":"Transaction hash filter","examples":["0x61adb6da30853c5988f0204dd9f6e4abbc878e02c34030a4f707cf4ec3124bcb"]},"trader_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address Label","description":"Trader name filter","examples":["High Gas Consumer"]},"token_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Address","description":"Token address filter","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"action":{"anyOf":[{"type":"string"}],"title":"Action","description":"Action filter (buy/sell)","examples":["buy","sell"]},"token_name":{"anyOf":[{"type":"string"}],"title":"Token Name","description":"Token name filter","examples":["USDC","%Uniswap%"]},"token_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token amount range filter","examples":[{"min":100}]},"traded_token_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Traded Token Address","description":"Traded token address filter","examples":["0x1234...","%DAI%"]},"traded_token_name":{"anyOf":[{"type":"string"}],"title":"Traded Token Name","description":"Traded token name filter","examples":["DAI","%Maker%"]},"traded_token_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Traded token amount range filter","examples":[{"min":100}]},"estimated_swap_price_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Estimated swap price range filter in USD","examples":[{"min":0.01}]},"estimated_value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Estimated value range filter in USD","examples":[{"min":1000}]}},"additionalProperties":false,"type":"object","title":"TGMDexTradesFilters","description":"Filters for TGM DEX trades endpoint.\n\nThese filters control which DEX trades are included in the analysis."},"TGMDexTradesRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMChain","description":"Blockchain chain","examples":["solana"]},"token_address":{"type":"string","title":"Token Address","description":"Token address","examples":["2zMMhcVQEXDtdE6vsFS7S7D5oUodfJHE8vd1gnBouauv"]},"only_smart_money":{"type":"boolean","title":"Only Smart Money","description":"Returns only the DEX Trades made by Smart Money wallets","default":false,"examples":[false]},"date":{"$ref":"#/components/schemas/DateRange","description":"ISO 8601 date-time range object with optional from and to fields","examples":[{"from":"2025-07-07T00:00:00Z","to":"2025-07-14T23:59:59Z"}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMDexTradesFilters"}],"description":"Additional filters to apply to the query.","examples":[{"action":"BUY","estimated_value_usd":{"min":1000},"include_smart_money_labels":["Whale","Smart Trader"],"token_amount":{"min":100}}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TGMDexTradesSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"block_timestamp\", \"direction\": \"DESC\"}] - Sort by timestamp descending\n- [{\"field\": \"estimated_value_usd\", \"direction\": \"ASC\"}] - Sort by estimated value ascending\n- [{\"field\": \"token_amount\", \"direction\": \"DESC\"}] - Sort by token amount descending"}},"additionalProperties":false,"type":"object","required":["chain","token_address","date"],"title":"TGMDexTradesRequest","description":"Request model for TGM dex-trades endpoint.\n\nThis endpoint provides all DEX trades for a specific token with optional filtering\nfor smart money wallets only."},"TGMDexTradesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMDexTrade"},"type":"array","title":"Data","description":"List of TGM DEX trade records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TGMDexTradesResponse","description":"Response model for TGM dex-trades endpoint.\n\nContains a list of DEX trade records with pagination and metadata."},"TGMDexTradesSortField":{"type":"string","enum":["block_timestamp","transaction_hash","trader_address","trader_address_label","token_address","action","token_name","token_amount","traded_token_address","traded_token_name","traded_token_amount","estimated_swap_price_usd","estimated_value_usd"],"title":"TGMDexTradesSortField","description":"Enum for sortable fields in TGM DEX trades."},"TGMFlowIntelligence":{"properties":{"public_figure_net_flow_usd":{"anyOf":[{"type":"number"}],"title":"Public Figure Net Flow Usd","description":"Net flow (USD) for addresses labeled as Public Figure","examples":[1000000.5]},"public_figure_avg_flow_usd":{"anyOf":[{"type":"number"}],"title":"Public Figure Avg Flow Usd","description":"Geometric mean of absolute flow for Public Figure addresses","examples":[50000.25]},"public_figure_wallet_count":{"anyOf":[{"type":"integer"}],"title":"Public Figure Wallet Count","description":"Unique wallet count for Public Figure addresses","examples":[10]},"top_pnl_net_flow_usd":{"anyOf":[{"type":"number"}],"title":"Top Pnl Net Flow Usd","description":"Net flow (USD) for addresses labeled as Top PnL","examples":[2000000.75]},"top_pnl_avg_flow_usd":{"anyOf":[{"type":"number"}],"title":"Top Pnl Avg Flow Usd","description":"Geometric mean of absolute flow for Top PnL addresses","examples":[100000.5]},"top_pnl_wallet_count":{"anyOf":[{"type":"integer"}],"title":"Top Pnl Wallet Count","description":"Unique wallet count for Top PnL addresses","examples":[15]},"whale_net_flow_usd":{"anyOf":[{"type":"number"}],"title":"Whale Net Flow Usd","description":"Net flow (USD) for addresses labeled as Whale","examples":[5000000.25]},"whale_avg_flow_usd":{"anyOf":[{"type":"number"}],"title":"Whale Avg Flow Usd","description":"Geometric mean of absolute flow for Whale addresses","examples":[250000.75]},"whale_wallet_count":{"anyOf":[{"type":"integer"}],"title":"Whale Wallet Count","description":"Unique wallet count for Whale addresses","examples":[25]},"smart_trader_net_flow_usd":{"anyOf":[{"type":"number"}],"title":"Smart Trader Net Flow Usd","description":"Net flow (USD) for addresses labeled as Smart Trader","examples":[1500000.5]},"smart_trader_avg_flow_usd":{"anyOf":[{"type":"number"}],"title":"Smart Trader Avg Flow Usd","description":"Geometric mean of absolute flow for Smart Trader addresses","examples":[75000.25]},"smart_trader_wallet_count":{"anyOf":[{"type":"integer"}],"title":"Smart Trader Wallet Count","description":"Unique wallet count for Smart Trader addresses","examples":[20]},"exchange_net_flow_usd":{"anyOf":[{"type":"number"}],"title":"Exchange Net Flow Usd","description":"Net flow (USD) for addresses labeled as Exchange","examples":[3000000.75]},"exchange_avg_flow_usd":{"anyOf":[{"type":"number"}],"title":"Exchange Avg Flow Usd","description":"Geometric mean of absolute flow for Exchange addresses","examples":[150000.5]},"exchange_wallet_count":{"anyOf":[{"type":"integer"}],"title":"Exchange Wallet Count","description":"Unique wallet count for Exchange addresses","examples":[5]},"fresh_wallets_net_flow_usd":{"anyOf":[{"type":"number"}],"title":"Fresh Wallets Net Flow Usd","description":"Net flow (USD) for fresh wallets. Only available for 1d and 7d timeframes.","examples":[500000.25]},"fresh_wallets_avg_flow_usd":{"anyOf":[{"type":"number"}],"title":"Fresh Wallets Avg Flow Usd","description":"Average absolute flow (USD) for fresh wallets. Only available for 1d and 7d timeframes.","examples":[25000.75]},"fresh_wallets_wallet_count":{"anyOf":[{"type":"integer"}],"title":"Fresh Wallets Wallet Count","description":"Fresh wallets wallet count. Only available for 1d and 7d timeframes.","examples":[100]}},"type":"object","title":"TGMFlowIntelligence","description":"Individual TGM flow intelligence record.\n\nRepresents flow intelligence data for different wallet categories."},"TGMFlowIntelligenceFilters":{"properties":{"public_figure_net_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Public figure net flow range filter in USD","examples":[{"min":1000}]},"public_figure_avg_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Public figure average flow range filter in USD","examples":[{"min":100}]},"public_figure_wallet_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Public figure wallet count range filter","examples":[{"min":1}]},"top_pnl_net_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Top PnL net flow range filter in USD","examples":[{"min":1000}]},"top_pnl_avg_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Top PnL average flow range filter in USD","examples":[{"min":100}]},"top_pnl_wallet_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Top PnL wallet count range filter","examples":[{"min":1}]},"whale_net_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Whale net flow range filter in USD","examples":[{"min":1000}]},"whale_avg_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Whale average flow range filter in USD","examples":[{"min":100}]},"whale_wallet_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Whale wallet count range filter","examples":[{"min":1}]},"smart_trader_net_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Smart trader net flow range filter in USD","examples":[{"min":1000}]},"smart_trader_avg_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Smart trader average flow range filter in USD","examples":[{"min":100}]},"smart_trader_wallet_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Smart trader wallet count range filter","examples":[{"min":1}]},"exchange_net_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Exchange net flow range filter in USD","examples":[{"min":1000}]},"exchange_avg_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Exchange average flow range filter in USD","examples":[{"min":100}]},"exchange_wallet_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Exchange wallet count range filter","examples":[{"min":1}]},"fresh_wallets_net_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Fresh wallets net flow range filter in USD","examples":[{"min":1000}]},"fresh_wallets_avg_flow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Fresh wallets average flow range filter in USD","examples":[{"min":100}]},"fresh_wallets_wallet_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Fresh wallets wallet count range filter","examples":[{"min":1}]}},"additionalProperties":false,"type":"object","title":"TGMFlowIntelligenceFilters","description":"Filters for TGM flow intelligence endpoint.\n\nThese filters control the flow intelligence analysis data."},"TGMFlowIntelligenceRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMChain","description":"Blockchain chain","examples":["ethereum"]},"token_address":{"type":"string","title":"Token Address","description":"Token address","examples":["0x6982508145454ce325ddbe47a25d4ec3d2311933"]},"timeframe":{"$ref":"#/components/schemas/TGMFlowIntelligenceTimeframe","description":"Time window for the flow intelligence data","default":"1d"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMFlowIntelligenceFilters"}],"description":"Additional filters to apply to the query.","examples":[{"whale_wallet_count":{"min":1}}]}},"additionalProperties":false,"type":"object","required":["chain","token_address"],"title":"TGMFlowIntelligenceRequest","description":"Request model for TGM flow-intelligence endpoint.\n\nThis endpoint provides detailed token flow intelligence for analyzing token movements\nacross different chains. It helps track and categorize token transfers, identifying\npatterns such as exchange deposits, withdrawals, and transfers between different\ntypes of wallets."},"TGMFlowIntelligenceResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMFlowIntelligence"},"type":"array","title":"Data","description":"List of TGM flow intelligence records"},"warnings":{"anyOf":[{"items":{"type":"string"},"type":"array"}],"title":"Warnings","description":"Optional warnings about the query results. For example, if fresh_wallets fields are null due to timeframe constraints."}},"type":"object","required":["data"],"title":"TGMFlowIntelligenceResponse","description":"Response model for TGM flow-intelligence endpoint.\n\nContains flow intelligence data with pagination and metadata."},"TGMFlowIntelligenceTimeframe":{"type":"string","enum":["5m","1h","6h","12h","1d","7d"],"title":"TGMFlowIntelligenceTimeframe","description":"TGM flow intelligence timeframe options."},"TGMFlows":{"properties":{"date":{"type":"string","title":"Date","description":"Block date of the flow data point"},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Daily median token price in USD. For the current day, uses the latest spot price."},"token_amount":{"anyOf":[{"type":"number"}],"title":"Token Amount","description":"Total token amount"},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"Total token value in USD"},"holders_count":{"anyOf":[{"type":"integer"}],"title":"Holders Count","description":"Number of token holders"},"total_inflows_count":{"anyOf":[{"type":"number"}],"title":"Total Inflows Count","description":"Total inflows"},"total_outflows_count":{"anyOf":[{"type":"number"}],"title":"Total Outflows Count","description":"Total outflows"},"total_inflows_dex":{"anyOf":[{"type":"number"}],"title":"Total Inflows Dex","description":"Total DEX inflows (token amount). Only populated when label=exchange, null otherwise."},"total_outflows_dex":{"anyOf":[{"type":"number"}],"title":"Total Outflows Dex","description":"Total DEX outflows (token amount). Only populated when label=exchange, null otherwise."},"total_inflows_cex":{"anyOf":[{"type":"number"}],"title":"Total Inflows Cex","description":"Total CEX inflows (token amount). Only populated when label=exchange, null otherwise."},"total_outflows_cex":{"anyOf":[{"type":"number"}],"title":"Total Outflows Cex","description":"Total CEX outflows (token amount). Only populated when label=exchange, null otherwise."}},"type":"object","required":["date"],"title":"TGMFlows","description":"Individual TGM flow record.\n\nRepresents a single flow record with token holder statistics."},"TGMFlowsFilters":{"properties":{"price_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Price range filter in USD","examples":[{"max":1000,"min":0.01}]},"token_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token amount range filter","examples":[{"min":1000}]},"value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Value range filter in USD","examples":[{"min":10000}]},"holders_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Holders count range filter","examples":[{"min":100}]},"total_inflows_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Total inflows count range filter","examples":[{"min":10}]},"total_outflows_count":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Total outflows count range filter","examples":[{"min":10}]}},"additionalProperties":false,"type":"object","title":"TGMFlowsFilters","description":"Filters for TGM flows endpoint.\n\nThese filters control which data points are included in the flows analysis."},"TGMFlowsLabel":{"type":"string","enum":["whale","public_figure","smart_money","top_100_holders","exchange"],"title":"TGMFlowsLabel","description":"TGM flow label types."},"TGMFlowsRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMChain","description":"Blockchain chain","examples":["solana"]},"token_address":{"type":"string","title":"Token Address","description":"Token address","examples":["2zMMhcVQEXDtdE6vsFS7S7D5oUodfJHE8vd1gnBouauv"]},"date":{"$ref":"#/components/schemas/DateRange","description":"ISO 8601 date-time range object with optional from and to fields","examples":[{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"}]},"label":{"$ref":"#/components/schemas/TGMFlowsLabel","description":"Label type for filtering flows","default":"top_100_holders","examples":["smart_money"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMFlowsFilters"}],"description":"Additional filters to apply to the query.","examples":[{"price_usd":{"max":1000,"min":0.01},"value_usd":{"min":10000}}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TGMFlowsSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"date\", \"direction\": \"DESC\"}] - Sort by date descending (most recent first)\n- [{\"field\": \"total_inflows_usd\", \"direction\": \"ASC\"}] - Sort by total inflows ascending\n- [{\"field\": \"total_outflows_usd\", \"direction\": \"DESC\"}] - Sort by total outflows descending"}},"additionalProperties":false,"type":"object","required":["chain","token_address","date"],"title":"TGMFlowsRequest","description":"Request model for TGM flows endpoint.\n\nThis endpoint provides comprehensive token flow analytics showing inflow and outflow patterns\nfrom various holder segments including Exchanges, Smart Money addresses, Public Figures, and Whales\nwith time-based statistics and trends."},"TGMFlowsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMFlows"},"type":"array","title":"Data","description":"List of TGM flow records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TGMFlowsResponse","description":"Response model for TGM flows endpoint.\n\nContains a list of flow records with pagination and metadata."},"TGMFlowsSortField":{"type":"string","enum":["date","price_usd","token_amount","value_usd","holders_count","total_inflows_count","total_outflows_count","total_inflows_dex","total_outflows_dex","total_inflows_cex","total_outflows_cex"],"title":"TGMFlowsSortField","description":"Enum for sortable fields in TGM flows."},"TGMHolder":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Address of contract/EOA","examples":["0x1234567890123456789012345678901234567890"]},"address_label":{"anyOf":[{"type":"string"}],"title":"Address Label","description":"Label associated with the address","examples":["Smart Money"]},"token_amount":{"anyOf":[{"type":"number"}],"title":"Token Amount","description":"Total balance count","examples":[1000000.0]},"total_outflow":{"anyOf":[{"type":"number"}],"title":"Total Outflow","description":"Total amount of tokens sent by this address","examples":[50000.0]},"total_inflow":{"anyOf":[{"type":"number"}],"title":"Total Inflow","description":"Total amount of tokens received by this address","examples":[1050000.0]},"balance_change_24h":{"anyOf":[{"type":"number"}],"title":"Balance Change 24H","description":"Token balance change over the last 24 hours","examples":[1000.0]},"balance_change_7d":{"anyOf":[{"type":"number"}],"title":"Balance Change 7D","description":"Token balance change over the last 7 days","examples":[5000.0]},"balance_change_30d":{"anyOf":[{"type":"number"}],"title":"Balance Change 30D","description":"Token balance change over the last 30 days","examples":[15000.0]},"ownership_percentage":{"anyOf":[{"type":"number"}],"title":"Ownership Percentage","description":"Percentage of total token supply owned by this address","examples":[2.5]},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"Current token balance value in USD","examples":[50000.0]}},"type":"object","title":"TGMHolder","description":"Individual TGM holder record.\n\nRepresents a single holder with balance information and metadata."},"TGMHoldersChain":{"type":"string","enum":["arbitrum","avalanche","base","bitcoin","bnb","ethereum","hyperevm","injective","iotaevm","linea","mantle","monad","near","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","starknet","sui","ton","tron"],"title":"TGMHoldersChain","description":"Chains supported for TGM holders endpoint."},"TGMHoldersFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels for holders","examples":[["Public Figure"],["Exchange"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels for holders","examples":[["Public Figure"],["Exchange"]]},"address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Address","description":"Holder address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Address Label","description":"Holder label filter","examples":["Smart Money","%Fund%"]},"token_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token amount range filter","examples":[{"min":1000}]},"total_outflow":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total outflow range filter","examples":[{"min":100}]},"total_inflow":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total inflow range filter","examples":[{"min":100}]},"balance_change_24h":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"24-hour balance change range filter","examples":[{"max":1000,"min":-1000}]},"balance_change_7d":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"7-day balance change range filter","examples":[{"max":5000,"min":-5000}]},"balance_change_30d":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"30-day balance change range filter","examples":[{"max":10000,"min":-10000}]},"ownership_percentage":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Ownership percentage range filter","examples":[{"max":10,"min":0.01}]},"value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Balance range filter in USD. Defaults to min: 1.0 to exclude dust holders. Set explicitly to override (e.g., {\"min\": 0} to include all holders). Note: This default does not apply to native tokens with 'all_holders' label.","examples":[{"min":10000}]}},"additionalProperties":false,"type":"object","title":"TGMHoldersFilters","description":"Filters for TGM holders endpoint.\n\nThese filters control which holders are included in the analysis."},"TGMHoldersLabel":{"type":"string","enum":["whale","public_figure","smart_money","all_holders","exchange"],"title":"TGMHoldersLabel","description":"TGM holders label types."},"TGMHoldersRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMHoldersChain","description":"Blockchain chain","examples":["solana"]},"token_address":{"type":"string","title":"Token Address","description":"Token address","examples":["2zMMhcVQEXDtdE6vsFS7S7D5oUodfJHE8vd1gnBouauv"]},"aggregate_by_entity":{"type":"boolean","title":"Aggregate By Entity","description":"Whether to return entity data","default":false,"examples":[false]},"label_type":{"$ref":"#/components/schemas/TGMHoldersLabel","description":"Label type. You must also include the labels filter to match the label type. For example, for label type 'smart_money', you must include '30D Smart Trader', '90D Smart Trader', '180D Smart Trader', 'Fund' or 'Smart Trader' in the filters.labels.include parameter.","default":"all_holders","examples":["all_holders"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMHoldersFilters"}],"description":"Additional filters to apply to the query.","examples":[{"include_smart_money_labels":["30D Smart Trader","Fund"],"ownership_percentage":{"min":0.01},"token_amount":{"min":1000},"value_usd":{"min":10000}}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted, defaults to true (premium labels filtered by subscription plan). When false, returns free-tier labels for all users. When true, returns premium labels (filtered by subscription plan). Note: In a future release, the default will change from true to false — pass premium_labels=true explicitly to preserve premium label behavior."},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TGMHoldersSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"value_usd\", \"direction\": \"DESC\"}] - Sort by value USD descending\n- [{\"field\": \"token_amount\", \"direction\": \"ASC\"}] - Sort by token amount ascending\n- [{\"field\": \"ownership_percentage\", \"direction\": \"DESC\"}] - Sort by ownership percentage descending"}},"additionalProperties":false,"type":"object","required":["chain","token_address"],"title":"TGMHoldersRequest","description":"Request model for TGM holders endpoint.\n\nThis endpoint provides comprehensive data on token holders and their balances.\nRetrieve holders by various criteria including smart money, exchanges, public figures,\nwhales, and top holders with detailed balance information and filtering options."},"TGMHoldersResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMHolder"},"type":"array","title":"Data","description":"List of TGM holder records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"},"warnings":{"anyOf":[{"items":{"type":"string"},"type":"array"}],"title":"Warnings","description":"Optional warnings about the query results. For example, if a token has no USD price data, a warning will indicate that the default value_usd filter may be excluding results."}},"type":"object","required":["data","pagination"],"title":"TGMHoldersResponse","description":"Response model for TGM holders endpoint.\n\nContains a list of holder records with pagination and metadata."},"TGMHoldersSortField":{"type":"string","enum":["address","name","token_amount","total_outflow","total_inflow","balance_change_24h","balance_change_7d","balance_change_30d","ownership_percentage","value_usd"],"title":"TGMHoldersSortField","description":"Enum for sortable fields in TGM holders."},"TGMIndicator":{"properties":{"indicator_type":{"type":"string","title":"Indicator Type","description":"The type of indicator","examples":["btc-reflexivity","liquidity-risk","price-momentum"]},"score":{"anyOf":[{"type":"string"}],"title":"Score","description":"Summary score (risk: low/medium/high, reward: bearish/neutral/bullish)","examples":["bullish","high","neutral","low"]},"signal":{"anyOf":[{"type":"number"}],"title":"Signal","description":"The raw signal value for the indicator","examples":[0.75,-0.25]},"signal_percentile":{"anyOf":[{"type":"number"}],"title":"Signal Percentile","description":"Percentile of the signal against tokens in the same market cap group (0-100)","examples":[85.5,42.3]},"last_trigger_on":{"anyOf":[{"type":"string"}],"title":"Last Trigger On","description":"Date when the indicator last changed state (YYYY-MM-DD)","examples":["2025-01-15"]}},"type":"object","required":["indicator_type"],"title":"TGMIndicator","description":"Individual indicator record."},"TGMIndicatorTokenInfo":{"properties":{"market_cap_usd":{"anyOf":[{"type":"number"}],"title":"Market Cap Usd","description":"Market capitalization in USD","examples":[1500000000.0]},"market_cap_group":{"anyOf":[{"type":"string"}],"title":"Market Cap Group","description":"Market cap classification group","examples":["largecap","midcap","lowcap"]},"is_stablecoin":{"anyOf":[{"type":"boolean"}],"title":"Is Stablecoin","description":"Flag indicating if token is a stablecoin","examples":[false]}},"type":"object","title":"TGMIndicatorTokenInfo","description":"Token metadata from indicator data."},"TGMIndicatorsRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMChain","description":"Blockchain chain","examples":["ethereum"]},"token_address":{"type":"string","title":"Token Address","description":"Token contract address","examples":["0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9"]}},"additionalProperties":false,"type":"object","required":["chain","token_address"],"title":"TGMIndicatorsRequest","description":"Request model for TGM Indicators endpoint.\n\nThis endpoint provides risk and reward indicators for a specific token."},"TGMIndicatorsResponse":{"properties":{"token_address":{"type":"string","title":"Token Address","description":"Token contract address","examples":["0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9"]},"chain":{"type":"string","title":"Chain","description":"Blockchain chain","examples":["ethereum"]},"token_info":{"$ref":"#/components/schemas/TGMIndicatorTokenInfo","description":"Token metadata including market cap information"},"risk_indicators":{"items":{"$ref":"#/components/schemas/TGMIndicator"},"type":"array","title":"Risk Indicators","description":"Risk assessment indicators (btc-reflexivity, liquidity-risk, concentration-risk, token-supply-inflation)"},"reward_indicators":{"items":{"$ref":"#/components/schemas/TGMIndicator"},"type":"array","title":"Reward Indicators","description":"Reward/alpha potential indicators (chain-tvl, trading-range, price-momentum, chain-fees, protocol-fees, cex-flows, funding-rate)"}},"type":"object","required":["token_address","chain","token_info","risk_indicators","reward_indicators"],"title":"TGMIndicatorsResponse","description":"Response model for TGM Indicators endpoint.\n\nContains risk and reward indicators grouped separately."},"TGMJupDca":{"properties":{"since_timestamp":{"anyOf":[{"type":"string"}],"title":"Since Timestamp","description":"The timestamp of the earliest transaction","examples":["2024-01-15T10:30:00Z"]},"last_timestamp":{"anyOf":[{"type":"string"}],"title":"Last Timestamp","description":"The timestamp of the latest transaction","examples":["2024-01-20T15:45:00Z"]},"trader_address":{"type":"string","title":"Trader Address","description":"The address of the trader","examples":["7BgBvyjrZX8YKHKbbh3FbXzqKFKWJNJRVdVkgLkFUGG1"]},"creation_hash":{"anyOf":[{"type":"string"}],"title":"Creation Hash","description":"The transaction hash at the time of creation","examples":["3k2j9h4k5l6m7n8o9p0q1r2s3t4u5v6w7x8y9z0a1b2c3d4e5f6g7h8i9j0k1l2m"]},"trader_label":{"anyOf":[{"type":"string"}],"title":"Trader Label","description":"The label of the trader obtained from Nansen's multichain data","examples":["High Gas Consumer"]},"dca_vault_address":{"anyOf":[{"type":"string"}],"title":"Dca Vault Address","description":"The address of the DCA vault","examples":["8CvgjhGJeKM9xkRBKkwRGF2VchUxJKNDLvSfXBmZ4Pqr"]},"input_mint_address":{"anyOf":[{"type":"string"}],"title":"Input Mint Address","description":"The mint address of the input token","examples":["EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"]},"output_mint_address":{"anyOf":[{"type":"string"}],"title":"Output Mint Address","description":"The mint address of the output token","examples":["2zMMhcVQEXDtdE6vsFS7S7D5oUodfJHE8vd1gnBouauv"]},"deposit_amount":{"anyOf":[{"type":"number"}],"title":"Deposit Amount","description":"The amount deposited into the DCA vault","examples":[1000.0]},"deposit_spent":{"anyOf":[{"type":"number"}],"title":"Deposit Spent","description":"The amount spent from the deposit","examples":[250.5]},"other_token_redeemed":{"anyOf":[{"type":"number"}],"title":"Other Token Redeemed","description":"The amount of other tokens redeemed","examples":[50.25]},"status":{"anyOf":[{"$ref":"#/components/schemas/TGMJupDcaStatus"}],"description":"The status of the DCA vault","examples":["Active","Closed"]},"token_input":{"anyOf":[{"type":"string"}],"title":"Token Input","description":"The symbol of the input token","examples":["USDC"]},"token_output":{"anyOf":[{"type":"string"}],"title":"Token Output","description":"The symbol of the output token","examples":["PEPE"]},"deposit_usd_value":{"anyOf":[{"type":"number"}],"title":"Deposit Usd Value","description":"The USD value of the deposit","examples":[1000.0]}},"type":"object","required":["trader_address"],"title":"TGMJupDca","description":"Individual TGM Jupiter DCA record.\n\nRepresents a single Jupiter DCA order with stats per vault."},"TGMJupDcaFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels for traders","examples":[["Public Figure"],["Exchange"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels for traders","examples":[["Public Figure"],["Exchange"]]},"trader_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address","description":"Trader address filter","examples":["7BgBvyjrZX8YKHKbbh3FbXzqKFKWJNJRVdVkgLkFUGG1"]},"trader_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Label","description":"Trader label filter","examples":["High Gas Consumer"]},"creation_hash":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Creation Hash","description":"Creation transaction hash filter","examples":["3k2j9h4k5l6m7n8o9p0q1r2s3t4u5v6w7x8y9z0a1b2c3d4e5f6g7h8i9j0k1l2m"]},"dca_vault_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Dca Vault Address","description":"DCA vault address filter","examples":["8CvgjhGJeKM9xkRBKkwRGF2VchUxJKNDLvSfXBmZ4Pqr"]},"input_mint_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Input Mint Address","description":"Input token mint address filter","examples":["EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v"]},"output_mint_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Output Mint Address","description":"Output token mint address filter","examples":["2zMMhcVQEXDtdE6vsFS7S7D5oUodfJHE8vd1gnBouauv"]},"deposit_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Deposit amount range filter","examples":[{"min":100}]},"deposit_spent":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Deposit spent amount range filter","examples":[{"min":10}]},"other_token_redeemed":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Other token redeemed amount range filter","examples":[{"min":1}]},"status":{"anyOf":[{"type":"string"}],"title":"Status","description":"DCA vault status filter","examples":["Active","Closed"]},"token_input":{"anyOf":[{"type":"string"}],"title":"Token Input","description":"Input token symbol filter","examples":["USDC","%SOL%"]},"token_output":{"anyOf":[{"type":"string"}],"title":"Token Output","description":"Output token symbol filter","examples":["PEPE","%BTC%"]},"deposit_usd_value":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Deposit USD value range filter","examples":[{"min":1000}]}},"additionalProperties":false,"type":"object","title":"TGMJupDcaFilters","description":"Filters for TGM Jupiter DCA endpoint.\n\nThese filters control which Jupiter DCA orders are included in the analysis."},"TGMJupDcaRequest":{"properties":{"token_address":{"type":"string","title":"Token Address","description":"Token address on Solana","examples":["2zMMhcVQEXDtdE6vsFS7S7D5oUodfJHE8vd1gnBouauv"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMJupDcaFilters"}],"description":"Additional filters to apply to the query.","examples":[{"deposit_amount":{"min":100},"deposit_usd_value":{"min":1000},"status":"Closed"}]}},"additionalProperties":false,"type":"object","required":["token_address"],"title":"TGMJupDcaRequest","description":"Request model for TGM Jupiter DCA endpoint.\n\nThis endpoint provides Jupiter DCA orders with stats per vault for a specific token.\nOnly supports Solana chain as Jupiter DCA is exclusive to Solana."},"TGMJupDcaResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMJupDca"},"type":"array","title":"Data","description":"List of TGM Jupiter DCA records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TGMJupDcaResponse","description":"Response model for TGM Jupiter DCA endpoint.\n\nContains a list of Jupiter DCA records with pagination and metadata."},"TGMJupDcaStatus":{"type":"string","enum":["Active","Closed"],"title":"TGMJupDcaStatus","description":"Enum for TGM Jupiter DCA status values."},"TGMOHLCVChain":{"type":"string","enum":["algorand","aptos","arbitrum","avalanche","base","bitcoin","bitlayer","bnb","chiliz","ethereum","gravity","hyperevm","hyperliquid","injective","iotaevm","linea","mantle","monad","near","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","stacks","starknet","stellar","sui","ton","tron","viction"],"title":"TGMOHLCVChain","description":"Chains supported for TGM OHLCV endpoint (includes Bitcoin)."},"TGMPerpPnlLeaderboard":{"properties":{"trader_address":{"type":"string","title":"Trader Address","description":"Hexadecimal representation of the trader's address.","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"}],"title":"Trader Address Label","description":"Nansen name of the trader","examples":["🏦 Binance 14 [0x28c6c0]"]},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Token price in USD at date_to. Uses latest spot price if date_to is today or later, otherwise the daily median price for that date.","examples":[1.23]},"pnl_usd_realised":{"anyOf":[{"type":"number"}],"title":"Pnl Usd Realised","description":"Realised profit and loss in USD.","examples":[1250.5]},"pnl_usd_unrealised":{"anyOf":[{"type":"number"}],"title":"Pnl Usd Unrealised","description":"Unrealised profit and loss in USD.","examples":[100.25]},"holding_amount":{"anyOf":[{"type":"number"}],"title":"Holding Amount","description":"Current token balance","examples":[5000.0]},"position_value_usd":{"anyOf":[{"type":"number"}],"title":"Position Value Usd","description":"Position value in USD (+ve = Long position, -ve = Short position, 0 = Flat)","examples":[6000.0]},"max_balance_held":{"anyOf":[{"type":"number"}],"title":"Max Balance Held","description":"Maximum amount of tokens held at some point in time.","examples":[10000.0]},"max_balance_held_usd":{"anyOf":[{"type":"number"}],"title":"Max Balance Held Usd","description":"Maximum amount of tokens in current USD value, held at some point in time.","examples":[12000.0]},"still_holding_balance_ratio":{"anyOf":[{"type":"number"}],"title":"Still Holding Balance Ratio","description":"The ratio of current holdings to max balance held.","examples":[0.5]},"netflow_amount_usd":{"anyOf":[{"type":"number"}],"title":"Netflow Amount Usd","description":"Netflow amount in USD.","examples":[2500.75]},"netflow_amount":{"anyOf":[{"type":"number"}],"title":"Netflow Amount","description":"Netflow amount.","examples":[1500.0]},"roi_percent_total":{"anyOf":[{"type":"number"}],"title":"Roi Percent Total","description":"Total ROI.","examples":[15.5]},"roi_percent_realised":{"anyOf":[{"type":"number"}],"title":"Roi Percent Realised","description":"Realised ROI.","examples":[12.3]},"roi_percent_unrealised":{"anyOf":[{"type":"number"}],"title":"Roi Percent Unrealised","description":"Unrealised ROI.","examples":[3.2]},"pnl_usd_total":{"anyOf":[{"type":"number"}],"title":"Pnl Usd Total","description":"Total PNL in USD.","examples":[1350.75]},"nof_trades":{"anyOf":[{"type":"integer"}],"title":"Nof Trades","description":"Number of trades.","examples":[25]}},"type":"object","required":["trader_address"],"title":"TGMPerpPnlLeaderboard","description":"Individual TGM Perp PnL leaderboard record.\nRepresents a single trader's PnL performance for a specific perpetual contract."},"TGMPerpPnlLeaderboardFilters":{"properties":{"trader_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address Label","description":"Trader name filter","examples":["Smart Money","%Fund%"]},"token_price":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token price range filter","examples":[{"min":0.01}]},"pnl_usd_realised":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Realized PnL range filter in USD","examples":[{"min":1000}]},"pnl_usd_unrealised":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Unrealized PnL range filter in USD","examples":[{"min":1000}]},"holding_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Holding amount range filter","examples":[{"min":100}]},"position_value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Position value range filter in USD (+ve = Long position, -ve = Short position, 0 = Flat)","examples":[{"min":1000}]},"max_balance_held":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Maximum balance held range filter","examples":[{"min":100}]},"max_balance_held_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Maximum balance held range filter in USD","examples":[{"min":1000}]},"still_holding_balance_ratio":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Still holding balance ratio range filter","examples":[{"max":1.0,"min":0.1}]},"nof_trades":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Number of trades range filter","examples":[{"max":100,"min":10}]},"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels","examples":[["Fund","Smart Trader"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels","examples":[["30D Smart Trader"]]}},"additionalProperties":false,"type":"object","title":"TGMPerpPnlLeaderboardFilters","description":"Filters for TGM Perp PnL leaderboard endpoint.\n\nThese filters control which traders are included in the leaderboard."},"TGMPerpPnlLeaderboardRequest":{"properties":{"token_symbol":{"type":"string","title":"Token Symbol","description":"Perpetual contract symbol (e.g., BTC, ETH, SOL)","examples":["BTC"]},"date":{"$ref":"#/components/schemas/DateRange","description":"ISO 8601 date-time range object with optional from and to fields","examples":[{"from":"2025-10-14T00:00:00Z","to":"2025-10-15T23:59:59Z"}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMPerpPnlLeaderboardFilters"}],"description":"Additional filters to apply to the query.","examples":[{"pnl_usd_realised":{"min":1000},"position_value_usd":{"min":1000}}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted (default), returns labels as per subscription plan (existing behavior). When false, returns free-tier labels for all users. When true, returns premium labels. Note: In a future release, the default will change from true to false — pass premium_labels=true explicitly to preserve premium label behavior."},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TGMPerpPnlLeaderboardSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering"}},"type":"object","required":["token_symbol","date"],"title":"TGMPerpPnlLeaderboardRequest","description":"Request model for TGM Perp PnL leaderboard endpoint.\nSimplified version that only supports Hyperliquid perpetual contracts."},"TGMPerpPnlLeaderboardResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMPerpPnlLeaderboard"},"type":"array","title":"Data","description":"List of TGM Perp PnL leaderboard records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TGMPerpPnlLeaderboardResponse","description":"Response model for TGM Perp PnL leaderboard endpoint.\nContains a list of PnL leaderboard records with pagination and metadata."},"TGMPerpPnlLeaderboardSortField":{"type":"string","enum":["pnl_usd_realised","pnl_usd_unrealised","pnl_usd_total","roi_percent_total","roi_percent_realised","roi_percent_unrealised","holding_amount","position_value_usd","max_balance_held","max_balance_held_usd","still_holding_balance_ratio","netflow_amount_usd","netflow_amount","nof_trades"],"title":"TGMPerpPnlLeaderboardSortField","description":"Enum for sortable fields in TGM Perp PnL leaderboard."},"TGMPerpPosition":{"properties":{"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"The wallet address of the trader.","examples":["0x1234567890123456789012345678901234567890"]},"address_label":{"anyOf":[{"type":"string"}],"title":"Address Label","description":"Wallet or labeled entity holding the position.","examples":["Smart Money"]},"side":{"anyOf":[{"$ref":"#/components/schemas/PositionSide"}],"description":"Position direction (Long/Short)","examples":["Long"]},"position_value_usd":{"anyOf":[{"type":"number"}],"title":"Position Value Usd","description":"USD notional size of the position.","examples":[50000.0]},"position_size":{"anyOf":[{"type":"number"}],"title":"Position Size","description":"The position size (token amount).","examples":[1.5]},"leverage":{"type":"string","title":"Leverage","description":"The leverage applied to the position.","examples":["5X"]},"leverage_type":{"anyOf":[{"type":"string"}],"title":"Leverage Type","description":"The type of leverage used, e.g., cross or isolated.","examples":["cross"]},"entry_price":{"anyOf":[{"type":"number"}],"title":"Entry Price","description":"Average price where the position was opened.","examples":[50000.0]},"mark_price":{"anyOf":[{"type":"number"}],"title":"Mark Price","description":"The current mark price of the asset.","examples":[50500.0]},"liquidation_price":{"anyOf":[{"type":"number"}],"title":"Liquidation Price","description":"The price at which the position would be liquidated.","examples":[45000.0]},"funding_usd":{"anyOf":[{"type":"number"}],"title":"Funding Usd","description":"Net funding paid (-) or received (+) since entry.","examples":[10.5]},"upnl_usd":{"anyOf":[{"type":"number"}],"title":"Upnl Usd","description":"Unrealized profit/loss including funding.","examples":[500.0]}},"type":"object","required":["leverage"],"title":"TGMPerpPosition","description":"Individual TGM perp position record.\n\nRepresents a single perp position."},"TGMPerpPositionsFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels for traders","examples":[["Smart HL Perps Trader"],["Fund"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels for traders","examples":[["Smart HL Perps Trader"],["Fund"]]},"address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Address Label","description":"Trader label filter","examples":["Smart Money","%Fund%"]},"side":{"anyOf":[{"$ref":"#/components/schemas/PositionSide"},{"items":{"$ref":"#/components/schemas/PositionSide"},"type":"array"},{"type":"null"}],"title":"Side","description":"Position side filter (Long or Short)","examples":["Long",["Short","Long"]]},"position_value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Position value range filter in USD","examples":[{"min":10000}]},"position_size":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Position size range filter (token amount)","examples":[{"min":1.5}]},"entry_price":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Entry price range filter","examples":[{"max":60000,"min":50000}]},"upnl_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Unrealized PnL range filter in USD","examples":[{"max":10000,"min":-1000}]},"funding_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Funding range filter in USD","examples":[{"max":10000,"min":-1000}]}},"additionalProperties":false,"type":"object","title":"TGMPerpPositionsFilters","description":"Filters for TGM perp positions endpoint.\n\nThese filters control which perp positions are included in the analysis."},"TGMPerpPositionsLabel":{"type":"string","enum":["smart_money","all_traders","whale","public_figure"],"title":"TGMPerpPositionsLabel","description":"TGM perp positions label types."},"TGMPerpPositionsRequest":{"properties":{"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol","examples":["BTC"]},"label_type":{"$ref":"#/components/schemas/TGMPerpPositionsLabel","description":"Label type filter","default":"all_traders","examples":["all_traders"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMPerpPositionsFilters"}],"description":"Additional filters to apply to the query.","examples":[{"include_smart_money_labels":["Smart HL Perps Trader","Fund"],"position_value_usd":{"min":10000},"side":["Long"],"upnl_usd":{"min":0}}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TGMPerpPositionsSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"position_value_usd\", \"direction\": \"DESC\"}] - Sort by position value USD descending\n- [{\"field\": \"upnl_usd\", \"direction\": \"ASC\"}] - Sort by unrealized PnL ascending\n- [{\"field\": \"leverage\", \"direction\": \"DESC\"}] - Sort by leverage descending"}},"additionalProperties":false,"type":"object","required":["token_symbol"],"title":"TGMPerpPositionsRequest","description":"Request model for TGM perp positions endpoint.\n\nThis endpoint provides perp positions data for a specific token."},"TGMPerpPositionsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMPerpPosition"},"type":"array","title":"Data","description":"List of TGM perp position records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TGMPerpPositionsResponse","description":"Response model for TGM perp positions endpoint.\n\nContains a list of perp position records with pagination and metadata."},"TGMPerpPositionsSortField":{"type":"string","enum":["address","address_label","side","position_value_usd","position_size","leverage","entry_price","mark_price","liquidation_price","funding_usd","upnl_usd"],"title":"TGMPerpPositionsSortField","description":"Enum for sortable fields in TGM perp positions."},"TGMPerpTrade":{"properties":{"trader_address_label":{"anyOf":[{"type":"string"}],"title":"Trader Address Label","description":"The label associated with the trader","examples":["Smart Money"]},"trader_address":{"type":"string","title":"Trader Address","description":"The trader's address","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"token_symbol":{"anyOf":[{"type":"string"}],"title":"Token Symbol","description":"The symbol of the token","examples":["BTC"]},"side":{"anyOf":[{"$ref":"#/components/schemas/PositionSide"}],"description":"The side of the position (Long or Short)","examples":["Long","Short"]},"action":{"type":"string","title":"Action","description":"The action taken by the trader (Add, Reduce, Open, Close)","examples":["Add","Reduce","Open","Close"]},"token_amount":{"anyOf":[{"type":"number"}],"title":"Token Amount","description":"The amount of the specified token traded","examples":[1.5]},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Average fill price in USD across all fills in the trade, from exchange data.","examples":[60000.0]},"value_usd":{"anyOf":[{"type":"number"}],"title":"Value Usd","description":"The value in USD","examples":[90000.0]},"type":{"$ref":"#/components/schemas/OrderType","description":"The order type (MARKET or LIMIT)","examples":["MARKET","LIMIT"]},"block_timestamp":{"type":"string","title":"Block Timestamp","description":"The block timestamp for the transaction","examples":["2025-10-01T12:40:00Z"]},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"A representative transaction hash for this trade. Note: A single row may aggregate multiple fills that occurred at the same timestamp. If the trader had fills across multiple transactions at the exact same millisecond, only one transaction_hash is shown. The token_amount and value_usd reflect the total across all fills.","examples":["0x61adb6da30853c5988f0204dd9f6e4abbc878e02c34030a4f707cf4ec3124bcb"]}},"type":"object","required":["trader_address","action","type","block_timestamp","transaction_hash"],"title":"TGMPerpTrade","description":"Individual TGM perp trade record.\n\nRepresents a single perp trade with parsed action fields."},"TGMPerpTradesFilters":{"properties":{"trader_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address Label","description":"Trader label filter","examples":["Smart Money","%Fund%"]},"side":{"anyOf":[{"$ref":"#/components/schemas/PositionSide"},{"items":{"$ref":"#/components/schemas/PositionSide"},"type":"array"},{"type":"null"}],"title":"Side","description":"Position side filter (Long or Short)","examples":["Long",["Short","Long"]]},"action":{"anyOf":[{"$ref":"#/components/schemas/PerpActionType"},{"items":{"$ref":"#/components/schemas/PerpActionType"},"type":"array"},{"type":"null"}],"title":"Action","description":"Action filter with combined buy/sell direction (e.g., 'Buy - Add Long', 'Sell - Reduce Long')","examples":["Buy - Add Long","Sell - Reduce Long"]},"order_type":{"anyOf":[{"$ref":"#/components/schemas/OrderType"},{"items":{"$ref":"#/components/schemas/OrderType"},"type":"array"},{"type":"null"}],"title":"Order Type","description":"Order type filter (MARKET or LIMIT)","examples":["MARKET","LIMIT"]},"token_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token amount range filter","examples":[{"max":1000,"min":100}]},"price_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Price range filter in USD","examples":[{"max":10000,"min":1000}]},"value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Trade value range filter in USD","examples":[{"max":10000,"min":-10000}]},"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels","examples":[["Fund","Smart Trader"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels","examples":[["30D Smart Trader"]]}},"additionalProperties":false,"type":"object","title":"TGMPerpTradesFilters","description":"Filters for TGM perp trades endpoint.\n\nThese filters control which perp trades are included in the results."},"TGMPerpTradesRequest":{"properties":{"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol","examples":["BTC"]},"date":{"$ref":"#/components/schemas/DateRange","description":"ISO 8601 date-time range object with optional from and to fields","examples":[{"from":"2025-07-07T00:00:00Z","to":"2025-07-14T23:59:59Z"}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMPerpTradesFilters"}],"description":"Additional filters to apply to the query.","examples":[{"order_type":["MARKET"],"side":["Long"]}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TGMPerpTradesSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"block_timestamp\", \"direction\": \"DESC\"}] - Sort by timestamp descending\n- [{\"field\": \"value_usd\", \"direction\": \"DESC\"}] - Sort by trade value descending\n\nDefault: block_timestamp DESC, transaction_hash ASC, trader_address ASC (ensures stable pagination and prevents duplicate rows)"}},"additionalProperties":false,"type":"object","required":["token_symbol","date"],"title":"TGMPerpTradesRequest","description":"Request model for TGM perp trades endpoint.\n\nThis endpoint provides perp trades data for a specific token."},"TGMPerpTradesResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMPerpTrade"},"type":"array","title":"Data","description":"List of TGM perp trade records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TGMPerpTradesResponse","description":"Response model for TGM perp trades endpoint.\n\nContains a list of perp trade records with pagination and metadata."},"TGMPerpTradesSortField":{"type":"string","enum":["block_timestamp","token_amount","value_usd","transaction_hash","trader_address"],"title":"TGMPerpTradesSortField","description":"Enum for sortable fields in TGM perp trades."},"TGMPnLLeaderboardChain":{"type":"string","enum":["arbitrum","avalanche","base","bnb","ethereum","hyperevm","linea","mantle","monad","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic"],"title":"TGMPnLLeaderboardChain","description":"Chains supported for TGM PnL leaderboard endpoint."},"TGMPnlLeaderboard":{"properties":{"trader_address":{"type":"string","title":"Trader Address","description":"Hexadecimal representation of the trader's address.","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"}],"title":"Trader Address Label","description":"Nansen name of the trader","examples":["🏦 Binance 14 [0x28c6c0]"]},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Token price in USD at date_to. Uses latest spot price if date_to is today or later, otherwise the daily median price for that date.","examples":[1.23]},"pnl_usd_realised":{"anyOf":[{"type":"number"}],"title":"Pnl Usd Realised","description":"Realised profit and loss in USD.","examples":[1250.5]},"pnl_usd_unrealised":{"anyOf":[{"type":"number"}],"title":"Pnl Usd Unrealised","description":"Unrealised profit and loss in USD.","examples":[100.25]},"holding_amount":{"anyOf":[{"type":"number"}],"title":"Holding Amount","description":"Current token balance","examples":[5000.0]},"holding_usd":{"anyOf":[{"type":"number"}],"title":"Holding Usd","description":"USD value of token balance","examples":[6000.0]},"max_balance_held":{"anyOf":[{"type":"number"}],"title":"Max Balance Held","description":"Maximum amount of tokens held at some point in time.","examples":[10000.0]},"max_balance_held_usd":{"anyOf":[{"type":"number"}],"title":"Max Balance Held Usd","description":"Maximum amount of tokens in current USD value, held at some point in time.","examples":[12000.0]},"still_holding_balance_ratio":{"anyOf":[{"type":"number"}],"title":"Still Holding Balance Ratio","description":"The ratio of current holdings to max balance held.","examples":[0.5]},"netflow_amount_usd":{"anyOf":[{"type":"number"}],"title":"Netflow Amount Usd","description":"Netflow amount in USD.","examples":[2500.75]},"netflow_amount":{"anyOf":[{"type":"number"}],"title":"Netflow Amount","description":"Netflow amount.","examples":[1500.0]},"roi_percent_total":{"anyOf":[{"type":"number"}],"title":"Roi Percent Total","description":"Total ROI.","examples":[15.5]},"roi_percent_realised":{"anyOf":[{"type":"number"}],"title":"Roi Percent Realised","description":"Realised ROI.","examples":[12.3]},"roi_percent_unrealised":{"anyOf":[{"type":"number"}],"title":"Roi Percent Unrealised","description":"Unrealised ROI.","examples":[3.2]},"pnl_usd_total":{"anyOf":[{"type":"number"}],"title":"Pnl Usd Total","description":"Total PNL in USD.","examples":[1350.75]},"nof_trades":{"anyOf":[{"type":"integer"}],"title":"Nof Trades","description":"Number of trades.","examples":[25]}},"type":"object","required":["trader_address"],"title":"TGMPnlLeaderboard","description":"Individual TGM PnL leaderboard record.\nRepresents a single trader's PnL performance for a specific token."},"TGMPnlLeaderboardFilters":{"properties":{"trader_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"trader_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Trader Address Label","description":"Trader name filter","examples":["Smart Money","%Fund%"]},"token_price":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token price range filter","examples":[{"min":0.01}]},"pnl_usd_realised":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Realized PnL range filter in USD","examples":[{"min":1000}]},"pnl_usd_unrealised":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Unrealized PnL range filter in USD","examples":[{"min":1000}]},"holding_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Holding amount range filter","examples":[{"min":100}]},"holding_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Holding value range filter in USD","examples":[{"min":1000}]},"max_balance_held":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Maximum balance held range filter","examples":[{"min":100}]},"max_balance_held_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Maximum balance held range filter in USD","examples":[{"min":1000}]},"still_holding_balance_ratio":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Still holding balance ratio range filter","examples":[{"max":1.0,"min":0.1}]},"nof_trades":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Number of trades range filter","examples":[{"max":100,"min":10}]}},"additionalProperties":false,"type":"object","title":"TGMPnlLeaderboardFilters","description":"Filters for TGM PnL leaderboard endpoint.\n\nThese filters control which traders are included in the leaderboard."},"TGMPnlLeaderboardRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMPnLLeaderboardChain","description":"Blockchain chain","examples":["ethereum"]},"token_address":{"type":"string","title":"Token Address","description":"Token address","examples":["0x6982508145454ce325ddbe47a25d4ec3d2311933"]},"date":{"$ref":"#/components/schemas/DateRange","description":"ISO 8601 date-time range object with optional from and to fields","examples":[{"from":"2025-07-14T00:00:00Z","to":"2025-07-15T23:59:59Z"}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMPnlLeaderboardFilters"}],"description":"Additional filters to apply to the query.","examples":[{"holding_usd":{"min":1000},"pnl_usd_realised":{"min":1000}}]},"premium_labels":{"anyOf":[{"type":"boolean"}],"title":"Premium Labels","description":"Controls label tier in the response. When null/omitted, defaults to true (premium labels filtered by subscription plan). When false, returns free-tier labels for all users. When true, returns premium labels (filtered by subscription plan). Note: In a future release, the default will change from true to false — pass premium_labels=true explicitly to preserve premium label behavior."},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TGMPnlLeaderboardSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering"}},"additionalProperties":false,"type":"object","required":["chain","token_address","date"],"title":"TGMPnlLeaderboardRequest","description":"Request model for TGM PnL leaderboard endpoint.\nThis endpoint provides a token PnL leaderboard showing the most profitable\ntraders for a specific token within a given date range."},"TGMPnlLeaderboardResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMPnlLeaderboard"},"type":"array","title":"Data","description":"List of TGM PnL leaderboard records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TGMPnlLeaderboardResponse","description":"Response model for TGM PnL leaderboard endpoint.\nContains a list of PnL leaderboard records with pagination and metadata."},"TGMPnlLeaderboardSortField":{"type":"string","enum":["pnl_usd_realised","pnl_usd_unrealised","pnl_usd_total","roi_percent_total","roi_percent_realised","roi_percent_unrealised","holding_amount","holding_usd","max_balance_held","max_balance_held_usd","still_holding_balance_ratio","netflow_amount_usd","netflow_amount","nof_trades"],"title":"TGMPnlLeaderboardSortField","description":"Enum for sortable fields in TGM PnL leaderboard."},"TGMPositionIntelligence":{"properties":{"smart_trader_longs_usd":{"anyOf":[{"type":"number"}],"title":"Smart Trader Longs Usd","description":"Sum of absolute long sizes for addresses labeled Smart HL Perps Trader.","examples":[1000000.5]},"smart_trader_shorts_usd":{"anyOf":[{"type":"number"}],"title":"Smart Trader Shorts Usd","description":"Sum of absolute short sizes for addresses labeled Smart HL Perps Trader.","examples":[500000.25]},"smart_trader_total_usd":{"anyOf":[{"type":"number"}],"title":"Smart Trader Total Usd","description":"Total absolute position size for addresses labeled Smart HL Perps Trader.","examples":[1500000.75]},"whale_longs_usd":{"anyOf":[{"type":"number"}],"title":"Whale Longs Usd","description":"Sum of absolute long sizes for addresses labeled Whale.","examples":[2000000.5]},"whale_shorts_usd":{"anyOf":[{"type":"number"}],"title":"Whale Shorts Usd","description":"Sum of absolute short sizes for addresses labeled Whale.","examples":[1000000.25]},"whale_total_usd":{"anyOf":[{"type":"number"}],"title":"Whale Total Usd","description":"Total absolute position size for addresses labeled Whale.","examples":[3000000.75]},"public_figure_longs_usd":{"anyOf":[{"type":"number"}],"title":"Public Figure Longs Usd","description":"Sum of absolute long sizes for addresses labeled Public Figure.","examples":[500000.5]},"public_figure_shorts_usd":{"anyOf":[{"type":"number"}],"title":"Public Figure Shorts Usd","description":"Sum of absolute short sizes for addresses labeled Public Figure.","examples":[250000.25]},"public_figure_total_usd":{"anyOf":[{"type":"number"}],"title":"Public Figure Total Usd","description":"Total absolute position size for addresses labeled Public Figure.","examples":[750000.75]}},"type":"object","title":"TGMPositionIntelligence","description":"Individual TGM position intelligence record.\n\nRepresents aggregated position sizes for different trader cohorts."},"TGMPositionIntelligenceRequest":{"properties":{"token_address":{"type":"string","minLength":1,"title":"Token Address","description":"Token address (for perps and hyperliquid, validation is skipped)","examples":["BTC"]}},"additionalProperties":false,"type":"object","required":["token_address"],"title":"TGMPositionIntelligenceRequest","description":"Request model for TGM position-intelligence endpoint.\n\nThis endpoint provides position intelligence analytics for perpetual contracts\non Hyperliquid, showing aggregated position sizes by different trader cohorts."},"TGMPositionIntelligenceResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMPositionIntelligence"},"type":"array","title":"Data","description":"List of TGM position intelligence records"}},"type":"object","required":["data"],"title":"TGMPositionIntelligenceResponse","description":"Response model for TGM position-intelligence endpoint.\n\nContains position intelligence data with pagination and metadata."},"TGMTokenInformation":{"properties":{"name":{"anyOf":[{"type":"string"}],"title":"Name","description":"Token name","examples":["Aave"]},"symbol":{"anyOf":[{"type":"string"}],"title":"Symbol","description":"Token symbol","examples":["AAVE"]},"contract_address":{"anyOf":[{"type":"string"}],"title":"Contract Address","description":"Token contract address","examples":["0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9"]},"logo":{"anyOf":[{"type":"string"}],"title":"Logo","description":"Token logo URL","examples":["https://assets.coingecko.com/coins/images/12645/large/AAVE.png"]},"token_details":{"anyOf":[{"$ref":"#/components/schemas/TokenDetails"}],"description":"Token details including deployment, social links, and market metrics"},"spot_metrics":{"anyOf":[{"$ref":"#/components/schemas/SpotMetrics"}],"description":"Spot trading metrics for the token"}},"type":"object","title":"TGMTokenInformation","description":"Token information including basic details, token details, and spot metrics."},"TGMTokenInformationRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMChain","description":"Blockchain chain","examples":["ethereum"]},"token_address":{"type":"string","title":"Token Address","description":"Token address","examples":["0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9"]},"timeframe":{"$ref":"#/components/schemas/TGMFlowIntelligenceTimeframe","description":"Timeframe for the token information query","examples":["1d"]}},"additionalProperties":false,"type":"object","required":["chain","token_address","timeframe"],"title":"TGMTokenInformationRequest","description":"Request model for TGM token information endpoint.\nThis endpoint provides comprehensive token information including basic details,\ntoken details (deployment, social links, market metrics), and spot trading metrics."},"TGMTokenInformationResponse":{"properties":{"data":{"$ref":"#/components/schemas/TGMTokenInformation","description":"Token information data"}},"type":"object","required":["data"],"title":"TGMTokenInformationResponse","description":"Response model for TGM token information endpoint.\nContains comprehensive token information including basic details,\ntoken details, and spot metrics."},"TGMTransfer":{"properties":{"block_timestamp":{"type":"string","title":"Block Timestamp","description":"The block timestamp for the transaction","examples":["2025-05-01T12:00:00Z"]},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"The transaction hash for the transaction","examples":["0x1234567890abcdef..."]},"from_address":{"type":"string","title":"From Address","description":"from address","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"to_address":{"type":"string","title":"To Address","description":"to address","examples":["0x742d35cc6634c0532925a3b8d4c9db96c4b4d8b6"]},"from_address_label":{"anyOf":[{"type":"string"}],"title":"From Address Label","description":"from address label","examples":["🏦 Binance 14 [0x28c6c0]"]},"to_address_label":{"anyOf":[{"type":"string"}],"title":"To Address Label","description":"to address label","examples":["High Balance"]},"transaction_type":{"anyOf":[{"type":"string"}],"title":"Transaction Type","description":"Transaction type","examples":["DEX"]},"transfer_amount":{"anyOf":[{"type":"number"}],"title":"Transfer Amount","description":"value of the token traded","examples":[1000.0]},"transfer_value_usd":{"anyOf":[{"type":"number"}],"title":"Transfer Value Usd","description":"value of the token traded in USD","examples":[2500.0]}},"type":"object","required":["block_timestamp","transaction_hash","from_address","to_address"],"title":"TGMTransfer","description":"Individual TGM transfer record.\n\nRepresents a single token transfer with transaction details and participant information."},"TGMTransfersChain":{"type":"string","enum":["arbitrum","avalanche","base","bitcoin","bnb","ethereum","hyperevm","injective","iotaevm","linea","mantle","monad","near","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","starknet","sui","ton","tron"],"title":"TGMTransfersChain","description":"Chains supported for TGM transfers endpoint."},"TGMTransfersFilters":{"properties":{"include_dex":{"anyOf":[{"type":"boolean"}],"title":"Include Dex","description":"Whether to include DEX transfers","examples":[true]},"include_cex":{"anyOf":[{"type":"boolean"}],"title":"Include Cex","description":"Whether to include CEX transfers","examples":[true]},"non_exchange_transfers":{"anyOf":[{"type":"boolean"}],"title":"Non Exchange Transfers","description":"Whether to include non-exchange transfers","examples":[true]},"only_smart_money":{"anyOf":[{"type":"boolean"}],"title":"Only Smart Money","description":"Whether to include only smart money transfers","examples":[true]},"from_include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"From Include Smart Money Labels","description":"Include smart money labels for from address","examples":[["Public Figure"],["Exchange"]]},"from_exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"From Exclude Smart Money Labels","description":"Exclude smart money labels for from address","examples":[["Public Figure"],["Exchange"]]},"to_include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"To Include Smart Money Labels","description":"Include smart money labels for to address","examples":[["Public Figure"],["Exchange"]]},"to_exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"To Exclude Smart Money Labels","description":"Exclude smart money labels for to address","examples":[["Public Figure"],["Exchange"]]},"transaction_hash":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Transaction Hash","description":"Transaction hash filter","examples":["0x61adb6da30853c5988f0204dd9f6e4abbc878e02c34030a4f707cf4ec3124bcb"]},"from_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"From Address","description":"From address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"to_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"To Address","description":"To address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"from_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"From Address Label","description":"From address label filter","examples":["Smart Money","%Fund%"]},"to_address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"To Address Label","description":"To address label filter","examples":["Smart Money","%Exchange%"]},"transaction_type":{"anyOf":[{"type":"string"}],"title":"Transaction Type","description":"Transaction type filter","examples":["transfer","dex_trade"]},"transfer_amount":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Transfer amount range filter","examples":[{"min":100}]},"transfer_value_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Transfer value range filter in USD","examples":[{"min":1000}]}},"additionalProperties":false,"type":"object","title":"TGMTransfersFilters","description":"Filters for TGM transfers endpoint.\n\nThese filters control which transfers are included in the analysis."},"TGMTransfersRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMTransfersChain","description":"Blockchain chain","examples":["ethereum"]},"token_address":{"type":"string","title":"Token Address","description":"Token address","examples":["0x6982508145454ce325ddbe47a25d4ec3d2311933"]},"date":{"$ref":"#/components/schemas/DateRangeMaxOneYear","description":"ISO 8601 date-time range object with from and to fields (max 1 year).","examples":[{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMTransfersFilters"}],"description":"Additional filters to apply to the query.","examples":[{"include_cex":true,"include_dex":true,"non_exchange_transfers":true,"only_smart_money":true}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TGMTransfersSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"transfer_value_usd\", \"direction\": \"ASC\"}] - Sort by transfer value ascending\n- [{\"field\": \"transfer_amount\", \"direction\": \"DESC\"}] - Sort by transfer amount descending"}},"additionalProperties":false,"type":"object","required":["chain","token_address","date"],"title":"TGMTransfersRequest","description":"Request model for TGM transfers endpoint.\n\nThis endpoint provides top token transfers for a specific token, with support for ERC-20 tokens. The model selection is dynamic based\non the token address."},"TGMTransfersResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMTransfer"},"type":"array","title":"Data","description":"List of TGM transfer records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TGMTransfersResponse","description":"Response model for TGM transfers endpoint.\n\nContains a list of transfer records with pagination and metadata."},"TGMTransfersSortField":{"type":"string","enum":["block_timestamp","transaction_hash","from_address","to_address","from_address_label","to_address_label","transaction_type","transfer_amount","transfer_value_usd"],"title":"TGMTransfersSortField","description":"Enum for sortable fields in TGM transfers."},"TGMWhoBoughtSold":{"properties":{"address":{"type":"string","title":"Address","description":"The address that did the trades","examples":["0x1234567890123456789012345678901234567890"]},"address_label":{"anyOf":[{"type":"string"}],"title":"Address Label","description":"Label associated with the address","examples":["High Gas Consumer"]},"bought_token_volume":{"anyOf":[{"type":"number"}],"title":"Bought Token Volume","description":"The aggregate bought token volume for the address","examples":[1000.5]},"sold_token_volume":{"anyOf":[{"type":"number"}],"title":"Sold Token Volume","description":"The aggregate sold token volume for the address","examples":[500.25]},"token_trade_volume":{"anyOf":[{"type":"number"}],"title":"Token Trade Volume","description":"The net token trade volume for the address","examples":[500.25]},"bought_volume_usd":{"anyOf":[{"type":"number"}],"title":"Bought Volume Usd","description":"The aggregate bought volume in USD for the address","examples":[25000.0]},"sold_volume_usd":{"anyOf":[{"type":"number"}],"title":"Sold Volume Usd","description":"The aggregate sold volume in USD for the address","examples":[12500.0]},"trade_volume_usd":{"anyOf":[{"type":"number"}],"title":"Trade Volume Usd","description":"The net trade volume in USD for the address","examples":[12500.0]}},"type":"object","required":["address"],"title":"TGMWhoBoughtSold","description":"Individual TGM who bought/sold record.\n\nRepresents a single address with aggregated trade volumes."},"TGMWhoBoughtSoldFilters":{"properties":{"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels for traders","examples":[["Public Figure"],["Exchange"],["Smart HL Perps Trader"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/LabelType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels for traders","examples":[["Public Figure"],["Exchange"],["Smart HL Perps Trader"]]},"address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Address","description":"Trader address filter","examples":["0x28c6c06298d514db089934071355e5743bf21d60"]},"address_label":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Address Label","description":"Trader label filter","examples":["High Gas Consumer"]},"bought_token_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Bought token volume range filter","examples":[{"min":1000}]},"sold_token_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Sold token volume range filter","examples":[{"min":1000}]},"token_trade_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total token trade volume range filter","examples":[{"min":1000}]},"bought_volume_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Bought volume range filter in USD","examples":[{"min":1000}]},"sold_volume_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Sold volume range filter in USD","examples":[{"min":1000}]},"trade_volume_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total trade volume range filter in USD","examples":[{"min":1000}]}},"additionalProperties":false,"type":"object","title":"TGMWhoBoughtSoldFilters","description":"Filters for TGM who bought/sold endpoint.\n\nThese filters control which traders and trade data are included."},"TGMWhoBoughtSoldRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMChain","description":"Blockchain chain","examples":["solana"]},"token_address":{"type":"string","title":"Token Address","description":"Address of token","examples":["2zMMhcVQEXDtdE6vsFS7S7D5oUodfJHE8vd1gnBouauv"]},"buy_or_sell":{"$ref":"#/components/schemas/TGMWhoBoughtSoldType","description":"Are we checking buys or sells","default":"BUY"},"date":{"$ref":"#/components/schemas/DateRange","description":"ISO 8601 date-time range object with from and to fields","examples":[{"from":"2025-05-01T00:00:00Z","to":"2025-05-03T23:59:59Z"}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TGMWhoBoughtSoldFilters"}],"description":"Additional filters to apply to the query.","examples":[{"include_smart_money_labels":["Whale","Smart Trader"],"trade_volume_usd":{"min":1}},{"include_smart_money_labels":["Smart HL Perps Trader"],"trade_volume_usd":{"min":1000}}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TGMWhoBoughtSoldSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"bought_volume_usd\", \"direction\": \"DESC\"}] - Sort by bought volume descending\n- [{\"field\": \"sold_volume_usd\", \"direction\": \"ASC\"}] - Sort by sold volume ascending"}},"additionalProperties":false,"type":"object","required":["chain","token_address","date"],"title":"TGMWhoBoughtSoldRequest","description":"Request model for TGM who bought/sold endpoint.\n\nThis endpoint provides an aggregated summary of trade volumes in USD for addresses\ninvolved in DEX (Decentralized Exchange) trades for a specific token."},"TGMWhoBoughtSoldResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TGMWhoBoughtSold"},"type":"array","title":"Data","description":"List of TGM who bought/sold records"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TGMWhoBoughtSoldResponse","description":"Response model for TGM who bought/sold endpoint.\n\nContains a list of address records with pagination and metadata."},"TGMWhoBoughtSoldSortField":{"type":"string","enum":["bought_volume_usd","sold_volume_usd","token_trade_volume","trade_volume_usd","bought_token_volume","sold_token_volume"],"title":"TGMWhoBoughtSoldSortField","description":"Sortable fields for TGM who-bought-sold endpoint."},"TGMWhoBoughtSoldType":{"type":"string","enum":["BUY","SELL"],"title":"TGMWhoBoughtSoldType","description":"TGM who bought/sold type."},"TokenDetails":{"properties":{"token_deployment_date":{"anyOf":[{"type":"string"}],"title":"Token Deployment Date","description":"Token deployment date in ISO format","examples":["2020-11-05T00:00:00Z"]},"website":{"anyOf":[{"type":"string"}],"title":"Website","description":"Token website URL","examples":["https://aave.com"]},"x":{"anyOf":[{"type":"string"}],"title":"X","description":"X (Twitter) profile URL","examples":["https://x.com/aave"]},"telegram":{"anyOf":[{"type":"string"}],"title":"Telegram","description":"Telegram channel URL","examples":["https://t.me/Aavesome"]},"market_cap_usd":{"anyOf":[{"type":"number"}],"title":"Market Cap Usd","description":"Market capitalization in USD","examples":[4690000000]},"fdv_usd":{"anyOf":[{"type":"number"}],"title":"Fdv Usd","description":"Fully diluted valuation in USD","examples":[4930000000]},"circulating_supply":{"anyOf":[{"type":"number"}],"title":"Circulating Supply","description":"Circulating supply of the token","examples":[15230000]},"total_supply":{"anyOf":[{"type":"number"}],"title":"Total Supply","description":"Total supply of the token","examples":[16000000]}},"type":"object","title":"TokenDetails","description":"Token details including deployment, social links, and market metrics."},"TokenInfo":{"properties":{"token_address":{"type":"string","title":"Token Address","description":"Token contract address"},"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol"},"token_name":{"type":"string","title":"Token Name","description":"Token name"},"num_transfer":{"type":"string","title":"Num Transfer","description":"Number of transfers"}},"type":"object","required":["token_address","token_symbol","token_name","num_transfer"],"title":"TokenInfo","description":"Token information for counterparty interactions."},"TokenOHLCVDateRange":{"properties":{"start":{"type":"string","title":"Start","description":"Start date and time (ISO format)","examples":["2025-01-01T00:00:00Z"]},"end":{"type":"string","title":"End","description":"End date and time (ISO format)","examples":["2025-02-01T00:00:00Z"]}},"type":"object","required":["start","end"],"title":"TokenOHLCVDateRange","description":"DEPRECATED: Use 'date' field with standard DateRange instead."},"TokenOHLCVRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TGMOHLCVChain","description":"Blockchain chain","examples":["ethereum"]},"token_address":{"type":"string","title":"Token Address","description":"Token contract address","examples":["0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9"]},"date_range":{"anyOf":[{"$ref":"#/components/schemas/TokenOHLCVDateRange"}],"description":"DEPRECATED: Use 'date' instead. Date range with start/end fields.","deprecated":true},"date":{"anyOf":[{"$ref":"#/components/schemas/DateRange"}],"description":"Date range for the data (defaults to last 30 days if not specified)"},"timeframe":{"$ref":"#/components/schemas/ResolutionEnum","description":"Time resolution for OHLCV data","examples":["1h","1d"]}},"additionalProperties":false,"type":"object","required":["chain","token_address","timeframe"],"title":"TokenOHLCVRequest","description":"Request model for Token OHLCV endpoint.\n\nThis endpoint provides unified OHLCV (Open, High, Low, Close, Volume) data\nfor tokens across supported chains with different time resolutions."},"TokenOHLCVResponse":{"properties":{"chain":{"type":"string","title":"Chain","description":"Blockchain chain","examples":["ethereum"]},"token_address":{"type":"string","title":"Token Address","description":"Token contract address","examples":["0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae9"]},"timeframe":{"type":"string","title":"Timeframe","description":"Time resolution used","examples":["1h"]},"data":{"items":{"$ref":"#/components/schemas/OHLCVCandle"},"type":"array","title":"Data","description":"OHLCV candle data points, ordered by interval_start"}},"type":"object","required":["chain","token_address","timeframe","data"],"title":"TokenOHLCVResponse","description":"Response model for Token OHLCV endpoint.\n\nContains the requested OHLCV data with metadata about the request parameters."},"TokenScreenerChain":{"type":"string","enum":["arbitrum","avalanche","base","bitcoin","bnb","ethereum","hyperevm","injective","iotaevm","linea","mantle","monad","near","optimism","plasma","polygon","ronin","scroll","sei","solana","sonic","starknet","sui","ton","tron"],"title":"TokenScreenerChain","description":"Chains supported for Token Screener endpoint."},"TokenScreenerDataDefault":{"properties":{"chain":{"type":"string","title":"Chain","description":"The blockchain network on which the token is deployed."},"token_address":{"type":"string","title":"Token Address","description":"Address of token"},"token_symbol":{"type":"string","title":"Token Symbol","description":"The symbol of the token."},"token_age_days":{"anyOf":[{"type":"number"}],"title":"Token Age Days","description":"Number of days since token deployment."},"market_cap_usd":{"anyOf":[{"type":"number"}],"title":"Market Cap Usd","description":"Market capitalization in USD."},"liquidity":{"anyOf":[{"type":"number"}],"title":"Liquidity","description":"Total on-chain liquidity in USD."},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Price of the token"},"price_change":{"anyOf":[{"type":"number"}],"title":"Price Change","description":"Price change percentage from the previous period."},"fdv":{"anyOf":[{"type":"number"}],"title":"Fdv","description":"Fully Diluted Valuation in USD."},"fdv_mc_ratio":{"anyOf":[{"type":"number"}],"title":"Fdv Mc Ratio","description":"Ratio of Fully Diluted Valuation to Market Cap."},"buy_volume":{"anyOf":[{"type":"number"}],"title":"Buy Volume","description":"Total buy volume in USD."},"inflow_fdv_ratio":{"anyOf":[{"type":"number"}],"title":"Inflow Fdv Ratio","description":"Ratio of inflow to Fully Diluted Valuation."},"outflow_fdv_ratio":{"anyOf":[{"type":"number"}],"title":"Outflow Fdv Ratio","description":"Ratio of outflow to Fully Diluted Valuation."},"sell_volume":{"anyOf":[{"type":"number"}],"title":"Sell Volume","description":"Total sell volume in USD."},"volume":{"anyOf":[{"type":"number"}],"title":"Volume","description":"Total trading volume in USD."},"netflow":{"anyOf":[{"type":"number"}],"title":"Netflow","description":"Net flow (buy_volume - sell_volume) in USD."}},"type":"object","required":["chain","token_address","token_symbol"],"title":"TokenScreenerDataDefault","description":"Data model for token screener results with non-default query (excludes trader-related columns)."},"TokenScreenerDataNonDefault":{"properties":{"chain":{"type":"string","title":"Chain","description":"The blockchain network on which the token is deployed."},"token_address":{"type":"string","title":"Token Address","description":"Address of token"},"token_symbol":{"type":"string","title":"Token Symbol","description":"The symbol of the token."},"token_age_days":{"anyOf":[{"type":"number"}],"title":"Token Age Days","description":"Number of days since token deployment."},"market_cap_usd":{"anyOf":[{"type":"number"}],"title":"Market Cap Usd","description":"Market capitalization in USD."},"liquidity":{"anyOf":[{"type":"number"}],"title":"Liquidity","description":"Total on-chain liquidity in USD."},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Price of the token"},"price_change":{"anyOf":[{"type":"number"}],"title":"Price Change","description":"Price change percentage from the previous period."},"fdv":{"anyOf":[{"type":"number"}],"title":"Fdv","description":"Fully Diluted Valuation in USD."},"fdv_mc_ratio":{"anyOf":[{"type":"number"}],"title":"Fdv Mc Ratio","description":"Ratio of Fully Diluted Valuation to Market Cap."},"nof_buyers":{"anyOf":[{"type":"integer"}],"title":"Nof Buyers","description":"Number of unique buyers."},"nof_traders":{"anyOf":[{"type":"integer"}],"title":"Nof Traders","description":"Total number of unique traders."},"nof_sellers":{"anyOf":[{"type":"integer"}],"title":"Nof Sellers","description":"Number of unique sellers."},"nof_buys":{"anyOf":[{"type":"integer"}],"title":"Nof Buys","description":"Total number of buy transactions."},"nof_sells":{"anyOf":[{"type":"integer"}],"title":"Nof Sells","description":"Total number of sell transactions."},"buy_volume":{"anyOf":[{"type":"number"}],"title":"Buy Volume","description":"Total buy volume in USD."},"inflow_fdv_ratio":{"anyOf":[{"type":"number"}],"title":"Inflow Fdv Ratio","description":"Ratio of inflow to Fully Diluted Valuation."},"outflow_fdv_ratio":{"anyOf":[{"type":"number"}],"title":"Outflow Fdv Ratio","description":"Ratio of outflow to Fully Diluted Valuation."},"sell_volume":{"anyOf":[{"type":"number"}],"title":"Sell Volume","description":"Total sell volume in USD."},"volume":{"anyOf":[{"type":"number"}],"title":"Volume","description":"Total trading volume in USD."},"netflow":{"anyOf":[{"type":"number"}],"title":"Netflow","description":"Net flow (buy_volume - sell_volume) in USD."}},"type":"object","required":["chain","token_address","token_symbol"],"title":"TokenScreenerDataNonDefault","description":"Data model for token screener results with non-default query (includes all columns)."},"TokenScreenerDataSmartMoneyDefault":{"properties":{"chain":{"type":"string","title":"Chain","description":"The blockchain network on which the token is deployed."},"token_address":{"type":"string","title":"Token Address","description":"Address of token"},"token_symbol":{"type":"string","title":"Token Symbol","description":"The symbol of the token."},"token_age_days":{"anyOf":[{"type":"number"}],"title":"Token Age Days","description":"Number of days since token deployment."},"market_cap_usd":{"anyOf":[{"type":"number"}],"title":"Market Cap Usd","description":"Market capitalization in USD."},"liquidity":{"anyOf":[{"type":"number"}],"title":"Liquidity","description":"Total on-chain liquidity in USD."},"price_usd":{"anyOf":[{"type":"number"}],"title":"Price Usd","description":"Price of the token"},"price_change":{"anyOf":[{"type":"number"}],"title":"Price Change","description":"Price change percentage from the previous period."},"fdv":{"anyOf":[{"type":"number"}],"title":"Fdv","description":"Fully Diluted Valuation in USD."},"fdv_mc_ratio":{"anyOf":[{"type":"number"}],"title":"Fdv Mc Ratio","description":"Ratio of Fully Diluted Valuation to Market Cap."},"nof_traders":{"anyOf":[{"type":"integer"}],"title":"Nof Traders","description":"Total number of unique traders."},"buy_volume":{"anyOf":[{"type":"number"}],"title":"Buy Volume","description":"Total buy volume in USD."},"inflow_fdv_ratio":{"anyOf":[{"type":"number"}],"title":"Inflow Fdv Ratio","description":"Ratio of inflow to Fully Diluted Valuation."},"outflow_fdv_ratio":{"anyOf":[{"type":"number"}],"title":"Outflow Fdv Ratio","description":"Ratio of outflow to Fully Diluted Valuation."},"sell_volume":{"anyOf":[{"type":"number"}],"title":"Sell Volume","description":"Total sell volume in USD."},"volume":{"anyOf":[{"type":"number"}],"title":"Volume","description":"Total trading volume in USD."},"netflow":{"anyOf":[{"type":"number"}],"title":"Netflow","description":"Net flow (buy_volume - sell_volume) in USD."}},"type":"object","required":["chain","token_address","token_symbol"],"title":"TokenScreenerDataSmartMoneyDefault","description":"Data model for smart money token screener with default query.\n\nIncludes nof_traders but excludes other trader-related columns\n(nof_buyers, nof_sellers, nof_buys, nof_sells)."},"TokenScreenerFilters":{"properties":{"token_address":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Address","description":"Token address or symbol filter","examples":["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]},"token_symbol":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Token Symbol","description":"Token symbol filter","examples":["USDC"]},"only_smart_money":{"anyOf":[{"type":"boolean"}],"title":"Only Smart Money","description":"Deprecated: use trader_type instead. Whether to only include smart money tokens","deprecated":true,"examples":[true]},"trader_type":{"anyOf":[{"$ref":"#/components/schemas/TraderType"}],"description":"Filter by trader type. Overrides only_smart_money when provided.","examples":["sm"]},"sectors":{"anyOf":[{"items":{"type":"string"},"type":"array"}],"title":"Sectors","description":"Token sectors to include","examples":[["DeFi","Gaming"]]},"token_age_days":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Token age range filter in days","examples":[{"max":365,"min":1}]},"market_cap_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Market cap range filter","examples":[{"max":100000000,"min":1000000}]},"liquidity":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Liquidity range filter","examples":[{"min":100000}]},"price_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Current price range filter in USD","examples":[{"max":1000,"min":0.01}]},"price_change":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Price change percentage range filter","examples":[{"max":100,"min":-50}]},"fdv":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Fully Diluted Valuation range filter","examples":[{"min":1000000}]},"fdv_mc_ratio":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"FDV to Market Cap ratio range filter","examples":[{"max":10.0,"min":1.0}]},"nof_buyers":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of unique buyers range filter","examples":[{"min":10}]},"nof_traders":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of unique traders range filter","examples":[{"min":50}]},"nof_sellers":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of unique sellers range filter","examples":[{"min":10}]},"nof_buys":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of buy transactions range filter","examples":[{"min":20}]},"nof_sells":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of sell transactions range filter","examples":[{"min":20}]},"buy_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Buy volume range filter in USD","examples":[{"min":10000}]},"sell_volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Sell volume range filter in USD","examples":[{"min":10000}]},"volume":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total trading volume range filter in USD","examples":[{"min":50000}]},"netflow":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Net flow range filter in USD","examples":[{"max":100000,"min":-100000}]},"inflow_fdv_ratio":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Inflow to FDV ratio range filter","examples":[{"min":0.001}]},"outflow_fdv_ratio":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Outflow to FDV ratio range filter","examples":[{"min":0.001}]},"include_stablecoins":{"type":"boolean","title":"Include Stablecoins","description":"Whether to include stablecoins in token screener results. Default true preserves current behavior. Set to false to exclude USDC, USDT, DAI, and other major stablecoins.","default":true,"examples":[false]},"include_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Include Smart Money Labels","description":"Include smart money labels","examples":[["Public Figure","Exchange"]]},"exclude_smart_money_labels":{"anyOf":[{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array"}],"title":"Exclude Smart Money Labels","description":"Exclude smart money labels","examples":[["Fund"]]}},"additionalProperties":false,"type":"object","title":"TokenScreenerFilters","description":"Filters for token screener endpoints.\n\nThese filters control which tokens are included in the screening\nresults based on various criteria."},"TokenScreenerHistoricalFilters":{"properties":{"sm_label_filter":{"items":{"$ref":"#/components/schemas/SmartMoneyFilterType"},"type":"array","title":"Sm Label Filter","description":"Filter by SM label (only applied when only_smart_money=True). Empty list includes all SM labels.","default":[],"examples":[["Smart Trader"]]},"volume_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Total volume range filter in USD","examples":[{"max":100000,"min":1000}]},"buy_volume_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Buy volume range filter in USD","examples":[{"min":1000}]},"sell_volume_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Sell volume range filter in USD","examples":[{"min":1000}]},"market_cap_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Market cap range filter in USD","examples":[{"min":1000000}]},"nof_traders":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of traders range filter","examples":[{"min":10}]},"nof_buyers":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of buyers range filter","examples":[{"min":5}]},"nof_sellers":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of sellers range filter","examples":[{"min":5}]},"nof_buys":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of buy transactions range filter","examples":[{"min":10}]},"nof_sells":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Number of sell transactions range filter","examples":[{"min":10}]},"fdv_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"FDV range filter in USD","examples":[{"min":1000000}]},"fdv_mc_ratio":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"FDV/MC ratio range filter","examples":[{"max":5.0,"min":1.0}]},"liquidity_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"On-chain liquidity range filter in USD","examples":[{"min":100000}]},"netflow_usd":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Netflow range filter in USD (can be negative)","examples":[{"max":100000,"min":-100000}]},"inflow_fdv_ratio":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Inflow/FDV ratio range filter","examples":[{"min":0.01}]},"outflow_fdv_ratio":{"anyOf":[{"$ref":"#/components/schemas/NumericRangeFilter"}],"description":"Outflow/FDV ratio range filter","examples":[{"min":0.01}]},"token_age_days":{"anyOf":[{"$ref":"#/components/schemas/IntegerRangeFilter"}],"description":"Token age range filter in days","examples":[{"max":365,"min":30}]}},"additionalProperties":false,"type":"object","title":"TokenScreenerHistoricalFilters","description":"Filters for the historical token screener endpoint.\n\nAll filters are forwarded as ClickHouse view parameters.\nWhen only_smart_money=True, sm_label_filter restricts results to specific SM label types."},"TokenScreenerRequest":{"properties":{"chains":{"items":{"$ref":"#/components/schemas/TokenScreenerChain"},"type":"array","maxItems":5,"minItems":1,"title":"Chains","description":"List of blockchain chains to filter by","examples":[["ethereum","solana","base"]]},"timeframe":{"anyOf":[{"$ref":"#/components/schemas/TokenScreenerTimeframe"}],"description":"**Required** (unless using deprecated 'date' parameter).\n\nTime window for token screening data.\n\nAvailable timeframes and their data characteristics:\n- 5m: Last 5 minutes (minute-level granularity, 2-hour retention)\n- 10m: Last 10 minutes (minute-level granularity, 2-hour retention)\n- 1h: Last 1 hour (minute-level granularity, 2-hour retention)\n- 6h: Last 6 hours (hourly granularity, 2-day retention)\n- 24h: Last 24 hours (hourly granularity, 2-day retention)\n- 7d: Last 7 days (daily granularity, 2-month retention)\n- 30d: Last 30 days (daily granularity, 2-month retention)\n\nCannot be used together with 'date'.","examples":["24h"]},"date":{"anyOf":[{"$ref":"#/components/schemas/DateRange"}],"description":"**DEPRECATED**: Use 'timeframe' instead for better reliability and performance.\n\nRequired only if 'timeframe' is not provided.\n\nCustom date range for the token screener. The granularity is automatically determined from the date range:\n- ≤ 1 hour: minute-level data (limited to last 2 hours)\n- > 1 hour to 1 day: hourly data (limited to last 2 days)\n- > 1 day: daily data (limited to last 2 months)\n\nCannot be used together with 'timeframe'.","deprecated":true,"examples":[{"from":"2025-01-01T00:00:00Z","to":"2025-01-31T23:59:59Z"}]},"pagination":{"$ref":"#/components/schemas/PaginationRequest","description":"Pagination parameters"},"filters":{"anyOf":[{"$ref":"#/components/schemas/TokenScreenerFilters"}],"description":"Additional filters to apply","examples":[{"only_smart_money":true,"token_age_days":{"max":365,"min":1}}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TokenScreenerSortField_"},"type":"array"}],"title":"Order By","description":"Custom sort order to override the endpoint's default ordering.\n\nExamples:\n- [{\"field\": \"buy_volume\", \"direction\": \"DESC\"}] - Sort by buy volume descending\n- [{\"field\": \"price_change\", \"direction\": \"DESC\"}] - Sort by price change descending"}},"additionalProperties":false,"type":"object","required":["chains"],"title":"TokenScreenerRequest","description":"Request model for Token Screener endpoint.\n\nEither 'timeframe' (recommended) or 'date' (deprecated) must be provided."},"TokenScreenerResponse":{"properties":{"data":{"items":{"anyOf":[{"$ref":"#/components/schemas/TokenScreenerDataDefault"},{"$ref":"#/components/schemas/TokenScreenerDataSmartMoneyDefault"},{"$ref":"#/components/schemas/TokenScreenerDataNonDefault"}]},"type":"array","title":"Data","description":"List of token screening results"},"pagination":{"$ref":"#/components/schemas/PaginationInfo","description":"Pagination information"}},"type":"object","required":["data","pagination"],"title":"TokenScreenerResponse","description":"Response model for token screener endpoint."},"TokenScreenerSortField":{"type":"string","enum":["chain","token_address","token_symbol","market_cap_usd","volume","liquidity","nof_traders","nof_buyers","nof_sellers","nof_buys","nof_sells","price_change","price_usd","netflow","buy_volume","sell_volume"],"title":"TokenScreenerSortField","description":"Enum for sortable fields in token screener."},"TokenScreenerTimeframe":{"type":"string","enum":["5m","10m","1h","6h","24h","7d","30d"],"title":"TokenScreenerTimeframe","description":"Token screener timeframe options.\n\nDefines the time window for token screening data.\nEach timeframe corresponds to different data granularity and retention periods.\nMatches the timeframe options in the Superapp token-screener widget."},"TokenSearchResult":{"properties":{"name":{"type":"string","title":"Name","description":"Token name"},"symbol":{"type":"string","title":"Symbol","description":"Token symbol (ticker)"},"chain":{"type":"string","title":"Chain","description":"Blockchain the token is deployed on"},"address":{"type":"string","title":"Address","description":"Contract address of the token"},"price":{"anyOf":[{"type":"number"}],"title":"Price","description":"Current price in USD (may be delayed)"},"volume_24h":{"anyOf":[{"type":"number"}],"title":"Volume 24H","description":"24-hour trading volume in USD"},"market_cap":{"anyOf":[{"type":"number"}],"title":"Market Cap","description":"Market capitalization in USD"},"rank":{"anyOf":[{"type":"integer"}],"title":"Rank","description":"Popularity/relevance rank (lower is better)"}},"type":"object","required":["name","symbol","chain","address"],"title":"TokenSearchResult","description":"A token result from general search."},"TokenSectorItem":{"properties":{"sector":{"type":"string","title":"Sector","description":"Token sector name (e.g., 'Artificial Intelligence', 'DeFi Lending (Money Markets)')"}},"type":"object","required":["sector"],"title":"TokenSectorItem","description":"Single token sector result."},"TokenSectorsResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TokenSectorItem"},"type":"array","title":"Data","description":"List of available token sectors (ordered alphabetically)"}},"type":"object","required":["data"],"title":"TokenSectorsResponse","description":"Response model for token sectors endpoint.\n\nReturns all available token sectors that can be used to filter tokens\nin the token-screener and other endpoints that support sector filtering.\nSectors with fewer than 50 tokens are excluded."},"TokenTransfer":{"properties":{"from_address":{"type":"string","title":"From Address","description":"From address"},"from_address_label":{"type":"string","title":"From Address Label","description":"From address label"},"to_address":{"type":"string","title":"To Address","description":"To address"},"to_address_label":{"type":"string","title":"To Address Label","description":"To address label"},"token_address":{"type":"string","title":"Token Address","description":"Token contract address"},"token_symbol":{"type":"string","title":"Token Symbol","description":"Token symbol"},"token_amount":{"type":"number","title":"Token Amount","description":"Token amount transferred"},"dated_price_usd":{"anyOf":[{"type":"number"}],"title":"Dated Price Usd","description":"Price of the token in USD at the time of the transaction"},"dated_value_usd":{"anyOf":[{"type":"number"}],"title":"Dated Value Usd","description":"USD value of the token transferred at the time of the transaction"},"current_price_usd":{"anyOf":[{"type":"number"}],"title":"Current Price Usd","description":"Current price of the token in USD"},"current_value_usd":{"anyOf":[{"type":"number"}],"title":"Current Value Usd","description":"Current USD value of the token transferred"},"transfer_id":{"type":"string","title":"Transfer Id","description":"Transfer ID"}},"type":"object","required":["from_address","from_address_label","to_address","to_address_label","token_address","token_symbol","token_amount","dated_price_usd","dated_value_usd","current_price_usd","current_value_usd","transfer_id"],"title":"TokenTransfer","description":"Model for token transfer information."},"TopHolder":{"properties":{"market_id":{"type":"string","title":"Market Id","description":"Market ID","examples":["654412"]},"outcome_index":{"anyOf":[{"type":"integer"}],"title":"Outcome Index","description":"Outcome index","examples":[1]},"address":{"anyOf":[{"type":"string"}],"title":"Address","description":"Holder address (hex)","examples":["0x1234567890abcdef1234567890abcdef12345678"]},"owner_address":{"anyOf":[{"type":"string"}],"title":"Owner Address","description":"SAFE proxy owner address (hex)","examples":["0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"]},"side":{"anyOf":[{"type":"string"}],"title":"Side","description":"Side held (Yes/No)","examples":["Yes"]},"position_size":{"anyOf":[{"type":"number"}],"title":"Position Size","description":"Token position size","examples":[15000.0]},"avg_entry_price":{"anyOf":[{"type":"number"}],"title":"Avg Entry Price","description":"Average entry price","examples":[0.45]},"current_price":{"anyOf":[{"type":"number"}],"title":"Current Price","description":"Current price","examples":[0.52]},"unrealized_pnl_usd":{"anyOf":[{"type":"number"}],"title":"Unrealized Pnl Usd","description":"Unrealized PnL in USD","examples":[1050.0]}},"type":"object","required":["market_id"],"title":"TopHolder","description":"Top holder data from ch_api_pm_top_holders."},"TopHolderSortField":{"type":"string","enum":["position_size","unrealized_pnl_usd","avg_entry_price"],"title":"TopHolderSortField","description":"Sortable fields for top holders endpoint."},"TopHoldersRequest":{"properties":{"market_id":{"type":"string","maxLength":100,"minLength":1,"title":"Market Id","description":"Polymarket market ID","examples":["654412"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TopHolderSortField_"},"type":"array"}],"title":"Order By","description":"Sort order","examples":[[{"direction":"DESC","field":"position_size"}]]},"sort":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TopHolderSortField_"},"type":"array"}],"title":"Sort","description":"Deprecated: use 'order_by' instead."}},"additionalProperties":false,"type":"object","required":["market_id"],"title":"TopHoldersRequest","description":"Request for top holders endpoint."},"TopHoldersResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/TopHolder"},"type":"array","title":"Data","description":"List of top holder records"}},"type":"object","required":["data"],"title":"TopHoldersResponse","description":"Response for top holders endpoint."},"TradeByAddress":{"properties":{"timestamp":{"anyOf":[{"type":"string","format":"date-time"}],"title":"Timestamp","description":"Trade timestamp (ISO format)","examples":["2024-11-01T12:30:00"]},"seller":{"anyOf":[{"type":"string"}],"title":"Seller","description":"Seller address (hex)","examples":["0x1234567890abcdef1234567890abcdef12345678"]},"buyer":{"anyOf":[{"type":"string"}],"title":"Buyer","description":"Buyer address (hex)","examples":["0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"]},"taker_action":{"anyOf":[{"type":"string"}],"title":"Taker Action","description":"Taker action (buy/sell)","examples":["buy"]},"side":{"anyOf":[{"type":"string"}],"title":"Side","description":"Outcome side (Yes/No)","examples":["Yes"]},"outcome_index":{"anyOf":[{"type":"integer"}],"title":"Outcome Index","description":"Outcome index","examples":[1]},"size":{"anyOf":[{"type":"number"}],"title":"Size","description":"Trade size in tokens","examples":[1000.0]},"price":{"anyOf":[{"type":"number"}],"title":"Price","description":"Price per share (0-1)","examples":[0.52]},"usdc_value":{"anyOf":[{"type":"number"}],"title":"Usdc Value","description":"Trade value in USDC","examples":[520.0]},"tx_hash":{"anyOf":[{"type":"string"}],"title":"Tx Hash","description":"Transaction hash (hex)","examples":["0xabc123def456"]},"market_id":{"anyOf":[{"type":"string"}],"title":"Market Id","description":"Market ID"},"market_question":{"anyOf":[{"type":"string"}],"title":"Market Question","description":"Market question"},"event_id":{"anyOf":[{"type":"string"}],"title":"Event Id","description":"Parent event ID"},"event_title":{"anyOf":[{"type":"string"}],"title":"Event Title","description":"Parent event title"}},"type":"object","title":"TradeByAddress","description":"Trade data from ch_api_pm_trades_by_address."},"TradeByMarket":{"properties":{"timestamp":{"anyOf":[{"type":"string","format":"date-time"}],"title":"Timestamp","description":"Trade timestamp (ISO format)","examples":["2024-11-01T12:30:00"]},"seller":{"anyOf":[{"type":"string"}],"title":"Seller","description":"Seller address (hex)","examples":["0x1234567890abcdef1234567890abcdef12345678"]},"buyer":{"anyOf":[{"type":"string"}],"title":"Buyer","description":"Buyer address (hex)","examples":["0xabcdefabcdefabcdefabcdefabcdefabcdefabcd"]},"taker_action":{"anyOf":[{"type":"string"}],"title":"Taker Action","description":"Taker action (buy/sell)","examples":["buy"]},"side":{"anyOf":[{"type":"string"}],"title":"Side","description":"Outcome side (Yes/No)","examples":["Yes"]},"outcome_index":{"anyOf":[{"type":"integer"}],"title":"Outcome Index","description":"Outcome index","examples":[1]},"size":{"anyOf":[{"type":"number"}],"title":"Size","description":"Trade size in tokens","examples":[1000.0]},"price":{"anyOf":[{"type":"number"}],"title":"Price","description":"Price per share (0-1)","examples":[0.52]},"usdc_value":{"anyOf":[{"type":"number"}],"title":"Usdc Value","description":"Trade value in USDC","examples":[520.0]},"tx_hash":{"anyOf":[{"type":"string"}],"title":"Tx Hash","description":"Transaction hash (hex)","examples":["0xabc123def456"]},"market_id":{"type":"string","title":"Market Id","description":"Market ID","examples":["654412"]}},"type":"object","required":["market_id"],"title":"TradeByMarket","description":"Trade data from ch_api_pm_trades_by_market."},"TradeType":{"type":"string","enum":["Market","Limit"],"title":"TradeType","description":"Enum for trade types."},"TraderType":{"type":"string","enum":["all","sm","whale","public_figure"],"title":"TraderType","description":"Trader type filter for token screener."},"TradesByAddressRequest":{"properties":{"address":{"type":"string","maxLength":100,"minLength":1,"title":"Address","description":"Wallet address (hex, with or without 0x prefix)","examples":["0x1234567890abcdef1234567890abcdef12345678"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"},"date":{"anyOf":[{"$ref":"#/components/schemas/DateRange"}],"description":"Date range filter (ISO 8601 date-time)","examples":[{"from":"2024-01-01T00:00:00Z","to":"2024-12-31T23:59:59Z"}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TradesByAddressSortField_"},"type":"array"}],"title":"Order By","description":"Sort order","examples":[[{"direction":"DESC","field":"timestamp"}]]}},"additionalProperties":false,"type":"object","required":["address"],"title":"TradesByAddressRequest","description":"Request for trades by address endpoint."},"TradesByAddressResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/TradeByAddress"},"type":"array","title":"Data","description":"List of trade records"}},"type":"object","required":["data"],"title":"TradesByAddressResponse","description":"Response for trades by address endpoint."},"TradesByAddressSortField":{"type":"string","enum":["timestamp"],"title":"TradesByAddressSortField","description":"Sortable fields for trades by address endpoint."},"TradesByMarketRequest":{"properties":{"market_id":{"type":"string","maxLength":100,"minLength":1,"title":"Market Id","description":"Polymarket market ID","examples":["654412"]},"pagination":{"$ref":"#/components/schemas/PaginationRequest"},"date":{"anyOf":[{"$ref":"#/components/schemas/DateRange"}],"description":"Date range filter (ISO 8601 date-time)","examples":[{"from":"2024-01-01T00:00:00Z","to":"2024-12-31T23:59:59Z"}]},"order_by":{"anyOf":[{"items":{"$ref":"#/components/schemas/SortOrder_TradesByMarketSortField_"},"type":"array"}],"title":"Order By","description":"Sort order","examples":[[{"direction":"DESC","field":"timestamp"}]]}},"additionalProperties":false,"type":"object","required":["market_id"],"title":"TradesByMarketRequest","description":"Request for trades by market endpoint."},"TradesByMarketResponse":{"properties":{"pagination":{"$ref":"#/components/schemas/PaginationInfo"},"data":{"items":{"$ref":"#/components/schemas/TradeByMarket"},"type":"array","title":"Data","description":"List of trade records"}},"type":"object","required":["data"],"title":"TradesByMarketResponse","description":"Response for trades by market endpoint."},"TradesByMarketSortField":{"type":"string","enum":["timestamp"],"title":"TradesByMarketSortField","description":"Sortable fields for trades by market endpoint."},"TransactionLookupChain":{"type":"string","enum":["arbitrum","avalanche","base","bitcoin","bnb","ethereum","hyperevm","injective","iotaevm","linea","mantle","monad","near","optimism","plasma","ronin","scroll","sei","sonic","starknet","sui","ton","tron"],"title":"TransactionLookupChain","description":"Blockchain chain for the transaction lookup."},"TransactionLookupListResponse":{"properties":{"data":{"items":{"$ref":"#/components/schemas/TransactionLookupResponse"},"type":"array","title":"Data","description":"List of transaction lookup results"}},"type":"object","required":["data"],"title":"TransactionLookupListResponse","description":"Response model for transaction lookup endpoint returning a list of transactions."},"TransactionLookupRequest":{"properties":{"chain":{"$ref":"#/components/schemas/TransactionLookupChain","description":"Blockchain chain for the transaction lookup","examples":["ethereum","base"]},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"Transaction hash to lookup","examples":["0xf16f93cb53f4f977d45b1b08af7b66e1939d0fe69d669012458239b23797e492"]},"block_timestamp":{"type":"string","title":"Block Timestamp","description":"Timestamp of the transaction","examples":["2025-08-06 01:47:11"]}},"additionalProperties":false,"type":"object","required":["chain","transaction_hash","block_timestamp"],"title":"TransactionLookupRequest","description":""},"TransactionLookupResponse":{"properties":{"chain":{"type":"string","title":"Chain","description":"The blockchain network of the transaction"},"transaction_hash":{"type":"string","title":"Transaction Hash","description":"The unique identifier of the transaction"},"from_address":{"type":"string","title":"From Address","description":"The hexadecimal address of the sender"},"from_address_label":{"anyOf":[{"type":"string"}],"title":"From Address Label","description":"The name or label associated with the sender's address"},"to_address":{"type":"string","title":"To Address","description":"The hexadecimal address of the recipient"},"to_address_label":{"anyOf":[{"type":"string"}],"title":"To Address Label","description":"The name or label associated with the recipient's address"},"native_value":{"anyOf":[{"type":"number"}],"title":"Native Value","description":"The amount of native cryptocurrency transferred"},"dated_native_price":{"anyOf":[{"type":"number"}],"title":"Dated Native Price","description":"The price of the native cryptocurrency at the time of the transaction"},"dated_native_value_usd":{"anyOf":[{"type":"number"}],"title":"Dated Native Value Usd","description":"The USD value of the native cryptocurrency transferred at the time of the transaction"},"current_native_price":{"anyOf":[{"type":"number"}],"title":"Current Native Price","description":"The current price of the native cryptocurrency"},"current_native_value_usd":{"anyOf":[{"type":"number"}],"title":"Current Native Value Usd","description":"The current USD value of the native cryptocurrency transferred"},"receipt_status":{"anyOf":[{"type":"integer"}],"title":"Receipt Status","description":"The status of the transaction receipt (1 for success, 0 for failure)"},"block_timestamp":{"type":"string","title":"Block Timestamp","description":"The timestamp of the block in which the transaction was included"},"token_transfer_array":{"anyOf":[{"items":{"$ref":"#/components/schemas/TokenTransfer"},"type":"array"}],"title":"Token Transfer Array","description":"Information about any token transfers associated with this transaction"},"nft_transfer_array":{"anyOf":[{"items":{"$ref":"#/components/schemas/NFTTransfer"},"type":"array"}],"title":"Nft Transfer Array","description":"Information about any NFT transfers associated with this transaction"}},"type":"object","required":["chain","transaction_hash","from_address","from_address_label","to_address","to_address_label","native_value","dated_native_price","dated_native_value_usd","current_native_price","current_native_value_usd","receipt_status","block_timestamp","token_transfer_array","nft_transfer_array"],"title":"TransactionLookupResponse","description":"Response model for transaction lookup endpoint.\n\nContains comprehensive transaction information including token transfers and NFT transfers."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"responses":{"BadRequestError":{"description":"Bad Request - Invalid request parameters or malformed request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","examples":["Invalid request parameters"]}}}}}},"UnauthorizedError":{"description":"Authentication error - No API key found in request","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","examples":["No API key found in request"]}}}}}},"PaymentRequiredError":{"description":"Payment Required - This endpoint supports pay-per-request via the x402 protocol. The `Payment-Required` response header contains a base64-encoded JSON object describing accepted payment options (scheme, network, asset, amount, recipient). To pay, include a `Payment-Signature` header with a base64-encoded signed payment payload. See https://www.x402.org for protocol details.","headers":{"Payment-Required":{"description":"Base64-encoded JSON describing accepted payment options","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"object","description":"Empty object. Payment details are in the Payment-Required header."}}}},"ForbiddenError":{"description":"Forbidden - User does not have required subscription tier or has exceeded credit limit","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","examples":["Pro subscription required to access this endpoint"]}}}}}},"NotFoundError":{"description":"Not Found - The requested resource was not found","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","examples":["Resource not found"]}}}}}},"TooManyRequestsError":{"description":"Too Many Requests - Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","examples":["Rate limit exceeded. Please try again later."]},"retry_after":{"type":"integer","description":"Seconds to wait before retrying","examples":[60]}}}}},"headers":{"Retry-After":{"$ref":"#/components/headers/RetryAfter"}}},"InternalServerError":{"description":"Internal Server Error - An unexpected error occurred","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","examples":["Internal server error"]}}}}}},"BadGatewayError":{"description":"Bad Gateway - Upstream service unavailable","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"string","examples":["Service temporarily unavailable"]}}}}}},"ValidationError":{"description":"Validation error - Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"detail":{"type":"array","items":{"type":"object","properties":{"loc":{"type":"array","items":{"type":"string"}},"msg":{"type":"string"},"type":{"type":"string"}}}}}}}}}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"apiKey","description":"API key for authentication"}},"headers":{"XNansenCreditsUsed":{"description":"Number of credits consumed by this API request","schema":{"type":"string","examples":["5"]}},"XNansenCreditsRemaining":{"description":"Total credits remaining in the user's account after this request","schema":{"type":"string","examples":["9995"]}},"RateLimitLimit":{"description":"Combined rate limit across all configured time windows","schema":{"type":"string","examples":["20"]}},"RateLimitRemaining":{"description":"Number of requests remaining in the current limiting window","schema":{"type":"string","examples":["15"]}},"RateLimitReset":{"description":"Time in seconds until the rate limit window resets","schema":{"type":"string","examples":["30"]}},"XRateLimitLimitSecond":{"description":"Maximum requests allowed per second","schema":{"type":"string","examples":["20"]}},"XRateLimitRemainingSecond":{"description":"Requests remaining in the current second","schema":{"type":"string","examples":["19"]}},"XRateLimitLimitMinute":{"description":"Maximum requests allowed per minute","schema":{"type":"string","examples":["300"]}},"XRateLimitRemainingMinute":{"description":"Requests remaining in the current minute","schema":{"type":"string","examples":["295"]}},"RetryAfter":{"description":"Number of seconds to wait before making a new request","schema":{"type":"string","examples":["60"]}}}},"servers":[{"url":"https://api.nansen.ai"}],"security":[{"ApiKeyAuth":[]}]}