{ "openapi": "3.1.0", "x-zeroclick-navigation": { "fullSpec": "https://agents.x402stock.xyz/openapi.json", "services": "https://agents.x402stock.xyz/services", "serviceSpecTemplate": "https://agents.x402stock.xyz/services/{slug}/openapi.json", "searchTemplate": "https://agents.x402stock.xyz/openapi.json?q={text}", "operationTemplate": "https://agents.x402stock.xyz/openapi.json?path={path}&method={method}", "firstPage": "https://agents.x402stock.xyz/openapi.json?page=1", "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ] }, "info": { "title": "x402stock", "version": "1.0.0", "description": "Market and economic data for AI agents — US stocks, ETFs and options, forex, crypto and on-chain perps, energy commodities (crude, natural gas, gasoline), US and global macro (Fed funds, CPI/PCE, jobs, GDP, Treasury debt & yields, World Bank indicators), SEC filings, congressional trades, and market sentiment. No API keys, no accounts. Pay per request in USDC via x402 or MPP. This server is a pay-per-use, transparent proxy in front of x402stock's own API: it handles identity, payment, and proxying. Agents can purchase autonomously or with their human's approval. The complete verified paid surface is listed at /openapi.json, the source of truth for available operations. Each operation here carries its live price in x-payment-info. Use the operations and details here when they meet your needs. Filtered specs contain only matching operations; if you cannot find what you need here, use search or the service catalog. The live catalog at /manifest.json is authoritative for prices and any free included units (prices[].includedUnits) - some meters include free usage per account before any charge, reserved for agents claimed by a human with a verified email.", "contact": { "email": "parthnandaniya@gmail.com" }, "x-guidance": "Start with the free seller advisor: POST https://agents.x402stock.xyz/zeroclick/agent/quote with your goal and known budget or requirements. This operation costs $0 and requires only an x402 or MPP wallet proof; it returns a guide and never executes a purchase. Without a wallet, GET https://agents.x402stock.xyz/zeroclick/agent/guide?goal=URL_ENCODED_TASK or POST to that guide. Other operations below are the direct API reference; their own prices and access requirements still apply. Call the operations listed in this document at https://agents.x402stock.xyz. Each service's full price matrix, plans, and how to buy are at https://agents.x402stock.xyz/services/{slug}; each operation's x-payment-info names the service it bills by slug (rates[].service). Slugs identify services in prices and usage reports and are never request values: when one operation serves several services, its request body schema lists the accepted values of the field that selects the service, so send one of those exactly as written. An unpaid call returns 402 Payment Required with a signed challenge; settle it with a supported payment method - x402 (Base USDC) or MPP (Tempo USDC) today - and retry with the proof attached. No upstream API key is needed, and an agent without a payment method can set one up instantly at no cost. Read GET https://agents.x402stock.xyz/manifest.json for the live services, meters, plans, prices, and any free included units, and https://agents.x402stock.xyz/llms-full.txt for the full agent guide, including how the free allowance works without funding (it requires an agent identity claimed by a human with a verified email)." }, "x-service-info": { "categories": [ "data" ], "docs": { "homepage": "https://x402stock.xyz", "apiReference": "https://agents.x402stock.xyz/openapi.json", "llms": "https://agents.x402stock.xyz/llms.txt" } }, "externalDocs": { "url": "https://agents.x402stock.xyz/llms-full.txt", "description": "How to authenticate, pay, and call this API; links the upstream API reference." }, "servers": [ { "url": "https://agents.x402stock.xyz", "description": "Pay-per-use access to x402stock's API" } ], "security": [ { "payPerUse": [] } ], "components": { "securitySchemes": { "payPerUse": { "type": "apiKey", "in": "header", "name": "x-payment", "description": "Pay-per-use access. An unpaid call returns 402 Payment Required with a signed challenge; settle it with a supported payment method (x402 or MPP today) and retry with the proof in this header (x402) or as Authorization: Payment (MPP; use ZC-Agent-Authorization for a separate buyer bearer). No upstream API key is needed, and an agent without a payment method can set one up instantly at no cost." }, "sellerAgentX402": { "type": "apiKey", "in": "header", "name": "Payment-Signature", "description": "Signed $0 x402 proof from the 402 challenge" }, "sellerAgentMpp": { "type": "http", "scheme": "Payment", "description": "Signed $0 MPP proof from the 402 challenge" } } }, "paths": { "/api/v1/aggregates/{ticker}": { "get": { "summary": "The stock price history endpoint. Returns historical OHLCV bars at the requested multiplier and timespan (minute, hour, day, week, month) between `from` and `to`. Use for price history, charting, backtesting, and trend analysis over any date range. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "bars", "count" ], "properties": { "bars": { "type": "array", "items": { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap", "trade_count", "timestamp" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_count": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "count": { "type": "number" }, "adjusted": { "type": "boolean" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "multiplier", "schema": { "type": "integer", "default": 1, "maximum": 50000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "timespan", "schema": { "enum": [ "minute", "hour", "day", "week", "month", "quarter", "year" ], "type": "string", "default": "day" } }, { "in": "query", "name": "from", "schema": { "type": "string", "default": "2025-09-22", "minLength": 1 } }, { "in": "query", "name": "to", "schema": { "type": "string", "default": "2026-09-22", "minLength": 1 } }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "sort", "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "asc" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 5000, "maximum": 50000, "exclusiveMinimum": 0 } } ], "description": "OHLC bars over any timespan and date range", "operationId": "v1_aggregates_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing query parameters for timespan and date range" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [ "Missing query parameters for from, to, timespan, multiplier" ], "pages": [ 1 ], "sourceId": "sds_ZK2ecHqWAWiyVS6dEqpau", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_35aNHJCuOgzhkS7Elas2j" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (aggregates, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "stock-quotes", "meter": "aggregates", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "aggregates", "quantity": 1 } ] } } }, "/api/v1/archive": { "get": { "summary": "Use to discover the point-in-time archive: immutable daily snapshots of ephemeral market state (Hyperliquid perps/spot, JLP pool, pre-IPO marks, market regime, squeeze scores), captured once per UTC day and never overwritten or backfilled. Lists every feed and entity with date coverage; read days via /archive/{feed} and series via /archive/{feed}/range. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "note", "count", "feeds" ], "properties": { "note": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "feeds": { "type": "array", "items": { "type": "object", "required": [ "feed", "description", "entities" ], "properties": { "feed": { "type": "string" }, "entities": { "type": "array", "items": { "type": "object", "required": [ "entity", "coverage" ], "properties": { "entity": { "type": "string" }, "coverage": { "anyOf": [ { "type": "object", "required": [ "first_date", "last_date", "days" ], "properties": { "days": { "type": "number" }, "last_date": { "type": "string" }, "first_date": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Every feed & entity with first/last capture dates", "operationId": "v1_archive", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "market-archive" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (archive, service market-archive)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "market-archive", "meter": "archive", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "market-archive", "meter": "archive", "quantity": 1 } ] } } }, "/api/v1/archive/{feed}": { "get": { "summary": "Use to read one immutable archived day of a feed (sol.jlp, hl.perps, prestocks.markets, scores.squeeze, …): the exact payload the live endpoint returned that day, plus provenance (observed/captured/ingested timestamps + a content hash proving contemporaneous capture). Defaults to latest; ?date=YYYY-MM-DD for a past day, ?entity= on multi-entity feeds. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "snapshot" ], "properties": { "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "snapshot": { "type": "object", "required": [ "feed", "entity", "observed_date", "observed_at", "captured_at", "ingested_at", "content_hash", "summary", "payload" ], "properties": { "feed": { "type": "string" }, "entity": { "type": "string" }, "payload": {}, "summary": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "captured_at": { "type": "string" }, "ingested_at": { "type": "string" }, "observed_at": { "type": "string" }, "content_hash": { "type": "string" }, "observed_date": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "feed", "schema": { "type": "string" }, "example": "xstocks.premium", "required": true, "description": "Point-in-time archive feed name (see /api/v1/archive for the catalog)." } ], "description": "Full payload + provenance (latest or ?date=)", "operationId": "v1_archive_{feed}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing documentation for date query parameter" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "market-archive" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (archive_feed, service market-archive)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "market-archive", "meter": "archive_feed", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "market-archive", "meter": "archive_feed", "quantity": 1 } ] } } }, "/api/v1/archive/{feed}/range": { "get": { "summary": "Use for time-series questions over the archive: how JLP AUM, Hyperliquid funding, a pre-IPO token premium, or a ticker's squeeze score evolved day by day. Per-day summaries (oldest first, ?from ?to ?limit, max 366) with capture provenance; payloads omitted — buy a full day via /archive/{feed}?date=. History accumulates daily and cannot be reconstructed retroactively. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "feed", "entity", "from", "to", "count", "note", "days" ], "properties": { "to": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "days": { "type": "array", "items": { "type": "object", "required": [ "observed_date", "observed_at", "captured_at", "content_hash", "summary" ], "properties": { "summary": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "captured_at": { "type": "string" }, "observed_at": { "type": "string" }, "content_hash": { "type": "string" }, "observed_date": { "type": "string" } }, "additionalProperties": false } }, "feed": { "type": "string" }, "from": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "note": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "entity": { "type": "string" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "feed", "schema": { "type": "string" }, "example": "xstocks.premium", "required": true, "description": "Point-in-time archive feed name (see /api/v1/archive for the catalog)." } ], "description": "Per-day summaries + content hashes", "operationId": "v1_archive_{feed}_range", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "market-archive" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (archive_range, service market-archive)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "market-archive", "meter": "archive_range", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "market-archive", "meter": "archive_range", "quantity": 1 } ] } } }, "/api/v1/avg-interest-rates": { "get": { "summary": "The average interest rate the US Treasury currently pays on its outstanding debt, broken out by security (Treasury Bills, Notes, Bonds, TIPS, FRNs, savings, and the marketable/total aggregates) for the latest reported month, in percent. No ticker needed. A read on the government's cost of borrowing that complements the /treasury-yields curve. Sourced from the US Treasury (FiscalData).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series", "unit", "record_date", "count", "rates" ], "properties": { "unit": { "type": "string" }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "count": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "required": [ "security_type", "security", "avg_interest_rate" ], "properties": { "security": { "type": "string" }, "security_type": { "type": "string" }, "avg_interest_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "series": { "type": "string" }, "source": { "type": "string", "const": "us_treasury" }, "record_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Average interest rate the US Treasury pays on its debt, by security type", "operationId": "v1_avg-interest-rates", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (avg_interest_rates, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "us-macro-rates", "meter": "avg_interest_rates", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "avg_interest_rates", "quantity": 1 } ] } } }, "/api/v1/backtest/{ticker}": { "get": { "summary": "Backtests a simple rule on a US stock and returns a finished report PNG. Runs an SMA crossover (?strategy=sma_cross&fast=50&slow=200) or RSI mean-reversion (?strategy=rsi_reversion&period=14&lower=30&upper=70) over daily history (?years=, max 5), no lookahead, rendered as an equity curve vs buy & hold. Returns full stats plus a hosted `artifact.png_url`. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "source", "as_of", "artifact", "strategy", "data", "disclaimer" ], "properties": { "data": { "type": "object", "required": [ "bars", "start_date", "end_date", "initial_capital", "strategy", "buy_hold", "trades" ], "properties": { "bars": { "type": "number" }, "trades": { "type": "object", "required": [ "count", "win_rate_percent", "avg_return_percent", "best_percent", "worst_percent", "list" ], "properties": { "list": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ] } } }, "count": { "type": "number" }, "best_percent": { "type": "number" }, "worst_percent": { "type": "number" }, "win_rate_percent": { "type": "number" }, "avg_return_percent": { "type": "number" } }, "additionalProperties": false }, "buy_hold": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strategy": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "initial_capital": { "type": "number" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "artifact": { "type": "object", "required": [ "id", "url", "format", "expires_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "format": { "type": "string", "const": "png" }, "expires_at": { "type": "string" } }, "additionalProperties": false }, "strategy": { "type": "object", "required": [ "kind", "label", "params" ], "properties": { "kind": { "type": "string" }, "label": { "type": "string" }, "params": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } } }, "additionalProperties": false }, "disclaimer": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "strategy", "schema": { "enum": [ "sma_cross", "rsi_reversion" ], "type": "string", "default": "sma_cross" } }, { "in": "query", "name": "fast", "schema": { "type": "integer", "default": 50, "maximum": 200, "exclusiveMinimum": 0 } }, { "in": "query", "name": "slow", "schema": { "type": "integer", "default": 200, "maximum": 400, "exclusiveMinimum": 0 } }, { "in": "query", "name": "period", "schema": { "type": "integer", "default": 14, "maximum": 100, "exclusiveMinimum": 0 } }, { "in": "query", "name": "lower", "schema": { "type": "number", "default": 30, "maximum": 99, "minimum": 1 } }, { "in": "query", "name": "upper", "schema": { "type": "number", "default": 70, "maximum": 99, "minimum": 1 } }, { "in": "query", "name": "years", "schema": { "type": "number", "default": 3, "maximum": 5, "exclusiveMinimum": 0 } }, { "in": "query", "name": "capital", "schema": { "type": "number", "default": 10000, "maximum": 1000000000, "exclusiveMinimum": 0 } } ], "description": "Strategy backtest rendered as an equity-curve PNG report (vs buy & hold) you get a URL to", "operationId": "v1_backtest_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "screeners-scores-research" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "500000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.500000 per request (backtest, service screeners-scores-research)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.500000" }, "rates": [ { "service": "screeners-scores-research", "meter": "backtest", "unit": "request", "unitSize": 1, "priceUsd": "0.500000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "screeners-scores-research", "meter": "backtest", "quantity": 1 } ] } } }, "/api/v1/basis": { "get": { "summary": "Scans every US stock that also trades as a 24/7 synthetic perp and returns the gap: official (delayed) price, prev close, perp mark and oracle, funding APR, open interest, and computed `basis_percent` + `basis_vs_prev_close_percent` — the implied overnight move while the US market is shut. Widest dislocation first, plus a plain-English `reading`. `?limit=`, `?min_basis=`. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue_map", "us_market_open", "reading", "method", "count", "rows", "sections", "note", "total_available" ], "properties": { "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rows": { "type": "array", "items": { "type": "object", "required": [ "ticker", "equity_price", "equity_prev_close", "equity_change_percent", "equity_as_of", "perp_symbol", "perp_mark", "perp_oracle", "perp_funding_apr_percent", "perp_open_interest", "perp_day_volume_usd", "basis_percent", "basis_absolute", "basis_vs_prev_close_percent", "direction", "comparable", "excluded_reason" ], "properties": { "ticker": { "type": "string" }, "direction": { "enum": [ "premium", "discount", "flat", "unknown" ], "type": "string" }, "perp_mark": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comparable": { "type": "boolean" }, "perp_oracle": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perp_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "equity_as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "equity_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "basis_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "basis_absolute": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "excluded_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "equity_prev_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perp_open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perp_day_volume_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "equity_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perp_funding_apr_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "basis_vs_prev_close_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "as_of": { "type": "string" }, "count": { "type": "number" }, "method": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "reading": { "type": "string" }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "enum": [ "ok", "unavailable" ], "type": "string" } }, "venue_map": { "type": "object", "required": [ "equity", "perp" ], "properties": { "perp": { "type": "string" }, "equity": { "type": "string" } }, "additionalProperties": false }, "us_market_open": { "type": "boolean" }, "total_available": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "min_basis", "schema": { "type": "number", "default": 0, "maximum": 100, "minimum": 0 } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 40, "maximum": 200, "exclusiveMinimum": 0 } } ], "description": "Where every cross-listed stock trades 24/7 vs its official price", "operationId": "v1_basis", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "50000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.050000 per request (basis, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.050000" }, "rates": [ { "service": "stock-quotes", "meter": "basis", "unit": "request", "unitSize": 1, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "basis", "quantity": 1 } ] } } }, "/api/v1/basis/{ticker}": { "get": { "summary": "One stock priced on every rail at once: its official US listing (delayed, closed overnight) against the 24/7 Hyperliquid HIP-3 synthetic perp. Returns both prices, funding APR, open interest, and the gap as `basis_percent` + `basis_vs_prev_close_percent` — while the US market is shut, the live view of where the name reopens. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue_map", "us_market_open", "reading", "method", "count", "rows", "sections", "note" ], "properties": { "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "rows": { "type": "array", "items": { "type": "object", "required": [ "ticker", "equity_price", "equity_prev_close", "equity_change_percent", "equity_as_of", "perp_symbol", "perp_mark", "perp_oracle", "perp_funding_apr_percent", "perp_open_interest", "perp_day_volume_usd", "basis_percent", "basis_absolute", "basis_vs_prev_close_percent", "direction", "comparable", "excluded_reason" ], "properties": { "ticker": { "type": "string" }, "direction": { "enum": [ "premium", "discount", "flat", "unknown" ], "type": "string" }, "perp_mark": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "comparable": { "type": "boolean" }, "perp_oracle": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perp_symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "equity_as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "equity_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "basis_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "basis_absolute": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "excluded_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "equity_prev_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perp_open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perp_day_volume_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "equity_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "perp_funding_apr_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "basis_vs_prev_close_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "as_of": { "type": "string" }, "count": { "type": "number" }, "method": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "reading": { "type": "string" }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "enum": [ "ok", "unavailable" ], "type": "string" } }, "venue_map": { "type": "object", "required": [ "equity", "perp" ], "properties": { "perp": { "type": "string" }, "equity": { "type": "string" } }, "additionalProperties": false }, "us_market_open": { "type": "boolean" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "24/7 price vs the official listing", "operationId": "v1_basis_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (basis_ticker, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "stock-quotes", "meter": "basis_ticker", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "basis_ticker", "quantity": 1 } ] } } }, "/api/v1/beneficial-ownership/{ticker}": { "get": { "summary": "Schedule 13D/13G filings — triggered when a holder crosses 5% of a class — disclosing beneficial-ownership and activist stakes in a US-listed company, from SEC EDGAR. Per filing: the reporting person, filer-reported percent of class (can be <5% if held via derivatives), shares, voting/dispositive power, and (for 13D) the activist intent. `?type=13D|13G|all`, `?limit=` max 25. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "cik", "company", "filings_parsed", "count", "filings" ], "properties": { "cik": { "type": "string" }, "count": { "type": "number" }, "company": { "type": "string" }, "filings": { "type": "array", "items": { "type": "object", "required": [ "schedule", "form", "is_amendment", "filing_date", "accession", "url", "structured", "issuer_name", "cusip", "security_class", "event_date", "purpose", "reporting_persons" ], "properties": { "url": { "type": "string" }, "form": { "type": "string" }, "cusip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "purpose": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "schedule": { "enum": [ "13D", "13G" ], "type": "string" }, "accession": { "type": "string" }, "event_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "structured": { "type": "boolean" }, "filing_date": { "type": "string" }, "issuer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_amendment": { "type": "boolean" }, "security_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reporting_persons": { "type": "array", "items": { "type": "object", "required": [ "reporting_person", "citizenship", "percent_of_class", "aggregate_shares_owned", "sole_voting_power", "shared_voting_power", "sole_dispositive_power", "shared_dispositive_power", "type_of_reporting_person", "type_of_reporting_person_label" ], "properties": { "citizenship": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "percent_of_class": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "reporting_person": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sole_voting_power": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shared_voting_power": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "aggregate_shares_owned": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sole_dispositive_power": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shared_dispositive_power": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "type_of_reporting_person": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type_of_reporting_person_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } }, "filings_parsed": { "type": "number" } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "type", "schema": { "enum": [ "13D", "13G", "all" ], "type": "string", "default": "all" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 5, "maximum": 25, "exclusiveMinimum": 0 } } ], "description": "Schedule 13D/13G beneficial-ownership & activist stakes filed on a company (5%+ trigger)", "operationId": "v1_beneficial-ownership_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (beneficial_ownership, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sec-filings", "meter": "beneficial_ownership", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "beneficial_ownership", "quantity": 1 } ] } } }, "/api/v1/calendar": { "get": { "summary": "Upcoming US economic data releases — WHEN the market-moving prints land, not just their latest values. Returns curated high-importance releases (CPI, PPI, PCE, jobs, JOLTS, GDP, retail sales, housing starts, industrial production) within `?days=` (default 30, max 90), each with date and category, plus the next FOMC meeting. `?past=true` includes the last week. Release dates from FRED.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "window_days", "from", "to", "count", "releases", "fomc", "attribution" ], "properties": { "to": { "type": "string" }, "fomc": { "type": "object", "required": [ "next_meeting", "days_until" ], "properties": { "days_until": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "next_meeting": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "from": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "fred" }, "releases": { "type": "array", "items": { "type": "object", "required": [ "release_id", "name", "category", "date" ], "properties": { "date": { "type": "string" }, "name": { "type": "string" }, "category": { "type": "string" }, "release_id": { "type": "number" } }, "additionalProperties": false } }, "attribution": { "type": "string" }, "window_days": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "days", "schema": { "type": "integer", "default": 30, "maximum": 90, "exclusiveMinimum": 0 } }, { "in": "query", "name": "past", "schema": { "enum": [ "true", "false" ], "type": "string", "default": "false" } } ], "description": "Upcoming US economic data releases + next FOMC meeting", "operationId": "v1_calendar", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (calendar, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "us-macro-rates", "meter": "calendar", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "calendar", "quantity": 1 } ] } } }, "/api/v1/calendar/fomc": { "get": { "summary": "The full FOMC meeting schedule (2025–2027) with the last and next meeting and days-until. Each entry carries the two-day meeting's start and decision date, year, and past/upcoming status. No ticker needed — the rate-decision calendar every macro-aware agent plans around. Source: U.S. Federal Reserve. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "last_meeting", "next_meeting", "count", "meetings", "attribution" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "federal_reserve" }, "meetings": { "type": "array", "items": { "type": "object", "required": [ "start_date", "date", "year", "status" ], "properties": { "date": { "type": "string" }, "year": { "type": "number" }, "status": { "type": "string" }, "start_date": { "type": "string" } }, "additionalProperties": false } }, "attribution": { "type": "string" }, "last_meeting": { "anyOf": [ { "type": "object", "required": [ "date", "days_ago" ], "properties": { "date": { "type": "string" }, "days_ago": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "next_meeting": { "anyOf": [ { "type": "object", "required": [ "date", "days_until" ], "properties": { "date": { "type": "string" }, "days_until": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "FOMC meeting schedule with last & next meeting and days-until", "operationId": "v1_calendar_fomc", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (calendar_fomc, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "us-macro-rates", "meter": "calendar_fomc", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "calendar_fomc", "quantity": 1 } ] } } }, "/api/v1/clinical-trials": { "get": { "summary": "Clinical trials run by a company, from ClinicalTrials.gov, newest first. Pass `?sponsor=Vertex Pharmaceuticals` (required) plus `?limit=` (max 100). Each trial carries NCT id, title, status, phase(s), study type, conditions, enrollment, lead sponsor, and start/completion/update dates with a link. A primary biotech catalyst. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "sponsor", "total_matched", "count", "trials", "attribution" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "clinicaltrials_gov" }, "trials": { "type": "array", "items": { "type": "object", "required": [ "nct_id", "title", "status", "phases", "study_type", "conditions", "enrollment", "lead_sponsor", "sponsor_class", "start_date", "primary_completion_date", "completion_date", "last_update", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "nct_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phases": { "type": "array", "items": { "type": "string" } }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "conditions": { "type": "array", "items": { "type": "string" } }, "enrollment": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "study_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_update": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "lead_sponsor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sponsor_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "completion_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_completion_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "sponsor": { "type": "string" }, "attribution": { "type": "string" }, "total_matched": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "sponsor", "schema": { "type": "string", "maxLength": 120, "minLength": 2 } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "Clinical trials sponsored by a company (ClinicalTrials.gov)", "operationId": "v1_clinical-trials", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing ticker parameter documentation" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "fda-trials-patents" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (clinical_trials, service fda-trials-patents)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "fda-trials-patents", "meter": "clinical_trials", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "fda-trials-patents", "meter": "clinical_trials", "quantity": 1 } ] } } }, "/api/v1/company-facts/{ticker}": { "get": { "summary": "Every XBRL financial fact a company has reported to the SEC, each collapsed to its latest value: tag, taxonomy, label, unit, the figure, and the period/form/filing it came from. Filter with `?taxonomy=us-gaap|dei`, `?search=revenue`, and `?limit=`. Discover which metrics exist for a ticker before drilling into the full series via /concept. Sourced from SEC EDGAR. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "entity_name", "cik", "taxonomy", "search", "total_facts", "count", "facts" ], "properties": { "cik": { "type": "string" }, "count": { "type": "number" }, "facts": { "type": "array", "items": { "type": "object", "required": [ "tag", "taxonomy", "label", "unit", "latest_value", "end", "fiscal_year", "fiscal_period", "form", "filed" ], "properties": { "end": { "type": "string" }, "tag": { "type": "string" }, "form": { "type": "string" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filed": { "type": "string" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxonomy": { "type": "string" }, "fiscal_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_value": { "type": "number" }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "search": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "taxonomy": { "type": "string" }, "entity_name": { "type": "string" }, "total_facts": { "type": "number" } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "taxonomy", "schema": { "type": "string" } }, { "in": "query", "name": "search", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 500, "exclusiveMinimum": 0 } } ], "description": "Every reported financial fact for a company, latest value each, straight from SEC XBRL", "operationId": "v1_company-facts_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (company_facts, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sec-filings", "meter": "company_facts", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "company_facts", "quantity": 1 } ] } } }, "/api/v1/compare": { "get": { "summary": "Compare 2 to 3 US-listed stocks side by side (peer or watchlist comparisons). Pass a comma-separated list via `?tickers=AAPL,MSFT,NVDA` (1 to 3 symbols). Returns price and day change, market cap, P/E, EPS, revenue, gross and net margins, and dividend yield per ticker. Built for multiple stocks — for a single stock, `/api/v1/quote/{ticker}` is cheaper. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "tickers", "rows" ], "properties": { "note": { "type": "string" }, "rows": { "type": "array", "items": { "type": "object", "required": [ "ticker", "name", "price", "change_percent", "market_cap", "pe_ratio", "eps", "revenue", "gross_margin_percent", "net_margin_percent", "dividend_yield_percent", "available" ], "properties": { "eps": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pe_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "available": { "type": "string" }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "net_margin_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gross_margin_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "dividend_yield_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "tickers": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "tickers", "schema": { "type": "string" } } ], "description": "Compare 2 to 3 stocks side by side: price, P/E, market cap, margins, yield", "operationId": "v1_compare", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing ticker parameters" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "50000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.050000 per request (compare, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.050000" }, "rates": [ { "service": "company-fundamentals", "meter": "compare", "unit": "request", "unitSize": 1, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "compare", "quantity": 1 } ] } } }, "/api/v1/concept/{ticker}": { "get": { "summary": "The reported time series of one XBRL financial concept (e.g. Revenues, Assets, NetIncomeLoss) for a company, taken directly from its SEC filings. Pass the tag via `?tag=` and optionally `?taxonomy=` (default us-gaap) and `?limit=`. Each point carries the value, period, fiscal year/quarter, source form, and accession. Use for precise, filing-grade fundamentals and quant time series. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "tag", "taxonomy", "label", "unit", "count", "series" ], "properties": { "tag": { "type": "string" }, "unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "count": { "type": "number" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "series": { "type": "array", "items": { "type": "object", "required": [ "value", "start", "end", "fiscal_year", "fiscal_period", "form", "filed", "frame", "accession" ], "properties": { "end": { "type": "string" }, "form": { "type": "string" }, "filed": { "type": "string" }, "frame": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "type": "number" }, "accession": { "type": "string" }, "fiscal_year": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "taxonomy": { "type": "string" } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "tag", "schema": { "type": "string" } }, { "in": "query", "name": "taxonomy", "schema": { "type": "string", "default": "us-gaap" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 8, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "Time series of a single XBRL financial fact straight from SEC filings", "operationId": "v1_concept_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (concept, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sec-filings", "meter": "concept", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "concept", "quantity": 1 } ] } } }, "/api/v1/conditions": { "get": { "summary": "Reference catalog of trade/quote condition codes (the numeric `conditions` seen on trades) with names, types, data types, and SIP mappings. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "conditions" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "conditions": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "name", "data_types", "sip_mapping" ], "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "type": { "type": "string" }, "data_types": { "type": "array", "items": { "type": "string" } }, "sip_mapping": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 1000, "exclusiveMinimum": 0 } } ], "description": "Trade & quote condition codes reference", "operationId": "v1_conditions", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (conditions, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "conditions", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "conditions", "quantity": 1 } ] } } }, "/api/v1/congress-trades": { "get": { "summary": "Recent stock trades disclosed by US members of Congress under the STOCK Act, parsed live from official House and Senate Periodic Transaction Reports: per trade the member, chamber, ticker, asset, buy/sell type, date, and disclosed dollar range. ?chamber=house|senate|both, ?ticker=AAPL, ?limit= recent filings per chamber (max 20). From US House & Senate. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "chamber", "disclosure", "trade_count", "trades" ], "properties": { "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "enum": [ "us_house", "us_senate", "us_congress" ], "type": "string" }, "trades": { "type": "array", "items": { "type": "object", "required": [ "chamber", "member", "state", "district", "filing_date", "doc_id", "pdf_url", "asset", "ticker", "asset_type", "owner", "transaction_type", "transaction_code", "transaction_date", "notification_date", "amount_range", "amount_min", "amount_max" ], "properties": { "asset": { "type": "string" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "state": { "type": "string" }, "doc_id": { "type": "string" }, "member": { "type": "string" }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "chamber": { "enum": [ "house", "senate" ], "type": "string" }, "pdf_url": { "type": "string" }, "district": { "type": "string" }, "amount_max": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "amount_min": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "asset_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "type": "string" }, "amount_range": { "type": "string" }, "transaction_code": { "type": "string" }, "transaction_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "transaction_type": { "type": "string" }, "notification_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "chamber": { "enum": [ "house", "senate", "both" ], "type": "string" }, "disclosure": { "type": "string" }, "trade_count": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 7, "maximum": 20, "exclusiveMinimum": 0 } }, { "in": "query", "name": "ticker", "schema": { "type": "string", "maxLength": 10, "minLength": 1 } }, { "in": "query", "name": "chamber", "schema": { "enum": [ "house", "senate", "both" ], "type": "string", "default": "house" } } ], "description": "US congressional stock trades (House & Senate) from STOCK Act disclosures", "operationId": "v1_congress-trades", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "government-policy" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (congress_trades, service government-policy)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "government-policy", "meter": "congress_trades", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "government-policy", "meter": "congress_trades", "quantity": 1 } ] } } }, "/api/v1/cot": { "get": { "summary": "The weekly CFTC Commitments of Traders positioning across major futures markets in one call: for each market the open interest, non-commercial (large speculator) net position and weekly change, and commercial (hedger) net position. Covers equity indices, gold/silver, crude/natural gas, major FX, the 10-year note, and bitcoin. No ticker needed. Sourced from the US CFTC. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "report", "markets", "attribution" ], "properties": { "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "report": { "type": "string" }, "source": { "type": "string", "const": "cftc" }, "markets": { "type": "array", "items": { "type": "object", "required": [ "market", "contract_code", "name", "group", "report_date", "open_interest", "open_interest_change", "noncommercial_net", "noncommercial_net_change", "commercial_net" ], "properties": { "name": { "type": "string" }, "group": { "enum": [ "equity_index", "metals", "energy", "fx", "rates", "crypto" ], "type": "string" }, "market": { "type": "string" }, "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contract_code": { "type": "string" }, "open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "commercial_net": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "noncommercial_net": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open_interest_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "noncommercial_net_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "attribution": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Commitments of Traders snapshot: net futures positioning across major markets", "operationId": "v1_cot", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (cot, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sentiment-positioning", "meter": "cot", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "cot", "quantity": 1 } ] } } }, "/api/v1/cot/{market}": { "get": { "summary": "CFTC Commitments of Traders for one futures market by slug: sp500, nasdaq, gold, silver, crude-oil, natural-gas, euro, british-pound, japanese-yen, swiss-franc, us-dollar-index, 10y-note, bitcoin. Returns open interest and non-commercial, commercial, and non-reportable long/short/net with weekly changes plus net history. `?weeks=` 12 (max 52). From the US CFTC. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "market", "contract_code", "name", "group", "latest", "history", "report", "attribution" ], "properties": { "name": { "type": "string" }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "group": { "enum": [ "equity_index", "metals", "energy", "fx", "rates", "crypto" ], "type": "string" }, "latest": { "anyOf": [ { "type": "object", "required": [ "report_date", "open_interest", "open_interest_change", "noncommercial", "commercial", "nonreportable", "total_traders" ], "properties": { "commercial": { "type": "object", "required": [ "long", "short", "net", "long_change", "short_change" ], "properties": { "net": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "long": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "short": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "long_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "short_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "noncommercial": { "type": "object", "required": [ "long", "short", "spreading", "net", "long_change", "short_change" ], "properties": { "net": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "long": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "short": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "spreading": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "long_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "short_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "nonreportable": { "type": "object", "required": [ "long", "short", "net" ], "properties": { "net": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "long": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "short": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_traders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open_interest_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "market": { "type": "string" }, "report": { "type": "string" }, "source": { "type": "string", "const": "cftc" }, "history": { "type": "array", "items": { "type": "object", "required": [ "report_date", "open_interest", "noncommercial_net", "commercial_net" ], "properties": { "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "commercial_net": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "noncommercial_net": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "attribution": { "type": "string" }, "contract_code": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "market", "schema": { "type": "string" }, "example": "gold", "required": true, "description": "CFTC Commitments-of-Traders market/commodity name." }, { "in": "query", "name": "weeks", "schema": { "type": "integer", "default": 12, "maximum": 52, "exclusiveMinimum": 0 } } ], "description": "Commitments of Traders for one futures market", "operationId": "v1_cot_{market}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (cot_market, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "sentiment-positioning", "meter": "cot_market", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "cot_market", "quantity": 1 } ] } } }, "/api/v1/crypto/{pair}/aggregates": { "get": { "summary": "Historical OHLCV bars for a major-coin crypto spot pair at the requested multiplier and timespan (minute, hour, day, week, month) between `from` and `to`. Pass the pair in the path as BASE-QUOTE, e.g. BTC-USD or ETH-USD. Aggregated centralized-market spot — for Hyperliquid-listed token spot use /api/v1/spot, for perps use /api/v1/perps. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "bars", "count" ], "properties": { "bars": { "type": "array", "items": { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap", "trade_count", "timestamp" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_count": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "count": { "type": "number" }, "adjusted": { "type": "boolean" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "pair", "schema": { "type": "string" }, "example": "EUR-USD", "required": true, "description": "Currency or crypto spot pair as BASE-QUOTE, e.g. EUR-USD or BTC-USD." }, { "in": "query", "name": "multiplier", "schema": { "type": "integer", "default": 1, "maximum": 50000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "timespan", "schema": { "enum": [ "minute", "hour", "day", "week", "month", "quarter", "year" ], "type": "string", "default": "day" } }, { "in": "query", "name": "from", "schema": { "type": "string", "default": "2025-09-22", "minLength": 1 } }, { "in": "query", "name": "to", "schema": { "type": "string", "default": "2026-09-22", "minLength": 1 } }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "sort", "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "asc" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 5000, "maximum": 50000, "exclusiveMinimum": 0 } } ], "description": "Historical OHLCV bars for a major-coin crypto spot pair at the requested multiplier and timespan between from and to.", "operationId": "v1_crypto_{pair}_aggregates", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing documentation for query parameters 'from', 'to', 'timespan', and 'multiplier' mentioned in description." ], "pages": [ 1 ], "sourceId": "sds_-OaGKRnSF6kITO7eykLAd", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_KYxwGS1EuQ4-n3d1oc6uB" }, { "gaps": [ "Missing query parameters for timespan and date range" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (crypto_aggregates, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "crypto-perps", "meter": "crypto_aggregates", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "crypto_aggregates", "quantity": 1 } ] } } }, "/api/v1/crypto/{pair}/open-close": { "get": { "summary": "The official UTC open and close price for a crypto spot pair on a given date. Pass the pair in the path as BASE-QUOTE, e.g. BTC-USD, and the date via `?date=YYYY-MM-DD` (required). Crypto trades 24/7, so this is the UTC-day open/close. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "date", "open", "close" ], "properties": { "date": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "open": { "type": "number" }, "close": { "type": "number" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "pair", "schema": { "type": "string" }, "example": "EUR-USD", "required": true, "description": "Currency or crypto spot pair as BASE-QUOTE, e.g. EUR-USD or BTC-USD." }, { "in": "query", "name": "date", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "required": true } ], "description": "The official UTC open and close price for a crypto spot pair on a given date.", "operationId": "v1_crypto_{pair}_open-close", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_-OaGKRnSF6kITO7eykLAd", "authority": "supplemental", "conflicts": [ "/summary", "/parameters/query/date/schema/format", "/operationId" ], "revisionId": "sdrn_KYxwGS1EuQ4-n3d1oc6uB" }, { "gaps": [ "Missing date parameter documentation" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (crypto_open_close, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crypto-perps", "meter": "crypto_open_close", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "crypto_open_close", "quantity": 1 } ] } } }, "/api/v1/crypto/{pair}/prev-close": { "get": { "summary": "Crypto trades 24/7, so there is no session close: this returns the previous UTC calendar day's full OHLCV candle (00:00–24:00 UTC) for a spot pair — open, high, low, close, volume, and VWAP. Pass the pair in the path as BASE-QUOTE, e.g. BTC-USD. One call returns yesterday's daily bar. From x402stock, a pay-per-call market & economic data API. Pay per request in USDC via x402, no API key.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "anyOf": [ { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap", "trade_count", "timestamp" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "type": "string" }, "trade_count": { "type": "number" } } }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "pair", "schema": { "type": "string" }, "example": "EUR-USD", "required": true, "description": "Currency or crypto spot pair as BASE-QUOTE, e.g. EUR-USD or BTC-USD." } ], "description": "Returns the previous UTC calendar day's full OHLCV candle (00:00–24:00 UTC) for a spot pair.", "operationId": "v1_crypto_{pair}_prev-close", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_-OaGKRnSF6kITO7eykLAd", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_KYxwGS1EuQ4-n3d1oc6uB" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (crypto_prev_close, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crypto-perps", "meter": "crypto_prev_close", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "crypto_prev_close", "quantity": 1 } ] } } }, "/api/v1/dividend-calendar": { "get": { "summary": "Market-wide dividend calendar (no ticker needed). Per row: ticker, ex-dividend / record / pay / declaration dates, cash amount per share, currency, type, payments-per-year `frequency` + `frequency_label` (quarterly, monthly, weekly, one-time), and computed `annualized_amount`. Upcoming payments first. Filter `?from=`/`?to=` on ex-date, `?ticker=`, `?frequency=`, `?order=`, `?limit=`.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "dividends" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "dividends": { "type": "array", "items": { "type": "object", "required": [ "ticker", "ex_dividend_date", "pay_date", "record_date", "declaration_date", "cash_amount", "currency", "dividend_type", "frequency", "frequency_label", "annualized_amount" ], "properties": { "ticker": { "type": "string" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pay_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "frequency": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cash_amount": { "type": "number" }, "record_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dividend_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "frequency_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declaration_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ex_dividend_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "annualized_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "from", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "in": "query", "name": "to", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "in": "query", "name": "ticker", "schema": { "type": "string", "maxLength": 16 } }, { "in": "query", "name": "frequency", "schema": { "type": "integer", "maximum": 52, "minimum": 0 } }, { "in": "query", "name": "order", "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "asc" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 1000, "exclusiveMinimum": 0 } } ], "operationId": "v1_dividend-calendar", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (dividend_calendar, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "company-fundamentals", "meter": "dividend_calendar", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "dividend_calendar", "quantity": 1 } ] } } }, "/api/v1/dividends/{ticker}": { "get": { "summary": "Historical cash dividends for a ticker: amount, currency, type, frequency, and the declaration / ex-dividend / record / pay dates. Most recent first. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "dividends" ], "properties": { "count": { "type": "number" }, "dividends": { "type": "array", "items": { "type": "object", "required": [ "cash_amount", "currency", "dividend_type", "frequency", "declaration_date", "ex_dividend_date", "record_date", "pay_date" ], "properties": { "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pay_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "frequency": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cash_amount": { "type": "number" }, "record_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dividend_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "declaration_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ex_dividend_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 1000, "exclusiveMinimum": 0 } } ], "operationId": "v1_dividends_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (dividends, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "dividends", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "dividends", "quantity": 1 } ] } } }, "/api/v1/dossier/{ticker}": { "get": { "summary": "A company's recent SEC disclosure picture in one call: the filings index, insider transactions from Form 4 with a net buy/sell signal, material 8-K events by item code, and initial holdings from Form 3. The CIK is resolved once and shared across sections (faster than four separate calls), at a lower combined price. From SEC EDGAR; sections degrade independently. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "source", "as_of", "sections", "filings", "insider_trades", "material_events", "form_3" ], "properties": { "as_of": { "type": "string" }, "form_3": { "anyOf": [ { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "filings_parsed", "holding_count", "holdings" ], "properties": { "holdings": { "type": "array", "items": { "type": "object", "required": [ "owner_name", "is_director", "is_officer", "officer_title", "is_ten_percent_owner", "filing_date", "accession", "url", "security", "shares", "direct_or_indirect", "nature_of_ownership", "is_derivative", "exercise_price", "exercise_date", "expiration_date", "underlying_security", "underlying_shares" ], "properties": { "url": { "type": "string" }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "security": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accession": { "type": "string" }, "is_officer": { "type": "boolean" }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "type": "string" }, "is_director": { "type": "boolean" }, "exercise_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_derivative": { "type": "boolean" }, "officer_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "exercise_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "expiration_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "underlying_shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "direct_or_indirect": { "anyOf": [ { "enum": [ "D", "I" ], "type": "string" }, { "type": "null" } ] }, "nature_of_ownership": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "underlying_security": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_ten_percent_owner": { "type": "boolean" } }, "additionalProperties": false } }, "holding_count": { "type": "number" }, "filings_parsed": { "type": "number" } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "filings": { "anyOf": [ { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "cik", "company", "count", "filings" ], "properties": { "cik": { "type": "string" }, "count": { "type": "number" }, "company": { "type": "string" }, "filings": { "type": "array", "items": { "type": "object", "required": [ "form", "accession", "filing_date", "report_date", "description", "items", "primary_document", "url" ], "properties": { "url": { "type": "string" }, "form": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "accession": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "type": "string" }, "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_document": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "insider_trades": { "anyOf": [ { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "filings_parsed", "transaction_count", "summary", "transactions" ], "properties": { "summary": { "type": "object", "required": [ "buys", "sells", "shares_bought", "shares_sold", "net_shares", "signal" ], "properties": { "buys": { "type": "number" }, "sells": { "type": "number" }, "signal": { "enum": [ "net_buying", "net_selling", "neutral" ], "type": "string" }, "net_shares": { "type": "number" }, "shares_sold": { "type": "number" }, "shares_bought": { "type": "number" } }, "additionalProperties": false }, "transactions": { "type": "array", "items": { "type": "object", "required": [ "owner_name", "is_director", "is_officer", "officer_title", "is_ten_percent_owner", "filing_date", "accession", "url", "security", "transaction_date", "code", "code_label", "shares", "price_per_share", "acquired_disposed", "shares_owned_after", "is_derivative" ], "properties": { "url": { "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "security": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accession": { "type": "string" }, "code_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_officer": { "type": "boolean" }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "type": "string" }, "is_director": { "type": "boolean" }, "is_derivative": { "type": "boolean" }, "officer_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transaction_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "acquired_disposed": { "anyOf": [ { "enum": [ "A", "D" ], "type": "string" }, { "type": "null" } ] }, "shares_owned_after": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "is_ten_percent_owner": { "type": "boolean" } }, "additionalProperties": false } }, "filings_parsed": { "type": "number" }, "transaction_count": { "type": "number" } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "material_events": { "anyOf": [ { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "events" ], "properties": { "count": { "type": "number" }, "events": { "type": "array", "items": { "type": "object", "required": [ "form", "accession", "filing_date", "report_date", "url", "items" ], "properties": { "url": { "type": "string" }, "form": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "code", "label" ], "properties": { "code": { "type": "string" }, "label": { "type": "string" } }, "additionalProperties": false } }, "accession": { "type": "string" }, "filing_date": { "type": "string" }, "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "operationId": "v1_dossier_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "50000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.050000 per request (dossier, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.050000" }, "rates": [ { "service": "sec-filings", "meter": "dossier", "unit": "request", "unitSize": 1, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "dossier", "quantity": 1 } ] } } }, "/api/v1/energy": { "get": { "summary": "Every energy benchmark in one call: WTI and Brent crude oil spot, Henry Hub natural gas spot, and US regular retail gasoline — each with its latest price, prior reading, and change. The catalog's commodities feed (no equity/forex/crypto endpoint carries these). For one benchmark with history use /api/v1/energy/{product}. Source: U.S. Energy Information Administration (EIA). From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series", "products", "attribution" ], "properties": { "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "series": { "type": "string" }, "source": { "type": "string", "const": "eia" }, "products": { "type": "array", "items": { "type": "object", "required": [ "product", "series_id", "name", "unit", "eia_units", "frequency", "latest", "prior", "change", "change_percent" ], "properties": { "name": { "type": "string" }, "unit": { "type": "string" }, "prior": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "product": { "type": "string" }, "eia_units": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "frequency": { "type": "string" }, "series_id": { "type": "string" }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "attribution": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "operationId": "v1_energy", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "global-fx-commodities" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (energy, service global-fx-commodities)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "global-fx-commodities", "meter": "energy", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "global-fx-commodities", "meter": "energy", "quantity": 1 } ] } } }, "/api/v1/energy/{product}": { "get": { "summary": "Price history for one energy benchmark — `wti` (WTI crude, $/bbl), `brent` (Brent crude, $/bbl), `natural-gas` (Henry Hub, $/MMBtu), or `gasoline` (US regular retail, $/gal) — with the latest value, prior reading, change, and recent history. Tune with `?limit=` (default 30, max 365). The catalog's commodities feed. Source: U.S. Energy Information Administration (EIA). From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "product", "series_id", "name", "unit", "eia_units", "frequency", "latest", "prior", "change", "change_percent", "source", "as_of", "history", "attribution" ], "properties": { "name": { "type": "string" }, "unit": { "type": "string" }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prior": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "eia" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "product": { "type": "string" }, "eia_units": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "frequency": { "type": "string" }, "series_id": { "type": "string" }, "attribution": { "type": "string" }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "product", "schema": { "type": "string" }, "example": "wti", "required": true, "description": "Energy benchmark slug: wti, brent, natural-gas, or gasoline." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 30, "maximum": 365, "exclusiveMinimum": 0 } } ], "operationId": "v1_energy_{product}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "global-fx-commodities" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (energy_product, service global-fx-commodities)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "global-fx-commodities", "meter": "energy_product", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "global-fx-commodities", "meter": "energy_product", "quantity": 1 } ] } } }, "/api/v1/events/{ticker}": { "get": { "summary": "Timeline of corporate events for a ticker, such as ticker symbol changes, with the company name, CIK, and composite FIGI. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "name", "composite_figi", "cik", "events" ], "properties": { "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "events": { "type": "array", "items": { "type": "object", "required": [ "type", "date", "ticker" ], "properties": { "date": { "type": "string" }, "type": { "type": "string" }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "composite_figi": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "operationId": "v1_events_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (events, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "events", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "events", "quantity": 1 } ] } } }, "/api/v1/exchange-rates": { "get": { "summary": "Official US Treasury reporting rates of exchange — government FX reference rates for ~170 currencies, in units of foreign currency per 1 USD, for the latest quarter. Use for accounting-grade and exotic-currency conversion the market /api/v1/forex feed lacks. Filter with `?currency=Euro`. Updated quarterly. From the US Treasury (FiscalData). From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series", "note", "record_date", "count", "rates" ], "properties": { "note": { "type": "string" }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "count": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "required": [ "country", "currency", "country_currency", "exchange_rate", "effective_date" ], "properties": { "country": { "type": "string" }, "currency": { "type": "string" }, "exchange_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "effective_date": { "type": "string" }, "country_currency": { "type": "string" } }, "additionalProperties": false } }, "series": { "type": "string" }, "source": { "type": "string", "const": "us_treasury" }, "record_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "currency", "schema": { "type": "string", "maxLength": 64, "minLength": 1 } } ], "operationId": "v1_exchange-rates", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "global-fx-commodities" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (exchange_rates, service global-fx-commodities)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "global-fx-commodities", "meter": "exchange_rates", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "global-fx-commodities", "meter": "exchange_rates", "quantity": 1 } ] } } }, "/api/v1/exchanges": { "get": { "summary": "Reference list of US equity exchanges and market centers with names, MICs, operating MICs, and SIP participant IDs. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "exchanges" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "exchanges": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "name", "acronym", "mic", "operating_mic", "participant_id", "url" ], "properties": { "id": { "type": "number" }, "mic": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "type": { "type": "string" }, "acronym": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "operating_mic": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "participant_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "operationId": "v1_exchanges", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (exchanges, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "exchanges", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "exchanges", "quantity": 1 } ] } } }, "/api/v1/fails-to-deliver/{ticker}": { "get": { "summary": "Settlement fails-to-deliver for a US-listed stock from the SEC's semi-monthly data: the aggregate shares that failed to deliver on each settlement date, with the reference price, most recent first. A niche short-pressure and squeeze signal. ?limit= records (default 30). Sourced from SEC EDGAR. From x402stock, a pay-per-call market & economic data API. Pay per request in USDC via x402, no API key.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "symbol", "periods_read", "count", "note", "fails" ], "properties": { "note": { "type": "string" }, "as_of": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "count": { "type": "number" }, "fails": { "type": "array", "items": { "type": "object", "required": [ "settlement_date", "cusip", "symbol", "fails", "description", "price" ], "properties": { "cusip": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fails": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "symbol": { "type": "string" }, "description": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "settlement_date": { "type": "string" } }, "additionalProperties": false } }, "source": { "type": "string", "const": "sec_edgar" }, "symbol": { "type": "string" }, "periods_read": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 30, "maximum": 120, "exclusiveMinimum": 0 } }, { "in": "query", "name": "periods", "schema": { "type": "integer", "default": 2, "maximum": 6, "exclusiveMinimum": 0 } } ], "description": "Settlement fails-to-deliver for a US-listed stock from the SEC's semi-monthly data: the aggregate shares that failed to deliver on each settlement date, with the reference price, most recent first.", "operationId": "v1_fails-to-deliver_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_JCTvCfOjjIdw0XzdqbOif", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/count/type", "/responses/200/content/application/json/schema/properties/periods_read/type", "/parameters/query/limit/required", "/operationId" ], "revisionId": "sdrn_z5ju9Tpei8xwj_T7L8zQA" } ], "x-zeroclick-services": [ "options-short-interest" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (fails_to_deliver, service options-short-interest)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "options-short-interest", "meter": "fails_to_deliver", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "options-short-interest", "meter": "fails_to_deliver", "quantity": 1 } ] } } }, "/api/v1/fda": { "get": { "summary": "FDA catalysts for a pharma/biotech/medtech company, from openFDA. Pass `?company=Medtronic` (required) plus `?limit=` (max 50). Returns `drug` (recalls + approvals) and `device` (510(k) clearances, PMA approvals, recalls) sections, each with recent items, match totals, and official FDA links. One call across 5 FDA datasets. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "company", "drug", "device", "attribution" ], "properties": { "drug": { "type": "object", "required": [ "recalls", "approvals" ], "properties": { "recalls": { "type": "object", "required": [ "total_matched", "count", "items" ], "properties": { "count": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "required": [ "date", "status", "classification", "product_type", "product_description", "reason", "firm", "recall_number", "voluntary_mandated" ], "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "firm": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "product_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recall_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "classification": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "voluntary_mandated": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "product_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "total_matched": { "type": "number" } }, "additionalProperties": false }, "approvals": { "type": "object", "required": [ "total_matched", "count", "items" ], "properties": { "count": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "required": [ "application_number", "sponsor", "approval_date", "brand_names", "active_ingredients", "dosage_form", "route", "submission_class", "review_priority", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "route": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sponsor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brand_names": { "type": "array", "items": { "type": "string" } }, "dosage_form": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "approval_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "review_priority": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "submission_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active_ingredients": { "type": "array", "items": { "type": "string" } }, "application_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "total_matched": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "as_of": { "type": "string" }, "device": { "type": "object", "required": [ "clearances", "approvals", "recalls" ], "properties": { "recalls": { "type": "object", "required": [ "total_matched", "count", "items" ], "properties": { "count": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "required": [ "date", "status", "classification", "product_type", "product_description", "reason", "firm", "recall_number", "voluntary_mandated" ], "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "firm": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "product_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recall_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "classification": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "voluntary_mandated": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "product_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "total_matched": { "type": "number" } }, "additionalProperties": false }, "approvals": { "type": "object", "required": [ "total_matched", "count", "items" ], "properties": { "count": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "required": [ "pma_number", "supplement_number", "trade_name", "generic_name", "decision_date", "decision_code", "supplement_type", "advisory_committee", "product_code", "applicant", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "applicant": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pma_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "generic_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "product_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "decision_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "decision_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "supplement_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "supplement_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advisory_committee": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "total_matched": { "type": "number" } }, "additionalProperties": false }, "clearances": { "type": "object", "required": [ "total_matched", "count", "items" ], "properties": { "count": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "required": [ "k_number", "device_name", "decision", "decision_date", "clearance_type", "product_code", "advisory_committee", "date_received", "applicant", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "decision": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "k_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "applicant": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "device_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "product_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date_received": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "decision_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "clearance_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "advisory_committee": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "total_matched": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "source": { "type": "string", "const": "fda" }, "company": { "type": "string" }, "attribution": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "company", "schema": { "type": "string", "maxLength": 120, "minLength": 2 }, "required": true }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 50, "exclusiveMinimum": 0 } } ], "operationId": "v1_fda", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing ticker parameter documentation" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "fda-trials-patents" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (fda, service fda-trials-patents)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "fda-trials-patents", "meter": "fda", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "fda-trials-patents", "meter": "fda", "quantity": 1 } ] } } }, "/api/v1/fda/shortages": { "get": { "summary": "Current and resolved US drug shortages from openFDA, newest update first. Optional `?company=Pfizer` narrows to one manufacturer (omit for market-wide); `?limit=` (max 100). Each carries the generic name, company, status, therapeutic category, dosage form, presentation, posting/update dates, and reason. A supply-side catalyst for generic makers. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "company", "total_matched", "count", "shortages", "attribution" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "fda" }, "company": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shortages": { "type": "array", "items": { "type": "object", "required": [ "generic_name", "company_name", "status", "therapeutic_category", "dosage_form", "presentation", "posted_date", "updated_date", "update_type", "reason" ], "properties": { "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dosage_form": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "posted_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "update_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "generic_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "presentation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "therapeutic_category": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } }, "attribution": { "type": "string" }, "total_matched": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "company", "schema": { "type": "string", "maxLength": 120, "minLength": 2 } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 100, "exclusiveMinimum": 0 } } ], "operationId": "v1_fda_shortages", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "fda-trials-patents" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (fda_shortages, service fda-trials-patents)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "fda-trials-patents", "meter": "fda_shortages", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "fda-trials-patents", "meter": "fda_shortages", "quantity": 1 } ] } } }, "/api/v1/fear-greed": { "get": { "summary": "The current US stock-market Fear & Greed index (0–100, CNN-style) with its sentiment rating and all five weighted components — volatility, momentum, put/call, safe-haven demand, junk-bond demand — each with value, weight, and reading. Includes the last 30 days of scores and a backtest of S&P 500 forward returns by sentiment zone. A one-call read of market mood. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "index", "score", "rating", "components", "recent", "backtest" ], "properties": { "as_of": { "type": "string" }, "index": { "type": "string", "const": "us_stock" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recent": { "type": "array", "items": { "type": "object", "required": [ "date", "score" ], "properties": { "date": { "type": "string" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "source": { "type": "string", "const": "x402stock" }, "backtest": { "type": "array", "items": { "type": "object", "required": [ "zone", "label", "entries", "periods" ], "properties": { "zone": { "type": "string" }, "label": { "type": "string" }, "entries": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "periods": { "type": "array", "items": { "type": "object", "required": [ "period", "avg_return_percent", "win_rate_percent", "best_percent", "worst_percent", "samples" ], "properties": { "period": { "type": "string" }, "samples": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "best_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "worst_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "win_rate_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avg_return_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } }, "components": { "type": "array", "items": { "type": "object", "required": [ "name", "value", "weight", "description", "detail" ], "properties": { "name": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "detail": { "type": "string" }, "weight": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "operationId": "v1_fear-greed", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (fear_greed, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sentiment-positioning", "meter": "fear_greed", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "fear_greed", "quantity": 1 } ] } } }, "/api/v1/fear-greed/crypto": { "get": { "summary": "The Crypto Fear & Greed index (0–100) with its rating, alongside the US stock Fear & Greed score for comparison, current BTC and ETH prices with 24h change, and ~90 days of crypto sentiment history. Pass `?days=N` to size the history. The crypto-sentiment companion to /api/v1/fear-greed (stocks). From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "crypto", "stock", "prices", "history" ], "properties": { "as_of": { "type": "string" }, "stock": { "type": "object", "required": [ "score" ], "properties": { "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "crypto": { "type": "object", "required": [ "score", "rating" ], "properties": { "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "prices": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "required": [ "price", "change", "change_percent" ], "properties": { "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "source": { "type": "string", "const": "x402stock" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "score" ], "properties": { "date": { "type": "string" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "days", "schema": { "type": "integer", "default": 90, "maximum": 3650, "exclusiveMinimum": 0 } } ], "operationId": "v1_fear-greed_crypto", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (fear_greed_crypto, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "sentiment-positioning", "meter": "fear_greed_crypto", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "fear_greed_crypto", "quantity": 1 } ] } } }, "/api/v1/fear-greed/history": { "get": { "summary": "The full daily history of the US stock Fear & Greed index from 2016 to today, each point a date and 0–100 score. Pass `?days=N` to return only the most recent N days (default: full series). Use for charting sentiment regimes and backtesting against price. Companion to /api/v1/fear-greed (current reading). From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "index", "count", "history" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "index": { "type": "string", "const": "us_stock" }, "source": { "type": "string", "const": "x402stock" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "score" ], "properties": { "date": { "type": "string" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "days", "schema": { "type": "integer", "maximum": 10000, "exclusiveMinimum": 0 } } ], "operationId": "v1_fear-greed_history", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (fear_greed_history, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sentiment-positioning", "meter": "fear_greed_history", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "fear_greed_history", "quantity": 1 } ] } } }, "/api/v1/fear-greed/liquidity": { "get": { "summary": "US net liquidity (Fed balance sheet minus Treasury General Account minus reverse repo) as a 0–100 percentile with its label and 4-week trend, broken into its FRED components (WALCL, TGA, RRP, M2) plus ~52 weeks of history. A macro-liquidity gauge for risk appetite. Complements the /api/v1/fed-funds and other FRED macro endpoints. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "score", "rating", "net_liquidity_usd_trillions", "trend_4w_usd_trillions", "trend_label", "components", "history" ], "properties": { "as_of": { "type": "string" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rating": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "x402stock" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "net_usd_trillions" ], "properties": { "date": { "type": "string" }, "net_usd_trillions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "components": { "type": "array", "items": { "type": "object", "required": [ "name", "value_usd_trillions", "date", "fred_series", "mom_percent" ], "properties": { "date": { "type": "string" }, "name": { "type": "string" }, "fred_series": { "type": "string" }, "mom_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value_usd_trillions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "trend_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trend_4w_usd_trillions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "net_liquidity_usd_trillions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "weeks", "schema": { "type": "integer", "default": 52, "maximum": 520, "exclusiveMinimum": 0 } } ], "operationId": "v1_fear-greed_liquidity", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (fear_greed_liquidity, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "sentiment-positioning", "meter": "fear_greed_liquidity", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "fear_greed_liquidity", "quantity": 1 } ] } } }, "/api/v1/fear-greed/regime": { "get": { "summary": "The combined market regime — one read fusing the stock Fear & Greed score and velocity, VIX, insider-buying sentiment, and net liquidity into a named regime (e.g. Mixed Signals) with severity and a suggested stance, plus how the S&P 500 historically performed after similar regimes (forward 5/22-day and 1/3-month returns and win rates). From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "regime", "current", "history" ], "properties": { "as_of": { "type": "string" }, "regime": { "type": "object", "required": [ "id", "name", "severity", "description", "action" ], "properties": { "id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "action": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "severity": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "source": { "type": "string", "const": "x402stock" }, "current": { "type": "object", "required": [ "fg_score", "fg_zone", "velocity", "vix", "vix_level", "insider_score", "insider_label", "liquidity_score", "liquidity_label" ], "properties": { "vix": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fg_zone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fg_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "velocity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "vix_level": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "insider_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "insider_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "liquidity_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "liquidity_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "history": { "type": "object", "required": [ "episodes", "avg_forward_5d_percent", "avg_forward_22d_percent", "avg_spy_1m_percent", "avg_spy_3m_percent", "win_rate_1m_percent", "win_rate_3m_percent" ], "properties": { "episodes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avg_spy_1m_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avg_spy_3m_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "win_rate_1m_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "win_rate_3m_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avg_forward_5d_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "avg_forward_22d_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "operationId": "v1_fear-greed_regime", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (fear_greed_regime, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sentiment-positioning", "meter": "fear_greed_regime", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "fear_greed_regime", "quantity": 1 } ] } } }, "/api/v1/fed-funds": { "get": { "summary": "The effective federal funds rate — the Fed's benchmark policy rate that anchors every other US interest rate — as a monthly average in percent, with the latest value, prior month, month-over-month and year-over-year change, and recent history. No ticker needed. The rate every rate-sensitive analysis starts from. Sourced from the St. Louis Fed (FRED). From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series_id", "title", "unit", "frequency", "latest", "prior", "change", "change_percent", "yoy_percent", "history" ], "properties": { "unit": { "type": "string" }, "as_of": { "type": "string" }, "prior": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "fred" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "frequency": { "type": "string" }, "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "operationId": "v1_fed-funds", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (fed_funds, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "us-macro-rates", "meter": "fed_funds", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "fed_funds", "quantity": 1 } ] } } }, "/api/v1/filing-search": { "get": { "summary": "Full-text search across every SEC EDGAR filing since 2001. Find filings mentioning a keyword or exact phrase via ?q=, narrow by ?forms=10-K,8-K, ?ticker=, and ?startdt=/?enddt= dates, and cap with ?limit=. Returns each match's form, filer, date, and a link to the document. Sourced from SEC EDGAR. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "query", "forms", "ticker", "total_matches", "count", "results" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "forms": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "query": { "type": "string" }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "results": { "type": "array", "items": { "type": "object", "required": [ "accession", "form", "filing_date", "period_ending", "filer", "cik", "description", "url" ], "properties": { "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "form": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accession": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "period_ending": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "total_matches": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "minLength": 1 }, "required": true }, { "in": "query", "name": "forms", "schema": { "type": "string" } }, { "in": "query", "name": "ticker", "schema": { "type": "string" } }, { "in": "query", "name": "startdt", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "in": "query", "name": "enddt", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 100, "exclusiveMinimum": 0 } } ], "operationId": "v1_filing-search", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (filing_search, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sec-filings", "meter": "filing_search", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "filing_search", "quantity": 1 } ] } } }, "/api/v1/filings/{ticker}": { "get": { "summary": "List a company's recent SEC EDGAR filings sourced directly from the SEC: form type, filing and report dates, the 8-K item codes, and a direct link to each primary document. Filter to a single form with `?type=10-K` (also 10-Q, 8-K, 4, etc.) and cap with `?limit=`. Use as the index into a company's disclosures before fetching or summarizing a specific filing. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "cik", "company", "count", "filings" ], "properties": { "cik": { "type": "string" }, "count": { "type": "number" }, "company": { "type": "string" }, "filings": { "type": "array", "items": { "type": "object", "required": [ "form", "accession", "filing_date", "report_date", "description", "items", "primary_document", "url" ], "properties": { "url": { "type": "string" }, "form": { "type": "string" }, "items": { "type": "array", "items": { "type": "string" } }, "accession": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "type": "string" }, "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_document": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "type", "schema": { "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "SEC filing history for a company: 10-K, 10-Q, 8-K, Form 4, and more", "operationId": "v1_filings_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (filings, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "sec-filings", "meter": "filings", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "filings", "quantity": 1 } ] } } }, "/api/v1/filing-summary/{ticker}": { "get": { "summary": "Fetches a company's latest 10-K, 10-Q, or 8-K from SEC EDGAR and returns a structured JSON summary: a plain-language overview, the key risk factors, MD&A highlights, any forward guidance, and an overall sentiment label. Choose the document with `?type=10-K` (also 10-Q, 8-K). Built for agents that need the substance of a filing without parsing hundreds of pages of HTML. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "form", "accession", "filing_date", "report_date", "filing_url", "summary", "business_overview", "risk_factors", "mda_highlights", "guidance", "sentiment" ], "properties": { "form": { "type": "string" }, "summary": { "type": "string" }, "guidance": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accession": { "type": "string" }, "sentiment": { "anyOf": [ { "enum": [ "positive", "neutral", "negative" ], "type": "string" }, { "type": "null" } ] }, "filing_url": { "type": "string" }, "filing_date": { "type": "string" }, "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "risk_factors": { "type": "array", "items": { "type": "string" } }, "mda_highlights": { "type": "array", "items": { "type": "string" } }, "business_overview": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "type", "schema": { "enum": [ "10-K", "10-Q", "8-K" ], "type": "string", "default": "10-K" } } ], "description": "AI-structured summary of a 10-K, 10-Q, or 8-K: overview, risk factors, MD&A, guidance", "operationId": "v1_filing-summary_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (filing_summary, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "sec-filings", "meter": "filing_summary", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "filing_summary", "quantity": 1 } ] } } }, "/api/v1/financials/{ticker}": { "get": { "summary": "Per-period financial statements (income statement, balance sheet, cash flow, comprehensive income) sourced from SEC filings, flattened to fact_key → value maps. Pass `?timeframe=annual|quarterly|ttm` and `?limit=`. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "reports" ], "properties": { "count": { "type": "number" }, "reports": { "type": "array", "items": { "type": "object", "required": [ "company_name", "cik", "timeframe", "fiscal_period", "fiscal_year", "start_date", "end_date", "filing_date", "source_filing_url", "statements" ], "properties": { "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timeframe": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "statements": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "filing_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fiscal_year": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "company_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source_filing_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "timeframe", "schema": { "enum": [ "annual", "quarterly", "ttm" ], "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 4, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "Fundamentals: income, balance sheet, and cash flow statements", "operationId": "v1_financials_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (financials, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "company-fundamentals", "meter": "financials", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "financials", "quantity": 1 } ] } } }, "/api/v1/float/{ticker}": { "get": { "summary": "Free float for a ticker — the share count genuinely available to trade, net of insider, strategic and restricted holdings — plus `free_float_percent` (0-100), the derived `restricted_percent`, and the `effective_date`. The correct denominator for squeeze and liquidity work: short interest as a percentage of float, not of shares outstanding. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "free_float", "free_float_percent", "restricted_percent", "effective_date", "note" ], "properties": { "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "free_float": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "effective_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "free_float_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "restricted_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Free float: shares actually available to trade", "operationId": "v1_float_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (float, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "float", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "float", "quantity": 1 } ] } } }, "/api/v1/forex/{pair}/aggregates": { "get": { "summary": "Historical OHLCV bars for a foreign-exchange pair at the requested multiplier and timespan (minute, hour, day, week, month) between `from` and `to`. Pass the pair in the path as BASE-QUOTE, e.g. EUR-USD or USD-JPY. Use for FX charting, backtesting, and macro/rate analysis. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "bars", "count" ], "properties": { "bars": { "type": "array", "items": { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap", "trade_count", "timestamp" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_count": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "count": { "type": "number" }, "adjusted": { "type": "boolean" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "pair", "schema": { "type": "string" }, "example": "EUR-USD", "required": true, "description": "Currency or crypto spot pair as BASE-QUOTE, e.g. EUR-USD or BTC-USD." }, { "in": "query", "name": "multiplier", "schema": { "type": "integer", "default": 1, "maximum": 50000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "timespan", "schema": { "enum": [ "minute", "hour", "day", "week", "month", "quarter", "year" ], "type": "string", "default": "day" } }, { "in": "query", "name": "from", "schema": { "type": "string", "default": "2025-09-22", "minLength": 1 } }, { "in": "query", "name": "to", "schema": { "type": "string", "default": "2026-09-22", "minLength": 1 } }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "sort", "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "asc" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 5000, "maximum": 50000, "exclusiveMinimum": 0 } } ], "description": "Forex price history: OHLC bars for a currency pair over any timespan and date range", "operationId": "v1_forex_{pair}_aggregates", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [ "Missing query parameters for 'from', 'to', 'timespan', and 'multiplier' which are implied by the description but not explicitly defined in the schema." ], "pages": [ 1 ], "sourceId": "sds_O1hw4cnnp1zVw17N8vLhI", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_X89HzNFoUrpaOcjmE8UOE" } ], "x-zeroclick-services": [ "global-fx-commodities" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (forex_aggregates, service global-fx-commodities)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "global-fx-commodities", "meter": "forex_aggregates", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "global-fx-commodities", "meter": "forex_aggregates", "quantity": 1 } ] } } }, "/api/v1/forex/{pair}/prev-close": { "get": { "summary": "Open, high, low, close, volume, and VWAP for a foreign-exchange pair's most recent completed trading day. Pass the pair in the path as BASE-QUOTE, e.g. EUR-USD. One call returns one bar for a quick prior-close reference. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "anyOf": [ { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap", "trade_count", "timestamp" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "type": "string" }, "trade_count": { "type": "number" } } }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "pair", "schema": { "type": "string" }, "example": "EUR-USD", "required": true, "description": "Currency or crypto spot pair as BASE-QUOTE, e.g. EUR-USD or BTC-USD." } ], "description": "Previous day OHLC bar for a currency pair", "operationId": "v1_forex_{pair}_prev-close", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_O1hw4cnnp1zVw17N8vLhI", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_X89HzNFoUrpaOcjmE8UOE" } ], "x-zeroclick-services": [ "global-fx-commodities" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (forex_prev_close, service global-fx-commodities)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "global-fx-commodities", "meter": "forex_prev_close", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "global-fx-commodities", "meter": "forex_prev_close", "quantity": 1 } ] } } }, "/api/v1/form-144": { "get": { "summary": "Market-wide recent Form 144 insider intent-to-sell notices across all US issuers — who is filing to sell, before the Form 4 confirms it. Per notice: ticker, issuer, insider, shares to be sold, aggregate market value, and approximate sale date. Tune the window with `?days=` (max 90) or `?startdt`/`?enddt`, and `?limit=` (max 50). Proposed sales, not executed. From SEC EDGAR. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "start_date", "end_date", "total_matches", "count", "notices" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "sec_edgar" }, "notices": { "type": "array", "items": { "type": "object", "required": [ "ticker", "issuer", "issuer_cik", "insider_name", "relationships", "security", "shares_to_be_sold", "aggregate_market_value", "approx_sale_date", "filing_date", "accession", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "security": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accession": { "type": "string" }, "issuer_cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "insider_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "relationships": { "type": "array", "items": { "type": "string" } }, "approx_sale_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares_to_be_sold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "aggregate_market_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "end_date": { "type": "string" }, "start_date": { "type": "string" }, "total_matches": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "days", "schema": { "type": "integer", "default": 14, "maximum": 90, "exclusiveMinimum": 0 } }, { "in": "query", "name": "startdt", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "in": "query", "name": "enddt", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 50, "exclusiveMinimum": 0 } } ], "description": "Market-wide recent insider intent-to-sell notices (SEC Form 144) across all issuers", "operationId": "v1_form-144", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (form_144_feed, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sec-filings", "meter": "form_144_feed", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "form_144_feed", "quantity": 1 } ] } } }, "/api/v1/form-144/{ticker}": { "get": { "summary": "Insider intent-to-sell notices (SEC Form 144) for one US-listed company — the leading indicator that front-runs the Form 4. Per notice: the insider and relationship, shares to be sold, aggregate market value, approximate sale date, broker, shares outstanding, and any sales in the past 3 months. A PROPOSED sale, not an executed trade. `?limit=` max 25. From SEC EDGAR. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "filings_parsed", "count", "notices" ], "properties": { "count": { "type": "number" }, "notices": { "type": "array", "items": { "type": "object", "required": [ "filing_date", "accession", "form", "url", "structured", "insider_name", "relationships", "security", "broker", "shares_to_be_sold", "aggregate_market_value", "shares_outstanding", "approx_sale_date", "exchange", "notice_date", "acquisitions", "sold_past_3_months" ], "properties": { "url": { "type": "string" }, "form": { "type": "string" }, "broker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "security": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accession": { "type": "string" }, "structured": { "type": "boolean" }, "filing_date": { "type": "string" }, "notice_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "acquisitions": { "type": "array", "items": { "type": "object", "required": [ "security", "acquired_date", "nature_of_acquisition", "amount_acquired" ], "properties": { "security": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "acquired_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount_acquired": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nature_of_acquisition": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "insider_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "relationships": { "type": "array", "items": { "type": "string" } }, "approx_sale_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares_to_be_sold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sold_past_3_months": { "type": "array", "items": { "type": "object", "required": [ "seller", "sale_date", "shares_sold", "gross_proceeds" ], "properties": { "seller": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sale_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares_sold": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gross_proceeds": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "aggregate_market_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "filings_parsed": { "type": "number" } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 5, "maximum": 25, "exclusiveMinimum": 0 } } ], "description": "Insider intent-to-sell notices (SEC Form 144) for a company — leads the Form 4", "operationId": "v1_form-144_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (form_144, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sec-filings", "meter": "form_144", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "form_144", "quantity": 1 } ] } } }, "/api/v1/form-3/{ticker}": { "get": { "summary": "Initial beneficial-ownership holdings parsed from SEC Form 3 filings, the first report an insider files on becoming a director, officer, or 10% holder. Each holding carries the security, shares owned, direct or indirect ownership, and derivative terms. Complements Form 4 transactions. ?limit= filings (default 5). Sourced from SEC EDGAR. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "filings_parsed", "holding_count", "holdings" ], "properties": { "holdings": { "type": "array", "items": { "type": "object", "required": [ "owner_name", "is_director", "is_officer", "officer_title", "is_ten_percent_owner", "filing_date", "accession", "url", "security", "shares", "direct_or_indirect", "nature_of_ownership", "is_derivative", "exercise_price", "exercise_date", "expiration_date", "underlying_security", "underlying_shares" ], "properties": { "url": { "type": "string" }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "security": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accession": { "type": "string" }, "is_officer": { "type": "boolean" }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "type": "string" }, "is_director": { "type": "boolean" }, "exercise_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_derivative": { "type": "boolean" }, "officer_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "exercise_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "expiration_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "underlying_shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "direct_or_indirect": { "anyOf": [ { "enum": [ "D", "I" ], "type": "string" }, { "type": "null" } ] }, "nature_of_ownership": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "underlying_security": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_ten_percent_owner": { "type": "boolean" } }, "additionalProperties": false } }, "holding_count": { "type": "number" }, "filings_parsed": { "type": "number" } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 5, "maximum": 25, "exclusiveMinimum": 0 } } ], "description": "Initial insider ownership from SEC Form 3: holdings reported when an insider role begins", "operationId": "v1_form-3_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (form_3, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sec-filings", "meter": "form_3", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "form_3", "quantity": 1 } ] } } }, "/api/v1/frames": { "get": { "summary": "One reported XBRL financial fact for every company that disclosed it in a calendar period, for peer screening. Pass ?tag= (e.g. Revenues), ?period= (CY2024, CY2024Q1, or CY2024Q1I for balance-sheet facts), ?taxonomy= (default us-gaap), ?unit= (default USD), and ?limit=. Sorted by value. Sourced from SEC EDGAR. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "tag", "taxonomy", "label", "unit", "period", "total_filers", "count", "data" ], "properties": { "tag": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "required": [ "cik", "entity", "value", "start", "end", "accession" ], "properties": { "cik": { "type": "string" }, "end": { "type": "string" }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "type": "number" }, "entity": { "type": "string" }, "accession": { "type": "string" } }, "additionalProperties": false } }, "unit": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "period": { "type": "string" }, "source": { "type": "string", "const": "sec_edgar" }, "taxonomy": { "type": "string" }, "total_filers": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "tag", "schema": { "type": "string", "minLength": 1 }, "required": true }, { "in": "query", "name": "period", "schema": { "type": "string", "pattern": "^CY\\d{4}(Q[1-4]I?)?$" }, "required": true }, { "in": "query", "name": "taxonomy", "schema": { "type": "string", "default": "us-gaap" } }, { "in": "query", "name": "unit", "schema": { "type": "string", "default": "USD" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 500, "exclusiveMinimum": 0 } } ], "description": "Compare one financial metric across every public company for a single period", "operationId": "v1_frames", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (frames, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sec-filings", "meter": "frames", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "frames", "quantity": 1 } ] } } }, "/api/v1/fred/{series}": { "get": { "summary": "Pull a key market-signal macro series from the Federal Reserve (FRED) by slug: vix, yield-curve-10y-2y, yield-curve-10y-3m, high-yield-spread, ig-spread, breakeven-10y, real-yield-10y, jobless-claims, consumer-sentiment, mortgage-30y, financial-conditions, recession-probability. Each returns the latest value, prior, change, year-over-year, and recent history. No ticker needed. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series_id", "title", "unit", "frequency", "latest", "prior", "change", "change_percent", "yoy_percent", "history" ], "properties": { "unit": { "type": "string" }, "as_of": { "type": "string" }, "prior": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "fred" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "frequency": { "type": "string" }, "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "series", "schema": { "type": "string" }, "example": "DGS10", "required": true, "description": "FRED series ID, e.g. DGS10 (10-year Treasury) or VIXCLS." } ], "description": "Key market-signal macro series from the Fed (FRED): VIX, yield-curve & credit spreads, breakevens, jobless claims, sentiment, mortgage rate, recession odds", "operationId": "v1_fred_{series}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (fred, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "us-macro-rates", "meter": "fred", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "fred", "quantity": 1 } ] } } }, "/api/v1/full-market-snapshot": { "get": { "summary": "Current state of every US-listed ticker in a single call: price, day change and percent change, volume, and VWAP per symbol. The base layer for building a screener or scanning the whole market without iterating ticker by ticker. Optional `?tickers=AAPL,MSFT` to narrow and `?include_otc=true` to add OTC names. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "tickers" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "tickers": { "type": "array", "items": { "type": "object", "required": [ "ticker", "price", "change", "change_percent", "volume", "vwap", "updated" ], "properties": { "vwap": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "volume": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "updated": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "change_percent": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "tickers", "schema": { "type": "string", "minLength": 1 }, "description": "Comma-separated list of tickers to narrow the scope." }, { "in": "query", "name": "include_otc", "schema": { "type": "boolean" }, "description": "Include OTC names." } ], "description": "Whole-market snapshot: every US ticker's current price and day change in one call", "operationId": "v1_full-market-snapshot", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ga1phPv9S6kEqxFH_JwZ9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/count/type", "/parameters/query/tickers/required", "/parameters/query/include_otc/required", "/description", "/operationId" ], "revisionId": "sdrn_6bMLTumuFfzdUgYpYp2fw" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "40000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.040000 per request (full_market_snapshot, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.040000" }, "rates": [ { "service": "stock-quotes", "meter": "full_market_snapshot", "unit": "request", "unitSize": 1, "priceUsd": "0.040000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "full_market_snapshot", "quantity": 1 } ] } } }, "/api/v1/fund-holdings/{cik}": { "get": { "summary": "The latest 13F-HR institutional holdings for a fund or investment manager, looked up by its SEC CIK. Returns every reported position with issuer, CUSIP, market value, share count, option type, and voting authority, plus the portfolio's total value, sorted largest first. ?limit= positions. Sourced from SEC EDGAR. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "cik", "filer", "source", "as_of", "data" ], "properties": { "cik": { "type": "string" }, "data": { "type": "object", "required": [ "form", "accession", "filing_date", "report_date", "total_positions", "total_value", "count", "holdings" ], "properties": { "form": { "type": "string" }, "count": { "type": "number" }, "holdings": { "type": "array", "items": { "type": "object", "required": [ "issuer", "title_of_class", "cusip", "value", "shares", "shares_type", "put_call", "investment_discretion", "voting_sole", "voting_shared", "voting_none" ], "properties": { "cusip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "issuer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "put_call": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "voting_none": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "voting_sole": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "voting_shared": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "title_of_class": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "investment_discretion": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "accession": { "type": "string" }, "filing_date": { "type": "string" }, "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "total_value": { "type": "number" }, "total_positions": { "type": "number" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "filer": { "type": "string" }, "source": { "type": "string", "const": "sec_edgar" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "cik", "schema": { "type": "string" }, "example": "0001067983", "required": true, "description": "SEC Central Index Key (CIK) of the fund or investment manager." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 100, "maximum": 1000, "exclusiveMinimum": 0 } } ], "description": "Institutional 13F holdings for a fund by CIK: every position, value, and shares", "operationId": "v1_fund-holdings_{cik}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (fund_holdings, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "sec-filings", "meter": "fund_holdings", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "fund_holdings", "quantity": 1 } ] } } }, "/api/v1/fund-nport/{fund}": { "get": { "summary": "What's inside an ETF or mutual fund, from its latest SEC N-PORT filing. Pass an ETF/fund ticker (SPY, ARKK) or CIK in the path. Returns the registrant, net/total assets, report date, and every portfolio holding by value — name, CUSIP, ISIN, shares, USD value, % of net assets, asset/issuer class, country. `?limit=` (max 500). Fund composition the 13F feed doesn't cover. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "cik", "registrant", "source", "as_of", "data" ], "properties": { "cik": { "type": "string" }, "data": { "type": "object", "required": [ "series_name", "series_id", "form", "accession", "filing_date", "report_date", "report_period_end", "total_assets", "total_liabilities", "net_assets", "total_positions", "count", "holdings" ], "properties": { "form": { "type": "string" }, "count": { "type": "number" }, "holdings": { "type": "array", "items": { "type": "object", "required": [ "name", "title", "cusip", "isin", "lei", "balance", "units", "currency", "value_usd", "pct_value", "payoff_profile", "asset_category", "issuer_category", "country" ], "properties": { "lei": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "isin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cusip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "units": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "balance": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pct_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "value_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "asset_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "payoff_profile": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issuer_category": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "accession": { "type": "string" }, "series_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "net_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "filing_date": { "type": "string" }, "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "series_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "total_assets": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_positions": { "type": "number" }, "report_period_end": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "total_liabilities": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "sec_edgar" }, "registrant": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "fund", "schema": { "type": "string" }, "example": "SPY", "required": true, "description": "Fund identifier (SEC CIK or ticker) for the N-PORT holdings lookup." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 500, "exclusiveMinimum": 0 } } ], "description": "What's inside an ETF or fund: full N-PORT portfolio holdings", "operationId": "v1_fund-nport_{fund}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (fund_nport, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "sec-filings", "meter": "fund_nport", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "fund_nport", "quantity": 1 } ] } } }, "/api/v1/gainers": { "get": { "summary": "The day's biggest percentage gainers across US equities, with current and previous-day OHLCV per ticker. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "direction", "count", "tickers" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "tickers": { "type": "array", "items": { "type": "object", "required": [ "ticker", "change", "change_percent", "updated" ], "properties": { "day": { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" } }, "additionalProperties": false }, "change": { "type": "number" }, "ticker": { "type": "string" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "previous_day": { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" } }, "additionalProperties": false }, "change_percent": { "type": "number" } }, "additionalProperties": false } }, "direction": { "enum": [ "gainers", "losers" ], "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "The day's biggest percentage gainers across US equities, with current and previous-day OHLCV per ticker.", "operationId": "v1_gainers", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_4aPQussadcqCAv-3qhzcF", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/count/type", "/operationId" ], "revisionId": "sdrn_PGgAX-ZuG63A6PyPg5gyb" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (gainers, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "stock-quotes", "meter": "gainers", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "gainers", "quantity": 1 } ] } } }, "/api/v1/gdp": { "get": { "summary": "US real Gross Domestic Product, quarterly, in billions of chained 2017 dollars (seasonally adjusted annual rate), with the latest reading, prior quarter, quarter-over-quarter and year-over-year change, and recent history. No ticker needed. The broad measure of economic output for macro-aware analysis. Sourced from the St. Louis Fed (FRED). From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series_id", "title", "unit", "frequency", "latest", "prior", "change", "change_percent", "yoy_percent", "history" ], "properties": { "unit": { "type": "string" }, "as_of": { "type": "string" }, "prior": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "fred" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "frequency": { "type": "string" }, "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "US real GDP, quarterly, with quarter-over-quarter and year-over-year change", "operationId": "v1_gdp", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (gdp, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "us-macro-rates", "meter": "gdp", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "gdp", "quantity": 1 } ] } } }, "/api/v1/gov-awards": { "get": { "summary": "The latest large NEW federal awards across all recipients, from USAspending.gov — browse what the government is funding right now. Tune `?days=` lookback (max 365), `?award_type=contracts|grants|all`, `?min_amount=` floor, `?order=amount|date`, `?limit=` (max 50). Each award carries recipient, amount, awarding agency, dates, description, and a link. Uses new-award dating, not modifications.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "award_type", "window_days", "since", "min_amount", "count", "awards", "attribution" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "since": { "type": "string" }, "awards": { "type": "array", "items": { "type": "object", "required": [ "award_id", "recipient", "amount", "awarding_agency", "awarding_sub_agency", "start_date", "end_date", "description", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "award_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "awarding_agency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "awarding_sub_agency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "source": { "type": "string", "const": "usaspending" }, "award_type": { "type": "string" }, "min_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "attribution": { "type": "string" }, "window_days": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "award_type", "schema": { "enum": [ "contracts", "grants", "all" ], "type": "string", "default": "contracts" } }, { "in": "query", "name": "days", "schema": { "type": "integer", "default": 90, "maximum": 365, "exclusiveMinimum": 0 } }, { "in": "query", "name": "min_amount", "schema": { "type": "number", "minimum": 0 } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 50, "exclusiveMinimum": 0 } }, { "in": "query", "name": "order", "schema": { "enum": [ "amount", "date" ], "type": "string", "default": "amount" } } ], "description": "Latest large new federal awards across all recipients", "operationId": "v1_gov-awards", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "government-policy" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (gov_awards, service government-policy)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "government-policy", "meter": "gov_awards", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "government-policy", "meter": "gov_awards", "quantity": 1 } ] } } }, "/api/v1/gov-contracts": { "get": { "summary": "Federal contract and grant awards to a US company, from USAspending.gov. Pass `?recipient=Lockheed Martin` (required, fuzzy name match) plus optional `?award_type=contracts|grants|all`, `?order=amount|date`, `?limit=` (max 50). Each award carries the award id, amount, awarding agency, period of performance, description, and a usaspending.gov link, with a total. A government-spending catalyst.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "recipient", "award_type", "matched_recipients", "count", "total_awarded", "awards", "attribution" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "awards": { "type": "array", "items": { "type": "object", "required": [ "award_id", "recipient", "amount", "awarding_agency", "awarding_sub_agency", "start_date", "end_date", "description", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "award_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recipient": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "start_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "awarding_agency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "awarding_sub_agency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "source": { "type": "string", "const": "usaspending" }, "recipient": { "type": "string" }, "award_type": { "type": "string" }, "attribution": { "type": "string" }, "total_awarded": { "type": "number" }, "matched_recipients": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "recipient", "schema": { "type": "string", "maxLength": 120, "minLength": 2 } }, { "in": "query", "name": "award_type", "schema": { "enum": [ "contracts", "grants", "all" ], "type": "string", "default": "contracts" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 50, "exclusiveMinimum": 0 } }, { "in": "query", "name": "order", "schema": { "enum": [ "amount", "date" ], "type": "string", "default": "amount" } } ], "description": "Federal contract & grant awards to a company (USAspending.gov)", "operationId": "v1_gov-contracts", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "government-policy" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (gov_contracts, service government-policy)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "government-policy", "meter": "gov_contracts", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "government-policy", "meter": "gov_contracts", "quantity": 1 } ] } } }, "/api/v1/grouped-daily": { "get": { "summary": "End-of-day OHLCV bars for every US-listed ticker on a single date; one call returns the entire market. Pass `?date=YYYY-MM-DD` (required). From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "date", "count", "results" ], "properties": { "date": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "results": { "type": "array", "items": { "type": "object", "required": [ "ticker", "open", "high", "low", "close", "volume", "vwap", "trade_count", "timestamp" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "type": "number" }, "ticker": { "type": "string" }, "volume": { "type": "number" }, "timestamp": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_count": { "type": "integer", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "adjusted": { "type": "boolean" }, "results_note": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "date", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "required": true, "description": "The date for which to retrieve data (YYYY-MM-DD)." }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } } ], "description": "Whole-market daily OHLC for one date", "operationId": "v1_grouped-daily", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ga1phPv9S6kEqxFH_JwZ9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/count/type", "/description", "/operationId" ], "revisionId": "sdrn_6bMLTumuFfzdUgYpYp2fw" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (grouped_daily, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "stock-quotes", "meter": "grouped_daily", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "grouped_daily", "quantity": 1 } ] } } }, "/api/v1/hip3/{dex}": { "get": { "summary": "All markets in one Hyperliquid HIP-3 builder DEX (pass the dex id, e.g. `xyz`): 24/7 synthetic mark & oracle price, funding rate + APR, open interest, and day volume each. Covers equity perps (NVDA, TSLA), commodities (GOLD, BRENTOIL, COPPER), FX, and index perps. Oracle-priced proxies carrying funding — not the underlying's official last trade. List DEXs at /api/v1/hip3/dexs. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "standard", "dex", "dex_name", "deployer", "market_type", "disclaimer", "count", "markets" ], "properties": { "dex": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "venue": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "markets": { "type": "array", "items": { "type": "object", "required": [ "market", "symbol", "max_leverage", "mark_price", "oracle_price", "mid_price", "prev_day_price", "funding_rate_hourly", "funding_apr_percent", "premium", "open_interest", "day_volume_usd", "day_volume_base" ], "properties": { "market": { "type": "string" }, "symbol": { "type": "string" }, "premium": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mid_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mark_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "max_leverage": { "type": "number" }, "oracle_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "prev_day_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_base": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_apr_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_rate_hourly": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "deployer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dex_name": { "type": "string" }, "standard": { "type": "string", "const": "HIP-3" }, "disclaimer": { "type": "string" }, "market_type": { "type": "string", "const": "synthetic_perp" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "dex", "schema": { "type": "string" }, "required": true, "description": "The dex path parameter." } ], "description": "All markets in one HIP-3 builder DEX: 24/7 synthetic mark, funding & open interest", "operationId": "v1_hip3_{dex}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (hip3_dex, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "crypto-perps", "meter": "hip3_dex", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "hip3_dex", "quantity": 1 } ] } } }, "/api/v1/hip3/{dex}/{market}": { "get": { "summary": "One market in a Hyperliquid HIP-3 builder DEX by underlying symbol (e.g. `xyz`/`NVDA`, `xyz`/`GOLD`): its 24/7 synthetic mark & oracle price, funding rate + APR, premium, open interest, and day volume. A round-the-clock live proxy for the underlying that carries funding — NOT its official last trade, exchange close, or spot price. List a DEX's markets at /api/v1/hip3/{dex}. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "standard", "dex", "dex_name", "market_type", "disclaimer", "data" ], "properties": { "dex": { "type": "string" }, "data": { "type": "object", "required": [ "market", "symbol", "max_leverage", "mark_price", "oracle_price", "mid_price", "prev_day_price", "funding_rate_hourly", "funding_apr_percent", "premium", "open_interest", "day_volume_usd", "day_volume_base" ], "properties": { "market": { "type": "string" }, "symbol": { "type": "string" }, "premium": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mid_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mark_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "max_leverage": { "type": "number" }, "oracle_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "prev_day_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_base": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_apr_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_rate_hourly": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "venue": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "dex_name": { "type": "string" }, "standard": { "type": "string", "const": "HIP-3" }, "disclaimer": { "type": "string" }, "market_type": { "type": "string", "const": "synthetic_perp" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "dex", "schema": { "type": "string" }, "required": true, "description": "The dex path parameter." }, { "in": "path", "name": "market", "schema": { "type": "string" }, "example": "gold", "required": true, "description": "CFTC Commitments-of-Traders market/commodity name." } ], "description": "24/7 synthetic mark & funding for a specific HIP-3 builder-DEX market.", "operationId": "v1_hip3_{dex}_{market}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (hip3_market, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crypto-perps", "meter": "hip3_market", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "hip3_market", "quantity": 1 } ] } } }, "/api/v1/hip3/dexs": { "get": { "summary": "List every permissionless builder-deployed perp DEX on Hyperliquid (HIP-3). Each lists synthetic, oracle-priced 24/7 perp markets — US equities, commodities (gold, oil, copper), FX, and global index perps — that Hyperliquid's core perps and US-only stock feeds don't carry. Returns each DEX's id, name, deployer, and market count. Then read a DEX's markets at /api/v1/hip3/{dex}. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "standard", "market_type", "note", "count", "dexs" ], "properties": { "dexs": { "type": "array", "items": { "type": "object", "required": [ "dex", "name", "deployer", "fee_recipient", "market_count" ], "properties": { "dex": { "type": "string" }, "name": { "type": "string" }, "deployer": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "market_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fee_recipient": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "note": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "venue": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "standard": { "type": "string", "const": "HIP-3" }, "market_type": { "type": "string", "const": "synthetic_perp" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "List Hyperliquid HIP-3 builder perp DEXs — 24/7 synthetic markets for stocks, commodities, FX & global indices.", "operationId": "v1_hip3_dexs", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (hip3_dexs, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crypto-perps", "meter": "hip3_dexs", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "hip3_dexs", "quantity": 1 } ] } } }, "/api/v1/indicators/ema/{ticker}": { "get": { "summary": "Exponential Moving Average time series. Tune with `?window=`, `?timespan=`, `?series_type=`, `?limit=`. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "indicator", "count", "values" ], "properties": { "count": { "type": "number" }, "values": { "type": "array", "items": { "type": "object", "required": [ "timestamp", "value" ], "properties": { "value": { "type": "number" }, "signal": { "type": "number" }, "histogram": { "type": "number" }, "timestamp": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "indicator": { "type": "string" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "timespan", "schema": { "enum": [ "minute", "hour", "day", "week", "month", "quarter", "year" ], "type": "string", "default": "day" } }, { "in": "query", "name": "window", "schema": { "type": "integer", "default": 50, "maximum": 2000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "series_type", "schema": { "enum": [ "open", "high", "low", "close" ], "type": "string", "default": "close" } }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 30, "maximum": 5000, "exclusiveMinimum": 0 } } ], "description": "Exponential Moving Average time series. Tune with ?window=, ?timespan=, ?series_type=, ?limit=.", "operationId": "v1_indicators_ema_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ZK2ecHqWAWiyVS6dEqpau", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/data/properties/count/type", "/parameters/query/window/required", "/parameters/query/timespan/required", "/parameters/query/series_type/required", "/parameters/query/limit/required", "/operationId" ], "revisionId": "sdrn_35aNHJCuOgzhkS7Elas2j" } ], "x-zeroclick-services": [ "technical-analysis" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (ema, service technical-analysis)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "technical-analysis", "meter": "ema", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "technical-analysis", "meter": "ema", "quantity": 1 } ] } } }, "/api/v1/indicators/macd/{ticker}": { "get": { "summary": "MACD time series with value, signal line, and histogram. Tune with `?short_window=`, `?long_window=`, `?signal_window=`, `?timespan=`, `?series_type=`, `?limit=`. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "indicator", "count", "values" ], "properties": { "count": { "type": "number" }, "values": { "type": "array", "items": { "type": "object", "required": [ "timestamp", "value" ], "properties": { "value": { "type": "number" }, "signal": { "type": "number" }, "histogram": { "type": "number" }, "timestamp": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "indicator": { "type": "string" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "timespan", "schema": { "enum": [ "minute", "hour", "day", "week", "month", "quarter", "year" ], "type": "string", "default": "day" } }, { "in": "query", "name": "series_type", "schema": { "enum": [ "open", "high", "low", "close" ], "type": "string", "default": "close" } }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "short_window", "schema": { "type": "integer", "default": 12, "maximum": 2000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "long_window", "schema": { "type": "integer", "default": 26, "maximum": 2000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "signal_window", "schema": { "type": "integer", "default": 9, "maximum": 2000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 30, "maximum": 5000, "exclusiveMinimum": 0 } } ], "description": "MACD time series with value, signal line, and histogram. Tune with ?short_window=, ?long_window=, ?signal_window=, ?timespan=, ?series_type=, ?limit=.", "operationId": "v1_indicators_macd_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ZK2ecHqWAWiyVS6dEqpau", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/data/properties/count/type", "/parameters/query/short_window/required", "/parameters/query/long_window/required", "/parameters/query/signal_window/required", "/parameters/query/timespan/required", "/parameters/query/series_type/required", "/parameters/query/limit/required", "/operationId" ], "revisionId": "sdrn_35aNHJCuOgzhkS7Elas2j" } ], "x-zeroclick-services": [ "technical-analysis" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (macd, service technical-analysis)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "technical-analysis", "meter": "macd", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "technical-analysis", "meter": "macd", "quantity": 1 } ] } } }, "/api/v1/indicators/rsi/{ticker}": { "get": { "summary": "Relative Strength Index time series (momentum oscillator). Tune with `?window=` (default 14), `?timespan=`, `?series_type=`, `?limit=`. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "indicator", "count", "values" ], "properties": { "count": { "type": "number" }, "values": { "type": "array", "items": { "type": "object", "required": [ "timestamp", "value" ], "properties": { "value": { "type": "number" }, "signal": { "type": "number" }, "histogram": { "type": "number" }, "timestamp": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "indicator": { "type": "string" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "timespan", "schema": { "enum": [ "minute", "hour", "day", "week", "month", "quarter", "year" ], "type": "string", "default": "day" } }, { "in": "query", "name": "window", "schema": { "type": "integer", "default": 14, "maximum": 2000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "series_type", "schema": { "enum": [ "open", "high", "low", "close" ], "type": "string", "default": "close" } }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 30, "maximum": 5000, "exclusiveMinimum": 0 } } ], "description": "Relative Strength Index time series (momentum oscillator). Tune with ?window= (default 14), ?timespan=, ?series_type=, ?limit=.", "operationId": "v1_indicators_rsi_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ZK2ecHqWAWiyVS6dEqpau", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/data/properties/count/type", "/parameters/query/window/required", "/parameters/query/timespan/required", "/parameters/query/series_type/required", "/parameters/query/limit/required", "/operationId" ], "revisionId": "sdrn_35aNHJCuOgzhkS7Elas2j" } ], "x-zeroclick-services": [ "technical-analysis" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (rsi, service technical-analysis)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "technical-analysis", "meter": "rsi", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "technical-analysis", "meter": "rsi", "quantity": 1 } ] } } }, "/api/v1/indicators/sma/{ticker}": { "get": { "summary": "Simple Moving Average time series. Tune with `?window=`, `?timespan=`, `?series_type=`, `?limit=`. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "indicator", "count", "values" ], "properties": { "count": { "type": "number" }, "values": { "type": "array", "items": { "type": "object", "required": [ "timestamp", "value" ], "properties": { "value": { "type": "number" }, "signal": { "type": "number" }, "histogram": { "type": "number" }, "timestamp": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "indicator": { "type": "string" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "timespan", "schema": { "enum": [ "minute", "hour", "day", "week", "month", "quarter", "year" ], "type": "string", "default": "day" } }, { "in": "query", "name": "window", "schema": { "type": "integer", "default": 50, "maximum": 2000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "series_type", "schema": { "enum": [ "open", "high", "low", "close" ], "type": "string", "default": "close" } }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 30, "maximum": 5000, "exclusiveMinimum": 0 } } ], "description": "Simple Moving Average time series. Tune with ?window=, ?timespan=, ?series_type=, ?limit=.", "operationId": "v1_indicators_sma_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ZK2ecHqWAWiyVS6dEqpau", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/data/properties/count/type", "/parameters/query/window/required", "/parameters/query/timespan/required", "/parameters/query/series_type/required", "/parameters/query/limit/required", "/operationId" ], "revisionId": "sdrn_35aNHJCuOgzhkS7Elas2j" } ], "x-zeroclick-services": [ "technical-analysis" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (sma, service technical-analysis)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "technical-analysis", "meter": "sma", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "technical-analysis", "meter": "sma", "quantity": 1 } ] } } }, "/api/v1/inflation": { "get": { "summary": "US consumer price inflation from the Bureau of Labor Statistics: the latest headline CPI-U and core (ex food and energy) index levels with year-over-year percent change, plus recent monthly history. No ticker needed. Use for macro-aware analysis without leaving for a separate data source. Sourced from US BLS. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series", "unit", "headline", "core", "history" ], "properties": { "core": { "type": "object", "required": [ "latest_index", "latest_month", "yoy_percent" ], "properties": { "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_index": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "unit": { "type": "string" }, "as_of": { "type": "string" }, "series": { "type": "string" }, "source": { "type": "string", "const": "us_bls" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "period_name", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" }, "period_name": { "type": "string" } }, "additionalProperties": false } }, "headline": { "type": "object", "required": [ "latest_index", "latest_month", "yoy_percent" ], "properties": { "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_index": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Headline and core index with year-over-year percent.", "operationId": "v1_inflation", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (inflation, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "us-macro-rates", "meter": "inflation", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "inflation", "quantity": 1 } ] } } }, "/api/v1/insider-trades/{ticker}": { "get": { "summary": "Recent insider transactions parsed from SEC Form 4 filings: the reporting owner and their role (director, officer, 10% holder), each buy/sell with transaction code, share count, price, and shares held afterward, plus an aggregate net-buying/net-selling signal. Tune how many filings to parse with `?limit=` (default 5, max 25). Sourced live from SEC EDGAR. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "filings_parsed", "transaction_count", "summary", "transactions" ], "properties": { "summary": { "type": "object", "required": [ "buys", "sells", "shares_bought", "shares_sold", "net_shares", "signal" ], "properties": { "buys": { "type": "number" }, "sells": { "type": "number" }, "signal": { "enum": [ "net_buying", "net_selling", "neutral" ], "type": "string" }, "net_shares": { "type": "number" }, "shares_sold": { "type": "number" }, "shares_bought": { "type": "number" } }, "additionalProperties": false }, "transactions": { "type": "array", "items": { "type": "object", "required": [ "owner_name", "is_director", "is_officer", "officer_title", "is_ten_percent_owner", "filing_date", "accession", "url", "security", "transaction_date", "code", "code_label", "shares", "price_per_share", "acquired_disposed", "shares_owned_after", "is_derivative" ], "properties": { "url": { "type": "string" }, "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "security": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accession": { "type": "string" }, "code_label": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "is_officer": { "type": "boolean" }, "owner_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "type": "string" }, "is_director": { "type": "boolean" }, "is_derivative": { "type": "boolean" }, "officer_title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price_per_share": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "transaction_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "acquired_disposed": { "anyOf": [ { "enum": [ "A", "D" ], "type": "string" }, { "type": "null" } ] }, "shares_owned_after": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "is_ten_percent_owner": { "type": "boolean" } }, "additionalProperties": false } }, "filings_parsed": { "type": "number" }, "transaction_count": { "type": "number" } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 5, "maximum": 25, "exclusiveMinimum": 0 } } ], "description": "Insider transactions from SEC Form 4: who bought or sold, how much, at what price.", "operationId": "v1_insider-trades_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (insider_trades, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "sec-filings", "meter": "insider_trades", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "insider_trades", "quantity": 1 } ] } } }, "/api/v1/ipos": { "get": { "summary": "Upcoming and historical US IPOs: issuer name, ticker, announced and listing dates, offer price range and final price, shares offered, total deal size, exchange, and status. Filter by `?ipo_status=pending|new|history|rumor`, `?ticker=`, and `?limit=`. Use to track the new-issue calendar and recently priced deals. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "ipos" ], "properties": { "ipos": { "type": "array", "items": { "type": "object", "required": [ "ticker", "issuer_name", "status", "announced_date", "listing_date", "primary_exchange", "security_type", "security_description", "currency", "isin", "final_issue_price", "lowest_offer_price", "highest_offer_price", "max_shares_offered", "total_offer_size", "shares_outstanding", "last_updated" ], "properties": { "isin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "issuer_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "listing_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "security_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "announced_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "total_offer_size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "final_issue_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "lowest_offer_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "max_shares_offered": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "highest_offer_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "security_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "ticker", "schema": { "type": "string", "maxLength": 10, "minLength": 1 } }, { "in": "query", "name": "ipo_status", "schema": { "enum": [ "pending", "new", "history", "rumor", "postponed", "withdrawn" ], "type": "string" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 250, "exclusiveMinimum": 0 } } ], "description": "Upcoming and historical US listings with price range and size.", "operationId": "v1_ipos", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (ipos, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "company-fundamentals", "meter": "ipos", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "ipos", "quantity": 1 } ] } } }, "/api/v1/labor-market": { "get": { "summary": "US labor-market headline indicators from the Bureau of Labor Statistics: the unemployment rate, labor force participation rate, total nonfarm payrolls, and average hourly earnings, each with its latest value and change from the prior month. No ticker needed. Sourced from US BLS. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series", "metrics" ], "properties": { "as_of": { "type": "string" }, "series": { "type": "string" }, "source": { "type": "string", "const": "us_bls" }, "metrics": { "type": "array", "items": { "type": "object", "required": [ "metric", "unit", "latest_value", "latest_month", "prior_value", "change" ], "properties": { "unit": { "type": "string" }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "metric": { "type": "string" }, "prior_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latest_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Unemployment, participation, payrolls, and wage growth.", "operationId": "v1_labor-market", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (labor_market, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "us-macro-rates", "meter": "labor_market", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "labor_market", "quantity": 1 } ] } } }, "/api/v1/losers": { "get": { "summary": "The day's biggest percentage losers across US equities, with current and previous-day OHLCV per ticker. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "direction", "count", "tickers" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "tickers": { "type": "array", "items": { "type": "object", "required": [ "ticker", "change", "change_percent", "updated" ], "properties": { "day": { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" } }, "additionalProperties": false }, "change": { "type": "number" }, "ticker": { "type": "string" }, "updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "previous_day": { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" } }, "additionalProperties": false }, "change_percent": { "type": "number" } }, "additionalProperties": false } }, "direction": { "enum": [ "gainers", "losers" ], "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "The day's biggest percentage losers across US equities, with current and previous-day OHLCV per ticker.", "operationId": "v1_losers", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_4aPQussadcqCAv-3qhzcF", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/count/type", "/operationId" ], "revisionId": "sdrn_PGgAX-ZuG63A6PyPg5gyb" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (losers, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "stock-quotes", "meter": "losers", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "losers", "quantity": 1 } ] } } }, "/api/v1/macro": { "get": { "summary": "The US macro backdrop in one call: the federal funds rate, CPI and PCE inflation, the labor market (unemployment, payrolls, wages), real GDP, and the Treasury yield curve. No ticker needed. Replaces six macro calls (fed-funds + inflation + pce + labor-market + gdp + treasury-yields) at a lower combined price. Spans FRED, BLS, Treasury; sections degrade independently. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "sections", "fed_funds", "cpi", "pce", "labor", "gdp", "treasury_yields" ], "properties": { "cpi": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "series", "unit", "headline", "core", "history" ], "properties": { "core": { "type": "object", "required": [ "latest_index", "latest_month", "yoy_percent" ], "properties": { "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_index": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "unit": { "type": "string" }, "as_of": { "type": "string" }, "series": { "type": "string" }, "source": { "type": "string", "const": "us_bls" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "period_name", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" }, "period_name": { "type": "string" } }, "additionalProperties": false } }, "headline": { "type": "object", "required": [ "latest_index", "latest_month", "yoy_percent" ], "properties": { "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_index": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "gdp": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "series_id", "title", "unit", "frequency", "latest", "prior", "change", "change_percent", "yoy_percent", "history" ], "properties": { "unit": { "type": "string" }, "as_of": { "type": "string" }, "prior": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "fred" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "frequency": { "type": "string" }, "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "pce": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "series", "unit", "headline", "core", "history" ], "properties": { "core": { "type": "object", "required": [ "series_id", "latest_index", "latest_month", "yoy_percent" ], "properties": { "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_index": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "unit": { "type": "string" }, "as_of": { "type": "string" }, "series": { "type": "string" }, "source": { "type": "string", "const": "fred" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "headline": { "type": "object", "required": [ "series_id", "latest_index", "latest_month", "yoy_percent" ], "properties": { "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_index": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "as_of": { "type": "string" }, "labor": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "series", "metrics" ], "properties": { "as_of": { "type": "string" }, "series": { "type": "string" }, "source": { "type": "string", "const": "us_bls" }, "metrics": { "type": "array", "items": { "type": "object", "required": [ "metric", "unit", "latest_value", "latest_month", "prior_value", "change" ], "properties": { "unit": { "type": "string" }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "metric": { "type": "string" }, "prior_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latest_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "x402stock" }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "fed_funds": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "series_id", "title", "unit", "frequency", "latest", "prior", "change", "change_percent", "yoy_percent", "history" ], "properties": { "unit": { "type": "string" }, "as_of": { "type": "string" }, "prior": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "fred" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "frequency": { "type": "string" }, "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "treasury_yields": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "series", "unit", "maturities", "count", "rates" ], "properties": { "unit": { "type": "string" }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "count": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "required": [ "date", "rates" ], "properties": { "date": { "type": "string" }, "rates": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "additionalProperties": false } }, "series": { "type": "string" }, "source": { "type": "string", "const": "us_treasury" }, "maturities": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Fed funds, CPI, PCE, jobs, GDP, and the Treasury yield curve.", "operationId": "v1_macro", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "50000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.050000 per request (macro, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.050000" }, "rates": [ { "service": "us-macro-rates", "meter": "macro", "unit": "request", "unitSize": 1, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "macro", "quantity": 1 } ] } } }, "/api/v1/market-pulse": { "get": { "summary": "Use to find the day's biggest movers in one call. Returns the top 10 gainers and top 10 losers by percent move with price, the current US market session status (open, closed, pre, or post), and the latest market news headlines. No ticker needed. Built for agents scanning what is moving today. From x402stock, a pay-per-call market & economic data API. Pay per request in USDC via x402, no API key.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "market_status", "gainers", "losers", "news" ], "properties": { "news": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "publisher", "published_at", "tickers" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "tickers": { "type": "array", "items": { "type": "string" } }, "publisher": { "type": "string" }, "published_at": { "type": "string" } }, "additionalProperties": false } }, "as_of": { "type": "string" }, "losers": { "type": "array", "items": { "type": "object", "required": [ "ticker", "change_percent", "price" ], "properties": { "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "source": { "type": "string", "const": "x402stock" }, "gainers": { "type": "array", "items": { "type": "object", "required": [ "ticker", "change_percent", "price" ], "properties": { "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "market_status": { "anyOf": [ { "type": "object", "required": [ "market", "early_hours", "after_hours" ], "properties": { "market": { "type": "string" }, "after_hours": { "type": "boolean" }, "early_hours": { "type": "boolean" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "maximum": 50, "exclusiveMinimum": 0 } } ], "description": "Top gainers, top losers, market status, news.", "operationId": "v1_market-pulse", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (market_pulse, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "stock-quotes", "meter": "market_pulse", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "market_pulse", "quantity": 1 } ] } } }, "/api/v1/material-events/{ticker}": { "get": { "summary": "Recent 8-K material-event filings for a company, each classified by its SEC item code into a human-readable label (e.g. 2.02 Results of Operations, 5.02 Executive Changes, 1.01 Material Agreement). Returns filing date, item labels, and a link to the filing. Cap with `?limit=`. Use to track earnings releases, leadership changes, and material agreements. Sourced from SEC EDGAR. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "events" ], "properties": { "count": { "type": "number" }, "events": { "type": "array", "items": { "type": "object", "required": [ "form", "accession", "filing_date", "report_date", "url", "items" ], "properties": { "url": { "type": "string" }, "form": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "code", "label" ], "properties": { "code": { "type": "string" }, "label": { "type": "string" } }, "additionalProperties": false } }, "accession": { "type": "string" }, "filing_date": { "type": "string" }, "report_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "sec_edgar" }, "ticker": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "Material corporate events from 8-K filings, classified by SEC item code.", "operationId": "v1_material-events_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sec-filings" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (material_events, service sec-filings)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "sec-filings", "meter": "material_events", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sec-filings", "meter": "material_events", "quantity": 1 } ] } } }, "/api/v1/money-supply": { "get": { "summary": "US M2 money stock, monthly, in billions of dollars (seasonally adjusted), with the latest value, prior month, month-over-month and year-over-year change, and recent history. No ticker needed. A liquidity gauge watched for inflation and risk-asset context. Sourced from the St. Louis Fed (FRED). From x402stock, a pay-per-call market & economic data API. Pay per request in USDC via x402, no API key.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series_id", "title", "unit", "frequency", "latest", "prior", "change", "change_percent", "yoy_percent", "history" ], "properties": { "unit": { "type": "string" }, "as_of": { "type": "string" }, "prior": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "title": { "type": "string" }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "fred" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "frequency": { "type": "string" }, "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Monthly, with month-over-month and year-over-year change.", "operationId": "v1_money-supply", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (money_supply, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "us-macro-rates", "meter": "money_supply", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "money_supply", "quantity": 1 } ] } } }, "/api/v1/national-debt": { "get": { "summary": "The total US public debt outstanding to the penny — the headline national-debt figure — split into debt held by the public and intragovernmental holdings, with the latest value, prior business day, day-over-day change, and recent history. No ticker needed. Updates each business day. Sourced from the US Treasury (FiscalData). Pass `?limit=` for more history (default 30, max 250). From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series", "unit", "latest", "prior", "change", "change_percent", "history" ], "properties": { "unit": { "type": "string" }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prior": { "anyOf": [ { "type": "object", "required": [ "date", "total_public_debt_outstanding", "debt_held_by_public", "intragovernmental_holdings" ], "properties": { "date": { "type": "string" }, "debt_held_by_public": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "intragovernmental_holdings": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_public_debt_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "total_public_debt_outstanding", "debt_held_by_public", "intragovernmental_holdings" ], "properties": { "date": { "type": "string" }, "debt_held_by_public": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "intragovernmental_holdings": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_public_debt_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "series": { "type": "string" }, "source": { "type": "string", "const": "us_treasury" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "total_public_debt_outstanding", "debt_held_by_public", "intragovernmental_holdings" ], "properties": { "date": { "type": "string" }, "debt_held_by_public": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "intragovernmental_holdings": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_public_debt_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 30, "maximum": 250, "exclusiveMinimum": 0 } } ], "description": "Total public debt outstanding with daily change.", "operationId": "v1_national-debt", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (national_debt, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "us-macro-rates", "meter": "national_debt", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "national_debt", "quantity": 1 } ] } } }, "/api/v1/news": { "get": { "summary": "Curated stock-market news with ticker tags, source, publisher, image, and timestamps. Pass `?ticker=AAPL` to filter. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "articles" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "articles": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "description", "url", "image_url", "author", "publisher", "publisher_homepage", "published_at", "tickers", "keywords" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "title": { "type": "string" }, "author": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tickers": { "type": "array", "items": { "type": "string" } }, "keywords": { "type": "array", "items": { "type": "string" } }, "image_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publisher": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "published_at": { "type": "string" }, "publisher_homepage": { "type": "string" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "ticker", "schema": { "type": "string", "pattern": "^[A-Z][A-Z0-9.\\-]{0,9}$" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 50, "exclusiveMinimum": 0 } } ], "description": "Optionally filtered by ticker.", "operationId": "v1_news", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (news, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sentiment-positioning", "meter": "news", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "news", "quantity": 1 } ] } } }, "/api/v1/news-sentiment": { "get": { "summary": "Global news tone for any company, ticker, or topic, from the GDELT Project's worldwide news monitoring. Pass `?q=Nvidia` (required), `?timespan=1d|3d|1w|2w|1m|3m` (default 1w). Returns article-weighted average tone with a positive/neutral/negative label and split, article count, the headlines at each end of the tone range, and trend when cached. `stale: true` marks an older copy. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "venue", "as_of", "stale", "indexed_through", "query", "timespan", "sentiment", "volume", "tone_timeline", "volume_timeline", "recent_articles", "top_articles", "attribution" ], "properties": { "as_of": { "type": "string" }, "query": { "type": "string" }, "stale": { "type": "boolean" }, "venue": { "type": "string", "const": "gdelt" }, "source": { "type": "string", "const": "x402stock" }, "volume": { "type": "object", "required": [ "total_articles", "points" ], "properties": { "points": { "type": "number" }, "total_articles": { "type": "number" } }, "additionalProperties": false }, "timespan": { "type": "string" }, "sentiment": { "type": "object", "required": [ "latest_tone", "average_tone", "label", "trend", "distribution", "scale" ], "properties": { "label": { "type": "string" }, "scale": { "type": "string" }, "trend": { "type": "string" }, "latest_tone": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "average_tone": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "distribution": { "anyOf": [ { "type": "object", "required": [ "negative", "neutral", "positive" ], "properties": { "neutral": { "type": "number" }, "negative": { "type": "number" }, "positive": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "attribution": { "type": "string" }, "top_articles": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "domain", "tone" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tone": { "type": "number" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "tone_timeline": { "type": "array", "items": { "type": "object", "required": [ "date", "tone" ], "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "tone": { "type": "number" } }, "additionalProperties": false } }, "indexed_through": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recent_articles": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "domain", "source_country", "language", "seen" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "seen": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "language": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source_country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "volume_timeline": { "type": "array", "items": { "type": "object", "required": [ "date", "articles", "total_monitored" ], "properties": { "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "articles": { "type": "number" }, "total_monitored": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "maxLength": 120, "minLength": 2 } }, { "in": "query", "name": "timespan", "schema": { "enum": [ "1d", "3d", "1w", "2w", "1m", "3m" ], "type": "string", "default": "1w" } } ], "description": "Global news attention & tone for a company or topic (GDELT).", "operationId": "v1_news-sentiment", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (news_sentiment, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "sentiment-positioning", "meter": "news_sentiment", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "news_sentiment", "quantity": 1 } ] } } }, "/api/v1/open-close/{ticker}": { "get": { "summary": "Official open, close, high, low, volume, plus pre-market and after-hours prices for a ticker on a given date. Pass `?date=YYYY-MM-DD` (required). From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "date", "open", "high", "low", "close", "volume", "pre_market", "after_hours" ], "properties": { "low": { "type": "number" }, "date": { "type": "string" }, "high": { "type": "number" }, "open": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" }, "pre_market": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "after_hours": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "date", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" }, "required": true, "description": "Date in YYYY-MM-DD format" }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } } ], "description": "Daily open/close (+ pre/after-hours) for a specific date", "operationId": "v1_open-close_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing date parameter documentation" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ga1phPv9S6kEqxFH_JwZ9", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_6bMLTumuFfzdUgYpYp2fw" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (open_close, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "stock-quotes", "meter": "open_close", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "open_close", "quantity": 1 } ] } } }, "/api/v1/options-aggregates/{contract}": { "get": { "summary": "Historical OHLCV price bars for one option contract over any date range. Pass the option contract ticker in the path (e.g. O:AAPL280121C00300000) and tune ?multiplier=, ?timespan=minute|hour|day|week|month, ?from= and ?to= (optional; default to the trailing year), ?adjusted=, ?sort=, and ?limit=. Use for backtesting or charting a single option's price history. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "bars", "count" ], "properties": { "bars": { "type": "array", "items": { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap", "trade_count", "timestamp" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_count": { "type": "integer", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "count": { "type": "number" }, "adjusted": { "type": "boolean" } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "contract", "schema": { "type": "string" }, "example": "O:AAPL280121C00300000", "required": true, "description": "Option contract ticker (OCC/Polygon format), e.g. O:AAPL280121C00300000." }, { "in": "query", "name": "multiplier", "schema": { "type": "integer", "default": 1, "maximum": 50000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "timespan", "schema": { "enum": [ "minute", "hour", "day", "week", "month", "quarter", "year" ], "type": "string", "default": "day" } }, { "in": "query", "name": "from", "schema": { "type": "string", "default": "2025-09-22", "minLength": 1 } }, { "in": "query", "name": "to", "schema": { "type": "string", "default": "2026-09-22", "minLength": 1 } }, { "in": "query", "name": "adjusted", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "sort", "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "asc" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 5000, "maximum": 50000, "exclusiveMinimum": 0 } } ], "description": "Historical OHLCV price bars for one option contract over any date range.", "operationId": "v1_options-aggregates_{contract}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AgYBdM6Xkgia0I4ZDyMqo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/data/properties/bars/items/properties/volume/type", "/responses/200/content/application/json/schema/properties/data/properties/count/type", "/parameters/query/multiplier/required", "/parameters/query/timespan/schema/enum", "/parameters/query/timespan/required", "/parameters/query/from/required", "/parameters/query/to/required", "/parameters/query/adjusted/required", "/parameters/query/sort/required", "/parameters/query/limit/required", "/operationId" ], "revisionId": "sdrn_fD9aSXP0P1xt9gBWTWCUa" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "options-short-interest" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (options_aggregates, service options-short-interest)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "options-short-interest", "meter": "options_aggregates", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "options-short-interest", "meter": "options_aggregates", "quantity": 1 } ] } } }, "/api/v1/options/{ticker}": { "get": { "summary": "The options chain for a US-listed underlying: every listed contract with its strike price, expiration date, call or put type, exercise style, contract ticker, and shares per contract. Filter with ?expiration_date=YYYY-MM-DD, ?contract_type=call|put, ?strike_price=, ?expired=true|false, and ?limit=. Use to discover which option contracts exist before pulling price history. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "contracts" ], "properties": { "count": { "type": "number" }, "contracts": { "type": "array", "items": { "type": "object", "required": [ "contract_ticker", "type", "strike", "expiration_date", "exercise_style", "shares_per_contract", "primary_exchange", "cfi" ], "properties": { "cfi": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "strike": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "exercise_style": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contract_ticker": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expiration_date": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_exchange": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares_per_contract": { "type": "integer", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "contract_type", "schema": { "enum": [ "call", "put" ], "type": "string" } }, { "in": "query", "name": "expiration_date", "schema": { "type": "string" } }, { "in": "query", "name": "strike_price", "schema": { "type": "number", "exclusiveMinimum": 0 } }, { "in": "query", "name": "expired", "schema": { "type": "boolean" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 1000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "order", "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "asc" } } ], "description": "The options chain for a US-listed underlying: every listed contract with its strike price, expiration date, call or put type, exercise style, contract ticker, and shares per contract.", "operationId": "v1_options_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AgYBdM6Xkgia0I4ZDyMqo", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/data/properties/count/type", "/parameters/query/expiration_date/schema/format", "/parameters/query/expiration_date/required", "/parameters/query/contract_type/required", "/parameters/query/strike_price/required", "/parameters/query/expired/required", "/parameters/query/limit/required", "/operationId" ], "revisionId": "sdrn_fD9aSXP0P1xt9gBWTWCUa" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "options-short-interest" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (options, service options-short-interest)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "options-short-interest", "meter": "options", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "options-short-interest", "meter": "options", "quantity": 1 } ] } } }, "/api/v1/overview/{ticker}": { "get": { "summary": "Use when you need a full picture of one US-listed stock without making a dozen calls. Returns company profile, delayed price with OHLCV, fundamentals with computed P/E and margins, dividend yield, splits and corporate events, technical indicators (RSI, SMA, EMA, MACD) with neutral zone labels, recent news, and peers. A `sections` map flags anything unavailable. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "source", "as_of", "sections", "profile", "price", "fundamentals", "dividends", "corporate_actions", "technicals", "news", "peers" ], "properties": { "news": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "publisher", "published_at", "tickers" ], "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "tickers": { "type": "array", "items": { "type": "string" } }, "publisher": { "type": "string" }, "published_at": { "type": "string" } }, "additionalProperties": false } }, "as_of": { "type": "string" }, "peers": { "type": "array", "items": { "type": "string" } }, "price": { "anyOf": [ { "type": "object", "required": [ "last", "change", "change_percent", "previous_close", "is_delayed", "delayed_by", "timestamp" ], "properties": { "day": { "anyOf": [ { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "last": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "delayed_by": { "type": "string" }, "is_delayed": { "type": "boolean" }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "previous_close": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "profile": { "anyOf": [ { "type": "object", "required": [ "name", "sector", "sic_code", "market_cap", "shares_outstanding", "employees", "list_date", "homepage", "description", "logo_url" ], "properties": { "name": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "homepage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sic_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employees": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "list_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "dividends": { "type": "object", "required": [ "annualized_amount", "yield_percent", "frequency", "last", "count" ], "properties": { "last": { "anyOf": [ { "type": "object", "required": [ "cash_amount", "ex_dividend_date", "pay_date" ], "properties": { "pay_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cash_amount": { "type": "number" }, "ex_dividend_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "count": { "type": "number" }, "frequency": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "yield_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "annualized_amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "technicals": { "type": "object", "required": [ "rsi_14", "sma_50", "ema_20", "macd" ], "properties": { "macd": { "anyOf": [ { "type": "object", "required": [ "value", "signal", "histogram", "position" ], "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "signal": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "type": "string" }, "histogram": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "ema_20": { "anyOf": [ { "type": "object", "required": [ "value", "price_vs_percent", "position" ], "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "type": "string" }, "price_vs_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "rsi_14": { "anyOf": [ { "type": "object", "required": [ "value", "zone" ], "properties": { "zone": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "sma_50": { "anyOf": [ { "type": "object", "required": [ "value", "price_vs_percent", "position" ], "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "type": "string" }, "price_vs_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "fundamentals": { "anyOf": [ { "type": "object", "required": [ "period", "fiscal_period", "fiscal_year", "end_date", "revenue", "net_income", "gross_profit", "eps", "pe_ratio", "gross_margin_percent", "net_margin_percent" ], "properties": { "eps": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "period": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revenue": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "end_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pe_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "net_income": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fiscal_year": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "gross_profit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fiscal_period": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "net_margin_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "gross_margin_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "corporate_actions": { "type": "object", "required": [ "splits", "events" ], "properties": { "events": { "type": "array", "items": { "type": "object", "required": [ "type", "date", "ticker" ], "properties": { "date": { "type": "string" }, "type": { "type": "string" }, "ticker": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "splits": { "type": "array", "items": { "type": "object", "required": [ "execution_date", "type", "split_from", "split_to", "ratio", "ratio_text" ], "properties": { "type": { "enum": [ "forward", "reverse", "even" ], "type": "string" }, "ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "split_to": { "type": "number" }, "ratio_text": { "type": "string" }, "split_from": { "type": "number" }, "execution_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Everything about one stock in one call: profile, price, fundamentals, technicals, news, peers", "operationId": "v1_overview_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "50000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.050000 per request (overview, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.050000" }, "rates": [ { "service": "company-fundamentals", "meter": "overview", "unit": "request", "unitSize": 1, "priceUsd": "0.050000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "overview", "quantity": 1 } ] } } }, "/api/v1/patent/{application}": { "get": { "summary": "Full USPTO record for one patent application — pass the `{application}` number (e.g. 18687455, the `application_number` from /patents). Returns patent & application numbers, title, filing/grant dates, status, applicant, inventors, application type, examiner, art unit, CPC classes, publication number/date, term-adjustment days, and assignment/parent counts. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "application_number", "patent", "attribution" ], "properties": { "as_of": { "type": "string" }, "patent": { "type": "object", "required": [ "patent_number", "application_number", "title", "filing_date", "grant_date", "status", "applicant", "inventors", "url", "application_type", "examiner", "group_art_unit", "cpc_classes", "publication_number", "earliest_publication_date", "patent_term_adjustment_days", "assignment_count", "parent_count" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "examiner": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "applicant": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inventors": { "type": "array", "items": { "type": "string" } }, "grant_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "cpc_classes": { "type": "array", "items": { "type": "string" } }, "filing_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "parent_count": { "type": "number" }, "patent_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "group_art_unit": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "application_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "assignment_count": { "type": "number" }, "application_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publication_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "earliest_publication_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "patent_term_adjustment_days": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "source": { "type": "string", "const": "uspto" }, "attribution": { "type": "string" }, "application_number": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "application", "schema": { "type": "string" }, "required": true, "description": "The application path parameter." } ], "description": "Full detail for one patent application (USPTO)", "operationId": "v1_patent_{application}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "fda-trials-patents" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (patent, service fda-trials-patents)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "fda-trials-patents", "meter": "patent", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "fda-trials-patents", "meter": "patent", "quantity": 1 } ] } } }, "/api/v1/patent/{application}/assignments": { "get": { "summary": "Recorded ownership transfers (assignments) for one patent application — pass the `{application}` number. Each carries the reel/frame, conveyance text, received & recorded dates, assignors, assignees (with location), and the recorded-document link. A patent sale, collateral pledge, or M&A signal the price/filing feeds miss. Source: USPTO. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "application_number", "count", "assignments", "attribution" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "uspto" }, "assignments": { "type": "array", "items": { "type": "object", "required": [ "reel_frame", "conveyance", "received_date", "recorded_date", "assignors", "assignees", "document_url" ], "properties": { "assignees": { "type": "array", "items": { "type": "object", "required": [ "name", "location" ], "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "assignors": { "type": "array", "items": { "type": "string" } }, "conveyance": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reel_frame": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "document_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "received_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "recorded_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "attribution": { "type": "string" }, "application_number": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "application", "schema": { "type": "string" }, "required": true, "description": "The application path parameter." } ], "description": "Ownership-transfer history for a patent (USPTO assignments)", "operationId": "v1_patent_{application}_assignments", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "fda-trials-patents" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (patent_assignments, service fda-trials-patents)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "fda-trials-patents", "meter": "patent_assignments", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "fda-trials-patents", "meter": "patent_assignments", "quantity": 1 } ] } } }, "/api/v1/patent/{application}/continuity": { "get": { "summary": "The patent family for one application — pass the `{application}` number. Returns parent and child applications with their numbers, filing dates, status, and the continuity relationship (continuation, divisional, national-stage entry, etc.). Maps how deep a company's protection on an invention runs. Source: USPTO. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "application_number", "parents", "children", "attribution" ], "properties": { "as_of": { "type": "string" }, "source": { "type": "string", "const": "uspto" }, "parents": { "type": "array", "items": { "type": "object", "required": [ "application_number", "filing_date", "status", "relationship" ], "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "relationship": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "application_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "children": { "type": "array", "items": { "type": "object", "required": [ "application_number", "filing_date", "status", "relationship" ], "properties": { "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "relationship": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "application_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "attribution": { "type": "string" }, "application_number": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "application", "schema": { "type": "string" }, "required": true, "description": "The application path parameter." } ], "description": "Patent family (parent/child continuity) for an application (USPTO)", "operationId": "v1_patent_{application}_continuity", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "fda-trials-patents" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (patent_continuity, service fda-trials-patents)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "fda-trials-patents", "meter": "patent_continuity", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "fda-trials-patents", "meter": "patent_continuity", "quantity": 1 } ] } } }, "/api/v1/patent/{application}/transactions": { "get": { "summary": "The prosecution-history timeline for one patent application — pass the `{application}` number plus `?limit=` (max 200), newest first. Each event carries its date, USPTO event code, and description (office actions, allowance, grant, abandonment, etc.) — the momentum/risk read on where an application sits. Source: USPTO. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "application_number", "count", "transactions", "attribution" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "uspto" }, "attribution": { "type": "string" }, "transactions": { "type": "array", "items": { "type": "object", "required": [ "date", "code", "description" ], "properties": { "code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "application_number": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "application", "schema": { "type": "string" }, "required": true, "description": "The application path parameter." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 200, "exclusiveMinimum": 0 } } ], "description": "Prosecution-history timeline for a patent application (USPTO)", "operationId": "v1_patent_{application}_transactions", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "fda-trials-patents" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (patent_transactions, service fda-trials-patents)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "fda-trials-patents", "meter": "patent_transactions", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "fda-trials-patents", "meter": "patent_transactions", "quantity": 1 } ] } } }, "/api/v1/patents": { "get": { "summary": "A company's US patents from the USPTO Open Data Portal, newest filings first. Pass `?company=Tesla` (required, matches APPLICANT name — subsidiaries/variants need separate queries) plus `?limit=` (max 100). Each carries patent & application numbers, title, filing & grant dates, status, applicant, inventors, and a link. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "company", "total_matched", "count", "patents", "attribution" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "uspto" }, "company": { "type": "string" }, "patents": { "type": "array", "items": { "type": "object", "required": [ "patent_number", "application_number", "title", "filing_date", "grant_date", "status", "applicant", "inventors", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "applicant": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "inventors": { "type": "array", "items": { "type": "string" } }, "grant_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "filing_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "patent_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "application_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "attribution": { "type": "string" }, "total_matched": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "company", "schema": { "type": "string", "maxLength": 120, "minLength": 2 }, "required": true }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "A company's patents (USPTO Open Data Portal)", "operationId": "v1_patents", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing ticker/company parameter documentation" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "fda-trials-patents" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (patents, service fda-trials-patents)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "fda-trials-patents", "meter": "patents", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "fda-trials-patents", "meter": "patents", "quantity": 1 } ] } } }, "/api/v1/pce": { "get": { "summary": "US PCE (Personal Consumption Expenditures) price inflation — the Fed's preferred inflation gauge — with the latest headline and core (ex food and energy) index levels, each with year-over-year percent change, plus recent monthly history. No ticker needed. Complements the CPI endpoint with the measure the Fed actually targets. Sourced from the St. Louis Fed (FRED). From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series", "unit", "headline", "core", "history" ], "properties": { "core": { "type": "object", "required": [ "series_id", "latest_index", "latest_month", "yoy_percent" ], "properties": { "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_index": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "unit": { "type": "string" }, "as_of": { "type": "string" }, "series": { "type": "string" }, "source": { "type": "string", "const": "fred" }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "value" ], "properties": { "date": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false } }, "headline": { "type": "object", "required": [ "series_id", "latest_index", "latest_month", "yoy_percent" ], "properties": { "series_id": { "type": "string" }, "yoy_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_index": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_month": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "PCE inflation (the Fed's preferred gauge): headline and core index with year-over-year", "operationId": "v1_pce", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (pce, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "us-macro-rates", "meter": "pce", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "pce", "quantity": 1 } ] } } }, "/api/v1/perps": { "get": { "summary": "Live state of every perpetual-futures market in one call: per coin the mark and oracle price, hourly funding rate with annualized APR, premium, open interest, max leverage, previous-day price, and 24h USD and base volume. Native crypto-derivatives data — funding and open interest are perp-only, absent from any spot feed. Free on-chain DEX data (venue: Hyperliquid), no key. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "market", "count", "perps" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "perps": { "type": "array", "items": { "type": "object", "required": [ "coin", "max_leverage", "mark_price", "oracle_price", "mid_price", "prev_day_price", "funding_rate_hourly", "funding_apr_percent", "premium", "open_interest", "day_volume_usd", "day_volume_base" ], "properties": { "coin": { "type": "string" }, "premium": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mid_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mark_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "max_leverage": { "type": "number" }, "oracle_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "prev_day_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_base": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_apr_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_rate_hourly": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "venue": { "type": "string" }, "market": { "type": "string", "const": "perp" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Returns live state of every perpetual-futures market.", "operationId": "v1_perps", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (perps, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "crypto-perps", "meter": "perps", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "perps", "quantity": 1 } ] } } }, "/api/v1/perps/account/{address}": { "get": { "summary": "Live on-chain account state for any wallet on the Hyperliquid perp DEX, by 0x address: account value, total notional, margin used, withdrawable; every open perp position (size, long/short, leverage, entry, unrealized PnL, liquidation price, margin); and resting open orders (up to `?limit=`, default 200; `open_orders_count` is the total). Read-only public chain data, no key. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "market", "address", "account_value", "total_notional_position", "total_raw_usd", "total_margin_used", "maintenance_margin_used", "withdrawable", "positions", "open_orders_count", "open_orders" ], "properties": { "as_of": { "type": "string" }, "venue": { "type": "string" }, "market": { "type": "string", "const": "perp" }, "source": { "type": "string", "const": "x402stock" }, "address": { "type": "string" }, "positions": { "type": "array", "items": { "type": "object", "required": [ "coin", "size", "side", "leverage", "leverage_type", "entry_price", "position_value", "unrealized_pnl", "return_on_equity", "liquidation_price", "margin_used", "max_leverage", "funding_since_open" ], "properties": { "coin": { "type": "string" }, "side": { "anyOf": [ { "enum": [ "long", "short" ], "type": "string" }, { "type": "null" } ] }, "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "leverage": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "entry_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "margin_used": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "max_leverage": { "type": "number" }, "leverage_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "position_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "unrealized_pnl": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "return_on_equity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "liquidation_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_since_open": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "open_orders": { "type": "array", "items": { "type": "object", "required": [ "coin", "side", "limit_price", "size", "orig_size", "order_id", "timestamp" ], "properties": { "coin": { "type": "string" }, "side": { "anyOf": [ { "enum": [ "buy", "sell" ], "type": "string" }, { "type": "null" } ] }, "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "order_id": { "type": "number" }, "orig_size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "limit_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "withdrawable": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "account_value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_raw_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open_orders_count": { "type": "number" }, "total_margin_used": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "maintenance_margin_used": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_notional_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "address", "schema": { "type": "string" }, "example": "So11111111111111111111111111111111111111112", "required": true, "description": "Solana account address (base58)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 200, "maximum": 1000, "minimum": 0 } } ], "description": "Returns live on-chain account state for any wallet on the Hyperliquid perp DEX.", "operationId": "v1_perps_account_{address}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/parameters/query/limit/required", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (perps_account, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "crypto-perps", "meter": "perps_account", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "perps_account", "quantity": 1 } ] } } }, "/api/v1/perps/candles/{coin}": { "get": { "summary": "Historical OHLCV candles for one perpetual-futures market at the requested interval (1m, 5m, 15m, 1h, 4h, 1d, 1w, and more) over a time window. Pass the coin in the path (e.g. BTC) and tune with `?interval=` (default 1h), `?lookback=` candles (default 200, max 5000), or an explicit `?start=`/`?end=` epoch-ms range. Free on-chain DEX data (venue: Hyperliquid), no key. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "coin", "interval", "count", "candles" ], "properties": { "coin": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "venue": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "candles": { "type": "array", "items": { "type": "object", "required": [ "start", "end", "open", "high", "low", "close", "volume", "trades" ], "properties": { "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trades": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "interval": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "coin", "schema": { "type": "string" }, "example": "BTC", "required": true, "description": "Hyperliquid perpetual coin symbol, e.g. BTC or ETH." }, { "in": "query", "name": "interval", "schema": { "enum": [ "1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M" ], "type": "string", "default": "1h" } }, { "in": "query", "name": "lookback", "schema": { "type": "integer", "default": 200, "maximum": 5000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "start", "schema": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, { "in": "query", "name": "end", "schema": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } } ], "description": "Returns historical OHLCV candles for one perpetual-futures market.", "operationId": "v1_perps_candles_{coin}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/parameters/query/interval/required", "/parameters/query/lookback/required", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [ "Missing interval parameter documentation" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (perps_candles, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "crypto-perps", "meter": "perps_candles", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "perps_candles", "quantity": 1 } ] } } }, "/api/v1/perps/{coin}": { "get": { "summary": "Live state of one perpetual-futures market by coin (e.g. BTC, ETH, SOL): mark and oracle price, current hourly funding rate with annualized APR, premium, open interest, max leverage, previous-day price, and 24h USD and base volume. The single-coin read for funding and open-interest signals. Free on-chain DEX data (venue: Hyperliquid), no key. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "market", "data" ], "properties": { "data": { "type": "object", "required": [ "coin", "max_leverage", "mark_price", "oracle_price", "mid_price", "prev_day_price", "funding_rate_hourly", "funding_apr_percent", "premium", "open_interest", "day_volume_usd", "day_volume_base" ], "properties": { "coin": { "type": "string" }, "premium": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mid_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mark_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "max_leverage": { "type": "number" }, "oracle_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "prev_day_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_base": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_apr_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_rate_hourly": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "venue": { "type": "string" }, "market": { "type": "string", "const": "perp" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "coin", "schema": { "type": "string" }, "example": "BTC", "required": true, "description": "Hyperliquid perpetual coin symbol, e.g. BTC or ETH." } ], "description": "Returns live state of one perpetual-futures market by coin.", "operationId": "v1_perps_{coin}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (perps_market, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crypto-perps", "meter": "perps_market", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "perps_market", "quantity": 1 } ] } } }, "/api/v1/perps/fills/{address}": { "get": { "summary": "Recent fills (executed trade history) for any wallet on the Hyperliquid perp DEX, by 0x address: per fill the time, coin, buy/sell side, direction (open/close long/short), price, size, start position, closed PnL, fee, and order id, most recent first. Tune with `?limit=` (default 50, max 200). Read-only public chain data, no key. Pass the address in the path. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "market", "address", "count", "fills" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "fills": { "type": "array", "items": { "type": "object", "required": [ "time", "coin", "side", "direction", "price", "size", "start_position", "closed_pnl", "fee", "fee_token", "crossed", "order_id", "hash" ], "properties": { "fee": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "coin": { "type": "string" }, "hash": { "type": "string" }, "side": { "anyOf": [ { "enum": [ "buy", "sell" ], "type": "string" }, { "type": "null" } ] }, "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "crossed": { "type": "boolean" }, "order_id": { "type": "number" }, "direction": { "type": "string" }, "fee_token": { "type": "string" }, "closed_pnl": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "start_position": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "venue": { "type": "string" }, "market": { "type": "string", "const": "perp" }, "source": { "type": "string", "const": "x402stock" }, "address": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "address", "schema": { "type": "string" }, "example": "So11111111111111111111111111111111111111112", "required": true, "description": "Solana account address (base58)." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 200, "exclusiveMinimum": 0 } } ], "description": "Returns recent fills for any wallet on the Hyperliquid perp DEX.", "operationId": "v1_perps_fills_{address}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/parameters/query/limit/required", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (perps_fills, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "crypto-perps", "meter": "perps_fills", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "perps_fills", "quantity": 1 } ] } } }, "/api/v1/perps/funding/{coin}": { "get": { "summary": "The historical hourly funding-rate series for one perpetual-futures market, each point with the funding rate, annualized APR, and premium, most recent first. Pass the coin in the path (e.g. BTC) and tune the window with `?hours=` (default 24, max 720) or an explicit `?start=`/`?end=` epoch-ms range. Use to study funding regimes and carry. Free on-chain DEX data (venue: Hyperliquid), no key.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "coin", "count", "history" ], "properties": { "coin": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "venue": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "history": { "type": "array", "items": { "type": "object", "required": [ "time", "funding_rate_hourly", "funding_apr_percent", "premium" ], "properties": { "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_apr_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_rate_hourly": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "coin", "schema": { "type": "string" }, "example": "BTC", "required": true, "description": "Hyperliquid perpetual coin symbol, e.g. BTC or ETH." }, { "in": "query", "name": "hours", "schema": { "type": "integer", "default": 24, "maximum": 720, "exclusiveMinimum": 0 } }, { "in": "query", "name": "start", "schema": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, { "in": "query", "name": "end", "schema": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } } ], "description": "Returns historical hourly funding-rate series for one perpetual-futures market.", "operationId": "v1_perps_funding_{coin}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/parameters/query/hours/required", "/parameters/query/start/required", "/parameters/query/end/required", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (perps_funding, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crypto-perps", "meter": "perps_funding", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "perps_funding", "quantity": 1 } ] } } }, "/api/v1/perps/orderbook/{coin}": { "get": { "summary": "The level-2 order book for one perpetual-futures market: aggregated bid and ask price levels, each with size and the number of resting orders, as of the book timestamp. Pass the coin in the path (e.g. BTC). Use to gauge liquidity, spread, and depth. Free on-chain DEX data (venue: Hyperliquid), no key. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "coin", "bids", "asks" ], "properties": { "asks": { "type": "array", "items": { "type": "object", "required": [ "price", "size", "orders" ], "properties": { "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "bids": { "type": "array", "items": { "type": "object", "required": [ "price", "size", "orders" ], "properties": { "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "coin": { "type": "string" }, "as_of": { "type": "string" }, "venue": { "type": "string" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "coin", "schema": { "type": "string" }, "example": "BTC", "required": true, "description": "Hyperliquid perpetual coin symbol, e.g. BTC or ETH." } ], "description": "Returns level-2 order book for one perpetual-futures market.", "operationId": "v1_perps_orderbook_{coin}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (perps_orderbook, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crypto-perps", "meter": "perps_orderbook", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "perps_orderbook", "quantity": 1 } ] } } }, "/api/v1/perps/overview/{coin}": { "get": { "summary": "Everything about one on-chain perpetual-futures market in one call: live mark/oracle price with funding rate and open interest, recent funding history, the L2 order book, and OHLCV candles. Pass the coin in the path (e.g. BTC, ETH). Replaces four calls (perps/{coin} + funding + orderbook + candles) at a lower combined price. Free DEX data (venue: Hyperliquid). Sections degrade independently.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "coin", "source", "venue", "as_of", "sections", "context", "funding", "orderbook", "candles" ], "properties": { "coin": { "type": "string" }, "as_of": { "type": "string" }, "venue": { "type": "string", "const": "hyperliquid" }, "source": { "type": "string", "const": "x402stock" }, "candles": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "venue", "coin", "interval", "count", "candles" ], "properties": { "coin": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "venue": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "candles": { "type": "array", "items": { "type": "object", "required": [ "start", "end", "open", "high", "low", "close", "volume", "trades" ], "properties": { "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trades": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "interval": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "context": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "venue", "market", "data" ], "properties": { "data": { "type": "object", "required": [ "coin", "max_leverage", "mark_price", "oracle_price", "mid_price", "prev_day_price", "funding_rate_hourly", "funding_apr_percent", "premium", "open_interest", "day_volume_usd", "day_volume_base" ], "properties": { "coin": { "type": "string" }, "premium": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mid_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mark_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "max_leverage": { "type": "number" }, "oracle_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "prev_day_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_base": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_apr_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_rate_hourly": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "venue": { "type": "string" }, "market": { "type": "string", "const": "perp" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false }, { "type": "null" } ] }, "funding": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "venue", "coin", "count", "history" ], "properties": { "coin": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "venue": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "history": { "type": "array", "items": { "type": "object", "required": [ "time", "funding_rate_hourly", "funding_apr_percent", "premium" ], "properties": { "time": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "premium": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_apr_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "funding_rate_hourly": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, { "type": "null" } ] }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "orderbook": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "venue", "coin", "bids", "asks" ], "properties": { "asks": { "type": "array", "items": { "type": "object", "required": [ "price", "size", "orders" ], "properties": { "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "bids": { "type": "array", "items": { "type": "object", "required": [ "price", "size", "orders" ], "properties": { "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "coin": { "type": "string" }, "as_of": { "type": "string" }, "venue": { "type": "string" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "coin", "schema": { "type": "string" }, "example": "BTC", "required": true, "description": "Hyperliquid perpetual coin symbol, e.g. BTC or ETH." } ], "description": "Returns live context, funding history, order book, and price candles for one perp market.", "operationId": "v1_perps_overview_{coin}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (perps_overview, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "crypto-perps", "meter": "perps_overview", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "perps_overview", "quantity": 1 } ] } } }, "/api/v1/perps/predicted-funding": { "get": { "summary": "Predicted next-period funding rate for each coin across venues — on-chain plus centralized perp venues (Hyperliquid, Binance, Bybit) — each with the funding interval and next funding time. A cross-exchange funding-arbitrage signal in one call: compare where a coin's funding is richest or cheapest. Free on-chain DEX data, no key. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "coins" ], "properties": { "as_of": { "type": "string" }, "coins": { "type": "array", "items": { "type": "object", "required": [ "coin", "venues" ], "properties": { "coin": { "type": "string" }, "venues": { "type": "array", "items": { "type": "object", "required": [ "venue", "funding_rate", "funding_interval_hours", "next_funding_time" ], "properties": { "venue": { "type": "string" }, "funding_rate": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "next_funding_time": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "funding_interval_hours": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Returns predicted next-period funding rate for each coin across venues.", "operationId": "v1_perps_predicted-funding", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (perps_predicted_funding, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "crypto-perps", "meter": "perps_predicted_funding", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "perps_predicted_funding", "quantity": 1 } ] } } }, "/api/v1/portfolio/xray": { "get": { "summary": "Risk x-ray for a whole watchlist or portfolio in one call. Pass `?tickers=AAPL,MSFT,NVDA` (up to 25; optional `?weights=`). Returns per-holding price, sector and cap, plus portfolio concentration (top-weight, Herfindahl, diversification score), sector concentration, market-cap distribution, weighted day performance and risk flags. Replaces dozens of per-holding calls. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "holding_count", "weighting", "sections", "summary", "holdings", "disclaimer" ], "properties": { "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "summary": { "type": "object", "required": [ "day_change_percent", "sector_concentration", "market_cap_distribution", "concentration", "performance", "risk_flags" ], "properties": { "risk_flags": { "type": "array", "items": { "type": "string" } }, "performance": { "type": "object", "required": [ "best", "worst" ], "properties": { "best": { "anyOf": [ { "type": "object", "required": [ "ticker", "change_percent" ], "properties": { "ticker": { "type": "string" }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "worst": { "anyOf": [ { "type": "object", "required": [ "ticker", "change_percent" ], "properties": { "ticker": { "type": "string" }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "concentration": { "type": "object", "required": [ "top_weight", "top3_weight", "hhi", "diversification_score", "label" ], "properties": { "hhi": { "type": "number" }, "label": { "type": "string" }, "top_weight": { "type": "number" }, "top3_weight": { "type": "number" }, "diversification_score": { "type": "number" } }, "additionalProperties": false }, "day_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sector_concentration": { "type": "object", "required": [ "hhi", "label", "coverage", "top_sectors" ], "properties": { "hhi": { "type": "number" }, "label": { "type": "string" }, "coverage": { "type": "number" }, "top_sectors": { "type": "array", "items": { "type": "object", "required": [ "sector", "weight" ], "properties": { "sector": { "type": "string" }, "weight": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "market_cap_distribution": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } } }, "additionalProperties": false }, "holdings": { "type": "array", "items": { "type": "object", "required": [ "ticker", "name", "price", "change_percent", "market_cap", "sector", "cap_bucket", "weight" ], "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "sector": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "weight": { "type": "number" }, "cap_bucket": { "type": "string" }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "weighting": { "enum": [ "equal", "custom" ], "type": "string" }, "disclaimer": { "type": "string" }, "holding_count": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "tickers", "schema": { "type": "string", "minLength": 1 }, "required": true }, { "in": "query", "name": "weights", "schema": { "type": "string" } } ], "description": "Portfolio risk x-ray: concentration, sector & market-cap exposure, and weighted performance in one call", "operationId": "v1_portfolio_xray", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing portfolio data input documentation" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "screeners-scores-research" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "250000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.250000 per request (portfolio_xray, service screeners-scores-research)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.250000" }, "rates": [ { "service": "screeners-scores-research", "meter": "portfolio_xray", "unit": "request", "unitSize": 1, "priceUsd": "0.250000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "screeners-scores-research", "meter": "portfolio_xray", "quantity": 1 } ] } } }, "/api/v1/prediction-markets": { "get": { "summary": "Use to see where prediction-market money is flowing: the most recently traded Polymarket outcome tokens with implied probability (last on-chain price), today's VWAP and USD volume, and indexed totals — decoded by our own indexer from CTF Exchange V2 events on the public Polygon ledger, not from any Polymarket API. `?limit=` up to 100. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "note", "indexer", "count", "markets" ], "properties": { "note": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "venue": { "type": "string", "const": "polymarket" }, "source": { "type": "string", "const": "x402stock" }, "indexer": { "type": "object", "required": [ "cursor_standard", "cursor_neg_risk", "tokens_tracked" ], "properties": { "tokens_tracked": { "type": "number" }, "cursor_neg_risk": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "cursor_standard": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "markets": { "type": "array", "items": { "type": "object", "required": [ "token_id", "title", "condition_id", "neg_risk", "implied_probability", "last_side", "vwap_today", "volume_usd_today", "matches_today", "volume_usd_indexed", "matches_indexed", "last_block", "updated_at" ], "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "neg_risk": { "type": "boolean" }, "token_id": { "type": "string" }, "last_side": { "enum": [ "buy", "sell" ], "type": "string" }, "last_block": { "type": "number" }, "updated_at": { "type": "string" }, "vwap_today": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "condition_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matches_today": { "type": "number" }, "matches_indexed": { "type": "number" }, "volume_usd_today": { "type": "number" }, "volume_usd_indexed": { "type": "number" }, "implied_probability": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Returns implied probability, VWAP, and volume for most-active Polymarket outcome tokens.", "operationId": "v1_prediction-markets", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (prediction_markets, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "prediction_markets", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "prediction_markets", "quantity": 1 } ] } } }, "/api/v1/prediction-markets/{id}": { "get": { "summary": "Use to track one Polymarket outcome token by its uint256 decimal token id: implied probability, today's VWAP and USD volume, indexed totals, plus on-chain identity (condition id, question title, neg-risk flag) resolved from the market's preparation transaction on Polygon. List active token ids via /prediction-markets. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "note", "market", "identity" ], "properties": { "note": { "type": "string" }, "as_of": { "type": "string" }, "venue": { "type": "string", "const": "polymarket" }, "market": { "type": "object", "required": [ "token_id", "title", "condition_id", "neg_risk", "implied_probability", "last_side", "vwap_today", "volume_usd_today", "matches_today", "volume_usd_indexed", "matches_indexed", "last_block", "updated_at" ], "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "neg_risk": { "type": "boolean" }, "token_id": { "type": "string" }, "last_side": { "enum": [ "buy", "sell" ], "type": "string" }, "last_block": { "type": "number" }, "updated_at": { "type": "string" }, "vwap_today": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "condition_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "matches_today": { "type": "number" }, "matches_indexed": { "type": "number" }, "volume_usd_today": { "type": "number" }, "volume_usd_indexed": { "type": "number" }, "implied_probability": { "type": "number" } }, "additionalProperties": false }, "source": { "type": "string", "const": "x402stock" }, "identity": { "anyOf": [ { "type": "object", "required": [ "condition_id", "question_id", "oracle", "title", "neg_risk" ], "properties": { "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "oracle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "neg_risk": { "type": "boolean" }, "question_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "condition_id": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "id", "schema": { "type": "string" }, "required": true, "description": "Prediction-market token or condition id." } ], "description": "Returns probability, volume, and on-chain identity for a specific Polymarket outcome token.", "operationId": "v1_prediction-markets_{id}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (prediction_markets_id, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "prediction_markets_id", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "prediction_markets_id", "quantity": 1 } ] } } }, "/api/v1/prev-close/{ticker}": { "get": { "summary": "Open, high, low, close, volume, and VWAP for a ticker's most recent completed trading day. One call returns one bar, handy for prior-close reference without setting a date range. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "anyOf": [ { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap", "trade_count", "timestamp" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_count": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Returns the previous trading day OHLC bar for a US stock.", "operationId": "v1_prev-close_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ga1phPv9S6kEqxFH_JwZ9", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_6bMLTumuFfzdUgYpYp2fw" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (prev_close, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "stock-quotes", "meter": "prev_close", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "prev_close", "quantity": 1 } ] } } }, "/api/v1/private-stocks": { "get": { "summary": "Live valuations for private, pre-IPO companies — Anthropic, OpenAI, SpaceX, Anduril, Neuralink, Kalshi, Polymarket — in one call, via PreStocks Solana tokens backed 1:1 by SPV exposure. Per company: mark price and valuation, on-chain token price and implied valuation, the token's premium/discount, supply, and contract. The catalog's only pre-IPO feed. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "count", "companies", "attribution" ], "properties": { "as_of": { "type": "string", "description": "ISO 8601 timestamp when this response was generated." }, "count": { "type": "number", "description": "Number of companies in `companies`." }, "venue": { "type": "string", "description": "Issuing venue for the tokens — always 'prestocks'." }, "source": { "type": "string", "const": "x402stock" }, "companies": { "type": "array", "items": { "type": "object", "required": [ "symbol", "name", "description", "mark_price", "mark_valuation", "token_price", "implied_valuation", "token_premium_percent", "supply", "contract_address", "logo_url", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "PreStocks company page URL." }, "name": { "type": "string", "description": "PreStocks token name, e.g. 'Anthropic PreStocks'." }, "supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Circulating token supply." }, "symbol": { "type": "string", "description": "PreStocks token symbol, e.g. ANTHROPIC, OPENAI, SPACEX. Use as the {symbol} path param." }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Company logo image URL." }, "mark_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "SPV mark price per token in USD — the underlying private company's marked value. NOT a last-trade price." }, "description": { "type": "string", "description": "Plain-language overview of the underlying private company, plus the token's 1:1 SPV-backing note." }, "token_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Current on-chain token trading price in USD. Can diverge from mark_price — that gap is the premium/discount." }, "mark_valuation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Company valuation in USD implied by the SPV mark (mark_price basis)." }, "contract_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Solana mint address of the PreStocks SPV token." }, "implied_valuation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Company valuation in USD implied by the on-chain token_price." }, "token_premium_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "token_price vs mark_price, in percent. Positive = token trades at a premium to the SPV mark; negative = discount." } }, "additionalProperties": false }, "description": "Every PreStocks private company, most-valuable first." }, "attribution": { "type": "string", "description": "Required source-attribution string; pass through to end users." } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Returns prices for pre-IPO private companies like Anthropic, OpenAI, SpaceX, etc.", "operationId": "v1_private-stocks", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (private_stocks, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "private_stocks", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "private_stocks", "quantity": 1 } ] } } }, "/api/v1/private-stocks/{symbol}": { "get": { "summary": "The current valuation of one private, pre-IPO company by symbol — e.g. ANTHROPIC, OPENAI, SPACEX, ANDURIL, NEURALINK, KALSHI, POLYMARKET — via its PreStocks Solana token, backed 1:1 by SPV exposure. Returns the SPV mark price and valuation, the on-chain token price and implied valuation, the token's premium/discount, supply, and contract. List them all at /api/v1/private-stocks. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "data", "attribution" ], "properties": { "data": { "type": "object", "required": [ "symbol", "name", "description", "mark_price", "mark_valuation", "token_price", "implied_valuation", "token_premium_percent", "supply", "contract_address", "logo_url", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "PreStocks company page URL." }, "name": { "type": "string", "description": "PreStocks token name, e.g. 'Anthropic PreStocks'." }, "supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Circulating token supply." }, "symbol": { "type": "string", "description": "PreStocks token symbol, e.g. ANTHROPIC, OPENAI, SPACEX. Use as the {symbol} path param." }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Company logo image URL." }, "mark_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "SPV mark price per token in USD — the underlying private company's marked value. NOT a last-trade price." }, "description": { "type": "string", "description": "Plain-language overview of the underlying private company, plus the token's 1:1 SPV-backing note." }, "token_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Current on-chain token trading price in USD. Can diverge from mark_price — that gap is the premium/discount." }, "mark_valuation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Company valuation in USD implied by the SPV mark (mark_price basis)." }, "contract_address": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Solana mint address of the PreStocks SPV token." }, "implied_valuation": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Company valuation in USD implied by the on-chain token_price." }, "token_premium_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "token_price vs mark_price, in percent. Positive = token trades at a premium to the SPV mark; negative = discount." } }, "description": "The requested private company.", "additionalProperties": false }, "as_of": { "type": "string", "description": "ISO 8601 timestamp when this response was generated." }, "venue": { "type": "string", "description": "Issuing venue for the token — always 'prestocks'." }, "source": { "type": "string", "const": "x402stock" }, "attribution": { "type": "string", "description": "Required source-attribution string; pass through to end users." } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "symbol", "schema": { "type": "string" }, "example": "OPENAI", "required": true, "description": "PreStocks private/pre-IPO company symbol, e.g. OPENAI." } ], "description": "Returns price and valuation for a specific pre-IPO private company.", "operationId": "v1_private-stocks_{symbol}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (private_stocks_symbol, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "private_stocks_symbol", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "private_stocks_symbol", "quantity": 1 } ] } } }, "/api/v1/quote/{ticker}": { "get": { "summary": "Get the latest available price for any US-listed stock: the most recent 1-minute bar close plus today's OHLCV, change, and previous close. Currently 15 minutes delayed; each response carries `is_delayed: true`. Real-time pricing lands when the data plan is upgraded. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "price", "change", "change_percent", "previous_close", "timestamp", "is_delayed", "delayed_by" ], "properties": { "day": { "type": "object", "required": [ "open", "high", "low", "close", "volume" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" } }, "additionalProperties": false }, "price": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "timestamp": { "type": "null", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "delayed_by": { "type": "string" }, "is_delayed": { "type": "boolean" }, "change_percent": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "previous_close": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Returns the last price for a US stock, 15 minute delayed.", "operationId": "v1_quote_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ga1phPv9S6kEqxFH_JwZ9", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_6bMLTumuFfzdUgYpYp2fw" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (quote, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "stock-quotes", "meter": "quote", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "quote", "quantity": 1 } ] } } }, "/api/v1/regulatory": { "get": { "summary": "Proposed/final rules and notices from a federal agency — the regulatory pipeline that reprices sectors. Pass `?agency=securities-and-exchange-commission` (slug) and/or `?q=` (at least one), plus `?type=all|rule|proposed|notice` and `?limit=` (max 100). Each doc has number, type, title, abstract, dates, agencies, and a link. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "agency", "query", "type", "total_matched", "count", "documents", "attribution" ], "properties": { "type": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "agency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "federal_register" }, "documents": { "type": "array", "items": { "type": "object", "required": [ "document_number", "type", "title", "abstract", "publication_date", "effective_on", "agencies", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "abstract": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "agencies": { "type": "array", "items": { "type": "string" } }, "effective_on": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "document_number": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "publication_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "attribution": { "type": "string" }, "total_matched": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "agency", "schema": { "type": "string", "maxLength": 120, "minLength": 2 } }, { "in": "query", "name": "q", "schema": { "type": "string", "maxLength": 120, "minLength": 2 } }, { "in": "query", "name": "type", "schema": { "enum": [ "all", "rule", "proposed", "notice", "presidential" ], "type": "string", "default": "all" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "Returns Federal Register rules & notices by agency.", "operationId": "v1_regulatory", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "government-policy" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (regulatory, service government-policy)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "government-policy", "meter": "regulatory", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "government-policy", "meter": "regulatory", "quantity": 1 } ] } } }, "/api/v1/related/{ticker}": { "get": { "summary": "Tickers related to the given symbol based on news and analyst coverage co-occurrence, a quick peer set for comparative analysis. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "related" ], "properties": { "count": { "type": "number" }, "related": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Returns a list of related peer companies for a given ticker.", "operationId": "v1_related_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (related, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "related", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "related", "quantity": 1 } ] } } }, "/api/v1/report/{ticker}": { "get": { "summary": "Renders a finished one-page equity tearsheet PNG for a US-listed stock — not raw JSON to assemble. Fans out to profile, price, 1-year history, fundamentals, technicals and news, then draws a 1-year price chart with its 50-day average plus key stats (market cap, P/E, margins, dividend yield, 52-week range) and headlines. Returns the data plus a hosted `artifact.png_url`. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "source", "as_of", "artifact", "data" ], "properties": { "data": { "type": "object", "required": [ "name", "price", "stats", "technicals", "news", "sections" ], "properties": { "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "news": { "type": "array", "items": { "type": "object", "required": [ "title", "publisher", "url" ], "properties": { "url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "title": { "type": "string" }, "publisher": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } }, "price": { "type": "object", "required": [ "last", "change", "change_percent" ], "properties": { "last": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "stats": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ] } }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "enum": [ "ok", "unavailable" ], "type": "string" } }, "technicals": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "null" } ] } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "artifact": { "type": "object", "required": [ "id", "url", "format", "expires_at" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" }, "format": { "type": "string", "const": "png" }, "expires_at": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Returns a URL to a rendered one-page PNG equity tearsheet report.", "operationId": "v1_report_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "screeners-scores-research" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "500000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.500000 per request (report, service screeners-scores-research)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.500000" }, "rates": [ { "service": "screeners-scores-research", "meter": "report", "unit": "request", "unitSize": 1, "priceUsd": "0.500000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "screeners-scores-research", "meter": "report", "quantity": 1 } ] } } }, "/api/v1/research/{ticker}": { "get": { "summary": "A full AI-synthesized equity-research memo for one US stock in one call. Fans out across profile, fundamentals, technicals, short interest, insider activity (Form 4/144), 13D/G stakes, 8-K events, news and sentiment, then an LLM distils a balanced bull/bear case, valuation context, catalysts, risks and a per-signal read-out with an overall stance. Factual synthesis, not advice. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "source", "as_of", "sections", "completeness", "memo_generated", "report", "evidence", "model", "disclaimer" ], "properties": { "as_of": { "type": "string" }, "model": { "type": "string" }, "report": { "anyOf": [ { "type": "object", "required": [ "thesis_summary", "bull_case", "bear_case", "valuation_context", "catalysts", "risk_factors", "signal_readout", "overall_stance", "confidence" ], "properties": { "bear_case": { "type": "array", "items": { "type": "string" } }, "bull_case": { "type": "array", "items": { "type": "string" } }, "catalysts": { "type": "array", "items": { "type": "string" } }, "confidence": { "enum": [ "low", "medium", "high" ], "type": "string" }, "risk_factors": { "type": "array", "items": { "type": "string" } }, "overall_stance": { "enum": [ "bullish", "neutral", "bearish", "mixed" ], "type": "string" }, "signal_readout": { "type": "object", "required": [ "insider", "short_interest", "technical", "sentiment", "institutional" ], "properties": { "insider": { "type": "string" }, "sentiment": { "type": "string" }, "technical": { "type": "string" }, "institutional": { "type": "string" }, "short_interest": { "type": "string" } }, "additionalProperties": false }, "thesis_summary": { "type": "string" }, "valuation_context": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "evidence": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "disclaimer": { "type": "string" }, "completeness": { "type": "object", "required": [ "sections_ok", "sections_total", "fraction" ], "properties": { "fraction": { "type": "number" }, "sections_ok": { "type": "number" }, "sections_total": { "type": "number" } }, "additionalProperties": false }, "memo_generated": { "type": "boolean" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Returns an AI-generated equity-research report for one stock.", "operationId": "v1_research_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "screeners-scores-research" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "750000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.750000 per request (research, service screeners-scores-research)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.750000" }, "rates": [ { "service": "screeners-scores-research", "meter": "research", "unit": "request", "unitSize": 1, "priceUsd": "0.750000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "screeners-scores-research", "meter": "research", "quantity": 1 } ] } } }, "/api/v1/score/factors/{ticker}": { "get": { "summary": "A transparent quant factor score for a US stock: Value (P/E, P/S, P/B), Quality (ROE, margins, leverage), Growth (YoY revenue & earnings) and Momentum (trailing return), each 0–100 from filing-grade fundamentals plus an equal-weighted composite. Returns every metric it scored, with labels. Factual, not advice. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "source", "as_of", "sections", "composite", "factors", "methodology", "inputs", "disclaimer" ], "properties": { "as_of": { "type": "string" }, "inputs": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "factors": { "type": "object", "required": [ "value", "quality", "growth", "momentum" ], "properties": { "value": { "type": "object", "required": [ "score", "label", "metrics" ], "properties": { "label": { "type": "string" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "metrics": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, { "type": "null" } ] } } }, "additionalProperties": false }, "growth": { "type": "object", "required": [ "score", "label", "metrics" ], "properties": { "label": { "type": "string" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "metrics": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, { "type": "null" } ] } } }, "additionalProperties": false }, "quality": { "type": "object", "required": [ "score", "label", "metrics" ], "properties": { "label": { "type": "string" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "metrics": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, { "type": "null" } ] } } }, "additionalProperties": false }, "momentum": { "type": "object", "required": [ "score", "label", "metrics" ], "properties": { "label": { "type": "string" }, "score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "metrics": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "number" }, { "type": "boolean" } ] }, { "type": "null" } ] } } }, "additionalProperties": false } }, "additionalProperties": false }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "composite": { "type": "object", "required": [ "value", "max", "label", "confidence" ], "properties": { "max": { "type": "number" }, "label": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "confidence": { "type": "number" } }, "additionalProperties": false }, "disclaimer": { "type": "string" }, "methodology": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Returns value, quality, growth, and momentum sub-scores plus a composite score.", "operationId": "v1_score_factors_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "screeners-scores-research" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "150000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.150000 per request (score_factors, service screeners-scores-research)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.150000" }, "rates": [ { "service": "screeners-scores-research", "meter": "score_factors", "unit": "request", "unitSize": 1, "priceUsd": "0.150000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "screeners-scores-research", "meter": "score_factors", "quantity": 1 } ] } } }, "/api/v1/score/insider/{ticker}": { "get": { "summary": "A transparent 0–100 insider-conviction score for a US stock. Starts neutral, then adjusts for net Form 4 buy/sell share flow, role-weighted activity (C-suite and 10% owners weigh more), cluster buying by distinct insiders, Form 144 intent-to-sell overhang, and any activist 13D stake — returning the full factor breakdown. From SEC EDGAR. Factual, not advice. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "source", "as_of", "sections", "score", "methodology", "inputs", "rationale", "disclaimer" ], "properties": { "as_of": { "type": "string" }, "score": { "type": "object", "required": [ "value", "max", "label", "confidence", "baseline", "factors" ], "properties": { "max": { "type": "number" }, "label": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "factors": { "type": "array", "items": { "type": "object", "required": [ "name", "label", "points" ], "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "string" }, { "type": "boolean" }, { "type": "null" } ] } }, "points": { "type": "number" } }, "additionalProperties": false } }, "baseline": { "type": "number" }, "confidence": { "type": "number" } }, "additionalProperties": false }, "inputs": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "rationale": { "type": "string" }, "disclaimer": { "type": "string" }, "methodology": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Returns an insider-conviction score (0-100) based on Form 4 flow, role weighting, etc.", "operationId": "v1_score_insider_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "screeners-scores-research" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "150000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.150000 per request (score_insider, service screeners-scores-research)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.150000" }, "rates": [ { "service": "screeners-scores-research", "meter": "score_insider", "unit": "request", "unitSize": 1, "priceUsd": "0.150000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "screeners-scores-research", "meter": "score_insider", "quantity": 1 } ] } } }, "/api/v1/score/squeeze/{ticker}": { "get": { "summary": "A transparent 0–100 short-squeeze pressure score for a US stock. Combines short interest as a % of shares, days-to-cover, the daily short-volume ratio, fails-to-deliver vs average volume, and a price/social spark into one gauge — with the full sub-factor breakdown and the raw inputs it scored. Factual quantitative reading, not advice. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "source", "as_of", "sections", "score", "methodology", "inputs", "rationale", "disclaimer" ], "properties": { "as_of": { "type": "string" }, "score": { "type": "object", "required": [ "value", "max", "label", "confidence", "factors" ], "properties": { "max": { "type": "number" }, "label": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "factors": { "type": "array", "items": { "type": "object", "required": [ "name", "label", "score", "max", "value", "unit" ], "properties": { "max": { "type": "number" }, "name": { "type": "string" }, "unit": { "type": "string" }, "label": { "type": "string" }, "score": { "type": "number" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "confidence": { "type": "number" } }, "additionalProperties": false }, "inputs": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "rationale": { "type": "string" }, "disclaimer": { "type": "string" }, "methodology": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Returns a short-squeeze score (0-100) based on short interest, FTDs, etc.", "operationId": "v1_score_squeeze_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "screeners-scores-research" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "150000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.150000 per request (score_squeeze, service screeners-scores-research)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.150000" }, "rates": [ { "service": "screeners-scores-research", "meter": "score_squeeze", "unit": "request", "unitSize": 1, "priceUsd": "0.150000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "screeners-scores-research", "meter": "score_squeeze", "quantity": 1 } ] } } }, "/api/v1/screener": { "get": { "summary": "Screen the entire US stock market in one call. Filter every listed ticker by price range, percent change, and minimum volume, then sort by percent move, price, or volume. Tune with ?min_price=, ?max_price=, ?min_change_percent=, ?max_change_percent=, ?min_volume=, ?sort=, ?order=, ?limit=. Built for agents scanning for setups without iterating ticker by ticker. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "universe", "matched", "sort", "order", "count", "results" ], "properties": { "sort": { "enum": [ "change_percent", "price", "volume" ], "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "order": { "enum": [ "asc", "desc" ], "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "matched": { "type": "number" }, "results": { "type": "array", "items": { "type": "object", "required": [ "ticker", "price", "change", "change_percent", "volume", "vwap" ], "properties": { "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "universe": { "type": "number" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "min_price", "schema": { "type": "number", "minimum": 0 } }, { "in": "query", "name": "max_price", "schema": { "type": "number", "minimum": 0 } }, { "in": "query", "name": "min_change_percent", "schema": { "type": "number" } }, { "in": "query", "name": "max_change_percent", "schema": { "type": "number" } }, { "in": "query", "name": "min_volume", "schema": { "type": "number", "minimum": 0 } }, { "in": "query", "name": "sort", "schema": { "enum": [ "change_percent", "price", "volume" ], "type": "string", "default": "change_percent" } }, { "in": "query", "name": "order", "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 500, "exclusiveMinimum": 0 } } ], "description": "Screen the entire US stock market in one call. Filter every listed ticker by price range, percent change, and minimum volume, then sort by percent move, price, or volume.", "operationId": "v1_screener", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_4aPQussadcqCAv-3qhzcF", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/count/type", "/responses/200/content/application/json/schema/properties/matched/type", "/responses/200/content/application/json/schema/properties/universe/type", "/parameters/query/min_volume/schema/type" ], "revisionId": "sdrn_PGgAX-ZuG63A6PyPg5gyb" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "screeners-scores-research" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (screener, service screeners-scores-research)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "screeners-scores-research", "meter": "screener", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "screeners-scores-research", "meter": "screener", "quantity": 1 } ] } } }, "/api/v1/screener/smart": { "get": { "summary": "Describe a screen in plain English via `?q=` (e.g. 'oversold large caps up today on high volume'). An LLM parses it into a filter, screens the entire US market, optionally confirms oversold/overbought with RSI, and returns a ranked shortlist with a one-line rationale per name. No need to know the filter schema or run the enrichment loop yourself. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "query", "source", "as_of", "interpretation", "note", "filter", "sections", "result_count", "results", "summary", "model", "disclaimer" ], "properties": { "note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "as_of": { "type": "string" }, "model": { "type": "string" }, "query": { "type": "string" }, "filter": { "type": "object", "required": [ "min_price", "max_price", "min_change_percent", "max_change_percent", "min_volume", "sort", "order", "limit", "signal" ], "properties": { "sort": { "type": "string" }, "limit": { "type": "number" }, "order": { "type": "string" }, "signal": { "type": "string" }, "max_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "min_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "min_volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "max_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "min_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "source": { "type": "string", "const": "x402stock" }, "results": { "type": "array", "items": { "type": "object", "required": [ "ticker", "price", "change_percent", "volume", "rsi", "rationale" ], "properties": { "rsi": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rationale": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "summary": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "disclaimer": { "type": "string" }, "result_count": { "type": "number" }, "interpretation": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "q", "schema": { "type": "string", "minLength": 1 }, "required": true } ], "description": "Returns a ranked shortlist with rationale based on natural language input.", "operationId": "v1_screener_smart", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "screeners-scores-research" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "200000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.200000 per request (screener_smart, service screeners-scores-research)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.200000" }, "rates": [ { "service": "screeners-scores-research", "meter": "screener_smart", "unit": "request", "unitSize": 1, "priceUsd": "0.200000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "screeners-scores-research", "meter": "screener_smart", "quantity": 1 } ] } } }, "/api/v1/short-interest/{ticker}": { "get": { "summary": "The exchange-reported short-interest history for a US-listed stock: total shares sold short, average daily volume, and days-to-cover for each bi-weekly FINRA settlement date, most recent first. A core short-squeeze and bearish-positioning signal. Tune how many settlements to return with `?limit=` (default 12). From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "latest", "history" ], "properties": { "count": { "type": "number" }, "latest": { "type": "object", "anyOf": [ { "type": "object", "required": [ "settlement_date", "short_interest", "avg_daily_volume", "days_to_cover" ], "properties": { "days_to_cover": { "type": "number" }, "short_interest": { "type": "number" }, "settlement_date": { "type": "string" }, "avg_daily_volume": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ], "properties": { "days_to_cover": { "type": "number" }, "short_interest": { "type": "number" }, "settlement_date": { "type": "string" }, "avg_daily_volume": { "type": "number" } } }, "history": { "type": "array", "items": { "type": "object", "required": [ "settlement_date", "short_interest", "avg_daily_volume", "days_to_cover" ], "properties": { "days_to_cover": { "type": "number" }, "short_interest": { "type": "number" }, "settlement_date": { "type": "string" }, "avg_daily_volume": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 12, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "Returns bi-weekly short interest and days-to-cover for a stock.", "operationId": "v1_short-interest_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_JCTvCfOjjIdw0XzdqbOif", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/data/properties/count/type", "/parameters/query/limit/required", "/description", "/operationId" ], "revisionId": "sdrn_z5ju9Tpei8xwj_T7L8zQA" } ], "x-zeroclick-services": [ "options-short-interest" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (short_interest, service options-short-interest)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "options-short-interest", "meter": "short_interest", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "options-short-interest", "meter": "short_interest", "quantity": 1 } ] } } }, "/api/v1/short-volume/{ticker}": { "get": { "summary": "Daily short-sale volume for a US-listed stock: total volume, short volume, exempt and non-exempt short volume, the short-volume ratio, and a per-venue breakdown (NYSE, Nasdaq, ADF), most recent day first. A higher-frequency read on shorting pressure than bi-weekly short interest. Tune with `?limit=` (default 20). From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "latest", "history" ], "properties": { "count": { "type": "number" }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "total_volume", "short_volume", "exempt_volume", "non_exempt_volume", "short_volume_ratio", "venues" ], "properties": { "date": { "type": "string" }, "venues": { "type": "object", "required": [ "nyse", "nasdaq_carteret", "nasdaq_chicago", "adf" ], "properties": { "adf": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nyse": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nasdaq_chicago": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nasdaq_carteret": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "short_volume": { "type": "number" }, "total_volume": { "type": "number" }, "exempt_volume": { "type": "number" }, "non_exempt_volume": { "type": "number" }, "short_volume_ratio": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "total_volume", "short_volume", "exempt_volume", "non_exempt_volume", "short_volume_ratio", "venues" ], "properties": { "date": { "type": "string" }, "venues": { "type": "object", "required": [ "nyse", "nasdaq_carteret", "nasdaq_chicago", "adf" ], "properties": { "adf": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nyse": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nasdaq_chicago": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nasdaq_carteret": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "short_volume": { "type": "number" }, "total_volume": { "type": "number" }, "exempt_volume": { "type": "number" }, "non_exempt_volume": { "type": "number" }, "short_volume_ratio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "Returns daily short-sale volume and short-volume ratio for a stock.", "operationId": "v1_short-volume_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_JCTvCfOjjIdw0XzdqbOif", "authority": "supplemental", "conflicts": [ "/summary", "/parameters/query/limit/required", "/description", "/operationId" ], "revisionId": "sdrn_z5ju9Tpei8xwj_T7L8zQA" } ], "x-zeroclick-services": [ "options-short-interest" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (short_volume, service options-short-interest)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "options-short-interest", "meter": "short_volume", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "options-short-interest", "meter": "short_volume", "quantity": 1 } ] } } }, "/api/v1/snapshot/{ticker}": { "get": { "summary": "Single-call snapshot of a ticker's current state: last quote, last trade, today's OHLC + volume + VWAP, previous-day OHLC, today's change vs previous close. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "properties": { "day": { "type": "object", "required": [ "open", "high", "low", "close", "volume" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" } }, "additionalProperties": false }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "last_quote": { "type": "object", "required": [ "bid_price", "bid_size", "ask_price", "ask_size", "timestamp" ], "properties": { "ask_size": { "type": "number" }, "bid_size": { "type": "number" }, "ask_price": { "type": "number" }, "bid_price": { "type": "number" }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "last_trade": { "type": "object", "required": [ "price", "size", "exchange_id", "timestamp", "conditions" ], "properties": { "size": { "type": "number" }, "price": { "type": "number" }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "conditions": { "type": "array", "items": { "type": "number" } }, "exchange_id": { "type": "number" } }, "additionalProperties": false }, "previous_day": { "type": "object", "required": [ "open", "high", "low", "close", "volume" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" } }, "additionalProperties": false }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "last_minute_bar": { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap", "timestamp" ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" }, "timestamp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trade_count": { "type": "number" }, "accumulated_volume": { "type": "number" } }, "additionalProperties": false } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Returns a full ticker snapshot including last quote, last trade, OHLC, and prev close.", "operationId": "v1_snapshot_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ga1phPv9S6kEqxFH_JwZ9", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_6bMLTumuFfzdUgYpYp2fw" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (snapshot, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "stock-quotes", "meter": "snapshot", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "snapshot", "quantity": 1 } ] } } }, "/api/v1/solana/balance/{address}": { "get": { "summary": "The native SOL balance and basic account state for any Solana address, read from the public ledger: lamports and SOL, whether the account exists, its owning program, executable flag, and data size. Pass a base58 address in the path. Keyless on-chain data — no Jupiter API, no account. From x402stock, a pay-per-call market & economic data API. Pay per request in USDC via x402, no API key.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "data" ], "properties": { "data": { "type": "object", "required": [ "address", "lamports", "sol", "exists", "owner", "executable", "data_size" ], "properties": { "sol": { "type": "number" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Owning program of the account, if it exists." }, "exists": { "type": "boolean", "description": "False for an address the ledger has never seen." }, "address": { "type": "string" }, "lamports": { "type": "number" }, "data_size": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Account data size in bytes." }, "executable": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "venue": { "type": "string", "const": "solana" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "address", "schema": { "type": "string" }, "example": "So11111111111111111111111111111111111111112", "required": true, "description": "Solana account address (base58)." } ], "description": "Returns native SOL balance and account metadata for any Solana address.", "operationId": "v1_solana_balance_{address}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (solana_balance, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "solana_balance", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "solana_balance", "quantity": 1 } ] } } }, "/api/v1/solana/holders/{mint}": { "get": { "summary": "The largest holders of any Solana SPL token (top accounts by balance, up to 20), each with its token account, owner wallet, balance, and share of total supply — for holder-concentration and whale analysis. Pass a base58 mint or a known symbol (JUP, JLP, …); tune with `?limit=` (max 20). Read from the public ledger, no Jupiter API. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "data" ], "properties": { "data": { "type": "object", "required": [ "mint", "symbol", "total_supply", "holder_count", "holders" ], "properties": { "mint": { "type": "string" }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "holders": { "type": "array", "items": { "type": "object", "required": [ "rank", "token_account", "owner", "amount", "percent_of_supply" ], "properties": { "rank": { "type": "number" }, "owner": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "The wallet that owns this token account." }, "amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "token_account": { "type": "string", "description": "The SPL token account (not necessarily the owner wallet)." }, "percent_of_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "holder_count": { "type": "number", "description": "Number of top accounts returned (max 20)." }, "total_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "venue": { "type": "string", "const": "solana" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "mint", "schema": { "type": "string" }, "example": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", "required": true, "description": "Solana SPL token mint address (base58)." } ], "description": "Returns top holders of any Solana SPL token.", "operationId": "v1_solana_holders_{mint}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing schema definition for response body" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (solana_holders, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "solana_holders", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "solana_holders", "quantity": 1 } ] } } }, "/api/v1/solana/jlp": { "get": { "summary": "Jupiter's JLP liquidity pool, decoded from the Perpetuals program's on-chain accounts (not the Jupiter API): AUM (USD), JLP supply and virtual price (AUM ÷ supply), pool-wide long/short trader exposure, and each asset (SOL, ETH, WBTC, USDC, USDT) with holdings, owned/locked, utilization %, and long/short USD. Keyless public-chain data, no Jupiter API. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "chain", "protocol", "program", "pool", "jlp_mint", "aum_usd", "jlp_supply", "jlp_virtual_price", "total_guaranteed_usd", "total_short_usd", "asset_count", "assets" ], "properties": { "pool": { "type": "string", "description": "The JLP Pool account address." }, "as_of": { "type": "string" }, "chain": { "type": "string", "const": "solana" }, "venue": { "type": "string", "const": "jupiter" }, "assets": { "type": "array", "items": { "type": "object", "required": [ "symbol", "mint", "decimals", "custody", "token_account", "amount", "owned", "locked", "utilization_percent", "guaranteed_usd", "global_short_usd" ], "properties": { "mint": { "type": "string" }, "owned": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Pool-accounting owned amount (can differ from physical `amount`)." }, "amount": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Physical on-chain holdings (custody token-account balance, UI amount)." }, "locked": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Amount reserved to back open trader positions." }, "symbol": { "type": "string" }, "custody": { "type": "string", "description": "The Perpetuals custody account for this asset." }, "decimals": { "type": "number" }, "token_account": { "type": "string", "description": "SPL account holding the physical balance." }, "guaranteed_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Long positions' guaranteed USD exposure for this asset." }, "global_short_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Open short USD exposure for this asset." }, "utilization_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "locked ÷ owned × 100 — the JLP yield driver." } }, "additionalProperties": false } }, "source": { "type": "string", "const": "x402stock" }, "aum_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Pool assets under management in USD (cached on-chain)." }, "program": { "type": "string", "description": "Jupiter Perpetuals program ID." }, "jlp_mint": { "type": "string" }, "protocol": { "type": "string" }, "jlp_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "asset_count": { "type": "number" }, "total_short_usd": { "type": "number", "description": "Pool-wide open short USD exposure." }, "jlp_virtual_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "aum_usd ÷ jlp_supply — the JLP token's backing value." }, "total_guaranteed_usd": { "type": "number", "description": "Pool-wide long (guaranteed) USD exposure." } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Jupiter JLP pool: AUM, virtual price, per-asset holdings, utilization & trader exposure", "operationId": "v1_solana_jlp", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing parameter definitions", "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (solana_jlp, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "solana_jlp", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "solana_jlp", "quantity": 1 } ] } } }, "/api/v1/solana/token/{mint}": { "get": { "summary": "On-chain facts for any Solana SPL token, read straight from the public ledger (not the Jupiter API): total supply and decimals, mint and freeze authority, initialization, and token program (SPL Token or Token-2022). Pass a base58 mint address or a known symbol (SOL, JUP, JLP, USDC, USDT, BONK, JTO, WIF). Keyless public-chain data, no account. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "data" ], "properties": { "data": { "type": "object", "required": [ "mint", "symbol", "decimals", "supply", "supply_raw", "mint_authority", "freeze_authority", "is_initialized", "token_program", "token_standard" ], "properties": { "mint": { "type": "string", "description": "The SPL token mint address (base58)." }, "supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Total supply as a UI amount (raw ÷ 10^decimals)." }, "symbol": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Known symbol for the mint, if one is mapped; else null." }, "decimals": { "type": "number" }, "supply_raw": { "type": "string", "description": "Total supply in base units, as an exact integer string." }, "token_program": { "type": "string", "description": "Owning token program address." }, "is_initialized": { "type": "boolean" }, "mint_authority": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "token_standard": { "type": "string", "description": "'spl-token', 'token-2022', or 'unknown'." }, "freeze_authority": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "venue": { "type": "string", "const": "solana" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "mint", "schema": { "type": "string" }, "example": "EPjFWdd5AufqSSqeM2qN1xzybapC8G4wEGGkZwyTDt1v", "required": true, "description": "Solana SPL token mint address (base58)." } ], "description": "On-chain SPL token facts for any Solana mint: supply, decimals, mint & freeze authority", "operationId": "v1_solana_token_{mint}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (solana_token, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "solana_token", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "solana_token", "quantity": 1 } ] } } }, "/api/v1/splits-calendar": { "get": { "summary": "Market-wide split calendar across all US tickers (no ticker needed). Each row has the ticker, execution date, direction (`forward`/`reverse`), split_from/split_to, numeric `ratio`, and a human `ratio_text` like `10:1` or `1:8`. Future-dated announced splits sort first. Filter `?type=forward|reverse|all`, `?from=`/`?to=` date window, `?order=`, `?limit=`. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "splits" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "splits": { "type": "array", "items": { "type": "object", "required": [ "ticker", "execution_date", "type", "split_from", "split_to", "ratio", "ratio_text" ], "properties": { "type": { "enum": [ "forward", "reverse", "even" ], "type": "string" }, "ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "split_to": { "type": "number" }, "ratio_text": { "type": "string" }, "split_from": { "type": "number" }, "execution_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "from", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "in": "query", "name": "to", "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$" } }, { "in": "query", "name": "type", "schema": { "enum": [ "forward", "reverse", "all" ], "type": "string", "default": "all" } }, { "in": "query", "name": "order", "schema": { "enum": [ "asc", "desc" ], "type": "string", "default": "desc" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 50, "maximum": 1000, "exclusiveMinimum": 0 } } ], "description": "Split calendar: upcoming and recent forward & reverse splits across all US tickers", "operationId": "v1_splits-calendar", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (splits_calendar, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "company-fundamentals", "meter": "splits_calendar", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "splits_calendar", "quantity": 1 } ] } } }, "/api/v1/splits/{ticker}": { "get": { "summary": "Historical stock splits for a ticker, with execution date and split ratio (split_from to split_to). Most recent first. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "splits" ], "properties": { "count": { "type": "number" }, "splits": { "type": "array", "items": { "type": "object", "required": [ "execution_date", "type", "split_from", "split_to", "ratio", "ratio_text" ], "properties": { "type": { "enum": [ "forward", "reverse", "even" ], "type": "string" }, "ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "split_to": { "type": "number" }, "ratio_text": { "type": "string" }, "split_from": { "type": "number" }, "execution_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 1000, "exclusiveMinimum": 0 } } ], "description": "Stock split history", "operationId": "v1_splits_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (splits, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "splits", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "splits", "quantity": 1 } ] } } }, "/api/v1/spot": { "get": { "summary": "Live on-chain spot prices for every token on the Hyperliquid DEX (HYPE, PURR, and hundreds more), quoted in USDC: mid/mark price, previous-day price, 24h USD and base volume, circulating and total supply, and market cap — sorted by 24h volume. Spot, not derivatives: for funding/open interest use /api/v1/perps; for major-coin fiat prices use /api/v1/crypto. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "market", "count", "pairs" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "pairs": { "type": "array", "items": { "type": "object", "required": [ "pair", "id", "base_token", "quote_token", "canonical", "mark_price", "mid_price", "prev_day_price", "day_volume_usd", "day_volume_base", "circulating_supply", "total_supply", "market_cap_usd" ], "properties": { "id": { "type": "string" }, "pair": { "type": "string" }, "canonical": { "type": "boolean" }, "mid_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "base_token": { "type": "string" }, "mark_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "quote_token": { "type": "string" }, "total_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "market_cap_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "prev_day_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_base": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "circulating_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "venue": { "type": "string" }, "market": { "type": "string", "const": "spot" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Live on-chain spot prices for every token on the Hyperliquid DEX, quoted in USDC.", "operationId": "v1_spot", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/count/type", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (spot, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "crypto-perps", "meter": "spot", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "spot", "quantity": 1 } ] } } }, "/api/v1/spot/candles/{token}": { "get": { "summary": "Historical OHLCV candles for one Hyperliquid spot market at the requested interval (1m, 5m, 15m, 1h, 4h, 1d, 1w) over a time window. Pass a token symbol (e.g. HYPE, PURR) or @index and tune with `?interval=` (default 1h), `?lookback=` candles (default 200, max 5000), or `?start=`/`?end=` epoch-ms. Spot candles — for perp candles use /api/v1/perps/candles/{coin}. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "market", "pair", "id", "interval", "count", "candles" ], "properties": { "id": { "type": "string" }, "pair": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "venue": { "type": "string" }, "market": { "type": "string", "const": "spot" }, "source": { "type": "string", "const": "x402stock" }, "candles": { "type": "array", "items": { "type": "object", "required": [ "start", "end", "open", "high", "low", "close", "volume", "trades" ], "properties": { "end": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "start": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trades": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "interval": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "token", "schema": { "type": "string" }, "example": "PURR", "required": true, "description": "Hyperliquid spot token symbol, e.g. PURR." }, { "in": "query", "name": "interval", "schema": { "enum": [ "1m", "3m", "5m", "15m", "30m", "1h", "2h", "4h", "8h", "12h", "1d", "3d", "1w", "1M" ], "type": "string", "default": "1h" } }, { "in": "query", "name": "lookback", "schema": { "type": "integer", "default": 200, "maximum": 5000, "exclusiveMinimum": 0 } }, { "in": "query", "name": "start", "schema": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } }, { "in": "query", "name": "end", "schema": { "type": "integer", "maximum": 9007199254740991, "exclusiveMinimum": 0 } } ], "description": "Historical OHLCV candles for one Hyperliquid spot market at the requested interval.", "operationId": "v1_spot_candles_{token}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/count/type", "/responses/200/description", "/parameters/query/interval/required", "/parameters/query/lookback/required", "/parameters/query/start/required", "/parameters/query/end/required", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (spot_candles, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "crypto-perps", "meter": "spot_candles", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "spot_candles", "quantity": 1 } ] } } }, "/api/v1/spot/orderbook/{token}": { "get": { "summary": "Level-2 order book for one Hyperliquid spot market: aggregated bid and ask price levels, each with size and resting order count, as of the book timestamp. Pass a token symbol (e.g. HYPE, PURR) or @index. Use to gauge spot liquidity, spread, and depth. Spot book — for the perp book use /api/v1/perps/orderbook/{coin}. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "market", "pair", "id", "bids", "asks" ], "properties": { "id": { "type": "string" }, "asks": { "type": "array", "items": { "type": "object", "required": [ "price", "size", "orders" ], "properties": { "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "bids": { "type": "array", "items": { "type": "object", "required": [ "price", "size", "orders" ], "properties": { "size": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "orders": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "pair": { "type": "string" }, "as_of": { "type": "string" }, "venue": { "type": "string" }, "market": { "type": "string", "const": "spot" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "token", "schema": { "type": "string" }, "example": "PURR", "required": true, "description": "Hyperliquid spot token symbol, e.g. PURR." } ], "description": "Level-2 order book for one Hyperliquid spot market.", "operationId": "v1_spot_orderbook_{token}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (spot_orderbook, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crypto-perps", "meter": "spot_orderbook", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "spot_orderbook", "quantity": 1 } ] } } }, "/api/v1/spot/{token}": { "get": { "summary": "Live on-chain spot market for one Hyperliquid-listed token by symbol (e.g. HYPE, PURR) or @index: mid/mark price, previous-day price, 24h USD and base volume, circulating and total supply, and market cap, quoted in USDC. Spot, not a perp — for funding/open interest use /api/v1/perps/{coin}; for major-coin fiat prices use /api/v1/crypto. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "market", "data" ], "properties": { "data": { "type": "object", "required": [ "pair", "id", "base_token", "quote_token", "canonical", "mark_price", "mid_price", "prev_day_price", "day_volume_usd", "day_volume_base", "circulating_supply", "total_supply", "market_cap_usd" ], "properties": { "id": { "type": "string" }, "pair": { "type": "string" }, "canonical": { "type": "boolean" }, "mid_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "base_token": { "type": "string" }, "mark_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "quote_token": { "type": "string" }, "total_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "market_cap_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "prev_day_price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "day_volume_base": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "circulating_supply": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "venue": { "type": "string" }, "market": { "type": "string", "const": "spot" }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "token", "schema": { "type": "string" }, "example": "PURR", "required": true, "description": "Hyperliquid spot token symbol, e.g. PURR." } ], "description": "Live on-chain spot market for one Hyperliquid-listed token by symbol or @index.", "operationId": "v1_spot_{token}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_7p80JlGjTt6Gg0X2BdCLR", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/description", "/operationId" ], "revisionId": "sdrn_c0DA_Ll0S78UFUXDDs-ns" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "crypto-perps" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (spot_market, service crypto-perps)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "crypto-perps", "meter": "spot_market", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "crypto-perps", "meter": "spot_market", "quantity": 1 } ] } } }, "/api/v1/squeeze/{ticker}": { "get": { "summary": "The short-squeeze picture for a US stock in one call: bi-weekly short interest with days-to-cover, daily short-sale volume with short-volume ratio, and settlement fails-to-deliver, plus a computed signal pulling the headline gauges together. Replaces three separate calls (short-interest + short-volume + fails-to-deliver) at a lower combined price. Sections degrade independently. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "source", "as_of", "sections", "signal", "short_interest", "short_volume", "fails_to_deliver" ], "properties": { "as_of": { "type": "string" }, "signal": { "anyOf": [ { "type": "object", "required": [ "days_to_cover", "short_interest", "short_volume_ratio" ], "properties": { "days_to_cover": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "short_interest": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "short_volume_ratio": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "sections": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, "short_volume": { "anyOf": [ { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "latest", "history" ], "properties": { "count": { "type": "number" }, "latest": { "anyOf": [ { "type": "object", "required": [ "date", "total_volume", "short_volume", "exempt_volume", "non_exempt_volume", "short_volume_ratio", "venues" ], "properties": { "date": { "type": "string" }, "venues": { "type": "object", "required": [ "nyse", "nasdaq_carteret", "nasdaq_chicago", "adf" ], "properties": { "adf": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nyse": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nasdaq_chicago": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nasdaq_carteret": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "short_volume": { "type": "number" }, "total_volume": { "type": "number" }, "exempt_volume": { "type": "number" }, "non_exempt_volume": { "type": "number" }, "short_volume_ratio": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "history": { "type": "array", "items": { "type": "object", "required": [ "date", "total_volume", "short_volume", "exempt_volume", "non_exempt_volume", "short_volume_ratio", "venues" ], "properties": { "date": { "type": "string" }, "venues": { "type": "object", "required": [ "nyse", "nasdaq_carteret", "nasdaq_chicago", "adf" ], "properties": { "adf": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nyse": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nasdaq_chicago": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "nasdaq_carteret": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "short_volume": { "type": "number" }, "total_volume": { "type": "number" }, "exempt_volume": { "type": "number" }, "non_exempt_volume": { "type": "number" }, "short_volume_ratio": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "short_interest": { "anyOf": [ { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "count", "latest", "history" ], "properties": { "count": { "type": "number" }, "latest": { "anyOf": [ { "type": "object", "required": [ "settlement_date", "short_interest", "avg_daily_volume", "days_to_cover" ], "properties": { "days_to_cover": { "type": "number" }, "short_interest": { "type": "number" }, "settlement_date": { "type": "string" }, "avg_daily_volume": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "history": { "type": "array", "items": { "type": "object", "required": [ "settlement_date", "short_interest", "avg_daily_volume", "days_to_cover" ], "properties": { "days_to_cover": { "type": "number" }, "short_interest": { "type": "number" }, "settlement_date": { "type": "string" }, "avg_daily_volume": { "type": "number" } }, "additionalProperties": false } } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "fails_to_deliver": { "anyOf": [ { "type": "object", "required": [ "source", "as_of", "symbol", "periods_read", "count", "note", "fails" ], "properties": { "note": { "type": "string" }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "count": { "type": "number" }, "fails": { "type": "array", "items": { "type": "object", "required": [ "settlement_date", "cusip", "symbol", "fails", "description", "price" ], "properties": { "cusip": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "fails": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "price": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "symbol": { "type": "string" }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "settlement_date": { "type": "string" } }, "additionalProperties": false } }, "source": { "type": "string", "const": "sec_edgar" }, "symbol": { "type": "string" }, "periods_read": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Short-squeeze bundle: short interest, daily short volume, and fails-to-deliver in one call", "operationId": "v1_squeeze_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [ "Response schema not provided in documentation" ], "pages": [ 1 ], "sourceId": "sds_JCTvCfOjjIdw0XzdqbOif", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_z5ju9Tpei8xwj_T7L8zQA" } ], "x-zeroclick-services": [ "options-short-interest" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "40000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.040000 per request (squeeze, service options-short-interest)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.040000" }, "rates": [ { "service": "options-short-interest", "meter": "squeeze", "unit": "request", "unitSize": 1, "priceUsd": "0.040000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "options-short-interest", "meter": "squeeze", "quantity": 1 } ] } } }, "/api/v1/technicals/{ticker}": { "get": { "summary": "Use for a quick momentum or trend read on a US-listed stock. Returns the latest RSI (14) with overbought, oversold, or neutral zone, SMA 50 and EMA 20 with price position, and MACD with signal cross state, alongside the current delayed price. Factual indicator readings, not buy or sell guidance. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "price", "rsi_14", "sma_50", "ema_20", "macd" ], "properties": { "macd": { "type": "object", "anyOf": [ { "type": "object", "required": [ "value", "signal", "histogram", "position" ], "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "signal": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "type": "string" }, "histogram": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "price": { "type": "object", "required": [ "last", "change_percent" ], "properties": { "last": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "ema_20": { "type": "object", "anyOf": [ { "type": "object", "required": [ "value", "price_vs_percent", "position" ], "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "type": "string" }, "price_vs_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "rsi_14": { "type": "object", "anyOf": [ { "type": "object", "required": [ "value", "zone" ], "properties": { "zone": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "sma_50": { "type": "object", "anyOf": [ { "type": "object", "required": [ "value", "price_vs_percent", "position" ], "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "position": { "type": "string" }, "price_vs_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Technical indicators in one call: RSI, SMA, EMA, MACD with signal zones", "operationId": "v1_technicals_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ZK2ecHqWAWiyVS6dEqpau", "authority": "supplemental", "conflicts": [ "/summary", "/description", "/operationId" ], "revisionId": "sdrn_35aNHJCuOgzhkS7Elas2j" } ], "x-zeroclick-services": [ "technical-analysis" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "30000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.030000 per request (technicals, service technical-analysis)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.030000" }, "rates": [ { "service": "technical-analysis", "meter": "technicals", "unit": "request", "unitSize": 1, "priceUsd": "0.030000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "technical-analysis", "meter": "technicals", "quantity": 1 } ] } } }, "/api/v1/tickers": { "get": { "summary": "Find tickers by free-text `?search=` (name or symbol) across asset classes via `?market=stocks|crypto|fx|indices` (default stocks), with optional `?type=`, `?exchange=`, `?active=`, `?limit=`. Returns symbol, name, market, exchange, type, and identifiers. Use to discover crypto pairs (X:BTCUSD), FX pairs (C:EURUSD), and index symbols (I:SPX). From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "tickers" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "tickers": { "type": "array", "items": { "type": "object", "required": [ "ticker", "name", "market", "locale", "primary_exchange", "type", "active", "currency", "cik", "composite_figi" ], "properties": { "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "locale": { "type": "string" }, "market": { "type": "string" }, "ticker": { "type": "string" }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "composite_figi": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "search", "schema": { "type": "string", "maxLength": 100, "minLength": 1 } }, { "in": "query", "name": "type", "schema": { "type": "string", "maxLength": 20, "minLength": 1 } }, { "in": "query", "name": "exchange", "schema": { "type": "string", "maxLength": 20, "minLength": 1 } }, { "in": "query", "name": "market", "schema": { "enum": [ "stocks", "crypto", "fx", "indices" ], "type": "string", "default": "stocks" } }, { "in": "query", "name": "active", "schema": { "type": "boolean", "default": true } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 20, "maximum": 1000, "exclusiveMinimum": 0 } } ], "description": "Search / list tickers across stocks, crypto, forex, and indices", "operationId": "v1_tickers", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (tickers, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "tickers", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "tickers", "quantity": 1 } ] } } }, "/api/v1/ticker/{ticker}": { "get": { "summary": "Company name, exchange, market cap, share class, SIC code, address, and other reference fields for a US-listed ticker. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "ticker", "data", "source", "as_of" ], "properties": { "data": { "type": "object", "required": [ "name", "market", "locale", "active", "cik", "composite_figi", "share_class_figi", "market_cap", "sic_code", "sic_description", "description", "homepage", "phone", "address", "list_date", "employees", "shares_outstanding", "logo_url", "icon_url" ], "properties": { "cik": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "type": "string" }, "type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "active": { "type": "boolean" }, "locale": { "type": "string" }, "market": { "type": "string" }, "address": { "anyOf": [ { "type": "object", "properties": { "city": { "type": "string" }, "state": { "type": "string" }, "address1": { "type": "string" }, "postal_code": { "type": "string" } }, "additionalProperties": false }, { "type": "null" } ] }, "currency": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "homepage": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "icon_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sic_code": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "employees": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "list_date": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "market_cap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "composite_figi": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sic_description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_exchange": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "share_class_figi": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "shares_outstanding": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "as_of": { "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "ticker": { "type": "string" }, "feedback": { "type": "object", "required": [ "endpoint", "method", "free", "note" ], "properties": { "free": { "type": "boolean" }, "note": { "type": "string" }, "method": { "type": "string", "const": "POST" }, "endpoint": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "Company / ticker reference data", "operationId": "v1_ticker_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (ticker, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "ticker", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "ticker", "quantity": 1 } ] } } }, "/api/v1/ticker-types": { "get": { "summary": "Reference list of security type codes used in ticker reference data (e.g. CS = Common Stock, ETF, PFD, WARRANT) with descriptions. From x402stock, a pay-per-call market & economic data API for AI agents. No API key or account; pay in USDC via x402.", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "types" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "types": { "type": "array", "items": { "type": "object", "required": [ "code", "description", "asset_class", "locale" ], "properties": { "code": { "type": "string" }, "locale": { "type": "string" }, "asset_class": { "type": "string" }, "description": { "type": "string" } }, "additionalProperties": false } }, "source": { "type": "string", "const": "x402stock" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Ticker type codes reference (CS, ETF, ADRC, …)", "operationId": "v1_ticker-types", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "company-fundamentals" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (ticker_types, service company-fundamentals)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "company-fundamentals", "meter": "ticker_types", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "company-fundamentals", "meter": "ticker_types", "quantity": 1 } ] } } }, "/api/v1/treasury-yields": { "get": { "summary": "The daily US Treasury par yield curve (Constant Maturity Treasury rates) for every maturity from 1 month to 30 years, in percent. Defaults to the latest published day; pass `?limit=` for more recent days (max 250) and `?year=YYYY`. No ticker needed. Use for the risk-free rate, rate-sensitivity context, and yield-curve inversion in macro-aware analysis. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "series", "unit", "maturities", "count", "rates" ], "properties": { "unit": { "type": "string" }, "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "count": { "type": "number" }, "rates": { "type": "array", "items": { "type": "object", "required": [ "date", "rates" ], "properties": { "date": { "type": "string" }, "rates": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "additionalProperties": false } }, "series": { "type": "string" }, "source": { "type": "string", "const": "us_treasury" }, "maturities": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 1, "maximum": 250, "exclusiveMinimum": 0 } }, { "in": "query", "name": "year", "schema": { "type": "integer", "maximum": 2100, "minimum": 1990 } } ], "description": "US Treasury par yield curve (1mo to 30yr) for the latest day or a date range", "operationId": "v1_treasury-yields", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "us-macro-rates" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (treasury_yields, service us-macro-rates)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "us-macro-rates", "meter": "treasury_yields", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "us-macro-rates", "meter": "treasury_yields", "quantity": 1 } ] } } }, "/api/v1/trending": { "get": { "summary": "Use for one call answering 'where is retail attention right now': a deterministic 0–100 attention score per ticker blending Reddit finance-community and 4chan /biz/ mention shares (24h window), with momentum, cross-platform confirmation, breadth & concentration (HHI), and Fear & Greed context. Transparent — every row carries its raw per-platform inputs. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "window", "methodology", "sections", "market_context", "breadth", "count", "leaders" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "window": { "type": "string", "const": "24h" }, "breadth": { "type": "object", "required": [ "tickers_tracked", "total_reddit_mentions", "total_fourchan_mentions", "concentration_hhi" ], "properties": { "tickers_tracked": { "type": "number" }, "concentration_hhi": { "type": "number" }, "total_reddit_mentions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "total_fourchan_mentions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "leaders": { "type": "array", "items": { "type": "object", "required": [ "rank", "ticker", "name", "attention_score", "mention_share_percent", "cross_platform", "momentum_24h_percent", "reddit", "fourchan" ], "properties": { "name": { "type": "string" }, "rank": { "type": "number" }, "reddit": { "anyOf": [ { "type": "object", "required": [ "rank", "mentions", "mentions_change_percent" ], "properties": { "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "ticker": { "type": "string" }, "fourchan": { "anyOf": [ { "type": "object", "required": [ "rank", "mentions", "mentions_change_percent" ], "properties": { "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] }, "cross_platform": { "type": "boolean" }, "attention_score": { "type": "number" }, "momentum_24h_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mention_share_percent": { "type": "number" } }, "additionalProperties": false } }, "sections": { "type": "object", "required": [ "reddit", "fourchan", "fear_greed" ], "properties": { "reddit": { "enum": [ "ok", "unavailable" ], "type": "string" }, "fourchan": { "enum": [ "ok", "unavailable" ], "type": "string" }, "fear_greed": { "enum": [ "ok", "unavailable" ], "type": "string" } }, "additionalProperties": false }, "methodology": { "type": "string" }, "market_context": { "anyOf": [ { "type": "object", "required": [ "fear_greed_score", "fear_greed_rating" ], "properties": { "fear_greed_score": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "fear_greed_rating": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Retail attention index: cross-platform 0–100 scores, momentum, concentration", "operationId": "v1_trending", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "40000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.040000 per request (trending, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.040000" }, "rates": [ { "service": "sentiment-positioning", "meter": "trending", "unit": "request", "unitSize": 1, "priceUsd": "0.040000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "trending", "quantity": 1 } ] } } }, "/api/v1/trending/4chan": { "get": { "summary": "What tickers 4chan's finance board (/biz/) is buzzing about most over the last 24h, ranked by mention volume. Each ticker carries its mention count and 24h change in rank and mentions (4chan has no upvotes, so upvotes is always 0). No ticker needed; ?page= to paginate (100 per page). A raw read of /biz/ chatter, separate from the Reddit feed. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "platform", "board", "window", "page", "pages", "count", "results" ], "properties": { "page": { "type": "number" }, "as_of": { "type": "string" }, "board": { "type": "string", "const": "/biz/" }, "count": { "type": "number" }, "pages": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "window": { "type": "string", "const": "24h" }, "results": { "type": "array", "items": { "type": "object", "required": [ "rank", "ticker", "name", "mentions", "upvotes", "rank_24h_ago", "mentions_24h_ago", "mentions_change", "mentions_change_percent", "rank_change" ], "properties": { "name": { "type": "string" }, "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "upvotes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rank_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rank_24h_ago": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions_24h_ago": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "platform": { "type": "string", "const": "4chan" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "Trending tickers on 4chan /biz/ (last 24h): the most-mentioned by post volume", "operationId": "v1_trending_4chan", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (trending_4chan, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "sentiment-positioning", "meter": "trending_4chan", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "trending_4chan", "quantity": 1 } ] } } }, "/api/v1/trending/reddit": { "get": { "summary": "What stocks and crypto Reddit is talking about most over the last 24h, by mention volume across the busiest Reddit money subreddits (r/wallstreetbets, r/stocks, r/CryptoCurrency, r/Bitcoin, etc.). Each ticker carries mentions, upvotes, and 24h change in rank and mentions; covered subreddits are listed per response. ?filter=stocks|crypto|all (default all), ?page=. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "platform", "filter", "window", "communities", "page", "pages", "count", "results" ], "properties": { "page": { "type": "number" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "pages": { "type": "number" }, "filter": { "enum": [ "all", "stocks", "crypto" ], "type": "string" }, "source": { "type": "string", "const": "x402stock" }, "window": { "type": "string", "const": "24h" }, "results": { "type": "array", "items": { "type": "object", "required": [ "rank", "ticker", "name", "mentions", "upvotes", "rank_24h_ago", "mentions_24h_ago", "mentions_change", "mentions_change_percent", "rank_change" ], "properties": { "name": { "type": "string" }, "rank": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "upvotes": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rank_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "rank_24h_ago": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions_change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions_24h_ago": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "mentions_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "platform": { "type": "string", "const": "reddit" }, "communities": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "filter", "schema": { "enum": [ "all", "stocks", "crypto" ], "type": "string", "default": "all" } }, { "in": "query", "name": "page", "schema": { "type": "integer", "default": 1, "maximum": 100, "exclusiveMinimum": 0 } } ], "description": "Trending tickers on Reddit (last 24h): the most-mentioned stocks, crypto, or both", "operationId": "v1_trending_reddit", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "sentiment-positioning" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (trending_reddit, service sentiment-positioning)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "sentiment-positioning", "meter": "trending_reddit", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "sentiment-positioning", "meter": "trending_reddit", "quantity": 1 } ] } } }, "/api/v1/unified-snapshot": { "get": { "summary": "Snapshot a list of US-listed tickers at once: for each symbol, the company name, market session, current price, day change and percent change, day OHLCV with VWAP, and previous close. Pass a comma-separated list via `?tickers=AAPL,MSFT,NVDA` (up to 250). Built for pricing a watchlist or portfolio in a single request. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "count", "tickers" ], "properties": { "as_of": { "type": "string" }, "count": { "type": "number" }, "source": { "type": "string", "const": "x402stock" }, "tickers": { "type": "array", "items": { "type": "object", "required": [ "ticker", "name", "market_status", "price", "change", "change_percent", "day", "previous_close", "updated" ], "properties": { "day": { "type": "object", "anyOf": [ { "type": "object", "required": [ "open", "high", "low", "close", "volume", "vwap" ], "properties": { "low": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "high": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "open": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "vwap": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "close": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "volume": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, { "type": "null" } ], "properties": { "low": { "type": "number" }, "high": { "type": "number" }, "open": { "type": "number" }, "vwap": { "type": "number" }, "close": { "type": "number" }, "volume": { "type": "number" } } }, "name": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "price": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "change": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "ticker": { "type": "string" }, "updated": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "market_status": { "type": "string", "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "change_percent": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "previous_close": { "type": "number", "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "query", "name": "tickers", "schema": { "type": "string", "minLength": 1 }, "required": true, "description": "Comma-separated list of tickers" } ], "description": "Multi-ticker snapshot: fetch a whole watchlist's prices in one call", "operationId": "v1_unified-snapshot", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_ga1phPv9S6kEqxFH_JwZ9", "authority": "supplemental", "conflicts": [ "/summary", "/responses/200/content/application/json/schema/properties/count/type", "/parameters/query/tickers/required", "/description", "/operationId" ], "revisionId": "sdrn_6bMLTumuFfzdUgYpYp2fw" } ], "x-zeroclick-services": [ "stock-quotes" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (unified_snapshot, service stock-quotes)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "stock-quotes", "meter": "unified_snapshot", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "stock-quotes", "meter": "unified_snapshot", "quantity": 1 } ] } } }, "/api/v1/world-bank/country/{iso}": { "get": { "summary": "A country's macro profile in one call: latest GDP, GDP growth, GDP per capita, inflation, unemployment, population, government debt, current account, exports, and FDI, from the World Bank's World Development Indicators. Pass an ISO country code in the path (e.g. US, CN, IN, DE). International macro the US-only FRED/BLS endpoints don't cover. Source: World Bank (CC BY 4.0). From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "country", "indicators", "attribution" ], "properties": { "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "source": { "type": "string", "const": "world_bank" }, "country": { "type": "object", "required": [ "code", "name", "iso3" ], "properties": { "code": { "type": "string" }, "iso3": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "indicators": { "type": "array", "items": { "type": "object", "required": [ "indicator", "indicator_code", "indicator_name", "latest" ], "properties": { "latest": { "anyOf": [ { "type": "object", "required": [ "year", "value" ], "properties": { "year": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "indicator": { "type": "string" }, "indicator_code": { "type": "string" }, "indicator_name": { "type": "string" } }, "additionalProperties": false } }, "attribution": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "iso", "schema": { "type": "string" }, "example": "US", "required": true, "description": "ISO 3166 country code (2- or 3-letter), e.g. US or USA." } ], "description": "Country macro snapshot: GDP, growth, inflation, unemployment, debt and more in one call", "operationId": "v1_world-bank_country_{iso}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "global-fx-commodities" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (world_bank_country, service global-fx-commodities)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "global-fx-commodities", "meter": "world_bank_country", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "global-fx-commodities", "meter": "world_bank_country", "quantity": 1 } ] } } }, "/api/v1/world-bank/{indicator}": { "get": { "summary": "Annual time series of one World Bank indicator for a country, with latest value, prior year, and change. Indicators: gdp, gdp-growth, gdp-per-capita, inflation, unemployment, population, govt-debt, current-account, exports, fdi. Pick the country with `?country=US` (ISO2/ISO3, default US) and the span with `?limit=` years (default 10). Cross-country macro reference. Source: World Bank (CC BY 4.0).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "indicator", "indicator_code", "indicator_name", "country", "last_updated", "latest", "prior", "change", "change_percent", "history", "attribution" ], "properties": { "as_of": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "prior": { "anyOf": [ { "type": "object", "required": [ "year", "value" ], "properties": { "year": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "change": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest": { "anyOf": [ { "type": "object", "required": [ "year", "value" ], "properties": { "year": { "type": "string" }, "value": { "type": "number" } }, "additionalProperties": false }, { "type": "null" } ] }, "source": { "type": "string", "const": "world_bank" }, "country": { "type": "object", "required": [ "code", "name", "iso3" ], "properties": { "code": { "type": "string" }, "iso3": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "additionalProperties": false }, "history": { "type": "array", "items": { "type": "object", "required": [ "year", "value" ], "properties": { "year": { "type": "string" }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "indicator": { "type": "string" }, "attribution": { "type": "string" }, "last_updated": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "indicator_code": { "type": "string" }, "indicator_name": { "type": "string" } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "indicator", "schema": { "type": "string" }, "example": "NY.GDP.MKTP.CD", "required": true, "description": "World Bank WDI indicator code, e.g. NY.GDP.MKTP.CD." }, { "in": "query", "name": "country", "schema": { "type": "string", "default": "US", "pattern": "^[A-Za-z]{2,3}$" } }, { "in": "query", "name": "limit", "schema": { "type": "integer", "default": 10, "maximum": 66, "exclusiveMinimum": 0 } } ], "description": "One World Bank indicator's annual time series for any country", "operationId": "v1_world-bank_{indicator}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [ "Missing response schema" ], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "global-fx-commodities" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "10000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.010000 per request (world_bank, service global-fx-commodities)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.010000" }, "rates": [ { "service": "global-fx-commodities", "meter": "world_bank", "unit": "request", "unitSize": 1, "priceUsd": "0.010000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "global-fx-commodities", "meter": "world_bank", "quantity": 1 } ] } } }, "/api/v1/xstocks": { "get": { "summary": "Use to monitor tokenized US equities (xStocks) against their real underlyings: every tracked xStock's on-chain price decoded from Raydium CLMM pool state on the public Solana ledger (no Backed/Chainlink/Pyth API), the underlying's live quote, and the premium/discount percent — plus pool liquidity, scaled-UI multiplier, and a us_market_open arb-context flag. From x402stock", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "protocol", "program", "note", "us_market_open", "sections", "count", "items" ], "properties": { "note": { "type": "string" }, "as_of": { "type": "string" }, "count": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "required": [ "symbol", "underlying", "pool", "mint", "xstock_price_usd", "pool_price_raw_unit", "multiplier", "liquidity", "tick_current", "underlying_price_usd", "underlying_change_percent", "underlying_market_status", "premium_percent" ], "properties": { "mint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pool": { "type": "string" }, "symbol": { "type": "string" }, "liquidity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "multiplier": { "type": "number" }, "underlying": { "type": "string" }, "tick_current": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "premium_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "xstock_price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pool_price_raw_unit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "underlying_price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "underlying_market_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "underlying_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false } }, "venue": { "type": "string", "const": "solana" }, "source": { "type": "string", "const": "x402stock" }, "program": { "type": "string" }, "protocol": { "type": "string", "const": "raydium-clmm" }, "sections": { "type": "object", "required": [ "onchain", "underlying" ], "properties": { "onchain": { "type": "string", "const": "ok" }, "underlying": { "enum": [ "ok", "unavailable" ], "type": "string" } }, "additionalProperties": false }, "us_market_open": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "description": "Tokenized-equity (xStocks) on-chain prices vs. underlyings, with premium.", "operationId": "v1_xstocks", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "40000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.040000 per request (xstocks, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.040000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "xstocks", "unit": "request", "unitSize": 1, "priceUsd": "0.040000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "xstocks", "quantity": 1 } ] } } }, "/api/v1/xstocks/{ticker}": { "get": { "summary": "Use to track one tokenized equity by xStock symbol (AAPLx) or underlying ticker (AAPL): the on-chain Raydium CLMM pool price from the public Solana ledger, the per-share price after its Token-2022 scaled-UI multiplier, the underlying's live quote, and the premium/discount percent. List every tracked symbol via /xstocks. From x402stock, a market & economic data API (x402, USDC).", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "as_of", "venue", "protocol", "program", "note", "us_market_open", "sections", "item" ], "properties": { "item": { "type": "object", "required": [ "symbol", "underlying", "pool", "mint", "xstock_price_usd", "pool_price_raw_unit", "multiplier", "liquidity", "tick_current", "underlying_price_usd", "underlying_change_percent", "underlying_market_status", "premium_percent" ], "properties": { "mint": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "pool": { "type": "string" }, "symbol": { "type": "string" }, "liquidity": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "multiplier": { "type": "number" }, "underlying": { "type": "string" }, "tick_current": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "premium_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "xstock_price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "pool_price_raw_unit": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "underlying_price_usd": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "underlying_market_status": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "underlying_change_percent": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } }, "additionalProperties": false }, "note": { "type": "string" }, "as_of": { "type": "string" }, "venue": { "type": "string", "const": "solana" }, "source": { "type": "string", "const": "x402stock" }, "program": { "type": "string" }, "protocol": { "type": "string", "const": "raydium-clmm" }, "sections": { "type": "object", "required": [ "onchain", "underlying" ], "properties": { "onchain": { "type": "string", "const": "ok" }, "underlying": { "enum": [ "ok", "unavailable" ], "type": "string" } }, "additionalProperties": false }, "us_market_open": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] } }, "additionalProperties": false } } }, "description": "Successful response" }, "402": { "description": "Payment required" } }, "parameters": [ { "in": "path", "name": "ticker", "schema": { "type": "string" }, "example": "AAPL", "required": true, "description": "US-listed ticker symbol (uppercase), e.g. AAPL." } ], "description": "One xStock: on-chain price, underlying quote, live premium/discount.", "operationId": "v1_xstocks_{ticker}", "x-zeroclick-document-sources": [ { "gaps": [], "pages": [], "sourceId": "sds_Uj696aGsgTK217yNyDaJ1", "authority": "official", "conflicts": [], "revisionId": "sdrn_Q38GNDB85-VxugE_TP3Yw" }, { "gaps": [], "pages": [ 1 ], "sourceId": "sds_AlfB7a9o5AfOpVzzehAmz", "authority": "supplemental", "conflicts": [ "/summary", "/operationId" ], "revisionId": "sdrn_mPIpdYKK84CNT4aRpO4kh" } ], "x-zeroclick-services": [ "onchain-tokenized-assets" ], "x-payment-info": { "access": "payg", "protocols": [ { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } }, { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } } ], "offers": [ { "amount": "20000", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "description": "$0.020000 per request (xstocks_ticker, service onchain-tokenized-assets)", "intent": "charge", "method": "tempo" } ], "price": { "mode": "fixed", "currency": "USD", "amount": "0.020000" }, "rates": [ { "service": "onchain-tokenized-assets", "meter": "xstocks_ticker", "unit": "request", "unitSize": 1, "priceUsd": "0.020000", "includedUnits": 0 } ], "perCallUsage": [ { "service": "onchain-tokenized-assets", "meter": "xstocks_ticker", "quantity": 1 } ] } } }, "/zeroclick/agent/quote": { "post": { "operationId": "sellerAgentQuote", "summary": "Get a free seller API quote and purchase guide", "description": "Describe your task to get the matching API contract, prices, prerequisites and next steps. This is a $0 wallet-proof lookup, not the seller's paid service. No purchase is executed. Without a wallet, use /zeroclick/agent/guide.", "servers": [ { "url": "https://agents.x402stock.xyz" } ], "security": [ { "sellerAgentX402": [] }, { "sellerAgentMpp": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "goal": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "Describe the task and known inputs. Do not include credentials." }, "quantity": { "description": "Number of API calls, not returned items. Omit when unknown; describe desired output in goal.", "type": "integer", "minimum": 1, "maximum": 1000000 }, "budgetUsd": { "description": "Total cash budget in USD. A quote does not authorize spending.", "type": "string", "pattern": "^(0|[1-9]\\d{0,8})(\\.\\d{1,6})?$" }, "budgetExclusive": { "type": "boolean" }, "reviewAfterCalls": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "requirements": { "type": "string", "minLength": 1, "maxLength": 300 }, "humanAvailable": { "description": "Whether a human is in the loop. False recommends anonymous auth for a new autonomous identity; omit when unknown. Executing a human's request without further interruptions does not by itself mean false.", "type": "boolean" }, "payment": { "description": "Known payment method for the eventual purchase, independent of this free lookup's wallet proof.", "type": "string", "enum": [ "x402", "mpp", "card" ] } }, "required": [ "goal" ], "additionalProperties": false }, "example": { "goal": "Find the available services, prices and purchase steps" } } } }, "responses": { "200": { "description": "Task guidance; inspect status before executing anything", "content": { "application/json": { "schema": { "$schema": "https://json-schema.org/draft/2020-12/schema", "type": "object", "properties": { "status": { "type": "string", "enum": [ "quoted", "ready", "needs_input", "blocked", "unknown", "unsupported", "unavailable" ] }, "priceUsd": { "type": "string", "const": "0" }, "guide": { "type": "string", "description": "Markdown guidance containing the task result, exact contract, pricing and next steps when available. No purchase is executed." }, "guideUrl": { "type": "string", "format": "uri", "description": "Wallet-free advisor endpoint for further planning or recovery." } }, "required": [ "status", "priceUsd", "guide", "guideUrl" ], "additionalProperties": false } } } }, "402": { "description": "$0 x402 or MPP wallet proof required; sign and retry the same request. No funds are transferred." }, "503": { "description": "Advisor unavailable; use the wallet-free guide or direct storefront references" } }, "x-payment-info": { "access": "payg", "price": { "mode": "fixed", "currency": "USD", "amount": "0" }, "protocols": [ { "x402": { "network": "eip155:8453", "scheme": "exact", "currency": "USDC" } }, { "mpp": { "method": "tempo", "intent": "charge", "currency": "USD" } } ], "offers": [ { "amount": "0", "currency": "0x20C000000000000000000000b9537d11c60E8b50", "method": "tempo", "intent": "charge", "description": "Free seller advisor lookup" } ] } } } }, "x-zeroclick-navigation-footer": { "instructions": [ "Use this spec if it contains the operation and details you need. Otherwise, search or open a relevant service spec using the links below.", "Find service slugs in x-zeroclick-services or x-payment-info.rates[].service; use them in serviceSpecTemplate, never as request values.", "URL-encode template values. Search is ranked; service, path, and method filters are exact. Filters combine.", "Pages contain up to 10 operations; follow info.x-next or the Link header if you need more results. Shared operations retain all selector values." ], "fullSpec": "https://agents.x402stock.xyz/openapi.json", "services": "https://agents.x402stock.xyz/services", "serviceSpecTemplate": "https://agents.x402stock.xyz/services/{slug}/openapi.json", "searchTemplate": "https://agents.x402stock.xyz/openapi.json?q={text}", "operationTemplate": "https://agents.x402stock.xyz/openapi.json?path={path}&method={method}", "firstPage": "https://agents.x402stock.xyz/openapi.json?page=1" } }