{ "openapi": "3.1.0", "info": { "title": "MarketSignal AI", "description": "Real-time market intelligence, news intelligence, trading signals and SEC EDGAR-derived stock fundamentals for AI agents. Analyze crypto and US stocks using trade-derived momentum, buying pressure, selling pressure, activity, trade flow, anomalies, market regime, market events, publisher-attributed market news and historical signal backtesting.", "version": "1.3.0" }, "servers": [ { "url": "https://api.marketintelligenceapi.com" } ], "x-discovery": { "ownershipProofs": [ "0x48d5A78d480B4C32dE319C2aEF69e682Dc304615" ] }, "components": { "securitySchemes": { "x402": { "type": "apiKey", "in": "header", "name": "X-PAYMENT" } }, "schemas": { "MarketIntelligenceDocument": { "type": "object", "description": "Derived real-time market intelligence document built from trade activity and rolling baselines.", "properties": { "id": { "type": "string", "description": "Stable MongoDB document identifier." }, "symbol": { "type": "string", "description": "Normalized crypto or US equity symbol, e.g. BTCUSD or AAPL." }, "window": { "type": "string", "description": "Analysis window.", "enum": [ "1m", "5m", "15m" ] }, "price": { "type": "number", "description": "Latest observed trade price." }, "volume": { "type": "number", "description": "Total traded volume in the analysis window." }, "buyVolume": { "type": "number", "description": "Volume classified as buy-side trade flow." }, "sellVolume": { "type": "number", "description": "Volume classified as sell-side trade flow." }, "buyPressure": { "type": "number", "description": "Buy pressure percentage, from 0 to 100." }, "buySellRatio": { "type": "number", "description": "Ratio of buy volume to sell volume." }, "buySellImbalance": { "type": "number", "description": "Buy-side minus sell-side imbalance as a percentage of total volume." }, "priceChangePercent": { "type": "number", "description": "Price change percentage over the analysis window." }, "volumeAcceleration": { "type": "number", "description": "Current volume relative to the previous comparable window." }, "tradeAcceleration": { "type": "number", "description": "Current trade count relative to the previous comparable window." }, "momentumScore": { "type": "number", "description": "Derived momentum score." }, "activityScore": { "type": "number", "description": "Derived relative trading activity score." }, "anomalyScore": { "type": "number", "description": "Derived anomaly score based on baseline deviations and activity/volume multiples." }, "confidenceScore": { "type": "number", "description": "Confidence score derived from trade count and historical baseline samples." }, "averageTradeSize": { "type": "number", "description": "Average traded volume per trade." }, "tradeRatePerMinute": { "type": "number", "description": "Trade count per minute." }, "volumeRatePerMinute": { "type": "number", "description": "Volume traded per minute." }, "priceChangePerMinute": { "type": "number", "description": "Price change percentage per minute." }, "tradeCount": { "type": "integer", "description": "Number of trades in the analysis window." }, "largeTradeCount": { "type": "integer", "description": "Number of detected large trades." }, "largeBuyVolume": { "type": "number", "description": "Volume attributed to large buy-side trades." }, "largeSellVolume": { "type": "number", "description": "Volume attributed to large sell-side trades." }, "maxTradeSize": { "type": "number", "description": "Largest individual trade size." }, "maxTradeNotional": { "type": "number", "description": "Largest individual trade notional value." }, "dominantSide": { "type": "string", "description": "Dominant trade-flow side.", "enum": [ "BUY", "SELL", "BALANCED" ] }, "signal": { "type": "string", "description": "Derived market signal." }, "signalStrength": { "type": "string", "description": "Signal strength.", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "timestamp": { "type": "string", "description": "Timestamp of the intelligence observation.", "format": "date-time" }, "previousSignal": { "type": "string", "description": "Previous signal when available." }, "signalChangedAt": { "type": "string", "description": "Timestamp when the current signal began.", "format": "date-time" }, "signalAgeSeconds": { "type": "integer", "description": "Age of the current signal in seconds." }, "activityMultiple": { "type": "number", "description": "Trading activity multiple relative to baseline." }, "volumeMultiple": { "type": "number", "description": "Volume multiple relative to baseline." }, "activityZScore": { "type": "number", "description": "Trading activity deviation from baseline in standard deviations." }, "volumeZScore": { "type": "number", "description": "Volume deviation from baseline in standard deviations." }, "baselineSamples": { "type": "integer", "description": "Number of historical baseline samples." }, "baselineReady": { "type": "boolean", "description": "Whether the historical baseline has reached the minimum sample threshold." }, "marketPercentile": { "type": "number", "description": "Percentile rank of activity among covered symbols." }, "relativeMomentumPercentile": { "type": "number", "description": "Percentile rank of momentum among covered symbols." }, "relativeBuyPressurePercentile": { "type": "number", "description": "Percentile rank of buy pressure among covered symbols." }, "eventType": { "type": "string", "description": "Derived market event type." }, "lifecycleState": { "type": "string", "description": "Signal lifecycle state.", "enum": [ "NEW_SIGNAL", "PERSISTING" ] }, "observations": { "type": "object", "description": "Machine-readable observed market measurements.", "additionalProperties": true }, "interpretation": { "type": "object", "description": "Machine-readable interpretation of momentum, activity, buying and relative strength.", "additionalProperties": true }, "evidence": { "type": "array", "description": "Human-readable evidence supporting the derived signal.", "items": { "type": "string" } } } }, "CompactMarketIntelligence": { "type": "object", "description": "Compact market intelligence representation used inside summary, comparison and regime responses.", "properties": { "symbol": { "type": "string", "description": "Normalized crypto or US equity symbol, e.g. BTCUSD or AAPL." }, "window": { "type": "string", "description": "Analysis window.", "enum": [ "1m", "5m", "15m" ] }, "price": { "type": "number", "description": "Latest observed trade price." }, "volume": { "type": "number", "description": "Total traded volume in the analysis window." }, "buyPressure": { "type": "number", "description": "Buy pressure percentage, from 0 to 100." }, "buySellImbalance": { "type": "number", "description": "Buy-side minus sell-side imbalance as a percentage of total volume." }, "priceChangePercent": { "type": "number", "description": "Price change percentage over the analysis window." }, "volumeAcceleration": { "type": "number", "description": "Current volume relative to the previous comparable window." }, "tradeAcceleration": { "type": "number", "description": "Current trade count relative to the previous comparable window." }, "momentumScore": { "type": "number", "description": "Derived momentum score." }, "activityScore": { "type": "number", "description": "Derived relative trading activity score." }, "anomalyScore": { "type": "number", "description": "Derived anomaly score based on baseline deviations and activity/volume multiples." }, "confidenceScore": { "type": "number", "description": "Confidence score derived from trade count and historical baseline samples." }, "tradeCount": { "type": "integer", "description": "Number of trades in the analysis window." }, "largeTradeCount": { "type": "integer", "description": "Number of detected large trades." }, "largeBuyVolume": { "type": "number", "description": "Volume attributed to large buy-side trades." }, "largeSellVolume": { "type": "number", "description": "Volume attributed to large sell-side trades." }, "maxTradeSize": { "type": "number", "description": "Largest individual trade size." }, "maxTradeNotional": { "type": "number", "description": "Largest individual trade notional value." }, "dominantSide": { "type": "string", "description": "Dominant trade-flow side.", "enum": [ "BUY", "SELL", "BALANCED" ] }, "signal": { "type": "string", "description": "Derived market signal." }, "signalStrength": { "type": "string", "description": "Signal strength.", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "previousSignal": { "type": "string", "description": "Previous signal when available." }, "signalChangedAt": { "type": "string", "description": "Timestamp when the current signal began.", "format": "date-time" }, "signalAgeSeconds": { "type": "integer", "description": "Age of the current signal in seconds." }, "activityMultiple": { "type": "number", "description": "Trading activity multiple relative to baseline." }, "volumeMultiple": { "type": "number", "description": "Volume multiple relative to baseline." }, "activityZScore": { "type": "number", "description": "Trading activity deviation from baseline in standard deviations." }, "volumeZScore": { "type": "number", "description": "Volume deviation from baseline in standard deviations." }, "baselineSamples": { "type": "integer", "description": "Number of historical baseline samples." }, "baselineReady": { "type": "boolean", "description": "Whether the historical baseline has reached the minimum sample threshold." }, "marketPercentile": { "type": "number", "description": "Percentile rank of activity among covered symbols." }, "relativeMomentumPercentile": { "type": "number", "description": "Percentile rank of momentum among covered symbols." }, "relativeBuyPressurePercentile": { "type": "number", "description": "Percentile rank of buy pressure among covered symbols." }, "eventType": { "type": "string", "description": "Derived market event type." }, "lifecycleState": { "type": "string", "description": "Signal lifecycle state.", "enum": [ "NEW_SIGNAL", "PERSISTING" ] }, "observations": { "type": "object", "description": "Machine-readable observed market measurements.", "additionalProperties": true }, "interpretation": { "type": "object", "description": "Machine-readable interpretation of momentum, activity, buying and relative strength.", "additionalProperties": true }, "evidence": { "type": "array", "description": "Human-readable evidence supporting the derived signal.", "items": { "type": "string" } } } }, "DataFreshness": { "type": "object", "properties": { "freshestMs": { "type": "integer", "description": "Age in milliseconds of the freshest covered symbol." }, "oldestMs": { "type": "integer", "description": "Age in milliseconds of the oldest covered symbol." } } }, "MarketSummary": { "type": "object", "description": "Aggregated market summary generated from the current intelligence documents.", "properties": { "window": { "type": "string", "description": "Normalized analysis window.", "enum": [ "1m", "5m", "15m" ] }, "symbolsCovered": { "type": "integer", "description": "Number of symbols covered." }, "bullishSymbols": { "type": "integer", "description": "Number of symbols with bullish signals." }, "bearishSymbols": { "type": "integer", "description": "Number of symbols with bearish signals." }, "neutralSymbols": { "type": "integer", "description": "Number of symbols that are neither bullish nor bearish." }, "bullishBreadthPercent": { "type": "number", "description": "Percentage of symbols with bullish signals." }, "bearishBreadthPercent": { "type": "number", "description": "Percentage of symbols with bearish signals." }, "averageBuyPressure": { "type": "number", "description": "Average buy pressure across covered symbols." }, "averagePriceChangePercent": { "type": "number", "description": "Average price change percentage across covered symbols." }, "unusualActivitySymbols": { "type": "integer", "description": "Number of symbols with anomaly score at least 70." }, "regime": { "type": "string", "description": "Current aggregated market regime." }, "topMomentum": { "type": "array", "items": { "$ref": "#/components/schemas/CompactMarketIntelligence" } }, "topActivity": { "type": "array", "items": { "$ref": "#/components/schemas/CompactMarketIntelligence" } }, "topBuying": { "type": "array", "items": { "$ref": "#/components/schemas/CompactMarketIntelligence" } }, "topSelling": { "type": "array", "items": { "$ref": "#/components/schemas/CompactMarketIntelligence" } }, "events": { "type": "array", "items": { "$ref": "#/components/schemas/CompactMarketIntelligence" } }, "dataFreshness": { "$ref": "#/components/schemas/DataFreshness" }, "staleSymbols": { "type": "integer", "description": "Number of symbols considered stale." }, "source": { "type": "string", "description": "Trade data source identifier." }, "timestamp": { "type": "string", "description": "Response generation timestamp.", "format": "date-time" } } }, "MarketRegime": { "type": "object", "properties": { "window": { "type": "string", "description": "Normalized analysis window.", "enum": [ "1m", "5m", "15m" ] }, "regime": { "type": "string", "description": "Aggregated regime: BULLISH, BEARISH, MIXED, or NO_DATA." }, "symbolsCovered": { "type": "integer", "description": "Number of symbols covered." }, "bullishBreadthPercent": { "type": "number", "description": "Percentage of symbols satisfying the bullish context." }, "bearishBreadthPercent": { "type": "number", "description": "Percentage of symbols satisfying the bearish context." }, "averageBuyPressure": { "type": "number", "description": "Average buy pressure." }, "averagePriceChangePercent": { "type": "number", "description": "Average price change percentage." }, "averageMomentumScore": { "type": "number", "description": "Average momentum score." }, "highConfidenceSignals": { "type": "integer", "description": "Count of signals with confidence score at least 75." }, "unusualActivity": { "type": "integer", "description": "Count of symbols with anomaly score at least 70." }, "topLeaders": { "type": "array", "items": { "$ref": "#/components/schemas/CompactMarketIntelligence" } }, "topActivityConcentration": { "type": "array", "items": { "$ref": "#/components/schemas/CompactMarketIntelligence" } }, "timestamp": { "type": "string", "description": "Response generation timestamp.", "format": "date-time" } } }, "BacktestEventStats": { "type": "object", "properties": { "occurrences": { "type": "integer", "description": "Number of signal occurrences." }, "averageConfidence": { "type": "number", "description": "Average signal confidence." }, "winRate5m": { "type": "number", "description": "Win rate at the 5-minute horizon." }, "winRate15m": { "type": "number", "description": "Win rate at the 15-minute horizon." }, "winRate60m": { "type": "number", "description": "Win rate at the 60-minute horizon." }, "averageReturn5mPercent": { "type": "number", "description": "Average forward return at 5 minutes." }, "averageReturn15mPercent": { "type": "number", "description": "Average forward return at 15 minutes." }, "averageReturn60mPercent": { "type": "number", "description": "Average forward return at 60 minutes." }, "medianReturn15mPercent": { "type": "number", "description": "Median forward return at 15 minutes." }, "averageMfe15mPercent": { "type": "number", "description": "Average maximum favorable excursion over 15 minutes." }, "averageMae15mPercent": { "type": "number", "description": "Average maximum adverse excursion over 15 minutes." }, "direction": { "type": "string", "description": "Event direction." } } }, "BacktestReturnStats": { "type": "object", "properties": { "samples": { "type": "integer", "description": "Number of return observations." }, "averagePercent": { "type": "number", "description": "Average forward return percentage." }, "medianPercent": { "type": "number", "description": "Median forward return percentage." }, "positiveRate": { "type": "number", "description": "Percentage of positive returns." } } }, "BacktestResults": { "type": "object", "properties": { "start": { "type": "string", "description": "Backtest start timestamp.", "format": "date-time" }, "end": { "type": "string", "description": "Backtest end timestamp.", "format": "date-time" }, "window": { "type": "string", "description": "Analysis window.", "enum": [ "1m", "5m", "15m" ] }, "symbolsAnalyzed": { "type": "integer", "description": "Number of symbols analyzed." }, "signalsEvaluated": { "type": "integer", "description": "Number of qualifying signals evaluated." }, "minConfidence": { "type": "integer", "description": "Minimum confidence threshold." }, "minBaselineSamples": { "type": "integer", "description": "Minimum historical baseline samples." }, "methodology": { "type": "string", "description": "Walk-forward methodology description." }, "dataResolution": { "type": "string", "description": "Resolution of the historical source data." }, "effectiveWindow": { "type": "string", "description": "Effective aggregation window in seconds." }, "signals": { "type": "object", "description": "Statistics grouped by signal event type.", "additionalProperties": { "$ref": "#/components/schemas/BacktestEventStats" } }, "confidenceCalibration": { "type": "object", "description": "Signal statistics grouped into confidence buckets.", "additionalProperties": { "$ref": "#/components/schemas/BacktestEventStats" } }, "allSignalsForwardReturns": { "type": "object", "properties": { "1m": { "$ref": "#/components/schemas/BacktestReturnStats" }, "5m": { "$ref": "#/components/schemas/BacktestReturnStats" }, "15m": { "$ref": "#/components/schemas/BacktestReturnStats" }, "60m": { "$ref": "#/components/schemas/BacktestReturnStats" } } } } }, "SecMetric": { "type": "object", "description": "SEC EDGAR-derived financial metric. Exact fields depend on the available SEC XBRL fact.", "additionalProperties": true }, "LatestFiling": { "type": "object", "properties": { "form": { "type": "string", "description": "SEC filing form, such as 10-K, 10-Q or 8-K." }, "filingDate": { "type": "string", "description": "SEC filing date." }, "accessionNumber": { "type": "string", "description": "SEC accession number." }, "primaryDocument": { "type": "string", "description": "Primary filing document name." } }, "additionalProperties": true }, "SecFundamentalIntelligence": { "type": "object", "properties": { "symbol": { "type": "string", "description": "Normalized US equity ticker." }, "cik": { "type": "string", "description": "SEC Central Index Key." }, "companyName": { "type": "string", "description": "Company name from SEC submissions." }, "source": { "type": "string", "description": "Data source identifier." }, "sourceUrl": { "type": "string", "description": "SEC data source URL.", "format": "uri" }, "asOf": { "type": "string", "description": "Time at which the response was generated.", "format": "date-time" }, "latestFiling": { "$ref": "#/components/schemas/LatestFiling" }, "financials": { "type": "object", "description": "Latest available SEC/XBRL financial metrics.", "additionalProperties": { "$ref": "#/components/schemas/SecMetric" } }, "derivedIntelligence": { "type": "object", "properties": { "revenueGrowthYoYPercent": { "type": "number", "description": "Year-over-year revenue growth percentage." }, "earningsGrowthYoYPercent": { "type": "number", "description": "Year-over-year net income growth percentage." }, "operatingMarginPercent": { "type": "number", "description": "Operating margin percentage." }, "netMarginPercent": { "type": "number", "description": "Net margin percentage." }, "returnOnAssetsPercent": { "type": "number", "description": "Return on assets percentage." }, "debtToEquity": { "type": "number", "description": "Debt-to-equity ratio." }, "cashToDebt": { "type": "number", "description": "Cash-to-debt ratio." }, "fundamentalSignal": { "type": "string", "description": "Deterministic fundamental signal." }, "signalScore": { "type": "number", "description": "Deterministic fundamental signal score." }, "confidence": { "type": "number", "description": "Fundamental signal confidence." }, "interpretation": { "type": "string", "description": "Human-readable interpretation of the fundamental signal." } }, "additionalProperties": true }, "methodology": { "type": "array", "items": { "type": "string" } } } }, "MarketNewsDocument": { "type": "object", "description": "A publisher-attributed crypto or US stock news headline, or a corporate filing event. Full article content is not redistributed; items carry an attribution notice where the metadata provider requires one.", "required": [ "source", "category", "title", "url", "publishedAt", "sentiment", "sentimentScore" ], "properties": { "id": { "type": "string", "description": "Stable deduplication identifier." }, "source": { "type": "string", "description": "Publisher hostname from the article URL." }, "category": { "type": "string", "enum": [ "crypto", "stocks", "filings" ], "description": "News category; filings are material corporate events (Form 8-K)." }, "title": { "type": "string", "description": "Publisher headline." }, "summary": { "type": "string", "description": "Short summary if available, e.g. the reported filing items." }, "provider": { "type": "string", "description": "Collection channel of the item." }, "attribution": { "type": "string", "description": "Citation to display when redistributing the item, if required by its metadata provider." }, "url": { "type": "string", "format": "uri", "description": "Canonical publisher article URL." }, "publishedAt": { "type": "string", "format": "date-time", "description": "Publisher publication timestamp when supplied by the feed." }, "fetchedAt": { "type": "string", "format": "date-time", "description": "Timestamp when this service ingested the feed item." }, "symbols": { "type": "array", "items": { "type": "string" }, "description": "Ticker-like symbols extracted from the headline and summary." }, "keywords": { "type": "array", "items": { "type": "string" }, "description": "Matched market-sentiment keywords." }, "sentiment": { "type": "string", "enum": [ "positive", "negative", "neutral" ], "description": "Lightweight keyword-based headline sentiment; not investment advice." }, "sentimentScore": { "type": "integer", "description": "Signed lightweight headline-sentiment score." } } }, "CompareResult": { "$ref": "#/components/schemas/CompactMarketIntelligence" }, "ErrorResponse": { "type": "object", "description": "Error response.", "additionalProperties": true } } }, "paths": { "/api/v1/news": { "get": { "operationId": "getCryptoStockMarketNews", "summary": "Crypto and US stock market news", "description": "Recent publisher-attributed market news for crypto and US stocks. Search current market headlines by category, ticker, company or keyword. Results include source attribution, article URL, publication time, extracted symbols and lightweight headline sentiment.", "tags": [ "Market News", "Crypto News", "Stock News" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "category", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "crypto", "stocks" ] }, "description": "Optional market category." }, { "name": "query", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Optional keyword, company name or ticker search." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "description": "Maximum news items to return." } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.003", "currency": "USD" }, "responses": { "200": { "description": "Market-news results", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketNewsDocument" } } } } }, "402": { "description": "Payment Required" } } } }, "/api/v1/news/symbol": { "get": { "operationId": "getSymbolMarketNews", "summary": "Ticker-specific crypto and stock news", "description": "Recent publisher-attributed market-news headlines for one crypto or US stock ticker. Use this endpoint for company news, stock news, crypto asset news, symbol-specific headlines and news sentiment.", "tags": [ "Market News", "Symbol News" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "NVDA" }, "description": "Ticker or crypto symbol, for example NVDA, BTC or ETH." }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 }, "description": "Maximum news items to return." } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.003", "currency": "USD" }, "responses": { "200": { "description": "Ticker-specific market-news results", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketNewsDocument" } } } } }, "402": { "description": "Payment Required" } } } }, "/api/v1/intelligence": { "get": { "summary": "Market signals, trade flow and signal strength", "description": "Real-time market signals, trade flow and signal strength for crypto and US stocks. Use this endpoint for market signals, market intelligence, trade flow, buying pressure, selling pressure, signal strength, momentum, trading activity, acceleration, anomalies, and complete market snapshots.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Market intelligence response", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketIntelligenceDocument" } } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "getMarketIntelligence" } }, "/api/v1/intelligence/{symbol}": { "get": { "summary": "Symbol market intelligence", "description": "Real-time market intelligence for a specific crypto or US stock symbol. Analyze price movement, momentum, buying pressure, selling pressure, trade flow, trading activity, signal strength, and unusual market activity. Also returns on-chain liquidity (cost of a $1k/$10k/$50k market order, liquidity score), sources[] and as_of.", "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Symbol intelligence response", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/MarketIntelligenceDocument" }, { "type": "object", "properties": { "liquidity": { "type": "object", "description": "On-chain liquidity: cost of a market order as one swap in the best pool, fee included (Uniswap v3/v4 pool math from swap events). Sizes whose price move would exceed 1% are null with a reason.", "properties": { "method": { "type": "string" }, "as_of": { "type": [ "string", "null" ], "format": "date-time" }, "liquidity_score": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100, "description": "100*exp(-bps/50) of the average $10k buy/sell cost" }, "slippage_bps": { "type": [ "object", "null" ], "properties": { "buy": { "type": "object", "additionalProperties": { "type": [ "number", "null" ] } }, "sell": { "type": "object", "additionalProperties": { "type": [ "number", "null" ] } } }, "description": "Keys are USD sizes: 1000, 10000, 50000" }, "estimates": { "type": "array", "items": { "type": "object" } }, "pools": { "type": "array", "items": { "type": "object" } } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "status": { "type": "string" }, "as_of": { "type": [ "string", "null" ], "format": "date-time" } } } }, "as_of": { "type": [ "string", "null" ], "format": "date-time" } } } ] } } } }, "402": { "description": "Payment Required" }, "404": { "description": "No recent data for this symbol (not charged). The body lists the covered symbols.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "no_data" }, "message": { "type": "string" }, "symbol": { "type": "string" }, "coveredSymbols": { "type": "array", "items": { "type": "string" } }, "charged": { "type": "boolean", "example": false } } } } } } }, "tags": [ "Market Intelligence" ], "operationId": "getSymbolMarketIntelligence" } }, "/api/v1/intelligence/summary": { "get": { "summary": "Market summary", "description": "Aggregated real-time market summary for crypto and US stocks. Get market breadth, regime, average buying pressure, price change, top momentum, top activity, top buying, top selling, market events, and data freshness.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Market summary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketSummary" } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "getMarketSummary" } }, "/api/v1/intelligence/top-momentum": { "get": { "summary": "Market momentum", "description": "Real-time short-term momentum rankings for crypto and US stocks. Find momentum leaders, strongest price momentum, fastest-moving assets, accelerating symbols, and high-momentum signals.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Momentum rankings", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketIntelligenceDocument" } } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "getCryptoStockMomentumRankings" } }, "/api/v1/intelligence/top-activity": { "get": { "summary": "Market activity", "description": "Real-time trading activity rankings for crypto and US stocks. Find the most actively traded assets, highest trade counts, trading volume, activity multiples, and significant trading activity.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Activity rankings", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketIntelligenceDocument" } } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "getMostActiveCryptoStocks" } }, "/api/v1/intelligence/unusual": { "get": { "summary": "Unusual trading activity", "description": "Detect unusual and abnormal trading activity across crypto and US stocks. Find volume spikes, activity anomalies, unusual price movement, abnormal buying or selling pressure, trade anomalies, and statistically unusual market behavior.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10 } }, { "name": "minAnomaly", "in": "query", "required": false, "schema": { "type": "number", "default": 70 } }, { "name": "minTrades", "in": "query", "required": false, "schema": { "type": "integer", "default": 3 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Unusual activity results", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketIntelligenceDocument" } } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "getUnusualTradingActivity" } }, "/api/v1/intelligence/events": { "get": { "summary": "Market events", "description": "Real-time market events for crypto and US stocks. Find significant price moves, momentum changes, unusual activity, buying or selling events, trade-flow changes, and emerging market signals.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Market events", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketIntelligenceDocument" } } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "getMarketEvents" } }, "/api/v1/intelligence/buying": { "get": { "summary": "Buying pressure", "description": "Real-time buy-side trade flow rankings for crypto and US stocks. Find assets with the strongest buying pressure, aggressive buying, buyer dominance, positive buy-side imbalance, and bullish buying signals.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10 } }, { "name": "minBuyPressure", "in": "query", "required": false, "schema": { "type": "number", "default": 60 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Buying pressure rankings", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketIntelligenceDocument" } } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "getStrongestBuyingPressure" } }, "/api/v1/intelligence/selling": { "get": { "summary": "Selling pressure", "description": "Real-time sell-side trade flow rankings for crypto and US stocks. Find assets with the strongest selling pressure, aggressive selling, seller dominance, negative buy-side imbalance, and bearish selling signals.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 10 } }, { "name": "maxBuyPressure", "in": "query", "required": false, "schema": { "type": "number", "default": 40 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Selling pressure rankings", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MarketIntelligenceDocument" } } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "getStrongestSellingPressure" } }, "/api/v1/intelligence/compare": { "get": { "summary": "Compare market signals", "description": "Compare selected crypto and US stocks using momentum, price movement, buying pressure, selling pressure, trade flow, trading activity, anomalies, and signal strength.", "security": [ { "x402": [] } ], "parameters": [ { "name": "symbols", "in": "query", "required": true, "schema": { "type": "string", "example": "BTCUSD,ETHUSD,SOLUSD" } }, { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Symbol comparison", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompactMarketIntelligence" } } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "compareCryptoStocks" } }, "/api/v1/intelligence/regime": { "get": { "summary": "Market regime", "description": "Current market regime across crypto and US stocks. Identify bullish, bearish, or mixed market conditions using market breadth, momentum, buying pressure, selling pressure, trading activity, trade flow, and market signals.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Market regime", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MarketRegime" } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "getMarketRegime" } }, "/api/v1/intelligence/backtest": { "get": { "summary": "Signal backtesting", "description": "Backtest and validate market intelligence signals using historical crypto and US stock data. Evaluate signal performance, forward returns, win rate, confidence, signal strength, maximum favorable excursion, maximum adverse excursion, and baseline performance.", "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "description": "Analysis window.", "schema": { "type": "string", "default": "5m", "enum": [ "1m", "5m", "15m" ] } }, { "name": "minConfidence", "in": "query", "required": false, "description": "Minimum signal confidence from 0 to 100.", "schema": { "type": "integer", "default": 60, "minimum": 0, "maximum": 100 } }, { "name": "minBaselineSamples", "in": "query", "required": false, "description": "Minimum historical baseline samples; service enforces a minimum of 2.", "schema": { "type": "integer", "default": 10, "minimum": 2 } }, { "name": "start", "in": "query", "required": false, "description": "ISO-8601 backtest start timestamp. Defaults to 24 hours before end.", "schema": { "type": "string", "format": "date-time" } }, { "name": "end", "in": "query", "required": false, "description": "ISO-8601 backtest end timestamp. Defaults to now.", "schema": { "type": "string", "format": "date-time" } }, { "name": "symbols", "in": "query", "required": false, "description": "Comma-separated crypto or US equity symbols. Empty means all available symbols.", "schema": { "type": "string" } }, { "name": "persist", "in": "query", "required": false, "description": "Whether to persist the backtest result.", "schema": { "type": "boolean", "default": false } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.05", "currency": "USD" }, "responses": { "200": { "description": "Backtest results", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BacktestResults" } } } }, "402": { "description": "Payment Required" } }, "tags": [ "Market Intelligence" ], "operationId": "backtestMarketSignals" } }, "/mcp": { "post": { "summary": "MCP market intelligence", "description": "MCP market intelligence tools for AI agents. Access aggregated market intelligence, symbol intelligence, momentum, activity, buying pressure, selling pressure, trade flow, signal strength, unusual activity, market regime, market events, SEC stock fundamentals, and signal backtesting through MCP JSON-RPC. initialize and tools/list are free; each tools/call is priced like the matching HTTP route ($0.003-$0.05), shown in the 402 response.", "security": [ { "x402": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "dynamic", "minPrice": "0.003", "maxPrice": "0.05", "currency": "USD" }, "responses": { "200": { "description": "MCP JSON-RPC response", "content": { "application/json": { "schema": { "type": "object", "description": "MCP JSON-RPC response containing the requested tool result or JSON-RPC error.", "additionalProperties": true } } } }, "402": { "description": "Payment Required" } }, "tags": [ "MCP" ], "operationId": "getMarketIntelligenceMcpTools" } }, "/api/v1/fundamentals/{symbol}": { "get": { "operationId": "getSecFundamentalsFinancialStatements", "summary": "SEC fundamentals financial statements", "description": "SEC fundamentals, stock fundamentals and financial statements for US equities. Get company financials from SEC EDGAR including income statement, balance sheet, cash flow, revenue, net income, EPS, assets, liabilities, equity, revenue growth, earnings growth, profit margins, return on assets, debt-to-equity, cash-to-debt, SEC filings, 10-K, 10-Q, XBRL data and deterministic fundamental signals.", "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "US equity ticker, e.g. AAPL, MSFT, NVDA." } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "SEC EDGAR-derived fundamental intelligence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SecFundamentalIntelligence" } } } }, "400": { "description": "Invalid or unknown US equity ticker" }, "402": { "description": "Payment Required" } }, "tags": [ "SEC Fundamentals", "Stock Fundamentals", "Financial Statements" ] } }, "/api/v1/intelligence/pre-trade": { "get": { "operationId": "preTradeCheck", "summary": "Pre-trade check: is now a good moment to buy or sell?", "description": "Use right before placing a trade: \"I want to buy (or sell) SYMBOL - is now a good moment?\". Returns a verdict (FAVORABLE, CAUTION, UNFAVORABLE) with a 0-100 score and the checks behind it: order flow, momentum, volatility, adverse market events, market regime, and news or material SEC filings from the last 24h. Works for crypto (ETHUSD, BTCUSD, ...) and tokenized US equities (NVDA, TSLA, SPY, ...), 24/7. Includes on-chain slippage of a $1k/$10k/$50k order and a liquidity score.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "query", "required": true, "schema": { "type": "string", "example": "ETHUSD" }, "description": "Asset symbol, e.g. ETHUSD, BTCUSD, NVDA, TSLA." }, { "name": "side", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "buy", "sell" ], "default": "buy" }, "description": "Intended trade direction." }, { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" }, "description": "Signal window (1m, 5m, 15m, 1h, 4h, 24h)." } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Verdict, score, checks and market snapshot", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string" }, "side": { "type": "string" }, "verdict": { "type": "string", "enum": [ "FAVORABLE", "CAUTION", "UNFAVORABLE" ] }, "score": { "type": "number" }, "checks": { "type": "array", "items": { "type": "object" } }, "snapshot": { "type": "object" }, "timestamp": { "type": "string", "format": "date-time" }, "liquidity": { "type": "object", "description": "On-chain liquidity: cost of a market order as one swap in the best pool, fee included (Uniswap v3/v4 pool math from swap events). Sizes whose price move would exceed 1% are null with a reason.", "properties": { "method": { "type": "string" }, "as_of": { "type": [ "string", "null" ], "format": "date-time" }, "liquidity_score": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 100, "description": "100*exp(-bps/50) of the average $10k buy/sell cost" }, "slippage_bps": { "type": [ "object", "null" ], "properties": { "buy": { "type": "object", "additionalProperties": { "type": [ "number", "null" ] } }, "sell": { "type": "object", "additionalProperties": { "type": [ "number", "null" ] } } }, "description": "Keys are USD sizes: 1000, 10000, 50000" }, "estimates": { "type": "array", "items": { "type": "object" } }, "pools": { "type": "array", "items": { "type": "object" } } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "status": { "type": "string" }, "as_of": { "type": [ "string", "null" ], "format": "date-time" } } } }, "as_of": { "type": [ "string", "null" ], "format": "date-time" } } } } } }, "400": { "description": "Invalid symbol or side (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No recent data for this symbol (not charged). The body lists the covered symbols.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "no_data" }, "message": { "type": "string" }, "symbol": { "type": "string" }, "coveredSymbols": { "type": "array", "items": { "type": "string" } }, "charged": { "type": "boolean", "example": false } } } } } } } } }, "/api/v1/intelligence/equities": { "get": { "operationId": "getTokenizedEquities", "summary": "24/7 US equity sentiment from tokenized stocks", "description": "Use to read US stock sentiment around the clock, including nights and weekends when exchanges are closed. Returns 24/7 trade flow of tokenized US equities and ETFs (NVDA, AAPL, TSLA, SPY, ...) traded on public blockchains, labelled with the current US market session, with breadth, average buy pressure and per-asset signals. Prices are on-chain trade prices, not official exchange quotes.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "default": "5m" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 20, "maximum": 100 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Session, breadth and per-asset flow", "content": { "application/json": { "schema": { "type": "object" } } } }, "402": { "description": "Payment Required" } } } }, "/api/v1/intelligence/token/{address}": { "get": { "operationId": "analyzeToken", "summary": "Live DEX trade flow and verdict for any ERC-20 token", "description": "Send any token contract address (Base by default; chain=arbitrum or optimism), get its live DEX trade flow for the last hour: swaps, buy and sell volume in USD, buy pressure, price change, largest trade, trader concentration and a verdict (ACCUMULATION, DISTRIBUTION, BALANCED, ILLIQUID_OR_INACTIVE, NO_POOL). Read live from the chain; repeat requests within 45 s share one read (see timestamp).", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^0x[0-9a-fA-F]{40}$" }, "description": "ERC-20 contract address." }, { "name": "chain", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "base", "arbitrum", "optimism" ], "default": "base" } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Token info, flow, price, pools and verdict", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Not a token address or unsupported chain (not charged)" }, "402": { "description": "Payment Required" } } } }, "/api/v1/intelligence/candles/{symbol}": { "get": { "operationId": "getCandles", "summary": "OHLCV candles with buy/sell volume split", "description": "Send a symbol (ETHUSD, BTCUSD, NVDA, TSLA, SPY, ...), get OHLCV candles (1m, 5m, 15m or 1h) with volume split into aggressive buys and sells, buy pressure, VWAP and trade count per candle, from on-chain trade flow. A free 15-minute delayed sample is at /api/v1/preview.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string", "example": "ETHUSD" } }, { "name": "interval", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1m", "5m", "15m", "1h" ], "default": "1m" } }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "default": 60, "maximum": 500 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Candles", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string" }, "interval": { "type": "string" }, "count": { "type": "integer" }, "candles": { "type": "array", "items": { "type": "object", "properties": { "time": { "type": "string", "format": "date-time" }, "open": { "type": "number" }, "high": { "type": "number" }, "low": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" }, "volumeUsd": { "type": "number" }, "buyVolume": { "type": "number" }, "sellVolume": { "type": "number" }, "buyPressure": { "type": [ "number", "null" ] }, "vwap": { "type": [ "number", "null" ] }, "trades": { "type": "integer" } } } } } } } } }, "400": { "description": "Invalid symbol or interval (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No recent data for this symbol (not charged). The body lists the covered symbols.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "no_data" }, "message": { "type": "string" }, "symbol": { "type": "string" }, "coveredSymbols": { "type": "array", "items": { "type": "string" } }, "charged": { "type": "boolean", "example": false } } } } } } } } }, "/api/v1/preview": { "get": { "operationId": "getFreePreview", "summary": "Free delayed sample (no payment)", "description": "Free, 15-minute delayed, truncated sample of the paid candle data (last 6 closed 5m candles: close, volumeUsd, buyPressure) for a few symbols, so an agent can check data quality before paying. Links to the matching paid endpoints are included.", "tags": [ "Free" ], "parameters": [ { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "ETHUSD", "BTCUSD", "TSLA" ], "default": "ETHUSD" } } ], "responses": { "200": { "description": "Delayed sample", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Symbol not in the preview set" } }, "security": [] } }, "/status": { "get": { "operationId": "getStatus", "summary": "Data freshness (free)", "description": "Free freshness report: per-chain ingestion state (last successful poll, last ingested block, last trade, error counts), time of the latest trade, and per-source fetch state for news and filings. Use it to verify the data is live before paying.", "tags": [ "Free" ], "responses": { "200": { "description": "Freshness report", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [] } }, "/transparency": { "get": { "operationId": "getTransparency", "summary": "Operator, data source and billing disclosure (free)", "description": "Who runs the service, where the data comes from, current prices per route, and the billing policy (settled only after a successful 2xx answer).", "tags": [ "Free" ], "responses": { "200": { "description": "Disclosure", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [] } }, "/.well-known/x402-resources": { "get": { "operationId": "getX402Resources", "summary": "Paid resource list (free)", "description": "Paid resources in the x402scan manifest form. Also served at /x402-resources.", "tags": [ "Free" ], "responses": { "200": { "description": "Resource list", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [] } }, "/.well-known/security.txt": { "get": { "operationId": "getSecurityTxt", "summary": "RFC 9116 security contact (free)", "tags": [ "Free" ], "responses": { "200": { "description": "security.txt", "content": { "text/plain": { "schema": { "type": "string" } } } } }, "security": [] } }, "/api/v1/intelligence/query": { "get": { "operationId": "queryHistoricalIntelligence", "summary": "Several signals for several symbols over a historical range", "description": "Use when an agent needs several signals for several symbols over a historical time range in one paid call. Returns momentum, activity, buying, selling, anomaly and regime per symbol for any from/to range; the data resolution (1m, 5m, 15m or 1h) is chosen automatically.", "tags": [ "Market Intelligence" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbols", "in": "query", "required": true, "schema": { "type": "string", "example": "BTCUSD,ETHUSD" }, "description": "Comma-separated symbols, up to 20." }, { "name": "from", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "description": "ISO-8601 UTC start." }, { "name": "to", "in": "query", "required": true, "schema": { "type": "string", "format": "date-time" }, "description": "ISO-8601 UTC end, after from." }, { "name": "signals", "in": "query", "required": false, "schema": { "type": "string", "example": "momentum,activity,buying,selling,anomaly,regime" }, "description": "Subset of signals; all when omitted." } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.05", "currency": "USD" }, "responses": { "200": { "description": "Window, resolution, source and one result per symbol", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid symbols or time range (not charged)" }, "402": { "description": "Payment Required" } } } }, "/api/v1/intelligence/token-risk/{address}": { "get": { "operationId": "checkTokenRisk", "summary": "Token due diligence: honeypot, admin functions, liquidity, LP burn, tax", "description": "Use before buying any ERC-20 (Base by default; chain=arbitrum or optimism). Simulates a sell by a real recent buyer and a buy from the main pool with eth_call (honeypot check), reads the owner and EIP-1967 proxy, scans the bytecode for mint, blacklist, pause, fee, limit and trading-switch functions, measures liquidity in Uniswap v2/v3 and Aerodrome pools, the share of burned LP tokens and the buy tax observed in recent buys, adds the last hour of trade flow, and returns a verdict (LOW_RISK, CAUTION, HIGH_RISK) with a 0-100 safety score and every check (PASS, WARN, FAIL, UNKNOWN, INFO). Automated checks, not an audit. Cached 120 s.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "address", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^0x[0-9a-fA-F]{40}$" }, "description": "ERC-20 contract address." }, { "name": "chain", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "base", "arbitrum", "optimism" ], "default": "base" } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.02", "currency": "USD" }, "responses": { "200": { "description": "Verdict, safety score, checks, contract, liquidity, simulation and trade flow", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Not a token address or unsupported chain (not charged)" }, "402": { "description": "Payment Required" } } } }, "/api/v1/intelligence/premium": { "get": { "operationId": "getTokenizedStockPremium", "summary": "Tokenized stock price gap between Robinhood Chain/EVM pools and Solana xStocks", "description": "Latest premium in basis points of the same tokenized US stock between the main on-chain pools (Robinhood Chain and EVM DEX) and Solana xStocks pools (Raydium, Orca, Meteora): volume-weighted prices of the last 15-minute bin with trades on both venues within the hour, both 1-hour volumes and the US market session. Sorted by absolute premium. Neither venue is a licensed NYSE/NASDAQ price.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbols", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated tickers, e.g. NVDA,TSLA; all paired stocks when omitted." } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Premiums per symbol", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid symbols (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No symbol traded on both venues in the last hour (not charged). The body lists the covered symbols where relevant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "no_data" }, "message": { "type": "string" }, "symbol": { "type": "string" }, "coveredSymbols": { "type": "array", "items": { "type": "string" } }, "charged": { "type": "boolean", "example": false } } } } } } } } }, "/api/v1/intelligence/premium/{symbol}": { "get": { "operationId": "getTokenizedStockPremiumHistory", "summary": "Premium history of one tokenized stock with statistics per US market session", "description": "Premium history of one tokenized US stock between Robinhood Chain/EVM pools and Solana xStocks pools: one point per 15m or 1h bin with trades on both venues, plus average, median, min, max and statistics per US market session (WEEKEND, OVERNIGHT, PRE_MARKET, REGULAR, AFTER_HOURS).", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Tokenized stock ticker, e.g. NVDA." }, { "name": "hours", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 720, "default": 24 } }, { "name": "interval", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "15m", "1h" ], "default": "15m" } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Statistics, per-session statistics and points", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid symbol or interval (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No bin with trades on both venues (not charged). The body lists the covered symbols where relevant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "no_data" }, "message": { "type": "string" }, "symbol": { "type": "string" }, "coveredSymbols": { "type": "array", "items": { "type": "string" } }, "charged": { "type": "boolean", "example": false } } } } } } } } }, "/api/v1/datasets": { "get": { "operationId": "listDatasets", "summary": "Free catalog of the trade-flow datasets", "description": "Which symbols, venues, dates and resolutions can be bought as datasets. Free.", "tags": [ "Free" ], "security": [], "responses": { "200": { "description": "Catalog", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/datasets/{symbol}": { "get": { "operationId": "getDataset", "summary": "One UTC day of trade-flow candles per venue, JSON or CSV", "description": "One UTC day of candles for a symbol, separately per venue (onchain_dex: Uniswap and Aerodrome pools on Base, Ethereum, Arbitrum, Optimism, Polygon and Robinhood Chain; solana_dex: tokenized stocks on Solana): OHLCV, aggressor buy and sell volume, buy pressure, VWAP and trade count. 1-minute data is kept 7 days, then 5m (30 days), 15m (180 days) and 1h; a finer interval than stored returns the stored resolution. format=csv returns a CSV file.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Covered symbol, e.g. ETHUSD, BTCUSD, NVDA." }, { "name": "date", "in": "query", "required": false, "schema": { "type": "string", "format": "date" }, "description": "UTC day (YYYY-MM-DD); yesterday when omitted." }, { "name": "interval", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1m", "5m", "15m", "1h" ], "default": "1m" } }, { "name": "format", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "json", "csv" ], "default": "json" } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.02", "currency": "USD" }, "responses": { "200": { "description": "Dataset", "content": { "application/json": { "schema": { "type": "object" } }, "text/csv": { "schema": { "type": "string" } } } }, "400": { "description": "Invalid symbol, date, interval or format (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No trades for the symbol on that day (not charged). The body lists the covered symbols where relevant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "no_data" }, "message": { "type": "string" }, "symbol": { "type": "string" }, "coveredSymbols": { "type": "array", "items": { "type": "string" } }, "charged": { "type": "boolean", "example": false } } } } } } } } }, "/api/v1/insiders/{symbol}": { "get": { "operationId": "getInsiderTrades", "summary": "Insider buying and selling from SEC Form 4", "description": "Insider transactions of a US-listed company from SEC Form 4 filings of the last days (1-365, the latest 40 filings are analyzed): open-market purchases and sales with value in USD, sales under 10b5-1 plans, grants, option exercises and tax withholding, per-insider totals, the latest 50 transactions with filing links, and a signal (CLUSTER_BUYING, NET_BUYING, PLANNED_SELLING, NET_SELLING, NO_OPEN_MARKET_ACTIVITY).", "tags": [ "SEC Fundamentals" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "US equity ticker, e.g. TSLA." }, { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 365, "default": 90 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Signal, summary, insiders and transactions", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Unknown ticker (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No Form 4 filings in the period (not charged). The body lists the covered symbols where relevant.", "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "no_data" }, "message": { "type": "string" }, "symbol": { "type": "string" }, "coveredSymbols": { "type": "array", "items": { "type": "string" } }, "charged": { "type": "boolean", "example": false } } } } } } } } }, "/track-record": { "get": { "operationId": "getPublicTrackRecord", "summary": "Free live track record of the signals", "description": "Hit rate (price moved in the signal's direction) of the 5m signals after 5m, 15m, 1h and 24h over the last 7, 30 and 90 days, calibration by confidence bucket, and an interim walk-forward backtest since the start of on-chain data (labelled as a backtest, not a live record). Free.", "tags": [ "Free" ], "security": [], "responses": { "200": { "description": "Track record", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/intelligence/track-record": { "get": { "operationId": "getTrackRecord", "summary": "Live signal track record: hit rate and calibration", "description": "Every published signal change is logged with its price, confidence and algorithm version; forward returns after 5m, 15m, 1h and 24h are filled as time passes. Returns hit rate and average return in the signal direction per horizon, per signal type and per confidence bucket, for any window, symbol and period, plus the latest signals with outcomes. Not charged (404) while nothing is logged for the query.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 120, "default": 30 } }, { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1m", "5m", "15m" ], "default": "5m" } }, { "name": "symbol", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Optional symbol, e.g. ETHUSD." } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Track record detail", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid window (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No logged signals for the query yet (not charged)" } } } }, "/coverage": { "get": { "operationId": "getCoverage", "summary": "Free map of data sources per symbol", "description": "Which sources exist per symbol (spot DEX flow on-chain and on Solana, perpetual futures venues), so an agent knows what a paid call returns. Paid endpoints answer 404 (not charged) when a symbol has no data for them. Free.", "tags": [ "Free" ], "security": [], "responses": { "200": { "description": "Coverage", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/api/v1/intelligence/positioning/{symbol}": { "get": { "operationId": "getPositioning", "summary": "Perpetual futures positioning next to the spot flow", "description": "For a tokenized stock, ETF or commodity (TSLA, NVDA, SPY, QQQ, AMZN, NFLX, HOOD, gold XAUUSD, silver XAGUSD, oil WTIUSD and BRENTUSD, NATGASUSD, ...): open interest long and short per perp venue (GMX v2 synthetic markets, gTrade on Arbitrum and Base) read on chain every 5 minutes, funding (GMX: annualized, positive = longs pay; gTrade: the larger side pays), 1h and 24h change of total open interest and a positioning flag (CROWDED_LONG / CROWDED_SHORT at a 65% long or short share, THIN below $50k), next to the latest spot DEX flow when the symbol trades spot. Symbols covered by perps only get a partial answer with a coverage note; 404 (not charged) when neither exists.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "e.g. TSLA, SPY, XAUUSD, WTIUSD." } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Perps and spot positioning", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid symbol (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No spot or perp data for the symbol (not charged); see /coverage" } } } }, "/api/v1/intelligence/smart-money/{symbol}": { "get": { "operationId": "getSmartMoney", "summary": "Most profitable DEX wallets of a symbol and their net flow", "description": "Wallets (public addresses only) trading a symbol in the DEX pools we ingest, ranked by realized plus unrealized PnL (average cost on what was bought while tracked, marked at the latest pool price), with win rate, average holding time, open position, and the net flow of the top-decile wallets vs all wallets over the last two UTC days. Wallet = recipient of organic swaps; arbitrage, MEV, two-sided bots and router-bound swaps are excluded; trades under $50 ignored. A reliable ranking needs 2-4 weeks of history. 404 (not charged) when no wallet trade is recorded for the symbol.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "schema": { "type": "string" }, "description": "e.g. ETHUSD, BTCUSD, NVDA." } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.02", "currency": "USD" }, "responses": { "200": { "description": "Ranked wallets and flow", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid symbol (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No wallet trades recorded yet (not charged)" } } } }, "/api/v1/rates/curve": { "get": { "operationId": "getYieldCurve", "summary": "Treasury yield curve, slopes, SOFR and euro STR", "description": "US Treasury daily par yield curve (1M-30Y) and real TIPS curve with the change vs the previous business day, 2s10s, 3m10y, 5s30s and 3m2y slopes with inversion flags, 10y breakeven inflation, and overnight rates: SOFR and EFFR (New York Fed; the response carries the notice its Terms of Use require) and euro STR (ECB). Sources: home.treasury.gov (public domain), markets.newyorkfed.org, ECB Data Portal.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Curve and overnight rates", "content": { "application/json": { "schema": { "type": "object" } } } }, "402": { "description": "Payment Required" }, "503": { "description": "Source temporarily unavailable (not charged)" } } } }, "/api/v1/rates/defi-spread": { "get": { "operationId": "getDefiRateSpread", "summary": "Aave USDC rates vs the 3-month T-bill", "description": "USDC supply and variable borrow APR on Aave v3 (Ethereum, Base, Arbitrum, Optimism, Polygon) read on chain, each against the 3-month Treasury bill, with the average spread and a signal (DEFI_PREMIUM, IN_LINE, TREASURY_PREMIUM at +-50 bp).", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Rates and spread", "content": { "application/json": { "schema": { "type": "object" } } } }, "402": { "description": "Payment Required" }, "503": { "description": "Source temporarily unavailable (not charged)" } } } }, "/api/v1/rates/tokenized-treasuries": { "get": { "operationId": "getTokenizedTreasuries", "summary": "On-chain treasury fund supply and net issuance", "description": "totalSupply of BlackRock BUIDL, Ondo USDY and OUSG, Superstate USTB and Hashnote USYC on Ethereum, snapshotted hourly on chain, with 24h and 7d change and an aggregate gauge (RISK_OFF_INFLOW / NEUTRAL / RISK_ON_OUTFLOW at +-0.5% per day). Token units; NAV per token differs by fund. 404 (not charged) before the first snapshot.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.01", "currency": "USD" }, "responses": { "200": { "description": "Funds and gauge", "content": { "application/json": { "schema": { "type": "object" } } } }, "402": { "description": "Payment Required" }, "404": { "description": "No snapshot yet (not charged)" } } } }, "/api/v1/rates/auctions": { "get": { "operationId": "getTreasuryAuctions", "summary": "Upcoming and recent Treasury auctions", "description": "US Treasury auctions of the last days (1-60) and those announced: security, term, offering amount, high yield or discount rate, bid-to-cover, indirect and primary-dealer shares, and the previous auction of the same security for comparison. Source: fiscaldata.treasury.gov (public domain).", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "days", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 60, "default": 14 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.005", "currency": "USD" }, "responses": { "200": { "description": "Auctions", "content": { "application/json": { "schema": { "type": "object" } } } }, "402": { "description": "Payment Required" }, "503": { "description": "Source temporarily unavailable (not charged)" } } } }, "/api/v1/intelligence/opportunities": { "get": { "operationId": "findOpportunities", "summary": "Goal-driven opportunity scan", "description": "Goal-driven opportunity scan for agents. Name an objective and constraints; get ranked symbols with supporting and conflicting evidence grouped by independent source (spot_dex_flow, perp_positioning, smart_money), typed risk factors, data quality, the live 1h hit rate of the signal and the next calls to make. Deterministic, no model in the loop. Objectives: unusual_buying, unusual_selling, breakout, breakdown, crowded_positioning (direction against the crowd), smart_money_accumulation, smart_money_distribution. An empty result list is a valid answer when data is fresh (filteredOut says why); 404 (not charged) only without fresh data; 400 (not charged) lists accepted values.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "objective", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "unusual_buying", "unusual_selling", "breakout", "breakdown", "crowded_positioning", "smart_money_accumulation", "smart_money_distribution" ] }, "description": "What to look for" }, { "name": "universe", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated symbols (max 100); omit for all covered symbols" }, { "name": "assetClass", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "crypto", "us_equity", "perp_only" ] } }, { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1m", "5m", "15m" ], "default": "5m" } }, { "name": "minBuyPressure", "in": "query", "required": false, "schema": { "type": "number", "minimum": 50, "maximum": 100, "default": 60 }, "description": "Pressure on the objective's side (sell pressure for selling objectives)" }, { "name": "minVolumeMultiple", "in": "query", "required": false, "schema": { "type": "number", "default": 1.5 }, "description": "Volume vs the symbol's own baseline" }, { "name": "minVolumeUsd", "in": "query", "required": false, "schema": { "type": "number", "default": 0 }, "description": "USD traded in the window" }, { "name": "minConfidence", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 100, "default": 50 } }, { "name": "minIndependentSources", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3, "default": 1 }, "description": "Distinct sources confirming the direction" }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated: metrics, evidence, risk_factors, data_quality, track_record, market_context (default all)" }, { "name": "maxResults", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 10 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.03", "currency": "USD" }, "responses": { "200": { "description": "Ranked opportunities", "content": { "application/json": { "schema": { "type": "object", "properties": { "objective": { "type": "string" }, "objectiveDefinition": { "type": "string" }, "window": { "type": "string" }, "asOf": { "type": "string", "format": "date-time" }, "algoVersion": { "type": "string" }, "request": { "type": "object", "description": "The request with defaults applied" }, "symbolsScanned": { "type": "integer" }, "matches": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "rank": { "type": "integer" }, "symbol": { "type": "string" }, "assetClass": { "type": "string", "enum": [ "crypto", "us_equity", "perp_only" ] }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH" ] }, "score": { "type": "integer", "minimum": 0, "maximum": 100, "description": "40 for meeting the objective + up to 20 for strength + 15 per extra confirming source +/- up to 15 for calibration (live hit rate minus 50 on >= 30 samples), - 10 per conflicting item, - 5 per HIGH risk" }, "independentSourcesConfirming": { "type": "integer" }, "confirmingSources": { "type": "array", "items": { "type": "string" } }, "price": { "type": "number" }, "signal": { "type": "string" }, "eventType": { "type": "string" }, "metrics": { "type": "object", "description": "buyPressure, momentumScore, priceChangePercent, volumeUsd, volumeMultiple, anomalyScore, activityScore, tradeCount, largeTradeCount, confidenceScore, asOf" }, "supportingEvidence": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "spot_dex_flow", "perp_positioning", "smart_money" ] }, "type": { "type": "string", "description": "buy_pressure, momentum, volume_anomaly, market_event, large_trades, long_short_open_interest, top_wallet_net_flow" }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH", "NEUTRAL", "ACTIVITY" ] }, "observedValue": {}, "unit": { "type": "string" }, "detail": { "type": "string" } } } }, "conflictingEvidence": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "spot_dex_flow", "perp_positioning", "smart_money" ] }, "type": { "type": "string", "description": "buy_pressure, momentum, volume_anomaly, market_event, large_trades, long_short_open_interest, top_wallet_net_flow" }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH", "NEUTRAL", "ACTIVITY" ] }, "observedValue": {}, "unit": { "type": "string" }, "detail": { "type": "string" } } } }, "riskFactors": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "thin_liquidity, low_confidence, bot_dominated_flow, baseline_not_ready, crowded_positioning, price_dislocation, us_market_closed, corporate_action, macro_event, conflicting_evidence, weak_signal_track_record" }, "severity": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "detail": { "type": "string" } } } }, "dataQuality": { "type": "object", "description": "sourcesAvailable, sourcesMissing, signalAgeSeconds, confidenceScore, tradeCount, baselineReady, organicSharePercent, freshPools, oracleDeviationBps" }, "signalTrackRecord1h": { "type": "object", "description": "Live 1h hit rate of this signal label over 30 days (all symbols); hitRatePercent is null below 30 evaluated signals; appliesToThisDirection says whether the signal points the same way as the result (only then it counts in the score)" }, "nextCalls": { "type": "object", "description": "Follow-up routes: preTradeCheck, positioning, smartMoney, trackRecord" }, "calibratedHitRatePercent": { "type": "number", "nullable": true, "description": "Live hit rate behind this result (signal 1h, or crowding events 4h for crowded_positioning); null below 30 samples" }, "positioningTrackRecord4h": { "type": "object", "description": "crowded_positioning only: 4h record of crowding events on this side" } } } }, "noMatchReason": { "type": "string" }, "filteredOut": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Why symbols were excluded, with counts" }, "notCovered": { "type": "array", "items": { "type": "string" } }, "marketContext": { "type": "object", "description": "regime, usMarketSession, stablecoinNetIssuance24hUsd, macroEventsNext2h" }, "method": { "type": "string" }, "disclaimer": { "type": "string" } } } } } }, "400": { "description": "Invalid request with the accepted values (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No fresh market data (not charged)" } } }, "post": { "operationId": "findOpportunitiesPost", "summary": "Goal-driven opportunity scan (JSON body)", "description": "Goal-driven opportunity scan for agents. Name an objective and constraints; get ranked symbols with supporting and conflicting evidence grouped by independent source (spot_dex_flow, perp_positioning, smart_money), typed risk factors, data quality, the live 1h hit rate of the signal and the next calls to make. Deterministic, no model in the loop. Objectives: unusual_buying, unusual_selling, breakout, breakdown, crowded_positioning (direction against the crowd), smart_money_accumulation, smart_money_distribution. An empty result list is a valid answer when data is fresh (filteredOut says why); 404 (not charged) only without fresh data; 400 (not charged) lists accepted values.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "objective" ], "properties": { "objective": { "type": "string", "enum": [ "unusual_buying", "unusual_selling", "breakout", "breakdown", "crowded_positioning", "smart_money_accumulation", "smart_money_distribution" ] }, "universe": { "type": "array", "items": { "type": "string" }, "maxItems": 100, "description": "Symbols to scan; omit for all covered" }, "constraints": { "type": "object", "description": "Optional; the same keys are also accepted at the top level", "properties": { "assetClass": { "type": "string", "enum": [ "crypto", "us_equity", "perp_only" ] }, "window": { "type": "string", "enum": [ "1m", "5m", "15m" ], "default": "5m" }, "minBuyPressure": { "type": "number", "minimum": 50, "maximum": 100, "default": 60, "description": "Pressure on the objective's side" }, "minVolumeMultiple": { "type": "number", "default": 1.5 }, "minVolumeUsd": { "type": "number", "default": 0 }, "minConfidence": { "type": "number", "minimum": 0, "maximum": 100, "default": 50 }, "minIndependentSources": { "type": "integer", "minimum": 1, "maximum": 3, "default": 1 } } }, "include": { "type": "array", "items": { "type": "string", "enum": [ "metrics", "evidence", "risk_factors", "data_quality", "track_record", "market_context" ] } }, "maxResults": { "type": "integer", "minimum": 1, "maximum": 50, "default": 10 } } }, "example": { "objective": "unusual_buying", "universe": [ "BTCUSD", "ETHUSD", "NVDA" ], "constraints": { "window": "15m", "minBuyPressure": 65, "minVolumeUsd": 100000, "minIndependentSources": 2 }, "include": [ "metrics", "evidence", "risk_factors", "data_quality", "track_record", "market_context" ], "maxResults": 10 } } } }, "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.03", "currency": "USD" }, "responses": { "200": { "description": "Ranked opportunities", "content": { "application/json": { "schema": { "type": "object", "properties": { "objective": { "type": "string" }, "objectiveDefinition": { "type": "string" }, "window": { "type": "string" }, "asOf": { "type": "string", "format": "date-time" }, "algoVersion": { "type": "string" }, "request": { "type": "object", "description": "The request with defaults applied" }, "symbolsScanned": { "type": "integer" }, "matches": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "rank": { "type": "integer" }, "symbol": { "type": "string" }, "assetClass": { "type": "string", "enum": [ "crypto", "us_equity", "perp_only" ] }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH" ] }, "score": { "type": "integer", "minimum": 0, "maximum": 100, "description": "40 for meeting the objective + up to 20 for strength + 15 per extra confirming source + 10 for a live 1h hit rate >= 55% on >= 30 samples, - 10 per conflicting item, - 5 per HIGH risk" }, "independentSourcesConfirming": { "type": "integer" }, "confirmingSources": { "type": "array", "items": { "type": "string" } }, "price": { "type": "number" }, "signal": { "type": "string" }, "eventType": { "type": "string" }, "metrics": { "type": "object", "description": "buyPressure, momentumScore, priceChangePercent, volumeUsd, volumeMultiple, anomalyScore, activityScore, tradeCount, largeTradeCount, confidenceScore, asOf" }, "supportingEvidence": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "spot_dex_flow", "perp_positioning", "smart_money" ] }, "type": { "type": "string", "description": "buy_pressure, momentum, volume_anomaly, market_event, large_trades, long_short_open_interest, top_wallet_net_flow" }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH", "NEUTRAL", "ACTIVITY" ] }, "observedValue": {}, "unit": { "type": "string" }, "detail": { "type": "string" } } } }, "conflictingEvidence": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "spot_dex_flow", "perp_positioning", "smart_money" ] }, "type": { "type": "string", "description": "buy_pressure, momentum, volume_anomaly, market_event, large_trades, long_short_open_interest, top_wallet_net_flow" }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH", "NEUTRAL", "ACTIVITY" ] }, "observedValue": {}, "unit": { "type": "string" }, "detail": { "type": "string" } } } }, "riskFactors": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "thin_liquidity, low_confidence, bot_dominated_flow, baseline_not_ready, crowded_positioning, price_dislocation, us_market_closed, corporate_action, macro_event, conflicting_evidence, weak_signal_track_record" }, "severity": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "detail": { "type": "string" } } } }, "dataQuality": { "type": "object", "description": "sourcesAvailable, sourcesMissing, signalAgeSeconds, confidenceScore, tradeCount, baselineReady, organicSharePercent, freshPools, oracleDeviationBps" }, "signalTrackRecord1h": { "type": "object", "description": "Live 1h hit rate of this signal label over 30 days (all symbols); hitRatePercent is null below 30 evaluated signals; appliesToThisDirection says whether the signal points the same way as the result (only then it counts in the score)" }, "nextCalls": { "type": "object", "description": "Follow-up routes: preTradeCheck, positioning, smartMoney, trackRecord" } } } }, "noMatchReason": { "type": "string" }, "filteredOut": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Why symbols were excluded, with counts" }, "notCovered": { "type": "array", "items": { "type": "string" } }, "marketContext": { "type": "object", "description": "regime, usMarketSession, stablecoinNetIssuance24hUsd, macroEventsNext2h" }, "method": { "type": "string" }, "disclaimer": { "type": "string" } } } } } }, "400": { "description": "Invalid request with the accepted values (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No fresh market data (not charged)" } } } }, "/api/v1/agent/opportunities": { "get": { "operationId": "findOpportunitiesAgent", "summary": "Goal-driven opportunity scan", "description": "Goal-driven opportunity scan for agents. Name an objective and constraints; get ranked symbols with supporting and conflicting evidence grouped by independent source (spot_dex_flow, perp_positioning, smart_money), typed risk factors, data quality, the live 1h hit rate of the signal and the next calls to make. Deterministic, no model in the loop. Objectives: unusual_buying, unusual_selling, breakout, breakdown, crowded_positioning (direction against the crowd), smart_money_accumulation, smart_money_distribution. An empty result list is a valid answer when data is fresh (filteredOut says why); 404 (not charged) only without fresh data; 400 (not charged) lists accepted values.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "parameters": [ { "name": "objective", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "unusual_buying", "unusual_selling", "breakout", "breakdown", "crowded_positioning", "smart_money_accumulation", "smart_money_distribution" ] }, "description": "What to look for" }, { "name": "universe", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated symbols (max 100); omit for all covered symbols" }, { "name": "assetClass", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "crypto", "us_equity", "perp_only" ] } }, { "name": "window", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "1m", "5m", "15m" ], "default": "5m" } }, { "name": "minBuyPressure", "in": "query", "required": false, "schema": { "type": "number", "minimum": 50, "maximum": 100, "default": 60 }, "description": "Pressure on the objective's side (sell pressure for selling objectives)" }, { "name": "minVolumeMultiple", "in": "query", "required": false, "schema": { "type": "number", "default": 1.5 }, "description": "Volume vs the symbol's own baseline" }, { "name": "minVolumeUsd", "in": "query", "required": false, "schema": { "type": "number", "default": 0 }, "description": "USD traded in the window" }, { "name": "minConfidence", "in": "query", "required": false, "schema": { "type": "number", "minimum": 0, "maximum": 100, "default": 50 } }, { "name": "minIndependentSources", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 3, "default": 1 }, "description": "Distinct sources confirming the direction" }, { "name": "include", "in": "query", "required": false, "schema": { "type": "string" }, "description": "Comma-separated: metrics, evidence, risk_factors, data_quality, track_record, market_context (default all)" }, { "name": "maxResults", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 10 } } ], "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.03", "currency": "USD" }, "responses": { "200": { "description": "Ranked opportunities", "content": { "application/json": { "schema": { "type": "object", "properties": { "objective": { "type": "string" }, "objectiveDefinition": { "type": "string" }, "window": { "type": "string" }, "asOf": { "type": "string", "format": "date-time" }, "algoVersion": { "type": "string" }, "request": { "type": "object", "description": "The request with defaults applied" }, "symbolsScanned": { "type": "integer" }, "matches": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "rank": { "type": "integer" }, "symbol": { "type": "string" }, "assetClass": { "type": "string", "enum": [ "crypto", "us_equity", "perp_only" ] }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH" ] }, "score": { "type": "integer", "minimum": 0, "maximum": 100, "description": "40 for meeting the objective + up to 20 for strength + 15 per extra confirming source +/- up to 15 for calibration (live hit rate minus 50 on >= 30 samples), - 10 per conflicting item, - 5 per HIGH risk" }, "independentSourcesConfirming": { "type": "integer" }, "confirmingSources": { "type": "array", "items": { "type": "string" } }, "price": { "type": "number" }, "signal": { "type": "string" }, "eventType": { "type": "string" }, "metrics": { "type": "object", "description": "buyPressure, momentumScore, priceChangePercent, volumeUsd, volumeMultiple, anomalyScore, activityScore, tradeCount, largeTradeCount, confidenceScore, asOf" }, "supportingEvidence": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "spot_dex_flow", "perp_positioning", "smart_money" ] }, "type": { "type": "string", "description": "buy_pressure, momentum, volume_anomaly, market_event, large_trades, long_short_open_interest, top_wallet_net_flow" }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH", "NEUTRAL", "ACTIVITY" ] }, "observedValue": {}, "unit": { "type": "string" }, "detail": { "type": "string" } } } }, "conflictingEvidence": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "spot_dex_flow", "perp_positioning", "smart_money" ] }, "type": { "type": "string", "description": "buy_pressure, momentum, volume_anomaly, market_event, large_trades, long_short_open_interest, top_wallet_net_flow" }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH", "NEUTRAL", "ACTIVITY" ] }, "observedValue": {}, "unit": { "type": "string" }, "detail": { "type": "string" } } } }, "riskFactors": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "thin_liquidity, low_confidence, bot_dominated_flow, baseline_not_ready, crowded_positioning, price_dislocation, us_market_closed, corporate_action, macro_event, conflicting_evidence, weak_signal_track_record" }, "severity": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "detail": { "type": "string" } } } }, "dataQuality": { "type": "object", "description": "sourcesAvailable, sourcesMissing, signalAgeSeconds, confidenceScore, tradeCount, baselineReady, organicSharePercent, freshPools, oracleDeviationBps" }, "signalTrackRecord1h": { "type": "object", "description": "Live 1h hit rate of this signal label over 30 days (all symbols); hitRatePercent is null below 30 evaluated signals; appliesToThisDirection says whether the signal points the same way as the result (only then it counts in the score)" }, "nextCalls": { "type": "object", "description": "Follow-up routes: preTradeCheck, positioning, smartMoney, trackRecord" }, "calibratedHitRatePercent": { "type": "number", "nullable": true, "description": "Live hit rate behind this result (signal 1h, or crowding events 4h for crowded_positioning); null below 30 samples" }, "positioningTrackRecord4h": { "type": "object", "description": "crowded_positioning only: 4h record of crowding events on this side" } } } }, "noMatchReason": { "type": "string" }, "filteredOut": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Why symbols were excluded, with counts" }, "notCovered": { "type": "array", "items": { "type": "string" } }, "marketContext": { "type": "object", "description": "regime, usMarketSession, stablecoinNetIssuance24hUsd, macroEventsNext2h" }, "method": { "type": "string" }, "disclaimer": { "type": "string" } } } } } }, "400": { "description": "Invalid request with the accepted values (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No fresh market data (not charged)" } } }, "post": { "operationId": "findOpportunitiesAgentPost", "summary": "Goal-driven opportunity scan (JSON body)", "description": "Goal-driven opportunity scan for agents. Name an objective and constraints; get ranked symbols with supporting and conflicting evidence grouped by independent source (spot_dex_flow, perp_positioning, smart_money), typed risk factors, data quality, the live 1h hit rate of the signal and the next calls to make. Deterministic, no model in the loop. Objectives: unusual_buying, unusual_selling, breakout, breakdown, crowded_positioning (direction against the crowd), smart_money_accumulation, smart_money_distribution. An empty result list is a valid answer when data is fresh (filteredOut says why); 404 (not charged) only without fresh data; 400 (not charged) lists accepted values.", "tags": [ "Agent Tools" ], "security": [ { "x402": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "objective" ], "properties": { "objective": { "type": "string", "enum": [ "unusual_buying", "unusual_selling", "breakout", "breakdown", "crowded_positioning", "smart_money_accumulation", "smart_money_distribution" ] }, "universe": { "type": "array", "items": { "type": "string" }, "maxItems": 100, "description": "Symbols to scan; omit for all covered" }, "constraints": { "type": "object", "description": "Optional; the same keys are also accepted at the top level", "properties": { "assetClass": { "type": "string", "enum": [ "crypto", "us_equity", "perp_only" ] }, "window": { "type": "string", "enum": [ "1m", "5m", "15m" ], "default": "5m" }, "minBuyPressure": { "type": "number", "minimum": 50, "maximum": 100, "default": 60, "description": "Pressure on the objective's side" }, "minVolumeMultiple": { "type": "number", "default": 1.5 }, "minVolumeUsd": { "type": "number", "default": 0 }, "minConfidence": { "type": "number", "minimum": 0, "maximum": 100, "default": 50 }, "minIndependentSources": { "type": "integer", "minimum": 1, "maximum": 3, "default": 1 } } }, "include": { "type": "array", "items": { "type": "string", "enum": [ "metrics", "evidence", "risk_factors", "data_quality", "track_record", "market_context" ] } }, "maxResults": { "type": "integer", "minimum": 1, "maximum": 50, "default": 10 } } }, "example": { "objective": "unusual_buying", "universe": [ "BTCUSD", "ETHUSD", "NVDA" ], "constraints": { "window": "15m", "minBuyPressure": 65, "minVolumeUsd": 100000, "minIndependentSources": 2 }, "include": [ "metrics", "evidence", "risk_factors", "data_quality", "track_record", "market_context" ], "maxResults": 10 } } } }, "x-payment-info": { "protocols": [ "x402" ], "pricingMode": "fixed", "price": "0.03", "currency": "USD" }, "responses": { "200": { "description": "Ranked opportunities", "content": { "application/json": { "schema": { "type": "object", "properties": { "objective": { "type": "string" }, "objectiveDefinition": { "type": "string" }, "window": { "type": "string" }, "asOf": { "type": "string", "format": "date-time" }, "algoVersion": { "type": "string" }, "request": { "type": "object", "description": "The request with defaults applied" }, "symbolsScanned": { "type": "integer" }, "matches": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "properties": { "rank": { "type": "integer" }, "symbol": { "type": "string" }, "assetClass": { "type": "string", "enum": [ "crypto", "us_equity", "perp_only" ] }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH" ] }, "score": { "type": "integer", "minimum": 0, "maximum": 100, "description": "40 for meeting the objective + up to 20 for strength + 15 per extra confirming source + 10 for a live 1h hit rate >= 55% on >= 30 samples, - 10 per conflicting item, - 5 per HIGH risk" }, "independentSourcesConfirming": { "type": "integer" }, "confirmingSources": { "type": "array", "items": { "type": "string" } }, "price": { "type": "number" }, "signal": { "type": "string" }, "eventType": { "type": "string" }, "metrics": { "type": "object", "description": "buyPressure, momentumScore, priceChangePercent, volumeUsd, volumeMultiple, anomalyScore, activityScore, tradeCount, largeTradeCount, confidenceScore, asOf" }, "supportingEvidence": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "spot_dex_flow", "perp_positioning", "smart_money" ] }, "type": { "type": "string", "description": "buy_pressure, momentum, volume_anomaly, market_event, large_trades, long_short_open_interest, top_wallet_net_flow" }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH", "NEUTRAL", "ACTIVITY" ] }, "observedValue": {}, "unit": { "type": "string" }, "detail": { "type": "string" } } } }, "conflictingEvidence": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "spot_dex_flow", "perp_positioning", "smart_money" ] }, "type": { "type": "string", "description": "buy_pressure, momentum, volume_anomaly, market_event, large_trades, long_short_open_interest, top_wallet_net_flow" }, "direction": { "type": "string", "enum": [ "BULLISH", "BEARISH", "NEUTRAL", "ACTIVITY" ] }, "observedValue": {}, "unit": { "type": "string" }, "detail": { "type": "string" } } } }, "riskFactors": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "thin_liquidity, low_confidence, bot_dominated_flow, baseline_not_ready, crowded_positioning, price_dislocation, us_market_closed, corporate_action, macro_event, conflicting_evidence, weak_signal_track_record" }, "severity": { "type": "string", "enum": [ "LOW", "MEDIUM", "HIGH" ] }, "detail": { "type": "string" } } } }, "dataQuality": { "type": "object", "description": "sourcesAvailable, sourcesMissing, signalAgeSeconds, confidenceScore, tradeCount, baselineReady, organicSharePercent, freshPools, oracleDeviationBps" }, "signalTrackRecord1h": { "type": "object", "description": "Live 1h hit rate of this signal label over 30 days (all symbols); hitRatePercent is null below 30 evaluated signals; appliesToThisDirection says whether the signal points the same way as the result (only then it counts in the score)" }, "nextCalls": { "type": "object", "description": "Follow-up routes: preTradeCheck, positioning, smartMoney, trackRecord" } } } }, "noMatchReason": { "type": "string" }, "filteredOut": { "type": "object", "additionalProperties": { "type": "integer" }, "description": "Why symbols were excluded, with counts" }, "notCovered": { "type": "array", "items": { "type": "string" } }, "marketContext": { "type": "object", "description": "regime, usMarketSession, stablecoinNetIssuance24hUsd, macroEventsNext2h" }, "method": { "type": "string" }, "disclaimer": { "type": "string" } } } } } }, "400": { "description": "Invalid request with the accepted values (not charged)" }, "402": { "description": "Payment Required" }, "404": { "description": "No fresh market data (not charged)" } } } } } }