{ "openapi": "3.1.0", "info": { "title": "Astreus API", "version": "2026-11-12", "description": "Astreus is a financial data terminal that turns the world's unstructured financial disclosure into structured, traceable data. It reads what companies, exchanges and central banks publish — annual and interim reports, SEC filings, results announcements, investor presentations, earnings calls, 8-Ks, regulator notices and policy text — across the United States, the Gulf (Tadawul, DFM, ADX, Boursa Kuwait, QSE), Japan, Taiwan, Korea, the UK and Europe, and serves it as data a program can trust: standardized financial statements (annual, quarterly, semiannual), segments and KPIs, the tables inside the notes, filing sections as text, investor decks page by page, earnings-call transcripts and audio, span-anchored observations, management guidance scored against outcomes, typed 8-K events, an attributed intraday news tape, insider and 13F ownership, a people registry, macro series (the current vintage: the latest published value for each period) and central-bank text, benchmark, commodity and compute-price series, and a source-linked claim graph with declared validation limits. Use `fact-source` and document metadata to retain available provenance. Publication and entitlement gates apply per dataset; inspect availability and tool limitations.\n\nCoverage is published live: `GET /api/v1/landing/coverage` (no key) returns every market served with company counts, history depth, completeness and periods held per data type — ask it before answering \"what do you cover?\". `{id}` is a ticker, a numeric SEC CIK, or a platform key for a non-SEC issuer (XSAU000001) — the `cik` field of the company payload. Human-readable guides: https://doc.astreus.ai (coverage at /coverage, data catalog at /data-catalog).\n\nTiers: `public` endpoints need no credentials. Everything else takes an **API key** — create one on the Developers page in the terminal (https://astreus.ai/developers) and send it as `X-API-KEY: pk_live_...` (or `Authorization: Bearer pk_live_...`). Signed-in terminal sessions may use their Cognito ID token instead.\n\nRate limits and quotas are per plan (fixed UTC windows): Free — 30 req/min, 250 req/day; Build — 300 req/min, 100,000 req/month; Scale — custom. Build, Scale and prepaid credits are set up with sales (https://astreus.ai/contact), not self-serve. Responses carry RateLimit-*, X-Quota-* and, when credits pay, X-Billing-Source/X-Credits-Remaining-USD headers; a 429 carries `Retry-After` and a machine `code` of rate_limited or quota_exceeded (with sales_email).\n\nServer-side use: `/api/v1` sends no CORS headers, so a browser page on another origin cannot call it. Call it from a server, a script or an agent, and keep the key there.\n\nVersioning: `info.version` is the UTC date the contract last changed, and every response carries it in `x-astreus-api-version`. Within `/api/v1` changes are additive; a field or parameter that will go is marked `deprecated` first and kept for at least 90 days. Policy: https://doc.astreus.ai/versioning.\n\nNot investment advice. See /terms.", "contact": { "email": "saif@astreus.ai" }, "termsOfService": "https://astreus.ai/terms", "license": { "name": "Proprietary: Astreus terms of service", "url": "https://astreus.ai/terms" } }, "servers": [ { "url": "https://astreus.ai" } ], "security": [], "tags": [ { "name": "Search & Meta", "description": "Entity resolution and platform metadata." }, { "name": "Company Data", "description": "Profiles, structure, leadership, calendars." }, { "name": "Geo & Assets", "description": "Physical assets on the map — what a company owns, operates or develops, where, since when, at what location precision, and the source behind each fact." }, { "name": "Financial Statements", "description": "Standardized XBRL-derived statements — every line traceable to its filing via fact provenance." }, { "name": "SEC Filings", "description": "The filing index and documents (SEC and exchange-published), parsed section text, and the tables inside the notes as gated grids and series." }, { "name": "8-K Events", "description": "Material events: 8-K items and exchange disclosures by item code, filterable by family, with extracted item text." }, { "name": "News", "description": "The intraday news tape: filings, releases and licensed wires with source attribution, storylines and topics." }, { "name": "Transcripts & Calls", "description": "Earnings-call transcripts, span-anchored observations, IR decks." }, { "name": "Guidance & Scorecards", "description": "What management promised vs. what happened." }, { "name": "Ownership & Insiders", "description": "13F holders, Forms 3/4/5, the people registry." }, { "name": "Macro", "description": "Economic series (the current vintage: the latest published value for each period) and central-bank text." }, { "name": "Market Data", "description": "Daily bars for stocks, benchmarks, commodities and compute." }, { "name": "Intelligence", "description": "Narratives and source-linked claims with declared validation status." }, { "name": "Analytics", "description": "Charting over any catalog series." } ], "components": { "securitySchemes": { "apiKey": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "description": "Astreus API key (pk_live_...), created on the Developers page in the terminal. Also accepted as `Authorization: Bearer pk_live_...`.", "x-default": "pk_live_YOUR_KEY" }, "cognitoIdToken": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Amazon Cognito ID token (token_use=id) for the Astreus user pool — the terminal's own session credential. API consumers should use an API key instead." } }, "schemas": { "Error": { "type": "object", "required": [ "error", "code" ], "properties": { "error": { "type": "string", "description": "Human-readable message. It may change; branch on `code`." }, "code": { "type": "string", "description": "Stable machine code; every error carries one. unknown_parameter, invalid_parameter and missing_parameter come with `param`; unknown_parameter also with `allowed`. A route may add codes of its own (e.g. key_limit); treat an unlisted code by its HTTP status.", "enum": [ "unknown_parameter", "invalid_parameter", "missing_parameter", "invalid_request", "unauthenticated", "upgrade_required", "forbidden", "not_found", "conflict", "too_large", "unsupported_media_type", "rate_limited", "quota_exceeded", "auth_unavailable", "upstream_unavailable", "internal_error" ] }, "param": { "type": "string", "description": "The query parameter at fault, when one is." }, "allowed": { "type": "array", "items": { "type": "string" }, "description": "With unknown_parameter: every query parameter the route takes." } } }, "Transformation": { "type": "string", "enum": [ "none", "pct_change", "yoy_pct_change", "first_difference", "log", "z_score", "rolling_volatility" ] }, "ChartSeriesDescriptor": { "description": "What to chart. Symbol/indicator/metric vocabularies are served by /api/v1/correlation/catalog.", "oneOf": [ { "type": "object", "required": [ "type", "indicatorCode" ], "properties": { "type": { "const": "macro" }, "indicatorCode": { "type": "string" } } }, { "type": "object", "required": [ "type", "companyId", "metric", "periodBasis" ], "properties": { "type": { "const": "company_fundamental" }, "companyId": { "type": "string" }, "metric": { "type": "string" }, "periodBasis": { "type": "string", "enum": [ "annual", "quarterly" ] } } }, { "type": "object", "required": [ "type", "companyId", "priceField" ], "properties": { "type": { "const": "stock_price" }, "companyId": { "type": "string" }, "priceField": { "type": "string", "enum": [ "close", "adj_close", "volume" ] } } }, { "type": "object", "required": [ "type", "symbol", "priceField" ], "properties": { "type": { "const": "index_price" }, "symbol": { "type": "string" }, "priceField": { "type": "string", "enum": [ "close", "adj_close", "volume" ] } } }, { "type": "object", "required": [ "type", "symbol" ], "properties": { "type": { "const": "commodity_price" }, "symbol": { "type": "string" } } } ] }, "NewsItem": { "type": "object", "required": [ "id", "sourceCode", "sourceName", "sourceKind", "displayPolicy", "attribution", "headline", "headlineKind", "snippet", "url", "publishedAt", "observedAt", "updatedAt", "importance", "isFlash", "tickers", "primaryCik", "formType", "itemCodes", "topics", "clusterId", "language", "publisher" ], "properties": { "id": { "type": "integer", "format": "int64" }, "sourceCode": { "type": "string", "description": "Tape code of the source, e.g. EDG, BW, FED." }, "sourceName": { "type": "string" }, "sourceKind": { "type": "string", "description": "edgar | wire_rss | ir_rss | gov | central_bank | exchange | regulator | social | aggregator | vendor | publisher_rss | macro." }, "displayPolicy": { "type": "string", "enum": [ "full_text", "headline_snippet", "headline_link" ], "description": "What the API is allowed to emit for this source; enforced server-side." }, "attribution": { "type": "string", "description": "Render on every row, e.g. \"Source: SEC EDGAR\"." }, "headline": { "type": "string" }, "headlineKind": { "type": "string", "enum": [ "source", "flash", "model" ], "description": "source = as published; flash/model = grounded rewrite by the flash desk." }, "snippet": { "type": [ "string", "null" ], "description": "null when the source is link-only, regardless of what was ingested." }, "url": { "type": [ "string", "null" ], "description": "Canonical source URL." }, "publishedAt": { "type": "string", "format": "date-time", "description": "Source timestamp (EDGAR acceptance, feed pubDate, post createdAt)." }, "observedAt": { "type": "string", "format": "date-time", "description": "When Astreus first saw the item." }, "updatedAt": { "type": "string", "format": "date-time", "description": "Bumps when the headline is rewritten or tags change; drives changedSince." }, "importance": { "type": "integer", "minimum": 0, "maximum": 100 }, "isFlash": { "type": "boolean" }, "tickers": { "type": "array", "items": { "type": "string" } }, "primaryCik": { "type": [ "string", "null" ], "description": "10-character CIK or platform key of the primary company." }, "formType": { "type": [ "string", "null" ], "description": "EDGAR / regulator form type, e.g. 8-K." }, "itemCodes": { "type": [ "array", "null" ], "items": { "type": "string" }, "description": "8-K item codes, e.g. 2.02." }, "topics": { "type": "array", "items": { "type": "string" }, "description": "Topic codes (see /news/topics)." }, "clusterId": { "type": [ "integer", "null" ], "format": "int64", "description": "Storyline id; items in the same cluster describe the same event." }, "language": { "type": [ "string", "null" ] }, "publisher": { "type": [ "string", "null" ], "description": "For aggregator sources, the originating outlet's domain (e.g. reuters.com); null when the source is the publisher." } } }, "NewsFeedResponse": { "type": "object", "required": [ "items", "latestId", "nextCursor", "serverTime" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NewsItem" }, "description": "Newest first." }, "latestId": { "type": [ "integer", "null" ], "format": "int64", "description": "Highest id in the response (never below the caller's `after`); poll with after=latestId." }, "nextCursor": { "type": [ "integer", "null" ], "format": "int64", "description": "Lowest id in the response when more rows exist below it; page older with before=nextCursor. null when exhausted." }, "serverTime": { "type": "string", "format": "date-time", "description": "Database time at query; pass back as changedSince on the next poll." } } }, "NewsEntityRef": { "type": "object", "required": [ "kind", "key", "companyId", "ticker", "name", "role", "method", "confidence" ], "properties": { "kind": { "type": "string", "enum": [ "company", "person", "macro_indicator", "commodity", "country", "index" ] }, "key": { "type": "string", "description": "CIK / platform key for companies, person id, indicator code, symbol or ISO2." }, "companyId": { "type": [ "string", "null" ], "format": "uuid" }, "ticker": { "type": [ "string", "null" ] }, "name": { "type": [ "string", "null" ] }, "role": { "type": "string", "enum": [ "filer", "subject", "issuer", "mention" ] }, "method": { "type": "string", "description": "How the tag was derived: edgar_filer, ticker_tag, cashtag, alias_match, llm, …" }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 } } }, "NewsStory": { "allOf": [ { "$ref": "#/components/schemas/NewsItem" }, { "type": "object", "required": [ "body", "entities", "related", "metadata" ], "properties": { "body": { "type": [ "string", "null" ], "description": "Full text; only ever non-null for full_text-licensed sources." }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/NewsEntityRef" } }, "related": { "type": "array", "items": { "$ref": "#/components/schemas/NewsItem" }, "description": "Other items in the same storyline, newest first (≤10)." }, "metadata": { "type": "object", "additionalProperties": true } } } ] }, "NewsTopic": { "type": "object", "required": [ "code", "label", "group", "isFlashDefault", "count24h" ], "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "group": { "type": "string", "enum": [ "corporate", "macro", "policy", "market", "sector", "region", "social" ] }, "isFlashDefault": { "type": "boolean" }, "count24h": { "type": "integer" } } }, "NewsSourceSummary": { "type": "object", "required": [ "code", "name", "kind", "licenseClass", "displayPolicy", "attribution", "homepageUrl", "count24h" ], "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "licenseClass": { "type": "string", "enum": [ "public_domain", "issuer_owned", "licensed_display", "link_only", "internal_only" ] }, "displayPolicy": { "type": "string", "enum": [ "full_text", "headline_snippet", "headline_link" ] }, "attribution": { "type": "string" }, "homepageUrl": { "type": [ "string", "null" ] }, "count24h": { "type": "integer" } } }, "NewsAlertRule": { "description": "A signed-in user's alert rule (session-only endpoints under /api/v1/news/alerts; not reachable with an API key).", "type": "object", "required": [ "id", "name", "tickers", "ciks", "topicCodes", "sourceCodes", "keywords", "minImportance", "flashOnly", "channels", "isActive", "createdAt", "updatedAt" ], "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string", "maxLength": 120 }, "tickers": { "type": "array", "items": { "type": "string" } }, "ciks": { "type": "array", "items": { "type": "string" } }, "topicCodes": { "type": "array", "items": { "type": "string" } }, "sourceCodes": { "type": "array", "items": { "type": "string" } }, "keywords": { "type": "array", "items": { "type": "string" } }, "minImportance": { "type": "integer", "minimum": 0, "maximum": 100 }, "flashOnly": { "type": "boolean" }, "channels": { "type": "array", "items": { "type": "string", "enum": [ "in_app", "email" ] } }, "isActive": { "type": "boolean" }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } } }, "NewsAlertEvent": { "description": "One rule match delivered to a user (session-only endpoints).", "type": "object", "required": [ "id", "ruleId", "ruleName", "channel", "item", "seenAt", "createdAt" ], "properties": { "id": { "type": "integer", "format": "int64" }, "ruleId": { "type": "integer", "format": "int64" }, "ruleName": { "type": "string" }, "channel": { "type": "string", "enum": [ "in_app", "email" ] }, "item": { "$ref": "#/components/schemas/NewsItem" }, "seenAt": { "type": [ "string", "null" ], "format": "date-time" }, "createdAt": { "type": "string", "format": "date-time" } } } } }, "paths": { "/api/v1/supercycle/private/{slug}": { "get": { "summary": "Private company profile", "description": "Published private-company profile, funding, KPIs, fund valuation marks and source-linked counterparty claims. Use the registry slug or canonical XPRV platform key. Fund marks and reported valuations are not exchange quotes; preserve each observation's provenance and date. Internal review data is excluded on the deployed site.", "operationId": "get-private-company-profile", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Registry slug or canonical private-company platform key.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "node": { "type": "object", "properties": { "key": { "type": "string" }, "kind": { "type": "string" }, "ticker": { "type": "null" }, "cik": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "website": { "type": "string" }, "published": { "type": "boolean" }, "marketCap": { "type": "null" }, "slug": { "type": "string" }, "reference": { "type": "object", "properties": { "markDate": { "type": "string", "format": "date" }, "pricePerShare": { "type": "number" }, "minPricePerShare": { "type": "number" }, "maxPricePerShare": { "type": "number" }, "markCount": { "type": "integer" }, "holderCount": { "type": "integer" } } } } }, "description": { "type": "string" }, "lei": { "type": "null" }, "transcriptMentions": { "type": "integer" }, "marks": { "type": "array", "items": { "type": "object", "properties": { "markDate": { "type": "string", "format": "date" }, "filingDate": { "type": "string", "format": "date" }, "securityTitle": { "type": "string" }, "securityClass": { "type": "string" }, "pricePerShare": { "type": "number" }, "positionUnits": { "type": "integer" }, "positionValue": { "type": "number" }, "fairValueLevel": { "type": "integer" }, "holderName": { "type": "string" }, "holderSeriesName": { "type": "string" }, "sourceForm": { "type": "string" }, "accessionNumber": { "type": "string" }, "sourceUrl": { "type": "string" } } } }, "claims": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "filerTicker": { "type": "string" }, "filerCik": { "type": "string" }, "filingType": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "accessionNumber": { "type": "string" }, "sectionType": { "type": "string" }, "claimType": { "type": "string" }, "relationship": { "type": "string" }, "metric": { "type": [ "string", "null" ] }, "value": { "type": [ "number", "null" ] }, "unit": { "type": [ "string", "null" ] }, "periodRaw": { "type": [ "string", "null" ] }, "statement": { "type": "string" }, "evidenceQuote": { "type": "string" }, "isForwardLooking": { "type": "boolean" }, "verifierNote": { "type": "null" } } } }, "unitContext": { "type": "object", "properties": { "unit": { "type": "object", "properties": { "unitKey": { "type": "string" }, "name": { "type": "string" }, "unitKind": { "type": "string" }, "parentCik": { "type": "null" }, "parentTicker": { "type": "null" }, "ownCik": { "type": "string" }, "status": { "type": "string" }, "statusEffective": { "type": "null" }, "statusSourceUrl": { "type": "null" }, "financialSource": { "type": "string" }, "segmentMember": { "type": "null" }, "description": { "type": "null" }, "headline": { "type": "object", "properties": { "valuationUsd": { "type": "integer" }, "valuationLabel": { "type": "string" }, "revenueUsd": { "type": "integer" }, "revenueLabel": { "type": "string" }, "revenueAsOf": { "type": "string", "format": "date" }, "sourceKind": { "type": "string" } } }, "link": { "type": "object", "properties": { "kind": { "type": "string" }, "key": { "type": "string" } } } } }, "peers": { "type": "array", "items": { "type": "object", "properties": { "unitKey": { "type": "string" }, "name": { "type": "string" }, "unitKind": { "type": "string" }, "parentCik": { "type": [ "string", "null" ] }, "parentTicker": { "type": [ "string", "null" ] }, "ownCik": { "type": "string" }, "status": { "type": "string" }, "statusEffective": { "type": [ "string", "null" ], "format": "date" }, "statusSourceUrl": { "type": [ "string", "null" ] }, "financialSource": { "type": "string" }, "segmentMember": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "headline": { "type": "object", "properties": { "valuationUsd": { "type": "null" }, "valuationLabel": { "type": "null" }, "revenueUsd": { "type": "integer" }, "revenueLabel": { "type": "string" }, "revenueAsOf": { "type": [ "string", "null" ], "format": "date" }, "sourceKind": { "type": "string" } } }, "link": { "type": "object", "properties": { "kind": { "type": "string" }, "key": { "type": "string" } } } } } }, "parent": { "type": "null" } } }, "models": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "modelKey": { "type": "string" }, "name": { "type": "string" }, "family": { "type": "string" }, "tier": { "type": "string" }, "releasedDate": { "type": "null" }, "modality": { "type": "null" }, "contextWindow": { "type": "null" }, "inputUsdPerMtok": { "type": "number" }, "outputUsdPerMtok": { "type": "number" }, "cachedInputUsdPerMtok": { "type": "number" }, "status": { "type": "string" }, "openWeights": { "type": "boolean" }, "notes": { "type": "string" }, "pricingAsOf": { "type": "string", "format": "date" }, "source": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "publisher": { "type": "string" }, "publishedDate": { "type": "string", "format": "date" }, "accessionNumber": { "type": "null" }, "verification": { "type": "string" } } } } } }, "sites": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "siteKey": { "type": "string" }, "name": { "type": "string" }, "city": { "type": "string" }, "region": { "type": "string" }, "countryCode": { "type": "string" }, "latitude": { "type": "number" }, "longitude": { "type": "number" }, "capacityGw": { "type": [ "number", "null" ] }, "capacityNote": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "role": { "type": "string" }, "counterparty": { "type": "string" }, "hardware": { "type": "null" }, "onlineYear": { "type": [ "integer", "null" ] }, "notes": { "type": [ "string", "null" ] }, "source": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "publisher": { "type": "string" }, "publishedDate": { "type": "string", "format": "date" }, "accessionNumber": { "type": [ "string", "null" ] }, "verification": { "type": "string" } } }, "assetKey": { "type": [ "string", "null" ] } } } }, "review": { "type": "array", "items": { "type": "object", "properties": { "table": { "type": "string" }, "id": { "type": "string" }, "date": { "type": "string", "format": "date" }, "label": { "type": "string" }, "value": { "type": [ "integer", "null" ] }, "unit": { "type": [ "string", "null" ] }, "quote": { "type": "string" }, "reviewStatus": { "type": "string" }, "source": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "publisher": { "type": "string" }, "publishedDate": { "type": "string", "format": "date" }, "accessionNumber": { "type": "null" }, "verification": { "type": "string" } } } } } }, "extractedCounts": { "type": "object", "properties": { "round": { "type": "integer" }, "kpi": { "type": "integer" }, "deal": { "type": "integer" }, "event": { "type": "integer" } } }, "dataCentres": { "type": "object", "properties": { "sites": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "country": { "type": "string" }, "status": { "type": "string" }, "statusSince": { "type": "string", "format": "date" }, "mw": { "type": "integer" }, "mwBasis": { "type": "string" }, "planned": { "type": "array", "items": { "type": "object", "properties": { "mw": { "type": "integer" }, "basis": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "note": { "type": "string" }, "source": { "type": "object", "properties": { "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" } } } } } }, "operating": { "type": "array", "items": { "type": "object", "properties": { "mw": { "type": "integer" }, "basis": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "note": { "type": "string" }, "source": { "type": "object", "properties": { "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" } } } } } }, "operatingEstimate": { "type": "object", "properties": { "mw": { "type": "integer" }, "basis": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "projected": { "type": "boolean" }, "note": { "type": "string" }, "source": { "type": "object", "properties": { "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" } } } } }, "series": { "type": "array", "items": { "type": "object", "properties": { "mw": { "type": "integer" }, "basis": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "note": { "type": "string" }, "source": { "type": "object", "properties": { "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" } } }, "projected": { "type": "boolean" } } } }, "money": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "value": { "type": "integer" }, "currency": { "type": "string" }, "date": { "type": "string", "format": "date" }, "note": { "type": [ "string", "null" ] }, "estimate": { "type": "boolean" }, "source": { "type": "object", "properties": { "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" } } } } } }, "parties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "cik": { "type": [ "string", "null" ] }, "ticker": { "type": [ "string", "null" ] }, "entityKey": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "sharePct": { "type": "null" }, "from": { "type": [ "string", "null" ], "format": "date" }, "to": { "type": "null" }, "current": { "type": "boolean" }, "self": { "type": "boolean" }, "note": { "type": "string" }, "source": { "type": "object", "properties": { "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" } } } } } }, "selfRoles": { "type": "array", "items": { "type": "string" } }, "selfOnly": { "type": "boolean" } } } }, "totals": { "type": "object", "properties": { "plannedFacilityMw": { "type": "integer" }, "plannedItMw": { "type": "integer" }, "plannedUnstatedMw": { "type": "integer" }, "operatingItMw": { "type": "null" }, "operatingFacilityMw": { "type": "null" }, "operatingUnstatedMw": { "type": "integer" }, "operatingEstimatedSites": { "type": "integer" }, "usd": { "type": "object", "properties": { "financing": { "type": "integer" }, "capital_cost_estimate": { "type": "integer" }, "capex": { "type": "integer" }, "incentive": { "type": "integer" } } } } }, "byStatus": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "sites": { "type": "integer" }, "mw": { "type": "integer" } } } }, "selfRoles": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string" }, "sites": { "type": "integer" } } } }, "counterparties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "cik": { "type": [ "string", "null" ] }, "ticker": { "type": [ "string", "null" ] }, "entityKey": { "type": [ "string", "null" ] }, "roles": { "type": "array", "items": { "type": "string" } }, "relations": { "type": "array", "items": { "type": "string" } }, "sites": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "roles": { "type": "array", "items": { "type": "string" } }, "current": { "type": "boolean" }, "mw": { "type": "integer" } } } }, "currentSites": { "type": "integer" }, "mw": { "type": "integer" }, "since": { "type": [ "string", "null" ], "format": "date" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "siteKey": { "type": "string" }, "site": { "type": "string" }, "party": { "type": "string" }, "role": { "type": "string" }, "sharePct": { "type": "null" }, "note": { "type": [ "string", "null" ] }, "date": { "type": "string", "format": "date" }, "kind": { "type": "string" } } } } } }, "profile": { "type": "object", "properties": { "foundedDate": { "type": "string", "format": "date" }, "founders": { "type": "array", "items": { "type": "string" } }, "headquarters": { "type": "string" }, "legalStructure": { "type": "string" }, "controllingEntity": { "type": "string" }, "ceo": { "type": "string" }, "employeeCount": { "type": "null" }, "employeeAsOf": { "type": "null" }, "ipoStatus": { "type": "string" }, "ipoNotes": { "type": "string" }, "oneLiner": { "type": "string" } } }, "rounds": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "seq": { "type": [ "integer", "null" ] }, "date": { "type": "string", "format": "date" }, "instrument": { "type": "string" }, "amountUsd": { "type": "integer" }, "amountNote": { "type": [ "string", "null" ] }, "preMoneyUsd": { "type": "null" }, "postMoneyUsd": { "type": "null" }, "leads": { "type": "array", "items": { "type": "string" } }, "investors": { "type": "array", "items": { "type": "string" } }, "investorTickers": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "null" }, "source": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "publisher": { "type": "string" }, "publishedDate": { "type": "string", "format": "date" }, "accessionNumber": { "type": "null" }, "verification": { "type": "string" } } } } } }, "kpis": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "metric": { "type": "string" }, "value": { "type": "number" }, "unit": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "periodRaw": { "type": [ "string", "null" ] }, "qualifier": { "type": [ "string", "null" ] }, "statement": { "type": "string" }, "isTarget": { "type": "boolean" }, "statedDate": { "type": "null" }, "source": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "publisher": { "type": "string" }, "publishedDate": { "type": "string", "format": "date" }, "accessionNumber": { "type": [ "string", "null" ] }, "verification": { "type": "string" } } } } } }, "deals": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "counterparty": { "type": "string" }, "ticker": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "date": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "capacityGw": { "type": "null" }, "capacityNote": { "type": "null" }, "commitmentUsd": { "type": [ "integer", "null" ] }, "commitmentNote": { "type": [ "string", "null" ] }, "termYears": { "type": [ "integer", "null" ] }, "startYear": { "type": [ "integer", "null" ] }, "endYear": { "type": [ "integer", "null" ] }, "hardware": { "type": [ "string", "null" ] }, "status": { "type": "string" }, "statement": { "type": "string" }, "source": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "publisher": { "type": "string" }, "publishedDate": { "type": "string", "format": "date" }, "accessionNumber": { "type": "null" }, "verification": { "type": "string" } } } } } }, "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "title": { "type": "string" }, "detail": { "type": [ "string", "null" ] }, "source": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "publisher": { "type": "string" }, "publishedDate": { "type": [ "string", "null" ], "format": "date" }, "accessionNumber": { "type": [ "string", "null" ] }, "verification": { "type": "string" } } } } } }, "counterparties": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "name": { "type": "string" }, "website": { "type": [ "string", "null" ] }, "published": { "type": "boolean" }, "claims": { "type": "integer" }, "maxUsd": { "type": [ "integer", "null" ] }, "latestFilingDate": { "type": "string" }, "relationships": { "type": "array", "items": { "type": "string" } }, "claimTypes": { "type": "array", "items": { "type": "string" } }, "roles": { "type": "array", "items": { "type": "string" } } } } }, "sourceCounts": { "type": "object", "properties": { "filed": { "type": "integer" }, "company_disclosed": { "type": "integer" }, "call_disclosed": { "type": "integer" }, "press_reported": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "node": { "key": "private:openai", "kind": "private", "ticker": null, "cik": "XPRV000001", "name": "OpenAI Group PBC", "shortName": "OpenAI", "website": "https://openai.com", "published": true, "marketCap": null, "slug": "openai", "reference": { "markDate": "2026-08-31", "pricePerShare": 687.69, "minPricePerShare": 687.69, "maxPricePerShare": 687.69, "markCount": 27, "holderCount": 4 } }, "description": "Private AI laboratory (ChatGPT, GPT models). Public-benefit corporation after the 2025 recapitalization; Microsoft is a major investor with revenue-sharing rights.", "lei": null, "transcriptMentions": 632, "marks": [ { "markDate": "2026-08-31", "filingDate": "2026-10-26", "securityTitle": "OPENAI GROUP PBC A-2 PC PP", "securityClass": "preferred", "pricePerShare": 687.69, "positionUnits": 21477, "positionValue": 14769518.13, "fairValueLevel": 3, "holderName": "Fidelity Advisor Series I", "holderSeriesName": "Fidelity Advisor Growth Opportunities Fund", "sourceForm": "NPORT-P", "accessionNumber": "0000035402-26-006747", "sourceUrl": "https://www.sec.gov/Archives/edgar/data/722574/000003540226006747/primary_doc.xml" }, { "markDate": "2026-08-31", "filingDate": "2026-10-26", "securityTitle": "OPENAI GROUP PBC A-2 PC PP", "securityClass": "preferred", "pricePerShare": 687.69, "positionUnits": 4000, "positionValue": 2750760, "fairValueLevel": 3, "holderName": "Fidelity Advisor Series I", "holderSeriesName": "Fidelity Advisor Series Equity Growth Fund", "sourceForm": "NPORT-P", "accessionNumber": "0000035402-26-006762", "sourceUrl": "https://www.sec.gov/Archives/edgar/data/722574/000003540226006762/primary_doc.xml" } ], "claims": [ { "id": "13", "filerTicker": "NVDA", "filerCik": "0001045810", "filingType": "10-Q", "filingDate": "2026-08-26", "accessionNumber": "0001045810-26-000075", "sectionType": "item_2", "claimType": "supply_agreement", "relationship": "supplier", "metric": "it_load_capacity_gw", "value": 4.25, "unit": "GW", "periodRaw": "August 2026", "statement": "NVDA entered into guarantees covering leases for approximately 4.25 gigawatts of IT load at SB Energy's campus that will exclusively host NVDA compute under leases to OpenAI.", "evidenceQuote": "we entered into guarantees with SB Energy Corp. to provide credit support on the land, power, and shell buildout at SB Energy’s PORTS Technology Campus in Pike County, Ohio, covering leases for approx…", "isForwardLooking": false, "verifierNote": null }, { "id": "60", "filerTicker": "MSFT", "filerCik": "0000789019", "filingType": "10-K", "filingDate": "2026-07-29", "accessionNumber": "0001193125-26-323660", "sectionType": "item_7", "claimType": "revenue_share", "relationship": "investor", "metric": null, "value": null, "unit": null, "periodRaw": null, "statement": "Microsoft will continue to receive revenue-sharing payments from OpenAI.", "evidenceQuote": "Microsoft is a major investor in OpenAI and will continue to receive revenue-sharing payments. We hold rights to OpenAI’s intellectual property, including models and infrastructure, for integration in…", "isForwardLooking": true, "verifierNote": null } ], "unitContext": { "unit": { "unitKey": "openai", "name": "OpenAI", "unitKind": "frontier_lab", "parentCik": null, "parentTicker": null, "ownCik": "XPRV000001", "status": "independent", "statusEffective": null, "statusSourceUrl": null, "financialSource": "private_record", "segmentMember": null, "description": null, "headline": { "valuationUsd": 852000000000, "valuationLabel": "post-money · 2026 round ($122B) · 2026-03-31", "revenueUsd": 24000000000, "revenueLabel": "run rate revenue · 2026-03-31", "revenueAsOf": "2026-03-31", "sourceKind": "company_disclosed" }, "link": { "kind": "private", "key": "XPRV000001" } }, "peers": [ { "unitKey": "anthropic", "name": "Anthropic", "unitKind": "frontier_lab", "parentCik": null, "parentTicker": null, "ownCik": "0002130357", "status": "independent", "statusEffective": null, "statusSourceUrl": null, "financialSource": "parent_whole", "segmentMember": null, "description": null, "headline": { "valuationUsd": null, "valuationLabel": null, "revenueUsd": 16286000000, "revenueLabel": "FY2026 revenue", "revenueAsOf": null, "sourceKind": "filed" }, "link": { "kind": "public", "key": "ANT" } }, { "unitKey": "xai", "name": "xAI (SpaceX AI segment)", "unitKind": "frontier_lab", "parentCik": "0001181412", "parentTicker": "SPCX", "ownCik": "XPRV000003", "status": "subsidiary", "statusEffective": "2026-02-02", "statusSourceUrl": "https://x.ai/news/xai-joins-spacex", "financialSource": "parent_segment", "segmentMember": "AI", "description": "Grok, X and AI compute; reported as SpaceX's AI segment since the February 2026 merger.", "headline": { "valuationUsd": null, "valuationLabel": null, "revenueUsd": 3201000000, "revenueLabel": "AI segment revenue FY2025", "revenueAsOf": "2025-12-31", "sourceKind": "filed" }, "link": { "kind": "public", "key": "SPCX" } } ], "parent": null }, "models": [ { "id": "40", "modelKey": "gpt-5.6-sol", "name": "GPT-5.6 Sol", "family": "GPT", "tier": "flagship", "releasedDate": null, "modality": null, "contextWindow": null, "inputUsdPerMtok": 4, "outputUsdPerMtok": 20, "cachedInputUsdPerMtok": 0.4, "status": "current", "openWeights": false, "notes": "standard tier, short context; long context $8/$30; promotional pricing through 2026-11-21; batch $2/$10", "pricingAsOf": "2026-08-30", "source": { "id": "2970", "kind": "company_disclosed", "title": "OpenAI API pricing", "url": "https://platform.openai.com/docs/pricing", "publisher": "OpenAI", "publishedDate": "2026-08-30", "accessionNumber": null, "verification": "content_verified" } }, { "id": "42", "modelKey": "gpt-5.6-luna", "name": "GPT-5.6 Luna", "family": "GPT", "tier": "small", "releasedDate": null, "modality": null, "contextWindow": null, "inputUsdPerMtok": 0.2, "outputUsdPerMtok": 1.2, "cachedInputUsdPerMtok": 0.02, "status": "current", "openWeights": false, "notes": "long context $0.40/$1.80; batch $0.10/$0.60", "pricingAsOf": "2026-08-30", "source": { "id": "2970", "kind": "company_disclosed", "title": "OpenAI API pricing", "url": "https://platform.openai.com/docs/pricing", "publisher": "OpenAI", "publishedDate": "2026-08-30", "accessionNumber": null, "verification": "content_verified" } } ], "sites": [ { "id": "324", "siteKey": "stargate-ports", "name": "Stargate — PORTS Technology Campus, Pike County, Ohio (SB Energy / NVIDIA)", "city": "Piketon", "region": "OH", "countryCode": "US", "latitude": 39.01, "longitude": -83, "capacityGw": 4.25, "capacityNote": "~4.25 GW of IT load under 20-year OpenAI leases with NVIDIA residual value guaranties (filed); NVIDIA can support ~3.8 GW more at its discretion; ready-for-service expected beginning 2028; former Port…", "status": "planned", "role": "tenant", "counterparty": "SB Energy (build/own/operate); NVIDIA ($105B-capped lease guaranties, exclusive compute)", "hardware": null, "onlineYear": 2028, "notes": null, "source": { "id": "8112", "kind": "filed", "title": "NVIDIA 8-K (2026-08-17) — residual value guaranties on ~4.25 GW of OpenAI leases at SB Energy's PORTS Technology Campus, Pike County, Ohio", "url": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000069/", "publisher": "SEC / NVIDIA Corp", "publishedDate": "2026-08-17", "accessionNumber": "0001045810-26-000069", "verification": "content_verified" }, "assetKey": null }, { "id": "46", "siteKey": "stargate-dona-ana", "name": "Stargate — Doña Ana County, New Mexico (Project Jupiter)", "city": "Santa Teresa", "region": "NM", "countryCode": "US", "latitude": 31.87, "longitude": -106.66, "capacityGw": null, "capacityNote": null, "status": "under_construction", "role": "tenant", "counterparty": "Oracle / STACK Infrastructure / BorderPlex Digital Assets", "hardware": null, "onlineYear": null, "notes": "Four-building, 1,400-acre campus in Santa Teresa; construction began Q4 2025 (foundation work per satellite). Epoch projects 2.2 GW total facility power — estimate, not company-disclosed, so no GW rec…", "source": { "id": "7682", "kind": "press_reported", "title": "OpenAI Stargate: where the US sites stand", "url": "https://epoch.ai/publications/openai-stargate-where-the-us-sites-stand", "publisher": "Epoch AI", "publishedDate": "2026-04-23", "accessionNumber": null, "verification": "content_verified" }, "assetKey": "us.nm.oracle.project-jupiter" } ], "review": [ { "table": "deal", "id": "321", "date": "2026-08-25", "label": "Oracle · cloud_commitment — Oracle is part of OpenAI's compute portfolio.", "value": null, "unit": null, "quote": "Today, our portfolio also includes AWS, AMD, Broadcom, Cerebras, CoreWeave, Oracle, SB Energy and SoftBank.", "reviewStatus": "needs_review", "source": { "id": "1240", "kind": "company_disclosed", "title": "https://openai.com/index/the-full-stack-behind-abundant-intelligence/", "url": "https://openai.com/index/the-full-stack-behind-abundant-intelligence/", "publisher": "OpenAI Group PBC", "publishedDate": "2026-08-25", "accessionNumber": null, "verification": "content_verified" } }, { "table": "kpi", "id": "1418", "date": "2026-05-11", "label": "valuation_reported — The Deployment Company joint venture is valued at $10 billion pre-money, excluding newly raised funds.", "value": 10000000000, "unit": "USD", "quote": "The transaction values the new entity at $10 billion excluding the newly raised funds, with OpenAI maintaining majority ownership and operational control over the venture.", "reviewStatus": "needs_review", "source": { "id": "2554", "kind": "press_reported", "title": "OpenAI Confirms Deployment Company Launch With More Than $4 Billion Backing, Acquires AI Consulting Firm Tomoro - Pulse 2.0", "url": "https://pulse2.com/openai-reportedly-secures-over-4-billion-for-new-joint-venture-the-deployment-company/", "publisher": "Pulse 2.0", "publishedDate": "2026-05-11", "accessionNumber": null, "verification": "content_verified" } } ], "extractedCounts": { "round": 1, "kpi": 5, "deal": 3, "event": 7 }, "dataCentres": { "sites": [ { "key": "us.tx.oracle.stargate-abilene", "name": "Stargate Abilene (Lancium Clean Campus)", "country": "US", "status": "operating", "statusSince": "2025-09-01", "mw": 1200, "mwBasis": "facility", "planned": [ { "mw": 1200, "basis": "unstated", "asOf": "2025-05-21", "kind": "disclosed", "note": "Full campus: 8 buildings, 'a total of 1.2 gigawatts' (Crusoe does not say IT vs utility). Phase 1 = 2 buildings, 206 MW (Oct 2024 release).", "source": { "title": "Crusoe, Blue Owl Capital and Primary Digital Infrastructure enter second phase of $15bn joint venture", "publisher": "Crusoe", "url": "https://www.crusoe.ai/resources/newsroom/crusoe-blue-owl-capital-and-primary-digital-infrastructure-enter-joint-venture" } } ], "operating": [ { "mw": 618, "basis": "unstated", "asOf": "2026-09-10", "kind": "disclosed", "note": "Oracle Q1 FY27 call: 6 of 8 buildings, 618 MW, ~75% of site capacity delivered to the customer; 131,000 GPUs delivered there in the quarter. Basis not stated.", "source": { "title": "Oracle Q1 Earnings Call Highlights", "publisher": "The Cerbat Gem", "url": "https://www.thecerbatgem.com/?p=10389557" } } ], "operatingEstimate": { "mw": 843, "basis": "it", "asOf": "2026-11-01", "kind": "estimate", "projected": true, "note": "Buildings 5-8 are estimated to be operational. On March 24, Building 8 roughly looked like where Building 3 was in September. Building 3 is estimated to be operational in April, 7 months later. This n…", "source": { "title": "AI data centers (data_centers.csv, data_center_timelines.csv): addresses, satellite-estimated power and build timelines", "publisher": "Epoch AI", "url": "https://epoch.ai/data/ai-data-centers" } }, "series": [ { "mw": 0, "basis": "it", "asOf": "2024-05-31", "kind": "estimate", "note": "Land clearing begins for northern two buildings (Building 1-2)", "source": { "title": "AI data centers (data_centers.csv, data_center_timelines.csv): addresses, satellite-estimated power and build timelines", "publisher": "Epoch AI", "url": "https://epoch.ai/data/ai-data-centers" } }, { "mw": 843, "basis": "it", "asOf": "2026-11-01", "kind": "estimate", "projected": true, "note": "Buildings 5-8 are estimated to be operational. On March 24, Building 8 roughly looked like where Building 3 was in September. Building 3 is estimated to be operational in April, 7 months later. This n…", "source": { "title": "AI data centers (data_centers.csv, data_center_timelines.csv): addresses, satellite-estimated power and build timelines", "publisher": "Epoch AI", "url": "https://epoch.ai/data/ai-data-centers" } } ], "money": [ { "kind": "financing", "value": 7100000000, "currency": "USD", "date": "2025-05-21", "note": "DEBT: $7.1bn construction loan from a JPMorgan-led consortium to the Blue Owl/Crusoe/Primary Digital JV for phase 2 (six buildings).", "estimate": false, "source": { "title": "JP Morgan Chase Lends $7B on Oracle-Leased Texas Data Center Development", "publisher": "Commercial Observer", "url": "https://commercialobserver.com/2025/05/7b-oracle-leased-texas-data-center-development/" } }, { "kind": "capital_cost_estimate", "value": 31934526000, "currency": "USD", "date": "2026-11-01", "note": null, "estimate": true, "source": { "title": "AI data centers (data_centers.csv, data_center_timelines.csv): addresses, satellite-estimated power and build timelines", "publisher": "Epoch AI", "url": "https://epoch.ai/data/ai-data-centers" } } ], "parties": [ { "name": "Lancium", "cik": "XPRV000029", "ticker": null, "entityKey": null, "role": "owner", "sharePct": null, "from": null, "to": null, "current": true, "self": false, "note": "LAND owner only (Lancium Clean Campus): Lancium 'acquires and owns the land ... while Crusoe designs, builds, and operates the AI data center' - stated as the Abilene model in the Childress announceme…", "source": { "title": "Crusoe and Lancium announce 1.0 gigawatt AI data center campus in Childress, Texas", "publisher": "StorageNewsletter", "url": "https://www.storagenewsletter.com/2026/07/23/crusoe-and-lancium-announce-1-0-gigawatt-ai-data-center-campus-in-childress-texas/" } }, { "name": "Blue Owl", "cik": null, "ticker": null, "entityKey": "blue-owl", "role": "owner", "sharePct": null, "from": "2024-10-15", "to": null, "current": true, "self": false, "note": "JV co-sponsor; funds managed by Blue Owl's Real Estate/Real Assets platform. Stakes not disclosed.", "source": { "title": "Crusoe, Blue Owl Capital and Primary Digital Infrastructure enter $3.4bn joint venture", "publisher": "Crusoe", "url": "https://www.crusoe.ai/resources/newsroom/crusoe-blue-owl-capital-primary-digital-joint-venture" } } ], "selfRoles": [ "offtaker" ], "selfOnly": false }, { "key": "us.nm.oracle.project-jupiter", "name": "Project Jupiter (Doña Ana County)", "country": "US", "status": "under_construction", "statusSince": "2026-04-01", "mw": 2200, "mwBasis": "facility", "planned": [ { "mw": 2450, "basis": "facility", "asOf": "2026-04-27", "kind": "disclosed", "note": "Revised design: up to 2.45 GW of on-site Bloom fuel-cell generation (the campus's power supply; no IT figure published). Earlier permits (Dec 2025) showed 'upward of 2.8 GW'.", "source": { "title": "Project Jupiter to run on 2.45 GW Bloom fuel cell microgrid", "publisher": "Converge Digest", "url": "https://convergedigest.com/project-jupiter-to-run-on-2-45-gw-bloom-fuel-cell-microgrid/" } } ], "operating": [], "operatingEstimate": { "mw": 0, "basis": "it", "asOf": "2026-06-22", "kind": "estimate", "note": "Construction has advanced significantly since February 2026. We observe extensive earthworks and multiple graded building pads across the campus, with structural work underway on the main data center …", "source": { "title": "AI data centers (data_centers.csv, data_center_timelines.csv): addresses, satellite-estimated power and build timelines", "publisher": "Epoch AI", "url": "https://epoch.ai/data/ai-data-centers" } }, "series": [ { "mw": 0, "basis": "it", "asOf": "2025-10-01", "kind": "estimate", "note": "Construction and land clearing begins", "source": { "title": "AI data centers (data_centers.csv, data_center_timelines.csv): addresses, satellite-estimated power and build timelines", "publisher": "Epoch AI", "url": "https://epoch.ai/data/ai-data-centers" } }, { "mw": 1750, "basis": "it", "asOf": "2028-12-31", "kind": "estimate", "projected": true, "note": "Estimated construction completion date of the site. Stormwater permitting says 2027-12-31 for stormwater construction to finish, but for a more conservative estimate and based on the current state of …", "source": { "title": "AI data centers (data_centers.csv, data_center_timelines.csv): addresses, satellite-estimated power and build timelines", "publisher": "Epoch AI", "url": "https://epoch.ai/data/ai-data-centers" } } ], "money": [ { "kind": "capex", "value": 165000000000, "currency": "USD", "date": "2025-09-19", "note": "Maximum expected investment over the 30-year life (same figure as the IRB cap). Microgrid + data centres targeted for Q3 2028 (Haussamen, 2025-09-12).", "estimate": false, "source": { "title": "Doña Ana County approves historic $165B bond for data center", "publisher": "Albuquerque Journal", "url": "https://www.abqjournal.com/business/doa-ana-county-approves-historic-165b-bond-for-data-center/680373" } }, { "kind": "incentive", "value": 360000000, "currency": "USD", "date": "2025-09-19", "note": "Developers' payments in lieu of taxes to the county over 30 years (counterpart of the IRB exemption); plus $50m water/wastewater and $6.9m community projects. Converge Digest (Apr 2026) totals communi…", "estimate": false, "source": { "title": "Doña Ana County approves historic $165B bond for data center", "publisher": "Albuquerque Journal", "url": "https://www.abqjournal.com/business/doa-ana-county-approves-historic-165b-bond-for-data-center/680373" } } ], "parties": [ { "name": "Doña Ana County", "cik": null, "ticker": null, "entityKey": "dona-ana-county", "role": "owner", "sharePct": null, "from": "2025-09-01", "to": null, "current": true, "self": false, "note": "Title holder under the up-to-$165bn industrial revenue bond: county holds title to property and equipment until the bonds mature and leases it back to the project company (company not named).", "source": { "title": "Doña Ana County approves historic $165B bond for data center", "publisher": "Albuquerque Journal", "url": "https://www.abqjournal.com/business/doa-ana-county-approves-historic-165b-bond-for-data-center/680373" } }, { "name": "Oracle", "cik": "0001341439", "ticker": "ORCL", "entityKey": null, "role": "tenant", "sharePct": null, "from": null, "to": null, "current": true, "self": false, "note": "'Oracle Cloud Infrastructure will lease the data center for 18 years, according to officials.'", "source": { "title": "Doña Ana County's Project Jupiter joins $500 billion Stargate initiative led by OpenAI, Oracle", "publisher": "Albuquerque Journal", "url": "https://www.abqjournal.com/business/doa-na-countys-project-jupiter-joins-500-billion-stargate-initiative-led-by-openai-oracle/493927" } } ], "selfRoles": [ "offtaker" ], "selfOnly": false } ], "totals": { "plannedFacilityMw": 3850, "plannedItMw": 902, "plannedUnstatedMw": 3600, "operatingItMw": null, "operatingFacilityMw": null, "operatingUnstatedMw": 618, "operatingEstimatedSites": 0, "usd": { "financing": 31000000000, "capital_cost_estimate": 31934526000, "capex": 248000000000, "incentive": 838000000 } }, "byStatus": [ { "status": "operating", "sites": 1, "mw": 1200 }, { "status": "under_construction", "sites": 4, "mw": 5885 } ], "selfRoles": [ { "role": "tenant", "sites": 1 }, { "role": "offtaker", "sites": 5 } ], "counterparties": [ { "name": "Oracle", "cik": "0001341439", "ticker": "ORCL", "entityKey": null, "roles": [ "tenant" ], "relations": [ "Compute provider: OpenAI pays it for compute", "Co-tenant beside OpenAI" ], "sites": [ { "key": "us.tx.oracle.stargate-abilene", "name": "Stargate Abilene (Lancium Clean Campus)", "roles": [ "tenant" ], "current": true, "mw": 1200 }, { "key": "us.nm.oracle.project-jupiter", "name": "Project Jupiter (Doña Ana County)", "roles": [ "tenant" ], "current": true, "mw": 2200 } ], "currentSites": 6, "mw": 8085, "since": "2025-05-22" }, { "name": "BorderPlex", "cik": null, "ticker": null, "entityKey": "borderplex-digital-assets", "roles": [ "developer" ], "relations": [ "Developer of a site OpenAI's compute runs in" ], "sites": [ { "key": "us.nm.oracle.project-jupiter", "name": "Project Jupiter (Doña Ana County)", "roles": [ "developer" ], "current": true, "mw": 2200 } ], "currentSites": 1, "mw": 2200, "since": null } ], "changes": [ { "siteKey": "us.mi.oracle.saline-the-barn", "site": "The Barn (Saline Township)", "party": "Blackstone", "role": "owner", "sharePct": null, "note": "Equity co-owner; Bloomberg reported ~$2bn equity (Yahoo Finance).", "date": "2026-04-27", "kind": "joined" }, { "siteKey": "us.wi.oracle.lighthouse-port-washington", "site": "Lighthouse (Port Washington)", "party": "Vantage", "role": "operator", "sharePct": null, "note": null, "date": "2025-10-22", "kind": "joined" } ] }, "profile": { "foundedDate": "2015-12-11", "founders": [ "Sam Altman", "Greg Brockman" ], "headquarters": "San Francisco, California", "legalStructure": "OpenAI Group PBC (Delaware public benefit corporation), formed in the October 2025 recapitalization", "controllingEntity": "OpenAI Foundation (nonprofit) — controls the PBC and holds equity valued at ~$130B at recapitalization", "ceo": "Sam Altman", "employeeCount": null, "employeeAsOf": null, "ipoStatus": "none", "ipoNotes": "No registration statement on EDGAR as of 2026-08-30. EDGAR name search returns only feeder SPVs (e.g. 'OpenAI — Futurum, a series of Master Fund I LLC'), not the company. Recapitalized into a PBC in O…", "oneLiner": "AI research and deployment company; developer of GPT models and ChatGPT." }, "rounds": [ { "id": "11", "name": "Strategic — Microsoft", "seq": 1, "date": "2019-07-22", "instrument": "equity", "amountUsd": 1000000000, "amountNote": null, "preMoneyUsd": null, "postMoneyUsd": null, "leads": [ "Microsoft" ], "investors": [], "investorTickers": [ "MSFT" ], "notes": null, "source": { "id": "20", "kind": "company_disclosed", "title": "Microsoft invests in and partners with OpenAI to support us building beneficial AGI", "url": "https://openai.com/index/microsoft-invests-in-and-partners-with-openai/", "publisher": "OpenAI", "publishedDate": "2019-07-22", "accessionNumber": null, "verification": "content_verified" } }, { "id": "236", "name": "Disney Strategic Investment", "seq": null, "date": "2025-12-11", "instrument": "equity", "amountUsd": 1000000000, "amountNote": "Disney also receives warrants to purchase additional equity. Transaction subject to negotiation of definitive agreements, required corporate and board approvals, and customary closing conditions.", "preMoneyUsd": null, "postMoneyUsd": null, "leads": [ "The Walt Disney Company" ], "investors": [ "The Walt Disney Company" ], "investorTickers": [ "DIS" ], "notes": null, "source": { "id": "706", "kind": "company_disclosed", "title": "https://openai.com/index/disney-sora-agreement/", "url": "https://openai.com/index/disney-sora-agreement/", "publisher": "OpenAI Group PBC", "publishedDate": "2025-12-11", "accessionNumber": null, "verification": "content_verified" } } ], "kpis": [ { "id": "5076", "metric": "annual_revenue", "value": 13807074, "unit": "USD", "asOf": "2016-12-31", "periodRaw": "tax year 2016", "qualifier": null, "statement": "OpenAI Inc: annual revenue $13,807,074 for tax year 2016 (IRS Form 990, total revenue (Part I line 12))", "isTarget": false, "statedDate": null, "source": { "id": "8695", "kind": "filed", "title": "OpenAI Inc — Form 990, tax year 2016", "url": "https://projects.propublica.org/nonprofits/download-filing?path=01_2018_prefixes_80-83%2F810861541_201612_990_2018010815094956.pdf", "publisher": "IRS Form 990 (ProPublica Nonprofit Explorer)", "publishedDate": "2016-12-31", "accessionNumber": "IRS990:810861541:2016", "verification": "content_verified" } }, { "id": "551", "metric": "site_capacity_gw", "value": 0.23, "unit": "GW", "asOf": "2025-07-31", "periodRaw": null, "qualifier": "null", "statement": "Stargate Norway is planned to deliver 230MW of capacity.", "isTarget": false, "statedDate": null, "source": { "id": "1277", "kind": "company_disclosed", "title": "Introducing Stargate Norway", "url": "https://openai.com/index/introducing-stargate-norway/", "publisher": "OpenAI", "publishedDate": "2025-07-31", "accessionNumber": null, "verification": "content_verified" } } ], "deals": [ { "id": "365", "counterparty": "Microsoft", "ticker": "MSFT", "role": "cloud", "date": "2019-07-22", "kind": "cloud_commitment", "capacityGw": null, "capacityNote": null, "commitmentUsd": null, "commitmentNote": null, "termYears": null, "startYear": null, "endYear": null, "hardware": "Azure AI supercomputing", "status": "announced", "statement": "Microsoft became OpenAI's exclusive cloud provider and the two companies agreed to jointly develop new Azure AI supercomputing technologies.", "source": { "id": "20", "kind": "company_disclosed", "title": "Microsoft invests in and partners with OpenAI to support us building beneficial AGI", "url": "https://openai.com/index/microsoft-invests-in-and-partners-with-openai/", "publisher": "OpenAI", "publishedDate": "2019-07-22", "accessionNumber": null, "verification": "content_verified" } }, { "id": "12", "counterparty": "Stargate (SoftBank, Oracle, MGX)", "ticker": null, "role": "infrastructure", "date": "2025-01-21", "kind": "capacity_build", "capacityGw": null, "capacityNote": null, "commitmentUsd": 500000000000, "commitmentNote": "$500B over four years; $100B deployed immediately", "termYears": 4, "startYear": 2025, "endYear": 2029, "hardware": null, "status": "announced", "statement": "The Stargate Project intends to invest $500 billion over the next four years building new AI infrastructure for OpenAI in the United States, beginning with $100 billion immediately.", "source": { "id": "23", "kind": "company_disclosed", "title": "Announcing The Stargate Project", "url": "https://openai.com/index/announcing-the-stargate-project/", "publisher": "OpenAI", "publishedDate": "2025-01-21", "accessionNumber": null, "verification": "content_verified" } } ], "events": [ { "id": "33", "date": "2026-08-26", "kind": "compute", "title": "NVIDIA files $105B of guarantees on 4.25 GW SB Energy campus leases for an OpenAI affiliate", "detail": null, "source": { "id": "40", "kind": "filed", "title": "NVIDIA 10-Q (filed 2026-08-26) — $105B guarantees on 4.25 GW SB Energy campus leases for an OpenAI affiliate; option for 3.8 GW more", "url": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000075/", "publisher": "SEC / NVIDIA Corp", "publishedDate": "2026-08-26", "accessionNumber": "0001045810-26-000075", "verification": "content_verified" } }, { "id": "1101", "date": "2026-07-09", "kind": "product", "title": "GPT-5.6 family launched: Sol, Terra, and Luna models", "detail": "GPT-5.6 is a new family of three models: Sol (flagship), Terra (lower-cost), and Luna (fastest/most cost-efficient).", "source": { "id": "1020", "kind": "company_disclosed", "title": "https://openai.com/research/index/", "url": "https://openai.com/research/index/", "publisher": "OpenAI Group PBC", "publishedDate": null, "accessionNumber": null, "verification": "content_verified" } } ], "counterparties": [ { "ticker": "NVDA", "name": "NVIDIA CORP", "website": "https://www.nvidia.com", "published": true, "claims": 12, "maxUsd": 105000000000, "latestFilingDate": "2026-08-26", "relationships": [ "investor", "other" ], "claimTypes": [ "other", "partnership" ], "roles": [ "chip_vendor", "financier" ] }, { "ticker": "SFTBF", "name": "SOFTBANK GROUP CORP.", "website": null, "published": false, "claims": 0, "maxUsd": null, "latestFilingDate": "", "relationships": [], "claimTypes": [], "roles": [ "financier", "infrastructure" ] } ], "sourceCounts": { "filed": 13, "company_disclosed": 237, "call_disclosed": 1, "press_reported": 4 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/supercycle/private/{slug}/filed": { "get": { "summary": "Private company filed record", "description": "Private-company filed record: Form D offerings, third-party SPV filings and fund-reported credit marks. Accession-numbered evidence only; an SPV's offering is not the operating company's own fundraising.", "operationId": "get-private-company-filed-record", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "slug", "in": "path", "required": true, "description": "Registry slug or canonical private-company platform key.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "formD": { "type": "array", "items": {} }, "feeders": { "type": "array", "items": { "type": "object", "properties": { "quarter": { "type": "string", "format": "date" }, "filings": { "type": "integer" }, "vehicles": { "type": "integer" }, "soldUsd": { "type": "integer" }, "investors": { "type": "integer" } } } }, "feederTotals": { "type": "object", "properties": { "filings": { "type": "integer" }, "vehicles": { "type": "integer" }, "soldUsd": { "type": "integer" }, "investors": { "type": "integer" } } }, "credit": { "type": "array", "items": {} }, "creditReference": { "type": "null" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "XPRV000001", "formD": [], "feeders": [ { "quarter": "2023-01-01", "filings": 1, "vehicles": 1, "soldUsd": 2049988, "investors": 12 }, { "quarter": "2023-10-01", "filings": 2, "vehicles": 2, "soldUsd": 2337490, "investors": 38 } ], "feederTotals": { "filings": 32, "vehicles": 32, "soldUsd": 54201867, "investors": 675 }, "credit": [], "creditReference": null } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/crypto": { "get": { "summary": "Crypto asset screener", "description": "Tracked crypto assets ranked by market cap, daily closes and returns, priced in the requested fiat currency. Preserve the returned CoinGecko attribution; these are daily reference observations, not executable quotes.", "operationId": "get-crypto-asset-screener", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "vs", "in": "query", "description": "Fiat ISO currency on the FX board.", "schema": { "type": "string", "default": "USD" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "vs": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "coins": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "symbol": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "imageUrl": { "type": "string" }, "rank": { "type": "integer" }, "lastDate": { "type": "string", "format": "date" }, "last": { "type": "number" }, "returns": { "type": "object", "properties": { "d1": { "type": "number" }, "w1": { "type": "number" }, "m1": { "type": "number" }, "m3": { "type": "number" }, "m6": { "type": "number" }, "y1": { "type": "number" }, "y2": { "type": "null" }, "y5": { "type": "null" }, "y10": { "type": "null" } } }, "marketCap": { "type": "integer" }, "volume24h": { "type": "integer" }, "spark": { "type": "array", "items": { "type": "number" } }, "stale": { "type": "boolean" } } } }, "historyFrom": { "type": "string", "format": "date" }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "attribution": { "type": "string" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "vs": "USD", "asOf": "2026-11-01", "coins": [ { "id": "bitcoin", "symbol": "BTC", "name": "Bitcoin", "kind": "coin", "imageUrl": "https://coin-images.coingecko.com/coins/images/1/large/bitcoin.png?1696501400", "rank": 1, "lastDate": "2026-11-01", "last": 77474.07610954811, "returns": { "d1": 0.0032490906545998843, "w1": -0.041287850368802004, "m1": -0.07301197309288254, "m3": 0.23326917984773687, "m6": 0.015430262859876587, "y1": -0.29290430268514545, "y2": null, "y5": null, "y10": null }, "marketCap": 1558254552295, "volume24h": 43303303462, "spark": [ 110066.94174051796, 102286.82524827348 ], "stale": false }, { "id": "blackrock-usd-institutional-digital-liquidity-fund", "symbol": "BUIDL", "name": "BlackRock USD Institutional Digital Liquidity Fund", "kind": "tokenized", "imageUrl": "https://coin-images.coingecko.com/coins/images/36291/large/blackrock.png?1711013223", "rank": 48, "lastDate": "2026-11-01", "last": 1, "returns": { "d1": 0, "w1": 0, "m1": 0, "m3": 0, "m6": 0, "y1": 0, "y2": null, "y5": null, "y10": null }, "marketCap": 2024692361, "volume24h": 0, "spark": [ 1, 0.9999999999999999 ], "stale": false } ], "historyFrom": "2025-10-28", "source": { "name": "CoinGecko", "url": "https://www.coingecko.com", "attribution": "Data provided by CoinGecko" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/crypto/{id}": { "get": { "summary": "Crypto asset profile", "description": "One crypto asset's profile, supply and USD reference prices. The identifier is the CoinGecko coin ID, such as bitcoin. Preserve the returned CoinGecko attribution.", "operationId": "get-crypto-asset-profile", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "CoinGecko coin ID.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "coin": { "type": "object", "properties": { "id": { "type": "string" }, "symbol": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "imageUrl": { "type": "string" }, "rank": { "type": "integer" }, "lastDate": { "type": "string", "format": "date" }, "last": { "type": "number" }, "returns": { "type": "object", "properties": { "d1": { "type": "number" }, "w1": { "type": "number" }, "m1": { "type": "number" }, "m3": { "type": "number" }, "m6": { "type": "number" }, "y1": { "type": "number" }, "y2": { "type": "null" }, "y5": { "type": "null" }, "y10": { "type": "null" } } }, "marketCap": { "type": "integer" }, "volume24h": { "type": "integer" }, "spark": { "type": "array", "items": { "type": "number" } }, "stale": { "type": "boolean" }, "categories": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "homepage": { "type": "string" }, "genesisDate": { "type": "string", "format": "date" }, "hashingAlgorithm": { "type": "string" }, "fullyDiluted": { "type": "integer" }, "circulatingSupply": { "type": "integer" }, "totalSupply": { "type": "integer" }, "maxSupply": { "type": "integer" }, "ath": { "type": "integer" }, "athDate": { "type": "string", "format": "date" }, "atl": { "type": "number" }, "atlDate": { "type": "string", "format": "date" }, "low52w": { "type": "number" }, "high52w": { "type": "number" }, "priceRows": { "type": "integer" }, "firstDate": { "type": "string", "format": "date" } } }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "attribution": { "type": "string" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "coin": { "id": "bitcoin", "symbol": "BTC", "name": "Bitcoin", "kind": "coin", "imageUrl": "https://coin-images.coingecko.com/coins/images/1/large/bitcoin.png?1696501400", "rank": 1, "lastDate": "2026-11-01", "last": 77474.07610954811, "returns": { "d1": 0.0032490906545998843, "w1": -0.041287850368802004, "m1": -0.07301197309288254, "m3": 0.23326917984773687, "m6": 0.015430262859876587, "y1": -0.29290430268514545, "y2": null, "y5": null, "y10": null }, "marketCap": 1558254552295, "volume24h": 43303303462, "spark": [ 110066.94174051796, 102286.82524827348 ], "stale": false, "categories": [ "Smart Contract Platform", "Layer 1 (L1)" ], "description": "Bitcoin is the world's first decentralized cryptocurrency, created in 2009 by the pseudonymous Satoshi Nakamoto. It enables peer-to-peer electronic cash transactions without intermediaries like banks …", "homepage": "http://www.bitcoin.org", "genesisDate": "2009-01-03", "hashingAlgorithm": "SHA-256", "fullyDiluted": 1558254552295, "circulatingSupply": 20105365, "totalSupply": 20105365, "maxSupply": 21000000, "ath": 126080, "athDate": "2025-10-06", "atl": 67.81, "atlDate": "2013-07-05", "low52w": 58566.091991843154, "high52w": 110499.52238345638, "priceRows": 370, "firstDate": "2025-10-28" }, "source": { "name": "CoinGecko", "url": "https://www.coingecko.com", "attribution": "Data provided by CoinGecko" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/crypto/{id}/prices": { "get": { "summary": "Crypto price history", "description": "Daily USD closes from CoinGecko snapshots, from the first day of `range` to the latest. Open, high and low repeat the close; these are close-only bars. History starts where the CoinGecko backfill did (about 365 days before the section launched on 2026-10-28), so 2Y, 5Y and ALL start there: `coverageFrom` is the first day held and `note` says so. `lookback` adds earlier bars for moving averages; `displayFrom` is the epoch ms of the first bar inside the range. An unknown coin is a 404. Preserve source attribution.", "operationId": "get-crypto-price-history", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "CoinGecko coin ID.", "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "Window of bars served: from the range's first day to the latest bar.", "schema": { "type": "string", "enum": [ "1M", "3M", "6M", "YTD", "1Y", "2Y", "5Y", "ALL" ], "default": "1Y", "x-case-insensitive": true } }, { "name": "lookback", "in": "query", "description": "Bars to add before the range's first day (e.g. 200 for a 200-day moving average). Default 0.", "schema": { "type": "integer", "minimum": 0, "maximum": 1000, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string" }, "bars": { "type": "array", "items": { "type": "object", "properties": { "t": { "type": "integer" }, "o": { "type": "number" }, "h": { "type": "number" }, "l": { "type": "number" }, "c": { "type": "number" }, "v": { "type": "number" }, "adj": { "type": "number" } } } }, "displayFrom": { "type": "integer" }, "currency": { "type": "string" }, "range": { "type": "string" }, "rangeFrom": { "type": "string", "format": "date" }, "lookbackBars": { "type": "integer" }, "coverageFrom": { "type": "string", "format": "date" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "symbol": "BTC", "bars": [ { "t": 1790812800000, "o": 83576.13460018387, "h": 83576.13460018387, "l": 83576.13460018387, "c": 83576.13460018387, "v": 35066512389.815475, "adj": 83576.13460018387 }, { "t": 1790899200000, "o": 84841.66634358242, "h": 84841.66634358242, "l": 84841.66634358242, "c": 84841.66634358242, "v": 33100807361.305866, "adj": 84841.66634358242 } ], "displayFrom": 1790812800000, "currency": "USD", "range": "1M", "rangeFrom": "2026-10-01", "lookbackBars": 0, "coverageFrom": "2025-10-28" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/financials/as-reported": { "get": { "summary": "Printed statement by period", "description": "Printed statement tables by reporting period, from the legacy lane: statements read from the filed documents before XBRL (for SEC registrants, periods before about 2010; for NVDA the newest is 2009-10-25). For later periods use /financials (standardized) or /financials/as-filed (the filer's own XBRL tree). With statement only, lists the winning documents; with period and periodicity, returns the printed captions and cells. Retain source evidence and period basis.", "operationId": "get-printed-statement-by-period", "tags": [ "Financial Statements" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker, SEC CIK or canonical platform key returned by company resolution.", "schema": { "type": "string" } }, { "name": "statement", "in": "query", "description": "Statement to retrieve.", "schema": { "type": "string", "enum": [ "income_statement", "balance_sheet", "cash_flow_statement" ] }, "required": true }, { "name": "period", "in": "query", "description": "Period end YYYY-MM-DD; omit to list periods.", "schema": { "type": "string" } }, { "name": "periodicity", "in": "query", "description": "Required when period is supplied.", "schema": { "type": "string", "enum": [ "annual", "quarterly" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "periods": { "type": "array", "items": { "type": "object", "properties": { "periodEnd": { "type": "string", "format": "date" }, "periodicity": { "type": "string" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": [ "integer", "null" ] }, "docRef": { "type": "string" }, "publishedDate": { "type": [ "string", "null" ], "format": "date" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "periods": [ { "periodEnd": "2009-10-25", "periodicity": "quarterly", "fiscalYear": 2010, "fiscalQuarter": 3, "docRef": "0001045810-09-000036", "publishedDate": null }, { "periodEnd": "2009-01-25", "periodicity": "annual", "fiscalYear": 2009, "fiscalQuarter": null, "docRef": "0001045810-09-000013", "publishedDate": null } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/earnings/statements": { "get": { "summary": "Earnings source statements", "description": "Verified statements from the issuer's speakers, by extraction type, newest call first. Retains source call and quote anchors; a speaker's causal claim is not independently proven causation. Retains source call and quote anchors; a speaker's causal claim is not independently proven causation.", "operationId": "get-earnings-source-statements", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker, SEC CIK or canonical platform key returned by company resolution.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Extraction type.", "schema": { "type": "string", "enum": [ "causal_claim", "guidance", "metric", "event", "state" ], "default": "causal_claim" } }, { "name": "document", "in": "query", "description": "Limit to one source document ID (an integer).", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Text contained in the statement, its quote, concept, cause, effect or speaker name; max 200 characters.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Rows per page, 1–100; default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string" }, "counts": { "type": "object", "properties": { "causal_claim": { "type": "integer" }, "guidance": { "type": "integer" }, "metric": { "type": "integer" }, "event": { "type": "integer" }, "state": { "type": "integer" } } }, "total": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "type": { "type": "string" }, "statement": { "type": "string" }, "concept": { "type": "string" }, "direction": { "type": "string" }, "value": { "type": "null" }, "valueLow": { "type": "null" }, "valueHigh": { "type": "null" }, "unit": { "type": "null" }, "valueQualifier": { "type": "null" }, "periodRaw": { "type": "string" }, "isForwardLooking": { "type": "boolean" }, "causeStatement": { "type": "string" }, "effectStatement": { "type": "string" }, "quote": { "type": "string" }, "speakerName": { "type": "string" }, "speakerRole": { "type": "string" }, "documentId": { "type": "integer" } } } }, "calls": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "integer" }, "externalId": { "type": "string" }, "date": { "type": "string", "format": "date" }, "label": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "ticker": "NVDA", "counts": { "causal_claim": 708, "guidance": 583, "metric": 2101, "event": 997, "state": 3758 }, "total": 708, "rows": [ { "observationId": 742816, "type": "causal_claim", "statement": "High compute infrastructure costs drove the sequential increase in NVIDIA's operating expenses in Q2 FY2027.", "concept": "operating expenses", "direction": "increasing", "value": null, "valueLow": null, "valueHigh": null, "unit": null, "valueQualifier": null, "periodRaw": "primarily due to", "isForwardLooking": false, "causeStatement": "NVIDIA incurred high compute infrastructure costs.", "effectStatement": "NVIDIA's GAAP and non-GAAP operating expenses increased sequentially.", "quote": "primarily due to high compute infrastructure costs", "speakerName": "Colette Kress", "speakerRole": "executive", "documentId": 35778 }, { "observationId": 742817, "type": "causal_claim", "statement": "Compensation and benefits costs drove the sequential increase in NVIDIA's operating expenses in Q2 FY2027.", "concept": "operating expenses", "direction": "increasing", "value": null, "valueLow": null, "valueHigh": null, "unit": null, "valueQualifier": null, "periodRaw": "primarily due to", "isForwardLooking": false, "causeStatement": "NVIDIA incurred compensation and benefits costs.", "effectStatement": "NVIDIA's GAAP and non-GAAP operating expenses increased sequentially.", "quote": "primarily due to high compute infrastructure costs and compensation and benefits costs.", "speakerName": "Colette Kress", "speakerRole": "executive", "documentId": 35778 } ], "calls": [ { "documentId": 35778, "externalId": "257198", "date": "2026-08-26", "label": "Q2 FY2027" }, { "documentId": 1, "externalId": "31919", "date": "2026-05-20", "label": "Q1 FY2027" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/regulators": { "get": { "summary": "Company regulators", "description": "Government bodies that regulate the issuer, with role and the sentence supporting the relationship.", "operationId": "get-company-regulators", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker, SEC CIK or canonical platform key returned by company resolution.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "regulators": { "type": "array", "items": { "type": "object", "properties": { "entityCode": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "label": { "type": "string" }, "level": { "type": "string" }, "logo": { "type": "object", "properties": { "url": { "type": "string" }, "kind": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "sourcePage": { "type": "string" }, "sourceUrl": { "type": "string" }, "license": { "type": "string" }, "onDark": { "type": "boolean" } } }, "website": { "type": "string" }, "description": { "type": "string" }, "evidenceQuote": { "type": "string" }, "evidenceUrl": { "type": "string" }, "source": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "validFrom": { "type": "null" }, "validTo": { "type": "null" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "regulators": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/fx/pairs/{pair}": { "get": { "summary": "FX pair profile", "description": "Reference-rate currency pair profile: latest cross, historical returns and derived range/volatility statistics, with canonical orientation and redenomination metadata. These are reference rates, not executable quotes.", "operationId": "get-fx-pair-profile", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "pair", "in": "path", "required": true, "description": "Six-letter currency pair, for example USDCAD.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "pair": { "type": "object", "properties": { "code": { "type": "string" }, "canonical": { "type": "string" }, "base": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "region": { "type": "string" } } }, "quote": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "symbol": { "type": "string" }, "region": { "type": "string" } } }, "asOf": { "type": "string", "format": "date" }, "stats": { "type": "object", "properties": { "lastDate": { "type": "string", "format": "date" }, "last": { "type": "number" }, "returns": { "type": "object", "properties": { "d1": { "type": "integer" }, "w1": { "type": "integer" }, "m1": { "type": "integer" }, "m3": { "type": "integer" }, "m6": { "type": "integer" }, "y1": { "type": "integer" }, "y2": { "type": "integer" }, "y5": { "type": "integer" }, "y10": { "type": "integer" } } }, "horizonDates": { "type": "object", "properties": { "w1": { "type": "string", "format": "date" }, "m1": { "type": "string", "format": "date" }, "m3": { "type": "string", "format": "date" }, "m6": { "type": "string", "format": "date" }, "y1": { "type": "string", "format": "date" }, "y2": { "type": "string", "format": "date" }, "y5": { "type": "string", "format": "date" }, "y10": { "type": "string", "format": "date" } } }, "low52w": { "type": "number" }, "high52w": { "type": "number" }, "high": { "type": "object", "properties": { "v": { "type": "number" }, "d": { "type": "string", "format": "date" } } }, "low": { "type": "object", "properties": { "v": { "type": "number" }, "d": { "type": "string", "format": "date" } } }, "volatility1y": { "type": "integer" }, "maxDrawdown1y": { "type": "integer" }, "pegged": { "type": "boolean" }, "firstDate": { "type": "string", "format": "date" }, "days": { "type": "integer" }, "years": { "type": "array", "items": { "type": "object", "properties": { "year": { "type": "integer" }, "close": { "type": "number" }, "change": { "type": "number" } } } } } }, "stale": { "type": "boolean" }, "redenominations": { "type": "array", "items": {} } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "pair": { "code": "USDAED", "canonical": "USDAED", "base": { "code": "USD", "name": "United States Dollar", "symbol": "$", "region": "majors" }, "quote": { "code": "AED", "name": "United Arab Emirates Dirham", "symbol": "د.إ", "region": "middle_east" }, "asOf": "2026-10-30", "stats": { "lastDate": "2026-10-30", "last": 3.6725, "returns": { "d1": 0, "w1": 0, "m1": 0, "m3": 0, "m6": 0, "y1": 0, "y2": 0, "y5": 0, "y10": 0 }, "horizonDates": { "w1": "2026-10-23", "m1": "2026-09-30", "m3": "2026-07-30", "m6": "2026-04-30", "y1": "2025-10-30", "y2": "2024-10-30", "y5": "2021-10-30", "y10": "2016-10-30" }, "low52w": 3.6725, "high52w": 3.6725, "high": { "v": 3.6731, "d": "1996-05-08" }, "low": { "v": 3.6707, "d": "1997-04-01" }, "volatility1y": 0, "maxDrawdown1y": 0, "pegged": true, "firstDate": "1996-04-11", "days": 7972, "years": [ { "year": 2026, "close": 3.6725, "change": 0 }, { "year": 1997, "close": 3.6725, "change": 0.0003541076487252326 } ] }, "stale": false, "redenominations": [] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/geo/companies": { "get": { "summary": "Companies with physical assets", "description": "Published companies with physical assets in the map registry and counts visible to the caller. Draft preview is a local-only development feature.", "operationId": "get-companies-with-physical-assets", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" }, "assets": { "type": "integer" } } } }, "preview": { "type": "boolean" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "companies": [ { "cik": "XSAU000020", "name": "Americana Restaurants International", "ticker": "6015", "assets": 2732 }, { "cik": "XADS000014", "name": "Abu Dhabi National Oil Company For Distribution", "ticker": "ADNOCDIST", "assets": 945 } ], "preview": false } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/digital-assets": { "get": { "summary": "Company digital assets", "description": "The issuer's held digital assets and their source-linked attributes. REST may include fields whose redistribution is filtered by the corresponding MCP tool.", "operationId": "get-company-digital-assets", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker, SEC CIK or canonical platform key returned by company resolution.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "company": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" } } }, "assets": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "type": { "type": "string" }, "architecture": { "type": [ "string", "null" ] }, "launch_date": { "type": [ "string", "null" ], "format": "date" }, "memory_gb": { "type": [ "integer", "null" ] }, "memory_type": { "type": [ "string", "null" ] }, "fp16_tflops": { "type": [ "number", "null" ] }, "tdp_w": { "type": [ "integer", "null" ] }, "process_nm": { "type": [ "integer", "null" ] }, "launch_price_usd": { "type": [ "integer", "null" ] }, "rental_usd_hour": { "type": [ "number", "null" ] }, "rental_date": { "type": [ "string", "null" ], "format": "date" }, "usd_per_pflop_hour": { "type": [ "number", "null" ] }, "return_1y": { "type": "null" }, "clouds": { "type": "integer" }, "source": { "type": [ "string", "null" ] }, "source_url": { "type": [ "string", "null" ] }, "rates": { "type": [ "object", "null" ], "properties": { "as_of": { "type": "string", "format": "date" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "url": { "type": "string" }, "first_seen": { "type": "string", "format": "date" }, "last_seen": { "type": "string", "format": "date" }, "via": { "type": "string" } } } }, "points": { "type": "array", "items": { "type": "object", "properties": { "product": { "type": "string" }, "currency": { "type": "string" }, "tenor": { "type": "string" }, "tenor_sort": { "type": "integer" }, "band": { "type": "string" }, "balance_from": { "type": "integer" }, "balance_to": { "type": [ "integer", "null" ] }, "rate": { "type": "number" }, "basis": { "type": "string" }, "conditions": { "type": [ "string", "null" ] }, "effective_from": { "type": [ "string", "null" ], "format": "date" }, "effective_until": { "type": [ "string", "null" ], "format": "date" } } } }, "history": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "via": { "type": "string" }, "rates": { "type": "object", "properties": { "1M": { "type": "number" }, "3M": { "type": "number" }, "6M": { "type": "number" }, "12M": { "type": "number" }, "1Y": { "type": "number" } } }, "bands": { "type": "object", "properties": { "1M": { "type": "string" }, "3M": { "type": "string" }, "6M": { "type": "string" }, "12M": { "type": "string" }, "1Y": { "type": "string" } } } } } }, "base_rate": { "type": "array", "items": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "value": { "type": "number" } } } }, "profile": { "type": "object", "properties": { "home_currency": { "type": "string" }, "term_product": { "type": "string" }, "policy": { "type": "object", "properties": { "origin": { "type": "string" }, "series": { "type": "string" }, "label": { "type": "string" } } }, "headline": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "tenor": { "type": "string" }, "days": { "type": "integer" } } } }, "lead": { "type": "array", "items": { "type": "string" } }, "chart_default": { "type": "array", "items": { "type": "string" } }, "reference_balance": { "type": [ "integer", "null" ] } } } } }, "app_metrics": { "type": "null" }, "spot": { "type": "null" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "company": { "cik": "0001045810", "ticker": "NVDA", "name": "NVIDIA CORP" }, "assets": [ { "key": "H100", "name": "NVIDIA H100 SXM", "kind": "chip", "type": "GPU", "architecture": "Hopper", "launch_date": "2022-09-20", "memory_gb": 80, "memory_type": "HBM3", "fp16_tflops": 989.4, "tdp_w": 700, "process_nm": 5, "launch_price_usd": 33600, "rental_usd_hour": 3.03, "rental_date": "2026-10-30", "usd_per_pflop_hour": 3.062462098241358, "return_1y": null, "clouds": 11, "source": "Epoch AI, Machine Learning Hardware (CC-BY 4.0)", "source_url": "https://www.nvidia.com/en-us/data-center/h100/", "rates": null }, { "key": "RTXPRO6000", "name": "NVIDIA RTX PRO 6000 (WS)", "kind": "chip", "type": "GPU", "architecture": "Blackwell", "launch_date": "2025-04-23", "memory_gb": 96, "memory_type": "GDDR7", "fp16_tflops": null, "tdp_w": 600, "process_nm": 4, "launch_price_usd": null, "rental_usd_hour": 1.995, "rental_date": "2026-09-19", "usd_per_pflop_hour": null, "return_1y": null, "clouds": 4, "source": "Epoch AI, Machine Learning Hardware (CC-BY 4.0)", "source_url": "https://www.nvidia.com/en-us/products/workstations/professional-desktop-gpus/rtx-pro-6000/", "rates": null } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/digital-assets/{key}": { "get": { "summary": "Digital asset detail", "description": "One digital asset by stable key, with current and historical holders, lifecycle, specification and available alternative data. The holder must be a published company.", "operationId": "get-digital-asset-detail", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Digital asset key returned by the company's asset register.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "asset": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "type": { "type": "string" }, "architecture": { "type": "string" }, "launch_date": { "type": "string", "format": "date" }, "memory_gb": { "type": "integer" }, "memory_type": { "type": "string" }, "fp16_tflops": { "type": "number" }, "tdp_w": { "type": "integer" }, "process_nm": { "type": "integer" }, "launch_price_usd": { "type": "integer" }, "rental_usd_hour": { "type": "number" }, "rental_date": { "type": "string", "format": "date" }, "usd_per_pflop_hour": { "type": "number" }, "return_1y": { "type": "null" }, "clouds": { "type": "integer" }, "source": { "type": "string" }, "source_url": { "type": "string" }, "rates": { "type": "null" } } }, "facts": { "type": "null" }, "holder": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" } } }, "parties": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "share_pct": { "type": "null" }, "via": { "type": "null" }, "how": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": "null" }, "precision": { "type": "string" }, "notes": { "type": "null" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "type": "string" } } } } } } }, "events": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "null" }, "from": { "type": "null" }, "to": { "type": "null" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } } } } } } }, "prices": { "type": "array", "items": {} }, "price_unit": { "type": "null" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "asset": { "key": "H100", "name": "NVIDIA H100 SXM", "kind": "chip", "type": "GPU", "architecture": "Hopper", "launch_date": "2022-09-20", "memory_gb": 80, "memory_type": "HBM3", "fp16_tflops": 989.4, "tdp_w": 700, "process_nm": 5, "launch_price_usd": 33600, "rental_usd_hour": 3.03, "rental_date": "2026-10-30", "usd_per_pflop_hour": 3.062462098241358, "return_1y": null, "clouds": 11, "source": "Epoch AI, Machine Learning Hardware (CC-BY 4.0)", "source_url": "https://www.nvidia.com/en-us/data-center/h100/", "rates": null }, "facts": null, "holder": { "cik": "0001045810", "ticker": "NVDA", "name": "NVIDIA CORP" }, "parties": [ { "cik": "0001045810", "name": "NVIDIA CORP", "role": "designer", "share_pct": null, "via": null, "how": "developed", "from": "2022-09-20", "to": null, "precision": "day", "notes": null, "sources": [ { "url": "https://www.nvidia.com/en-us/data-center/h100/", "title": "Epoch AI, Machine Learning Hardware (CC-BY 4.0)" } ] } ], "events": [ { "date": "2022-09-20", "precision": "day", "type": "launched", "title": "NVIDIA H100 SXM launched", "description": null, "from": null, "to": null, "sources": [ { "url": "https://www.nvidia.com/en-us/data-center/h100/" } ] } ], "prices": [], "price_unit": null } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/people/{cik}/votes": { "get": { "summary": "Person roll call votes", "description": "A member of Congress's recorded roll-call votes, with bill and party context. Returns available=false for a person without this coverage.", "operationId": "get-person-roll-call-votes", "tags": [ "Ownership & Insiders" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "cik", "in": "path", "required": true, "description": "Canonical person key.", "schema": { "type": "string" } }, { "name": "congress", "in": "query", "description": "Congress number (1–200) or all; default the newest held. A congress not held falls back to the newest.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Rows per page, 1–200; default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "available": { "type": "boolean" }, "bioguideId": { "type": "string" }, "name": { "type": "string" }, "party": { "type": "string" }, "currentChamber": { "type": "string" }, "senateVotesHeld": { "type": "boolean" }, "congress": { "type": "integer" }, "congresses": { "type": "array", "items": { "type": "integer" } }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "recordChambers": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "object", "properties": { "total": { "type": "integer" }, "yea": { "type": "integer" }, "nay": { "type": "integer" }, "present": { "type": "integer" }, "notVoting": { "type": "integer" }, "other": { "type": "integer" }, "partyComparable": { "type": "integer" }, "withParty": { "type": "integer" } } }, "total": { "type": "integer" }, "votes": { "type": "array", "items": { "type": "object", "properties": { "congress": { "type": "integer" }, "chamber": { "type": "string" }, "session": { "type": "integer" }, "rollNumber": { "type": "integer" }, "votedAt": { "type": "string", "format": "date-time" }, "day": { "type": "string", "format": "date" }, "question": { "type": "string" }, "voteType": { "type": "string" }, "result": { "type": "string" }, "position": { "type": "string" }, "positionRaw": { "type": "string" }, "withParty": { "type": "boolean" }, "partyTotals": { "type": "array", "items": { "type": "object", "properties": { "party": { "type": "string" }, "yea": { "type": "integer" }, "nay": { "type": "integer" }, "present": { "type": "integer" }, "notVoting": { "type": "integer" } } } }, "bill": { "type": "null" }, "url": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "available": true, "bioguideId": "A000382", "name": "Angela D. Alsobrooks", "party": "D", "currentChamber": "senate", "senateVotesHeld": true, "congress": 119, "congresses": [ 119 ], "offset": 0, "limit": 2, "recordChambers": [ "senate" ], "summary": { "total": 897, "yea": 273, "nay": 610, "present": 0, "notVoting": 14, "other": 0, "partyComparable": 855, "withParty": 836 }, "total": 897, "votes": [ { "congress": 119, "chamber": "senate", "session": 2, "rollNumber": 238, "votedAt": "2026-09-17T00:00:00.000Z", "day": "2026-09-16", "question": "On the Nomination", "voteType": "Yea-and-Nay", "result": "Nomination Confirmed", "position": "nay", "positionRaw": "Nay", "withParty": true, "partyTotals": [ { "party": "D", "yea": 0, "nay": 43, "present": 0, "notVoting": 2 }, { "party": "I", "yea": 0, "nay": 2, "present": 0, "notVoting": 0 } ], "bill": null, "url": "https://www.senate.gov/legislative/LIS/roll_call_votes/vote1192/vote_119_2_00238.htm" }, { "congress": 119, "chamber": "senate", "session": 2, "rollNumber": 237, "votedAt": "2026-09-17T00:00:00.000Z", "day": "2026-09-16", "question": "On the Cloture Motion", "voteType": "Yea-and-Nay", "result": "Cloture Motion Agreed to", "position": "nay", "positionRaw": "Nay", "withParty": true, "partyTotals": [ { "party": "D", "yea": 0, "nay": 45, "present": 0, "notVoting": 0 }, { "party": "I", "yea": 0, "nay": 2, "present": 0, "notVoting": 0 } ], "bill": null, "url": "https://www.senate.gov/legislative/LIS/roll_call_votes/vote1192/vote_119_2_00237.htm" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/military/conflicts/{key}": { "get": { "summary": "Conflict detail", "description": "One published conflict with parties, their periods, reported outcomes and source evidence. Draft review actions are not exposed by this operation.", "operationId": "get-conflict-detail", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "description": "Conflict key returned by search or the conflict index, e.g. ucdp:14609.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "conflict": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "incompatibility": { "type": "null" }, "territoryName": { "type": "null" }, "location": { "type": "string" }, "locationIso2": { "type": "array", "items": { "type": "string" } }, "region": { "type": "string" }, "start": { "type": "string", "format": "date" }, "startPrecision": { "type": "string" }, "end": { "type": "null" }, "endPrecision": { "type": "null" }, "activeYears": { "type": "array", "items": {} }, "intensity": { "type": "null" }, "battleDeaths": { "type": "null" }, "battleDeathsLow": { "type": "null" }, "battleDeathsHigh": { "type": "null" }, "battleDeathsSpan": { "type": "null" }, "summary": { "type": "string" }, "sourceCode": { "type": "string" }, "sourceRef": { "type": "null" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "type": "string" } } } }, "dataThrough": { "type": "integer" }, "draft": { "type": "boolean" }, "parties": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "iso2": { "type": [ "string", "null" ] }, "side": { "type": "string" }, "role": { "type": "string" }, "from": { "type": "string", "format": "date" }, "fromPrecision": { "type": "string" }, "to": { "type": "null" }, "toPrecision": { "type": "null" }, "activeYears": { "type": "array", "items": {} }, "outcome": { "type": "null" }, "opponents": { "type": "array", "items": { "type": "string" } }, "note": { "type": "string" }, "draft": { "type": "boolean" } } } }, "continues": { "type": "null" }, "continuedBy": { "type": "array", "items": {} }, "partOf": { "type": "null" }, "events": { "type": "array", "items": {} }, "review": { "type": "object", "properties": { "state": { "type": "string" }, "note": { "type": "null" }, "at": { "type": "null" } } }, "countryNames": { "type": "object", "properties": { "ET": { "type": "string" }, "ER": { "type": "string" } } }, "notices": { "type": "array", "items": {} } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "conflict": { "key": "seed:ethiopia-eritrea-2026", "name": "Ethiopia–Eritrea armed confrontation (2026)", "kind": "interstate", "incompatibility": null, "territoryName": null, "location": "Eastern Tigray (Adigrat, Zalambessa, Idaga Hamus, Rama); northern Afar", "locationIso2": [ "ET", "ER" ], "region": "africa", "start": "2026-10-01", "startPrecision": "month", "end": null, "endPrecision": null, "activeYears": [], "intensity": null, "battleDeaths": null, "battleDeathsLow": null, "battleDeathsHigh": null, "battleDeathsSpan": null, "summary": "During Ethiopia's September–October 2026 fighting with a TPLF-led rebel alliance, witnesses reported Eritrean troops in Adigrat and eastern Tigray from about 7 October 2026 and Ethiopia says its drone…", "sourceCode": "seed", "sourceRef": null, "sources": [ { "url": "https://www.bbc.com/news/articles/crpd0d0jl0y0o", "title": "BBC: Ethiopia and Eritrea cut diplomatic ties (2026-10-02)" }, { "url": "https://www.aljazeera.com/news/2026/10/7/witnesses-spot-eritrean-troops-inside-northern-ethiopia-as-tensions-flare", "title": "Al Jazeera (Reuters): Witnesses spot Eritrean troops inside northern Ethiopia as tensions flare (2026-10-07)" } ], "dataThrough": 2026, "draft": true, "parties": [ { "name": "Ethiopia", "iso2": "ET", "side": "A", "role": "primary", "from": "2026-10-01", "fromPrecision": "month", "to": null, "toPrecision": null, "activeYears": [], "outcome": null, "opponents": [ "Eritrea" ], "note": "Foreign Minister Gedion Timothewos told the UN Security Council on 8 October 2026 that Eritrean troops had advanced up to 60 km into Tigray and that Ethiopia was defending itself, citing drone strikes…", "draft": true }, { "name": "Tigray Peace Force", "iso2": null, "side": "A", "role": "secondary", "from": "2026-10-01", "fromPrecision": "month", "to": null, "toPrecision": null, "activeYears": [], "outcome": null, "opponents": [ "Eritrea" ], "note": "This pro-government Tigrayan force reported Eritrean troops in Adigrat on 6–7 October and claimed on 15 October 2026 that they had suffered significant casualties and retreated (not independently veri…", "draft": true } ], "continues": null, "continuedBy": [], "partOf": null, "events": [], "review": { "state": "draft", "note": null, "at": null }, "countryNames": { "ET": "Ethiopia", "ER": "Eritrea" }, "notices": [] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/foreign-relations/organisations/{code}": { "get": { "summary": "Organisation detail", "description": "One published international organisation, its bodies, country seats over time and linked agreements. An empty production registry does not include drafts.", "operationId": "get-organisation-detail", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "description": "Organisation code returned by the index.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "organisation": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "kind": { "type": "string" }, "domains": { "type": "array", "items": { "type": "string" } }, "parent": { "type": "null" }, "children": { "type": "array", "items": {} }, "founded": { "type": "string", "format": "date" }, "dissolved": { "type": "null" }, "hqCountry": { "type": "string" }, "website": { "type": "string" }, "description": { "type": "null" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "tier": { "type": "string" }, "quote": { "type": "string" }, "title": { "type": "string" }, "accessed": { "type": "string", "format": "date" } } } }, "draft": { "type": "boolean" }, "members": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "org": { "type": "string" }, "orgName": { "type": "string" }, "orgShortName": { "type": "string" }, "orgKind": { "type": "string" }, "domains": { "type": "array", "items": { "type": "string" } }, "parent": { "type": "null" }, "country": { "type": "string" }, "status": { "type": "string" }, "validFrom": { "type": [ "string", "null" ], "format": "date" }, "validTo": { "type": "null" }, "attributes": { "type": "object", "properties": { "joined_year": { "type": "integer" }, "valid_from_precision": { "type": "string" }, "to": { "type": "string" }, "from": { "type": "string" } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "tier": { "type": "string" }, "quote": { "type": "string" }, "title": { "type": "string" }, "accessed": { "type": "string", "format": "date" } } } }, "draft": { "type": "boolean" } } } }, "council": { "type": "null" }, "memberOrgs": { "type": "array", "items": {} }, "agreements": { "type": "array", "items": {} }, "countryNames": { "type": "object", "additionalProperties": { "type": "string" } }, "notices": { "type": "array", "items": {} } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "organisation": { "code": "OPEC", "name": "Organization of the Petroleum Exporting Countries", "shortName": "OPEC", "kind": "producer_group", "domains": [ "energy" ], "parent": null, "children": [], "founded": "1960-09-14", "dissolved": null, "hqCountry": "AT", "website": "https://www.opec.org/", "description": null, "sources": [ { "url": "https://jodidata.org/about-jodi/partners/opec.aspx", "tier": "official_announcement", "quote": "OPEC was founded on September 14, 1960, the result of a meeting that took place in the Iraqi capital of Baghdad", "title": "Organization Of The Petroleum Exporting Countries (OPEC) - JODI partners", "accessed": "2026-10-27" }, { "url": "https://jodidata.org/about-jodi/partners/opec.aspx", "tier": "official_announcement", "quote": "Helferstorferstrasse 17, A-1010 Vienna, Austria", "title": "Organization Of The Petroleum Exporting Countries (OPEC) - JODI partners", "accessed": "2026-10-27" } ], "draft": false, "members": [ { "id": 16670, "org": "OPEC", "orgName": "Organization of the Petroleum Exporting Countries", "orgShortName": "OPEC", "orgKind": "producer_group", "domains": [ "energy" ], "parent": null, "country": "CG", "status": "member", "validFrom": "2018-01-01", "validTo": null, "attributes": { "joined_year": 2018, "valid_from_precision": "year" }, "sources": [ { "url": "https://web.archive.org/web/20250331044139/https://www.opec.org/opec_web/en/about_us/25.htm", "tier": "org_page", "quote": "These countries were later joined by Qatar (1961), Indonesia (1962), Libya (1962), the United Arab Emirates (1967), Algeria (1969), Nigeria (1971), Ecuador (1973), Gabon (1975), Angola (2007), Equator…", "title": "OPEC : Member Countries (opec.org, Wayback Machine copy of 31 March 2025)", "accessed": "2026-10-28" } ], "draft": false }, { "id": 16665, "org": "OPEC", "orgName": "Organization of the Petroleum Exporting Countries", "orgShortName": "OPEC", "orgKind": "producer_group", "domains": [ "energy" ], "parent": null, "country": "EC", "status": "suspended", "validFrom": null, "validTo": null, "attributes": { "to": "October 2007", "from": "December 1992" }, "sources": [ { "url": "https://web.archive.org/web/20250331044139/https://www.opec.org/opec_web/en/about_us/25.htm", "tier": "org_page", "quote": "Ecuador suspended its membership in December 1992, rejoined OPEC in October 2007", "title": "OPEC : Member Countries (opec.org, Wayback Machine copy of 31 March 2025)", "accessed": "2026-10-28" } ], "draft": false } ], "council": null, "memberOrgs": [], "agreements": [], "countryNames": { "DZ": "Algeria", "AO": "Angola", "EC": "Ecuador", "GQ": "Equatorial Guinea", "GA": "Gabon", "ID": "Indonesia" }, "notices": [] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/bills": { "get": { "summary": "Legislative bills", "description": "Legislative measures and their derived action stages, with whole-population stage counts and bounded result pages.", "operationId": "get-legislative-bills", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO alpha-2 country code.", "schema": { "type": "string" } }, { "name": "congress", "in": "query", "description": "Congress number (1–200) or all; default the newest held. A congress not held falls back to the newest.", "schema": { "type": "string" } }, { "name": "stage", "in": "query", "description": "Action stage.", "schema": { "type": "string", "enum": [ "introduced", "passed_one", "cleared", "law", "vetoed" ] } }, { "name": "voted", "in": "query", "description": "1 to require a recorded vote.", "schema": { "type": "string", "enum": [ "1", "0" ] } }, { "name": "q", "in": "query", "description": "Title contains; max 120 characters.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Rows per page, 1–200; default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "available": { "type": "boolean" }, "load": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } }, "congress": { "type": [ "integer", "null" ] }, "congresses": { "type": "array", "items": { "type": "integer" } }, "stage": { "type": "null" }, "voted": { "type": "boolean" }, "query": { "type": "null" }, "total": { "type": "integer" }, "stageCounts": { "type": "object", "properties": { "introduced": { "type": "integer" }, "passed_one": { "type": "integer" }, "cleared": { "type": "integer" }, "law": { "type": "integer" }, "vetoed": { "type": "integer" } } }, "votedCounts": { "type": "object", "properties": { "introduced": { "type": "integer" }, "passed_one": { "type": "integer" }, "cleared": { "type": "integer" }, "law": { "type": "integer" }, "vetoed": { "type": "integer" } } }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "bills": { "type": "array", "items": { "type": "object", "properties": { "congress": { "type": "integer" }, "billType": { "type": "string" }, "billNumber": { "type": "integer" }, "label": { "type": "string" }, "title": { "type": "string" }, "introducedDate": { "type": "string", "format": "date" }, "originChamber": { "type": "string" }, "policyArea": { "type": "null" }, "sponsor": { "type": "object", "properties": { "bioguideId": { "type": "string" }, "name": { "type": "string" }, "party": { "type": "string" }, "stateCode": { "type": "string" }, "personKey": { "type": "string" } } }, "cosponsorCount": { "type": "integer" }, "latestActionDate": { "type": "string", "format": "date" }, "latestActionText": { "type": "string" }, "lawNumber": { "type": "null" }, "summary": { "type": "null" }, "url": { "type": "string" }, "subjects": { "type": "array", "items": {} }, "stage": { "type": "string" }, "measureClass": { "type": "string" }, "passedHouse": { "type": "boolean" }, "passedSenate": { "type": "boolean" }, "committees": { "type": "array", "items": { "type": "object", "properties": { "systemCode": { "type": "string" }, "name": { "type": "string" }, "activity": { "type": "string" } } } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "seq": { "type": "integer" }, "date": { "type": "string", "format": "date" }, "chamber": { "type": [ "string", "null" ] }, "type": { "type": "string" }, "text": { "type": "string" } } } }, "cosponsors": { "type": "array", "items": { "type": "object", "properties": { "bioguideId": { "type": "string" }, "name": { "type": "string" }, "party": { "type": "string" }, "stateCode": { "type": "string" }, "personKey": { "type": "string" }, "sponsorshipDate": { "type": "string", "format": "date" }, "isOriginal": { "type": "boolean" }, "withdrawnDate": { "type": "null" } } } }, "votes": { "type": "array", "items": {} } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "available": true, "load": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T01:51:46.741Z", "stale": true, "staleLanes": [ "govinfo/bills" ], "failedLanes": [], "runs": [ { "sourceCode": "govinfo", "lane": "bills", "mode": "backfill", "status": "succeeded", "rowsWritten": 2803741, "finishedAt": "2026-09-19T01:51:46.741Z" } ] }, "congress": 119, "congresses": [ 119, 118 ], "stage": null, "voted": false, "query": null, "total": 18956, "stageCounts": { "introduced": 17380, "passed_one": 1424, "cleared": 38, "law": 112, "vetoed": 2 }, "votedCounts": { "introduced": 94, "passed_one": 344, "cleared": 8, "law": 61, "vetoed": 2 }, "offset": 0, "limit": 2, "bills": [ { "congress": 119, "billType": "hr", "billNumber": 10477, "label": "H.R. 10477", "title": "To amend the Sarbanes-Oxley Act of 2002 to exclude the audits of privately held, non-carrying brokers and dealers that are in good standing from certain requirements under title I of that Act, and for…", "introducedDate": "2026-09-17", "originChamber": "house", "policyArea": null, "sponsor": { "bioguideId": "H001072", "name": "J. French Hill", "party": "R", "stateCode": "AR", "personKey": "USGVP00026" }, "cosponsorCount": 0, "latestActionDate": "2026-09-17", "latestActionText": "Referred to the House Committee on Financial Services.", "lawNumber": null, "summary": null, "url": "https://www.congress.gov/bill/119th-congress/house-bill/10477", "subjects": [], "stage": "introduced", "measureClass": "bill", "passedHouse": false, "passedSenate": false, "committees": [ { "systemCode": "hsba00", "name": "Committee on Financial Services", "activity": "Referred To" } ], "actions": [ { "seq": 3, "date": "2026-09-17", "chamber": "house", "type": "IntroReferral", "text": "Referred to the House Committee on Financial Services." }, { "seq": 2, "date": "2026-09-17", "chamber": null, "type": "IntroReferral", "text": "Introduced in House" } ], "cosponsors": [], "votes": [] }, { "congress": 119, "billType": "hr", "billNumber": 10478, "label": "H.R. 10478", "title": "To direct the Secretary of Veterans Affairs to establish a pilot program to arrange for qualified pension assistance organizations to provide claims development support to veterans and beneficiaries, …", "introducedDate": "2026-09-17", "originChamber": "house", "policyArea": null, "sponsor": { "bioguideId": "R000612", "name": "John W. Rose", "party": "R", "stateCode": "TN", "personKey": "USGVP00443" }, "cosponsorCount": 3, "latestActionDate": "2026-09-17", "latestActionText": "Referred to the House Committee on Veterans' Affairs.", "lawNumber": null, "summary": null, "url": "https://www.congress.gov/bill/119th-congress/house-bill/10478", "subjects": [], "stage": "introduced", "measureClass": "bill", "passedHouse": false, "passedSenate": false, "committees": [ { "systemCode": "hsvr00", "name": "Committee on Veterans' Affairs", "activity": "Referred To" } ], "actions": [ { "seq": 3, "date": "2026-09-17", "chamber": "house", "type": "IntroReferral", "text": "Referred to the House Committee on Veterans' Affairs." }, { "seq": 2, "date": "2026-09-17", "chamber": null, "type": "IntroReferral", "text": "Introduced in House" } ], "cosponsors": [ { "bioguideId": "B001309", "name": "Tim Burchett", "party": "R", "stateCode": "TN", "personKey": "USGVP00070", "sponsorshipDate": "2026-09-17", "isOriginal": true, "withdrawnDate": null }, { "bioguideId": "M001216", "name": "Cory Mills", "party": "R", "stateCode": "FL", "personKey": "USGVP00363", "sponsorshipDate": "2026-09-17", "isOriginal": true, "withdrawnDate": null } ], "votes": [] } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/next-sitting": { "get": { "summary": "Next chamber sittings", "description": "The next published chamber sitting and programme, plus the surrounding calendar. A null next sitting means nothing published within the returned horizon, not a declaration of recess.", "operationId": "get-next-chamber-sittings", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO alpha-2 country code.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "available": { "type": "boolean" }, "today": { "type": "string", "format": "date" }, "next": { "type": [ "object", "null" ], "properties": { "house": { "type": "object", "properties": { "chamber": { "type": "string" }, "date": { "type": "string", "format": "date" }, "status": { "type": "string" }, "conveneAt": { "type": "string", "format": "date-time" }, "conveneText": { "type": "string" }, "adjournedAt": { "type": "null" }, "adjournedText": { "type": "null" }, "ranPastMidnight": { "type": "boolean" }, "statusFrom": { "type": "null" }, "program": { "type": "string" }, "basis": { "type": "string" }, "bases": { "type": "array", "items": { "type": "string" } }, "observedOn": { "type": "string", "format": "date" }, "sourceRef": { "type": "string" } } }, "senate": { "type": "object", "properties": { "chamber": { "type": "string" }, "date": { "type": "string", "format": "date" }, "status": { "type": "string" }, "conveneAt": { "type": "string", "format": "date-time" }, "conveneText": { "type": "string" }, "adjournedAt": { "type": "null" }, "adjournedText": { "type": "null" }, "ranPastMidnight": { "type": "boolean" }, "statusFrom": { "type": "null" }, "program": { "type": "string" }, "basis": { "type": "string" }, "bases": { "type": "array", "items": { "type": "string" } }, "observedOn": { "type": "string", "format": "date" }, "sourceRef": { "type": "string" } } } } }, "days": { "type": "array", "items": { "type": "object", "properties": { "chamber": { "type": "string" }, "date": { "type": "string", "format": "date" }, "status": { "type": "string" }, "conveneAt": { "type": [ "string", "null" ], "format": "date-time" }, "conveneText": { "type": [ "string", "null" ] }, "adjournedAt": { "type": [ "string", "null" ], "format": "date-time" }, "adjournedText": { "type": [ "string", "null" ] }, "ranPastMidnight": { "type": "boolean" }, "statusFrom": { "type": [ "string", "null" ] }, "program": { "type": "null" }, "basis": { "type": "string" }, "bases": { "type": "array", "items": { "type": "string" } }, "observedOn": { "type": "string", "format": "date" }, "sourceRef": { "type": "string" } } } }, "horizon": { "type": [ "object", "null" ], "properties": { "house": { "type": "object", "properties": { "publishedThrough": { "type": "string", "format": "date" }, "note": { "type": "string" } } }, "senate": { "type": "object", "properties": { "publishedThrough": { "type": "string", "format": "date" }, "note": { "type": "string" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "available": true, "today": "2026-11-01", "next": { "house": { "chamber": "house", "date": "2026-11-02", "status": "pro_forma", "conveneAt": "2026-11-02T19:00:00.000Z", "conveneText": "2 p.m., Monday, November 2", "adjournedAt": null, "adjournedText": null, "ranPastMidnight": false, "statusFrom": null, "program": "House will meet in Pro Forma session at 2 p.m. _______________________________________________________________________", "basis": "daily_digest", "bases": [ "daily_digest" ], "observedOn": "2026-10-29", "sourceRef": "CREC-2026-10-29-pt1-PgD985-3" }, "senate": { "chamber": "senate", "date": "2026-11-02", "status": "pro_forma", "conveneAt": "2026-11-02T21:30:00.000Z", "conveneText": "4:30 p.m., Monday, November 2", "adjournedAt": null, "adjournedText": null, "ranPastMidnight": false, "statusFrom": null, "program": "Senate will meet in a pro forma session.", "basis": "daily_digest", "bases": [ "daily_digest" ], "observedOn": "2026-10-29", "sourceRef": "CREC-2026-10-29-pt1-PgD985-3" } }, "days": [ { "chamber": "house", "date": "2026-10-26", "status": "pro_forma", "conveneAt": "2026-10-26T16:30:00.000Z", "conveneText": "12:30 p.m.", "adjournedAt": "2026-10-26T16:32:00.000Z", "adjournedText": "12:32 p.m.", "ranPastMidnight": false, "statusFrom": "daily_digest", "program": null, "basis": "congressional_record", "bases": [ "annual_calendar", "congressional_record" ], "observedOn": "2026-10-26", "sourceRef": "CREC-2026-10-26-pt1-PgD981-3" }, { "chamber": "house", "date": "2026-10-27", "status": "district_work", "conveneAt": null, "conveneText": null, "adjournedAt": null, "adjournedText": null, "ranPastMidnight": false, "statusFrom": null, "program": null, "basis": "annual_calendar", "bases": [ "annual_calendar" ], "observedOn": "2026-11-01", "sourceRef": "https://www.majorityleader.gov/UploadedFiles/2026Calendar_Sept16.pdf" } ], "horizon": { "house": { "publishedThrough": "2026-12-31", "note": "The House publishes an annual calendar of session days and district work periods, and the Daily Digest announces each sitting the day before." }, "senate": { "publishedThrough": "2026-11-02", "note": "The Senate publishes no machine-readable forward calendar — senate.gov refuses automated access — so its days come from the Congressional Record and reach only as far as the last Daily Digest's announ…" } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/committees/{systemCode}": { "get": { "summary": "Government committee", "description": "Committee roster, subcommittees and meeting/hearing log for the selected Congress.", "operationId": "get-government-committee", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO alpha-2 country code.", "schema": { "type": "string" } }, { "name": "systemCode", "in": "path", "required": true, "description": "Committee system code from government data.", "schema": { "type": "string" } }, { "name": "congress", "in": "query", "description": "Congress number (1–200) or all; default the newest held. A congress not held falls back to the newest.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "available": { "type": "boolean" }, "load": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } }, "committee": { "type": "object", "properties": { "systemCode": { "type": "string" }, "parentSystemCode": { "type": "null" }, "name": { "type": "string" }, "chamber": { "type": "string" }, "committeeType": { "type": "string" }, "websiteUrl": { "type": "string" }, "seats": { "type": "array", "items": { "type": "object", "properties": { "bioguideId": { "type": "string" }, "name": { "type": "string" }, "party": { "type": "string" }, "stateCode": { "type": "string" }, "personKey": { "type": "string" }, "side": { "type": "string" }, "rank": { "type": "integer" }, "title": { "type": [ "string", "null" ] }, "sourceCode": { "type": "string" } } } }, "subcommittees": { "type": "array", "items": { "type": "object", "properties": { "systemCode": { "type": "string" }, "name": { "type": "string" }, "websiteUrl": { "type": "string" }, "seats": { "type": "array", "items": { "type": "object", "properties": { "bioguideId": { "type": "string" }, "name": { "type": "string" }, "party": { "type": "string" }, "stateCode": { "type": "string" }, "personKey": { "type": "string" }, "side": { "type": "string" }, "rank": { "type": "integer" }, "title": { "type": [ "string", "null" ] }, "sourceCode": { "type": "string" } } } } } } } } }, "congress": { "type": "integer" }, "congresses": { "type": "array", "items": { "type": "integer" } }, "events": { "type": "array", "items": { "type": "object", "properties": { "congress": { "type": "integer" }, "chamber": { "type": "string" }, "eventId": { "type": "string" }, "title": { "type": "string" }, "meetingType": { "type": "string" }, "status": { "type": "string" }, "meetingAt": { "type": "string", "format": "date-time" }, "day": { "type": "string", "format": "date" }, "location": { "type": "string" }, "committee": { "type": "object", "properties": { "systemCode": { "type": "string" }, "name": { "type": "string" } } }, "isSubcommittee": { "type": "boolean" }, "witnesses": { "type": "array", "items": { "type": "object", "properties": { "ordinal": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "string" }, "organization": { "type": [ "string", "null" ] }, "personKey": { "type": "null" } } } }, "hearing": { "type": [ "object", "null" ], "properties": { "congress": { "type": "integer" }, "chamber": { "type": "string" }, "jacketNumber": { "type": "integer" }, "hearingNumber": { "type": "null" }, "title": { "type": "string" }, "citation": { "type": "string" }, "firstDate": { "type": "string", "format": "date" }, "hearingDates": { "type": "array", "items": { "type": "string", "format": "date" } }, "textUrl": { "type": "string" }, "pdfUrl": { "type": "string" }, "linkBasis": { "type": "string" } } }, "url": { "type": "string" } } } }, "orphanHearings": { "type": "array", "items": { "type": "object", "properties": { "congress": { "type": "integer" }, "chamber": { "type": "string" }, "jacketNumber": { "type": "integer" }, "hearingNumber": { "type": "null" }, "title": { "type": "string" }, "citation": { "type": "string" }, "firstDate": { "type": "string", "format": "date" }, "hearingDates": { "type": "array", "items": { "type": "string", "format": "date" } }, "textUrl": { "type": "string" }, "pdfUrl": { "type": "string" }, "linkBasis": { "type": "null" } } } }, "counts": { "type": "object", "properties": { "meetings": { "type": "integer" }, "hearings": { "type": "integer" }, "linkedExplicit": { "type": "integer" }, "linkedByDate": { "type": "integer" }, "unlinkedHearings": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "available": true, "load": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-11-01T10:18:26.037Z", "stale": true, "staleLanes": [ "congress_gov/committees", "congress_gov/hearings" ], "failedLanes": [], "runs": [ { "sourceCode": "congress_gov", "lane": "committees", "mode": "backfill", "status": "succeeded", "rowsWritten": 785, "finishedAt": "2026-09-19T02:00:55.489Z" }, { "sourceCode": "congress_gov", "lane": "hearings", "mode": "backfill", "status": "succeeded", "rowsWritten": 0, "finishedAt": "2026-09-19T04:52:45.538Z" } ] }, "committee": { "systemCode": "hspw00", "parentSystemCode": null, "name": "Committee on Transportation and Infrastructure", "chamber": "house", "committeeType": "Standing", "websiteUrl": "https://transportation.house.gov/", "seats": [ { "bioguideId": "G000546", "name": "Sam Graves", "party": "R", "stateCode": "MO", "personKey": "USGVP00197", "side": "majority", "rank": 1, "title": "Chair", "sourceCode": "house_clerk" }, { "bioguideId": "W000806", "name": "Daniel Webster", "party": "R", "stateCode": "FL", "personKey": "USGVP00548", "side": "majority", "rank": 3, "title": null, "sourceCode": "house_clerk" } ], "subcommittees": [ { "systemCode": "hspw05", "name": "House Transportation and Infrastructure Subcommittee on Aviation", "websiteUrl": "https://transportation.house.gov/", "seats": [ { "bioguideId": "N000026", "name": "Troy E. Nehls", "party": "R", "stateCode": "TX", "personKey": "USGVP00395", "side": "majority", "rank": 1, "title": "Chairman", "sourceCode": "house_clerk" }, { "bioguideId": "M001184", "name": "Thomas Massie", "party": "R", "stateCode": "KY", "personKey": "USGVP00347", "side": "majority", "rank": 2, "title": null, "sourceCode": "house_clerk" } ] }, { "systemCode": "hspw13", "name": "House Transportation and Infrastructure Subcommittee on Economic Development, Public Buildings, and Emergency Management", "websiteUrl": "https://transportation.house.gov/", "seats": [ { "bioguideId": "P000605", "name": "Scott Perry", "party": "R", "stateCode": "PA", "personKey": "USGVP00417", "side": "majority", "rank": 1, "title": "Chairman", "sourceCode": "house_clerk" }, { "bioguideId": "E000235", "name": "Mike Ezell", "party": "R", "stateCode": "MS", "personKey": "USGVP00160", "side": "majority", "rank": 2, "title": null, "sourceCode": "house_clerk" } ] } ] }, "congress": 119, "congresses": [ 119, 118 ], "events": [ { "congress": 119, "chamber": "house", "eventId": "119552", "title": "\"Always Ready: A Day in the Life of a United States Coast Guard Member\"", "meetingType": "Hearing", "status": "Scheduled", "meetingAt": "2026-09-16T17:00:00.000Z", "day": "2026-09-16", "location": "Rayburn House Office Building 2167", "committee": { "systemCode": "hspw07", "name": "Subcommittee on Coast Guard and Maritime Transportation" }, "isSubcommittee": true, "witnesses": [ { "ordinal": 1, "name": "Vice Admiral Nathan Moore", "position": "Deputy Commandant for Operations", "organization": "United States Coast Guard", "personKey": null }, { "ordinal": 2, "name": "Master Chief Petty Officer Phillip Waldron", "position": "Master Chief Petty Officer", "organization": "United States Coast Guard", "personKey": null } ], "hearing": null, "url": "https://www.congress.gov/event/119th-congress/house-event/119552" }, { "congress": 119, "chamber": "house", "eventId": "118810", "title": "\"Committee on Transportation and Infrastructure Member Day\"", "meetingType": "Hearing", "status": "Scheduled", "meetingAt": "2026-01-14T15:00:00.000Z", "day": "2026-01-14", "location": "Rayburn House Office Building 2167", "committee": { "systemCode": "hspw00", "name": "Committee on Transportation and Infrastructure" }, "isSubcommittee": false, "witnesses": [ { "ordinal": 1, "name": "The Honorable Andrea Salinas", "position": "Member of Congress", "organization": null, "personKey": null }, { "ordinal": 2, "name": "The Honorable Nikki Budzinski", "position": "Member of Congress", "organization": null, "personKey": null } ], "hearing": { "congress": 119, "chamber": "house", "jacketNumber": 62880, "hearingNumber": null, "title": "COMMITTEE ON TRANSPORTATION AND INFRASTRUCTURE MEMBER DAY", "citation": "H.Hrg.119", "firstDate": "2026-01-14", "hearingDates": [ "2026-01-14" ], "textUrl": "https://congress.gov/119/chrg/CHRG-119hhrg62880/generated/CHRG-119hhrg62880.htm", "pdfUrl": "https://congress.gov/119/chrg/CHRG-119hhrg62880/CHRG-119hhrg62880.pdf", "linkBasis": "event_id" }, "url": "https://www.congress.gov/event/119th-congress/house-event/118810" } ], "orphanHearings": [ { "congress": 119, "chamber": "house", "jacketNumber": 64287, "hearingNumber": null, "title": "REVIEW OF THE COAST GUARD'S FISCAL YEAR 2027 BUDGET REQUEST", "citation": "H.Hrg.119", "firstDate": "2026-04-28", "hearingDates": [ "2026-04-28" ], "textUrl": "https://congress.gov/119/chrg/CHRG-119hhrg64287/generated/CHRG-119hhrg64287.htm", "pdfUrl": "https://congress.gov/119/chrg/CHRG-119hhrg64287/CHRG-119hhrg64287.pdf", "linkBasis": null }, { "congress": 119, "chamber": "house", "jacketNumber": 63902, "hearingNumber": null, "title": "FORCE DESIGN OR FORCE IN DECLINE: REVIEWING READINESS", "citation": "H.Hrg.119", "firstDate": "2026-03-17", "hearingDates": [ "2026-03-17" ], "textUrl": "https://congress.gov/119/chrg/CHRG-119hhrg63902/generated/CHRG-119hhrg63902.htm", "pdfUrl": "https://congress.gov/119/chrg/CHRG-119hhrg63902/CHRG-119hhrg63902.pdf", "linkBasis": null } ], "counts": { "meetings": 68, "hearings": 32, "linkedExplicit": 7, "linkedByDate": 3, "unlinkedHearings": 22 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/votes/{congress}/{chamber}/{session}/{roll}": { "get": { "summary": "Government roll call vote", "description": "One roll call by its natural key, including how each member voted. Separate from the bills page to keep large rosters bounded to one selected vote.", "operationId": "get-government-roll-call-vote", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO alpha-2 country code.", "schema": { "type": "string" } }, { "name": "congress", "in": "path", "required": true, "description": "congress", "schema": { "type": "string" } }, { "name": "chamber", "in": "path", "required": true, "description": "Chamber code from the source vote reference.", "schema": { "type": "string" } }, { "name": "session", "in": "path", "required": true, "description": "session", "schema": { "type": "string" } }, { "name": "roll", "in": "path", "required": true, "description": "roll", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "congress": { "type": "integer" }, "session": { "type": "integer" }, "rollNumber": { "type": "integer" }, "chamber": { "type": "string" }, "positions": { "type": "array", "items": { "type": "object", "properties": { "bioguideId": { "type": "string" }, "name": { "type": "string" }, "party": { "type": "string" }, "stateCode": { "type": "string" }, "position": { "type": "string" }, "personKey": { "type": "string" } } } }, "available": { "type": "boolean" }, "found": { "type": "boolean" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "congress": 119, "session": 1, "rollNumber": 1, "chamber": "house", "positions": [ { "bioguideId": "G000578", "name": "Matt Gaetz", "party": "R", "stateCode": "FL", "position": "Not Voting", "personKey": "USGVP01452" }, { "bioguideId": "J000288", "name": "Henry C. \"Hank\" Johnson, Jr.", "party": "D", "stateCode": "GA", "position": "Not Voting", "personKey": "USGVP00262" } ], "available": true, "found": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/budget-flow": { "get": { "summary": "Government budget flow", "description": "United States only: fiscal-year receipts by source and net outlays by function from Monthly Treasury Statement Table 9 (September, fiscal year to date), in billions of dollars, oldest year first. Any other country is a 404 (`not_found`): the statement covers the United States only.", "operationId": "get-government-budget-flow", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO alpha-2 country code.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "unit": { "type": "string" }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "table": { "type": "string" }, "url": { "type": "string" } } }, "years": { "type": "array", "items": { "type": "object", "properties": { "fiscalYear": { "type": "integer" }, "label": { "type": "string" }, "receipts": { "type": "number" }, "outlays": { "type": "number" }, "officialReceipts": { "type": "number" }, "officialOutlays": { "type": "number" }, "receiptSources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" } } } }, "outlayCategories": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "value": { "type": "number" } } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "unit": "Billions of dollars", "source": { "name": "U.S. Treasury, Monthly Treasury Statement", "table": "Table 9 — receipts by source, outlays by function (September, fiscal year to date)", "url": "https://fiscaldata.treasury.gov/datasets/monthly-treasury-statement/" }, "years": [ { "fiscalYear": 2015, "label": "FY2015", "receipts": 3402.86146706, "outlays": 3841.760325182, "officialReceipts": 3248.723200916, "officialOutlays": 3687.6220590380003, "receiptSources": [ { "id": "individual", "label": "Individual income", "value": 1540.802375213 }, { "id": "payroll", "label": "Payroll taxes", "value": 1065.277352876 } ], "outlayCategories": [ { "id": "ss", "label": "Social Security", "value": 887.770817464 }, { "id": "defense", "label": "National defense", "value": 591.372205224 } ] }, { "fiscalYear": 2016, "label": "FY2016", "receipts": 3394.728635185, "outlays": 3982.140404822, "officialReceipts": 3266.688370973, "officialOutlays": 3854.10014061, "receiptSources": [ { "id": "individual", "label": "Individual income", "value": 1546.074928108 }, { "id": "payroll", "label": "Payroll taxes", "value": 1115.062819157 } ], "outlayCategories": [ { "id": "ss", "label": "Social Security", "value": 916.0779871330001 }, { "id": "defense", "label": "National defense", "value": 595.303439435 } ] } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/fed-financials/source": { "get": { "summary": "Central bank financial source", "description": "Primary-source evidence for one served Federal Reserve statement figure, including document vintages, page/box/text anchors, and arithmetic for a derived Q4 where applicable.", "operationId": "get-central-bank-financial-source", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO alpha-2 country code.", "schema": { "type": "string" } }, { "name": "entity", "in": "query", "description": "Reporting entity.", "schema": { "type": "string", "default": "combined" } }, { "name": "statement", "in": "query", "description": "Statement identifier from the served grid.", "schema": { "type": "string" }, "required": true }, { "name": "line", "in": "query", "description": "Line identifier from the served grid.", "schema": { "type": "string" }, "required": true }, { "name": "period_end", "in": "query", "description": "Reporting period end YYYY-MM-DD.", "schema": { "type": "string" }, "required": true }, { "name": "duration", "in": "query", "description": "Period duration from the served cell; zero for a balance sheet.", "schema": { "type": "integer", "minimum": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "entity": { "type": "string" }, "statement": { "type": "string" }, "lineKey": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "durationMonths": { "type": "integer" }, "value": { "type": "integer" }, "derived": { "type": "boolean" }, "figures": { "type": "array", "items": { "type": "object", "properties": { "docId": { "type": "integer" }, "docKind": { "type": "string" }, "docPeriodEnd": { "type": "string", "format": "date" }, "sourceUrl": { "type": "string" }, "format": { "type": "string" }, "rawLabel": { "type": "string" }, "value": { "type": "integer" }, "periodEnd": { "type": "string", "format": "date" }, "durationMonths": { "type": "integer" }, "printedText": { "type": "string" }, "page": { "type": "integer" }, "bbox": { "type": "array", "items": { "type": "number" } }, "locator": { "type": "null" }, "isOcr": { "type": "boolean" }, "noteRef": { "type": "null" }, "served": { "type": "boolean" }, "withheld": { "type": "boolean" }, "erratum": { "type": "null" } } } }, "composition": { "type": "array", "items": {} } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "entity": "combined", "statement": "balance_sheet", "lineKey": "total_assets", "periodEnd": "2025-12-31", "durationMonths": 0, "value": 6883891, "derived": false, "figures": [ { "docId": 290, "docKind": "annual_audited", "docPeriodEnd": "2025-12-31", "sourceUrl": "https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf", "format": "pdf", "rawLabel": "Total assets", "value": 6883891, "periodEnd": "2025-12-31", "durationMonths": 0, "printedText": "6,883,891", "page": 6, "bbox": [ 0.760890007019043, 0.4563800096511841 ], "locator": null, "isOcr": false, "noteRef": null, "served": true, "withheld": false, "erratum": null }, { "docId": 292, "docKind": "quarterly_unaudited", "docPeriodEnd": "2026-06-30", "sourceUrl": "https://www.federalreserve.gov/aboutthefed/files/quarterly-report-20260828.pdf", "format": "pdf", "rawLabel": "Total assets", "value": 6883891, "periodEnd": "2025-12-31", "durationMonths": 0, "printedText": "6,883,891", "page": 5, "bbox": [ 0.8233399987220764, 0.5383999943733215 ], "locator": null, "isOcr": false, "noteRef": null, "served": false, "withheld": false, "erratum": null } ], "composition": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/research/widgets/{kind}": { "get": { "summary": "Company research widget", "description": "Normalized source-bearing research widget for a ticker. The MCP tool restricts kinds and licensed fields; REST availability does not imply unrestricted redistribution.", "operationId": "get-company-research-widget", "tags": [ "Analytics" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "kind", "in": "path", "required": true, "description": "One of historical_valuation, guidance_tracker, narrative_radar, ownership_crowding, earnings_quality, segment_momentum, event_study, filing_diff, statement_xray, macro_release_monitor, causal_exposure, compute_economics, corporate_actions_timeline, capital_allocation, manager_portfolio, release_filing_reconciliation, insider_activity_tape, data_confidence. Unknown kind: 404.", "schema": { "type": "string" } }, { "name": "symbol", "in": "query", "description": "Ticker; default NVDA.", "schema": { "type": "string", "default": "NVDA" } }, { "name": "offset", "in": "query", "description": "statement_xray: nodes to skip; the readout lists 160 a page. Other kinds ignore it.", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string" }, "title": { "type": "string" }, "subtitle": { "type": "string" }, "source": { "type": "string" }, "stats": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } } } }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "sublabel": { "type": "string" }, "value": { "type": "string" }, "secondary": { "type": "string" }, "date": { "type": "string", "format": "date" }, "detail": { "type": "string" } } } }, "symbol": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "emptyMessage": { "type": "string" }, "page": { "type": "object", "properties": { "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } } }, "cik": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "kind": "statement_xray", "title": "Statement X-Ray", "subtitle": "Latest XBRL presentation and calculation structure", "source": "SEC XBRL taxonomy", "stats": [ { "label": "Nodes", "value": "160" }, { "label": "Calculated", "value": "27" } ], "rows": [ { "id": "40209619", "label": "CoverAbstract", "sublabel": "Cover page.", "value": "0 links", "secondary": "depth 0", "date": "2026-08-26", "detail": "Statement root" }, { "id": "40209620", "label": " DocumentType", "sublabel": "Document Type", "value": "0 links", "secondary": "depth 1", "date": "2026-08-26", "detail": "Parent: dei:CoverAbstract" } ], "symbol": "NVDA", "asOf": "2026-08-26", "emptyMessage": "No XBRL presentation tree is available.", "page": { "total": 823, "offset": 0, "limit": 160, "nextOffset": 160 }, "cik": "0001045810" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/government-awards": { "get": { "summary": "Federal awards", "description": "Federal awards (USAspending) to the company's mapped recipient UEIs. A company reaches federal money only through an evidence-backed UEI mapping, never a name match; awards is null when none is mapped.", "operationId": "get-federal-awards", "tags": [ "Companies" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "awards": { "type": "null" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "awards": null } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/regulation": { "get": { "summary": "Regulation", "description": "Government documents that bear on the company, each with the evidence that ties it there. executiveActions[] carries every link basis per document, strongest first: named (the document's text names the company), company_cited (the company's own periodic report cites or describes the order; evidence is the company's sentence and its accession), sector (the order acts directly on the company's industry; evidence is the order's own text). A link is never a look-alike name. coverage reports how much of the record has been read — a short list is not 'no exposure' until it is whole. Pilot coverage.", "operationId": "get-regulation", "tags": [ "Companies" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "regulation": { "type": "object", "properties": { "cik": { "type": "string" }, "industry": { "type": "string" }, "legislation": { "type": "array", "items": { "type": "object", "properties": { "billKey": { "type": "string" }, "congress": { "type": "integer" }, "citation": { "type": "string" }, "title": { "type": "string" }, "lawNumber": { "type": "string" }, "policyArea": { "type": "string" }, "latestActionDate": { "type": "string", "format": "date" }, "url": { "type": "string" }, "summary": { "type": "string" }, "scope": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "basis": { "type": "string" }, "method": { "type": "string" }, "evidence": { "type": "string" }, "evidenceRef": { "type": "string" }, "accession": { "type": [ "string", "null" ] }, "evidenceDate": { "type": "string", "format": "date" }, "firstEvidenceDate": { "type": [ "string", "null" ], "format": "date" }, "mentionCount": { "type": "integer" }, "effect": { "type": [ "string", "null" ] } } } } } } }, "legislationCounts": { "type": "object", "properties": { "company_cited": { "type": "integer" }, "sector": { "type": "integer" } } }, "legalCases": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "key": { "type": "string" }, "caseName": { "type": "string" }, "court": { "type": "string" }, "date": { "type": "string", "format": "date" }, "role": { "type": "string" }, "status": { "type": "string" }, "detail": { "type": "string" }, "url": { "type": "string" } } } }, "legalDisclosures": { "type": "array", "items": { "type": "object", "properties": { "accession": { "type": "string" }, "form": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "sectionId": { "type": "integer" }, "preview": { "type": "string" }, "wordCount": { "type": "integer" } } } }, "executiveActions": { "type": "array", "items": { "type": "object", "properties": { "documentNumber": { "type": "string" }, "kind": { "type": "string" }, "executiveOrderNumber": { "type": "integer" }, "title": { "type": "string" }, "signingDate": { "type": "string", "format": "date" }, "publicationDate": { "type": "string", "format": "date" }, "president": { "type": "string" }, "url": { "type": "string" }, "summary": { "type": "string" }, "scope": { "type": "string" }, "links": { "type": "array", "items": { "type": "object", "properties": { "basis": { "type": "string" }, "method": { "type": "string" }, "evidence": { "type": "string" }, "evidenceRef": { "type": "string" }, "accession": { "type": "null" }, "evidenceDate": { "type": "string", "format": "date" }, "firstEvidenceDate": { "type": "null" }, "mentionCount": { "type": "integer" }, "effect": { "type": "string" } } } } } } }, "executiveActionCounts": { "type": "object", "properties": { "sector": { "type": "integer" } } }, "coverage": { "type": "object", "properties": { "ordersHeld": { "type": "integer" }, "ordersWithText": { "type": "integer" }, "ordersTagged": { "type": "integer" }, "filingsRead": { "type": "boolean" }, "lawsHeld": { "type": "integer" }, "lawsTagged": { "type": "integer" }, "lawsSinceCongress": { "type": "integer" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "regulation": { "cik": "0001045810", "industry": "Semiconductors", "legislation": [ { "billKey": "117-hr-5376", "congress": 117, "citation": "H.R. 5376", "title": "Inflation Reduction Act of 2022", "lawNumber": "117-169", "policyArea": "Economics and Public Finance", "latestActionDate": "2022-08-16", "url": "https://www.congress.gov/bill/117th-congress/house-bill/5376", "summary": "The Inflation Reduction Act of 2022 enacts a 15% corporate alternative minimum tax, a 1% stock buyback excise tax, Medicare drug price negotiation, expanded ACA subsidies, and sweeping tax credits and…", "scope": "broad", "links": [ { "basis": "company_cited", "method": "act_name", "evidence": "Inflation Reduction Act of 2022 requires a 1% excise tax on certain share repurchases in excess of shares issued for employee compensation made after December 31, 2022.", "evidenceRef": "0001045810-26-000075#item_2", "accession": "0001045810-26-000075", "evidenceDate": "2026-08-26", "firstEvidenceDate": "2023-02-24", "mentionCount": 14, "effect": null } ] }, { "billKey": "119-s-3971", "congress": 119, "citation": "S. 3971", "title": "Small Business Innovation and Economic Security Act", "lawNumber": "119-83", "policyArea": "Commerce", "latestActionDate": "2026-04-13", "url": "https://www.congress.gov/bill/119th-congress/senate-bill/3971", "summary": "Reauthorizes and modifies the SBIR and STTR programs through FY2031, adding security-risk evaluation requirements, proposal caps, expanded training, and strategic breakthrough allocations for critical…", "scope": "targeted", "links": [ { "basis": "sector", "method": "industry_tag", "evidence": "each agency must set a maximum number of proposals per fiscal year that a small business concern may submit in response to Phase I and Phase II solicitations", "evidenceRef": "119-s-3971", "accession": null, "evidenceDate": "2026-04-13", "firstEvidenceDate": null, "mentionCount": 1, "effect": "Small semiconductor and advanced technology firms pursuing SBIR/STTR funding in critical technology areas may benefit from new strategic breakthrough allocations while facing enhanced security review." } ] } ], "legislationCounts": { "company_cited": 3, "sector": 13 }, "legalCases": [ { "kind": "scotus_case", "key": "23-970", "caseName": "NVIDIA Corporation, et al. v. E. Ohman J:or Fonder AB, et al.", "court": "Supreme Court of the United States", "date": "2024-12-11", "role": "petitioner", "status": "decided", "detail": "United States Court of Appeals for the Ninth Circuit", "url": "https://www.supremecourt.gov/docket/docketfiles/html/public/23-970.html" }, { "kind": "scotus_case", "key": "23A578", "caseName": "NVIDIA Corporation, et al. v. E. Ohman J:or Fonder AB, et al.", "court": "Supreme Court of the United States", "date": "2023-12-22", "role": "petitioner", "status": "application_resolved", "detail": "United States Court of Appeals for the Ninth Circuit", "url": "https://www.supremecourt.gov/docket/docketfiles/html/public/23A578.html" } ], "legalDisclosures": [ { "accession": "0001045810-26-000021", "form": "10-K", "filingDate": "2026-02-25", "sectionId": 8823, "preview": "Item 3. Legal Proceedings\nPlease see Note 12 of the Notes to the Consolidated Financial Statements in Part IV, Item 15 of this Annual Report on Form 10-K for a discussion of our legal proceedings.", "wordCount": 35 }, { "accession": "0001045810-25-000023", "form": "10-K", "filingDate": "2025-02-26", "sectionId": 8798, "preview": "Item 3. Legal Proceedings\nPlease see Note 12 of the Notes to the Consolidated Financial Statements in Part IV, Item 15 of this Annual Report on Form 10-K for a discussion of our legal proceedings.", "wordCount": 35 } ], "executiveActions": [ { "documentNumber": "2026-15003", "kind": "executive_order", "executiveOrderNumber": 14415, "title": "Securing America's Defense Supply Chains and Ensuring Domestic Acquisition of Critical Materials", "signingDate": "2026-07-20", "publicationDate": "2026-07-23", "president": "Donald Trump", "url": "https://www.federalregister.gov/documents/2026/07/23/2026-15003/securing-americas-defense-supply-chains-and-ensuring-domestic-acquisition-of-critical-materials", "summary": "This executive order tightens domestic and allied sourcing requirements for defense supply chains by restricting waivers for non-compliant materials, mandating full supply chain mapping by contractors…", "scope": "targeted", "links": [ { "basis": "sector", "method": "industry_tag", "evidence": "The Secretary shall review the Department of War's present application of the exemption for electronic devices under 10 U.S.C. 4872(c)(3)(B) and ensure the continued application of that exemption meet…", "evidenceRef": "2026-15003", "accession": null, "evidenceDate": "2026-07-20", "firstEvidenceDate": null, "mentionCount": 1, "effect": "Semiconductor components used in defense systems are covered materials subject to domestic/allied sourcing requirements, and the order directs a review of the electronic devices exemption to ensure it…" } ] }, { "documentNumber": "2026-12910", "kind": "executive_order", "executiveOrderNumber": 14413, "title": "Ushering in the Next Frontier of Quantum Innovation", "signingDate": "2026-06-22", "publicationDate": "2026-06-25", "president": "Donald Trump", "url": "https://www.federalregister.gov/documents/2026/06/25/2026-12910/ushering-in-the-next-frontier-of-quantum-innovation", "summary": "This executive order directs a whole-of-government effort to accelerate U.S. quantum information science and technology (QIST) through a national quantum computing program, supply chain strengthening,…", "scope": "targeted", "links": [ { "basis": "sector", "method": "industry_tag", "evidence": "the Secretary of War, the Secretary of Commerce, the Secretary of Energy, and the Director of NSF shall develop a plan, with coordination from the APST and the Director of OMB, to encourage and partne…", "evidenceRef": "2026-12910", "accession": null, "evidenceDate": "2026-06-22", "firstEvidenceDate": null, "mentionCount": 1, "effect": "The order directs federal agencies to partner with private-sector quantum computing companies, use advance market commitments, develop domestic quantum-enabling component technologies, and increase ac…" } ] } ], "executiveActionCounts": { "sector": 20 }, "coverage": { "ordersHeld": 1538, "ordersWithText": 1538, "ordersTagged": 673, "filingsRead": true, "lawsHeld": 2156, "lawsTagged": 1766, "lawsSinceCongress": 113 } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/laws": { "get": { "summary": "Laws & regulations", "description": "The laws and regulations that affect the company outside the US (e.g. Dubai for Salik), read at article level (gov_legal_company_link_served) and grouped per instrument: { cik, articleCount, instruments: [{ docId, jurisdiction, docType, docTypeLabel, number, year, titleEn, titleAr, titleEnDisplay (official English title, else a machine translation), titleEnIsMachine, titleEnMachine, issueDate, effectiveDate, status, isHistorical, basis (named | activity | amends_tagged | sector), basisRank (1–4), effects[] (establishes, concession, sets_tariff, sets_fines, exemptions, enforcement_powers, operations, licensing, governance, other — most important first), governanceOnly, via ({ docId, relation, docType, number, year, titleEn, titleAr, titleEnMachine } — the law an amending instrument is tied through), sourcePageUrl, pdfUrlEn, pdfUrlAr, articles: [{ linkId, articleRef, articleLabel, effect, quoteLang, quote, quoteTranslationEn, translationIsMachine, explanation, judgeVerdict, basis }] }] }. Ordered in force first, newest issue date first (an undated instrument by its year), then by basis; repealed instruments last in the same order. The US counterpart is GET /companies/{id}/regulation.", "operationId": "get-laws-regulations", "tags": [ "Companies" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Instruments per page, 1–50, default 20; adds total, offset, limit, hasMore and nextOffset. Without limit, offset or q every instrument is served (about 180 KB for Salik).", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } }, { "name": "offset", "in": "query", "description": "Instruments to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "q", "in": "query", "description": "Words that must all appear in an instrument's own fields (title, number, issuer, …); pages the matches.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "instruments": { "type": "array", "items": { "type": "object", "properties": { "docId": { "type": "string" }, "jurisdiction": { "type": "string" }, "docType": { "type": "string" }, "docTypeLabel": { "type": "string" }, "number": { "type": "string" }, "year": { "type": "integer" }, "titleEn": { "type": [ "string", "null" ] }, "titleAr": { "type": "string" }, "titleEnDisplay": { "type": "string" }, "titleEnIsMachine": { "type": "boolean" }, "titleEnMachine": { "type": [ "string", "null" ] }, "issueDate": { "type": "string", "format": "date" }, "effectiveDate": { "type": "string", "format": "date" }, "status": { "type": "string" }, "isHistorical": { "type": "boolean" }, "basis": { "type": "string" }, "basisRank": { "type": "integer" }, "effects": { "type": "array", "items": { "type": "string" } }, "governanceOnly": { "type": "boolean" }, "via": { "type": "null" }, "sourcePageUrl": { "type": "string" }, "pdfUrlEn": { "type": [ "string", "null" ] }, "pdfUrlAr": { "type": "string" }, "storedLangs": { "type": "array", "items": { "type": "string" } }, "issuer": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "logo": { "type": "object", "properties": { "url": { "type": "string" }, "kind": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "sourcePage": { "type": "string" }, "sourceUrl": { "type": "string" }, "license": { "type": "string" }, "onDark": { "type": "boolean" } } } } }, "articles": { "type": "array", "items": { "type": "object", "properties": { "linkId": { "type": "string" }, "articleRef": { "type": "string" }, "articleLabel": { "type": "string" }, "effect": { "type": "string" }, "quoteLang": { "type": "string" }, "quote": { "type": "string" }, "quoteTranslationEn": { "type": "string" }, "translationIsMachine": { "type": "boolean" }, "explanation": { "type": "string" }, "judgeVerdict": { "type": "string" }, "basis": { "type": "string" } } } } } } }, "articleCount": { "type": "integer" }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "XDFM000029", "instruments": [ { "docId": "1063", "jurisdiction": "AE-DU", "docType": "executive_council_resolution", "docTypeLabel": "Executive Council Resolution", "number": "1", "year": 2025, "titleEn": "Executive Council Resolution No. (1) of 2025 Amending Executive Council Resolution No. (19) of 2010 Approving the Fees and Fines Prescribed by the Traffic Toll Law in the Emirate of Dubai", "titleAr": "قرار المجلس التنفيذي رقم (1) لسنة 2025 بتعديل بعض أحكام قرار المجلس التنفيذي رقم (19) لسنة 2010 باعتماد الرسوم والغرامات المترتبة على قانون التعرفة المرورية في إمارة دبي", "titleEnDisplay": "Executive Council Resolution No. (1) of 2025 Amending Executive Council Resolution No. (19) of 2010 Approving the Fees and Fines Prescribed by the Traffic Toll Law in the Emirate of Dubai", "titleEnIsMachine": false, "titleEnMachine": null, "issueDate": "2025-01-30", "effectiveDate": "2025-01-31", "status": "in_force", "isHistorical": false, "basis": "activity", "basisRank": 2, "effects": [ "sets_tariff", "operations" ], "governanceOnly": false, "via": null, "sourcePageUrl": "https://dlp.dubai.gov.ae/en/Pages/HTMLViewer.aspx?file=RXhlY3V0aXZlIENvdW5jaWwgUmVzb2x1dGlvbiBOby4gKDEpIG9mIDIwMjUgVHJhZmZpYyBUb2xsIExhdyBpbiB0aGUgRW1pcmF0ZSBvZiBEdWJhaQ==&year=2025", "pdfUrlEn": "https://dlp.dubai.gov.ae/Legislation%20Reference/2025/Executive%20Council%20Resolution%20No.%20(1)%20of%202025%20Traffic%20Toll%20Law%20in%20the%20Emirate%20of%20Dubai.pdf", "pdfUrlAr": "https://dlp.dubai.gov.ae/Legislation%20Ar%20Reference/2025/%D9%82%D8%B1%D8%A7%D8%B1%20%D8%A7%D9%84%D9%85%D8%AC%D9%84%D8%B3%20%D8%A7%D9%84%D8%AA%D9%86%D9%81%D9%8A%D8%B0%D9%8A%20%D8%B1%D9%82%D9%85%20(1)…", "storedLangs": [ "en", "ar" ], "issuer": { "code": "AE.DU.EXEC_COUNCIL", "name": "The Executive Council of Dubai", "shortName": "TEC", "logo": { "url": "/api/v1/countries/AE/government/entities/AE.DU.EXEC_COUNCIL/logo", "kind": "svg", "width": 169, "height": 65, "sourcePage": "https://tec.gov.ae/", "sourceUrl": "https://tec.gov.ae/documents/1561773/0/logo-tec.svg/b99a3d8f-f181-97ff-0dd6-724ab3f087dd", "license": "© 2026 جميع الحقوق محفوظة للأمانة العامة للمجلس التنفيذي لإمارة دبي مخفي — official logo as published on https://tec.gov.ae/", "onDark": false } }, "articles": [ { "linkId": "360", "articleRef": "1", "articleLabel": "Article (1)", "effect": "sets_tariff", "quoteLang": "ar", "quote": "يُستبدل بالجدول رقم (1) الخاص بتحديد رسم التعرفة المُروريّة على المركبات وبطاقات التعرفة المُروريّة المُلحق بقرار المجلس التنفيذي رقم (19) لسنة 2010 المُشار إليه، الجدول المُلحق بهذا القرار.", "quoteTranslationEn": "Schedule (1) prescribing the Traffic Toll charges and Tag fees attached to the above-mentioned Executive Council Resolution No. (19) of 2010 is hereby superseded by the Schedule attached to this Resol…", "translationIsMachine": false, "explanation": "This article replaces the toll and tag fee schedule, directly affecting Salik’s revenue from toll usage and tag activation fees.", "judgeVerdict": "confirmed", "basis": "activity" }, { "linkId": "361", "articleRef": "2", "articleLabel": "Article (2)", "effect": "sets_tariff", "quoteLang": "ar", "quote": "تقوم الهيئة بإيقاف تشغيل بوّابات التعرفة المُروريّة وعدم استيفاء رسم التعرفة المُروريّة من مالك المركبة التي تجتاز أياً من بوّابات التعرفة المُروريّة من الساعة الواحدة صباحاً وحتى الساعة السادسة صباحا…", "quoteTranslationEn": "The RTA will suspend the operation of Traffic Toll Gates and will not collect the Traffic Toll charges from a Vehicle Owner passing through any Traffic Toll Gate between 1:00 AM and 6:00 AM.", "translationIsMachine": false, "explanation": "This article sets a nightly toll-free window, directly reducing Salik’s potential toll revenue during those hours.", "judgeVerdict": "confirmed", "basis": "activity" } ] }, { "docId": "1666", "jurisdiction": "AE-DU", "docType": "law", "docTypeLabel": "Law", "number": "25", "year": 2023, "titleEn": null, "titleAr": "قانون رقم (25) لسنة 2023 بإنشاء صندوق دبي للاستثمارات", "titleEnDisplay": "Law No. (25) of 2023 Establishing the Dubai Investments Fund", "titleEnIsMachine": true, "titleEnMachine": "Law No. (25) of 2023 Establishing the Dubai Investments Fund", "issueDate": "2023-11-21", "effectiveDate": "2023-11-21", "status": "in_force", "isHistorical": false, "basis": "named", "basisRank": 1, "effects": [ "governance" ], "governanceOnly": true, "via": null, "sourcePageUrl": "https://dlp.dubai.gov.ae/ar/Pages/HTMLViewer.aspx?file=2YLYp9mG2YjZhiDYsdmC2YUgKDI1KSDZhNiz2YbYqSAyMDIzINio2KXZhti02KfYoSDYtdmG2K/ZiNmCINiv2KjZiiDZhNmE2KfYs9iq2KvZhdin2LHYp9iq&year=2023", "pdfUrlEn": null, "pdfUrlAr": "https://dlp.dubai.gov.ae/Legislation%20Ar%20Reference/2023/%D9%82%D8%A7%D9%86%D9%88%D9%86%20%D8%B1%D9%82%D9%85%20(25)%20%D9%84%D8%B3%D9%86%D8%A9%202023%20%D8%A8%D8%A5%D9%86%D8%B4%D8%A7%D8%A1%20%D8%B5%…", "storedLangs": [ "ar" ], "issuer": { "code": "AE.DU.GOV", "name": "Government of Dubai", "shortName": "Dubai Government", "logo": { "url": "/api/v1/countries/AE/government/entities/AE.DU.GOV/logo", "kind": "svg", "width": 681, "height": 274, "sourcePage": "https://tec.gov.ae/en/web/tec/dubai-government-entities", "sourceUrl": "https://tec.gov.ae/documents/d/tec/logo-god", "license": "Copyright © 2026 The Executive Council of Dubai - All rights reserved — official logo as published on https://tec.gov.ae/en/web/tec/dubai-government-entities (terms: https://legal.dubai.gov.ae/en/Page…", "onDark": false } }, "articles": [ { "linkId": "378", "articleRef": "18", "articleLabel": "Article (18)", "effect": "governance", "quoteLang": "ar", "quote": "شركة سالك (ش.م.ع)", "quoteTranslationEn": "Salik Company PJSC", "translationIsMachine": true, "explanation": "The article explicitly names Salik Company PJSC as one of the government-owned entities whose shares are now held by the Dubai Investment Fund, affecting its ownership structure.", "judgeVerdict": "confirmed", "basis": "named" } ] } ], "articleCount": 152, "total": 20, "offset": 0, "limit": 2, "hasMore": true, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/debt": { "get": { "summary": "Company debt disclosures", "description": "Source-backed debt disclosures: instruments, borrowing groups, financing programmes and filed ladders. Partial pilot coverage. Preserve amount basis, currency, reporting date and source_id; null is not zero. Equity-classified capital instruments are labelled separately and excluded from debt totals.", "operationId": "get-company-debt-disclosures", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "as_of", "in": "query", "description": "Public information through this UTC date, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Instrument or issuer contains; max 100 characters.", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Native ISO currency in upper case, e.g. USD.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Instrument kind: note includes subordinated, Tier 2 and AT1 notes; sukuk includes AT1 sukuk; loan is term loans and loans; capital is equity-classified capital instruments.", "schema": { "type": "string", "enum": [ "bond", "note", "sukuk", "loan", "capital", "group" ] } }, { "name": "include_prior", "in": "query", "description": "Include prior-only disclosures; these do not establish current outstanding status.", "schema": { "type": "boolean", "default": true } }, { "name": "include_matured", "in": "query", "description": "Include matured instruments and those the issuer shows as repaid or redeemed or the exchange delisted; default excludes them without deleting their evidence.", "schema": { "type": "boolean", "default": false } }, { "name": "sort", "in": "query", "description": "Amounts sort by their USD value at the cutoff (daily reference rates); an amount whose currency has no rate sorts last.", "schema": { "type": "string", "enum": [ "maturity", "coupon", "amount", "issuer" ], "default": "maturity" } }, { "name": "direction", "in": "query", "description": "Sort direction.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "limit", "in": "query", "description": "Instruments per page, 1–100 (above 100 is a 400). Each instrument brings its cited sources, ~6 KB.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "description": "`page_info.nextCursor` from the previous page (`next_cursor` is its deprecated alias); `page_info.hasMore` is false on the last page. Revision-bound: restart from the first page if the data or filters change.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "debt": { "type": "object", "properties": { "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" } } }, "coverage": { "type": "string" }, "coverage_note": { "type": "string" }, "scope": { "type": [ "string", "null" ] }, "observation_date": { "type": [ "string", "null" ], "format": "date" }, "instruments": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "events": { "type": "array", "items": {} }, "fields": { "type": "object", "properties": { "isin": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "cusip": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "coupon": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "maturity": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "rate_type": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "issue_date": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "string" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "effective_rate": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "gross_carrying_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "original_issue_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } } } }, "issuer": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" }, "source_id": { "type": "string" }, "review_state": { "type": "string" } } }, "status": { "type": "string" }, "object_id": { "type": "string" }, "description": { "type": "string" }, "disclosures": { "type": "array", "items": { "type": "object", "properties": { "document_ref": { "type": "string" }, "snapshot_kind": { "type": "string" }, "observation_date": { "type": "string", "format": "date" } } } }, "field_roles": { "type": "object", "properties": { "isin": { "type": "string" }, "cusip": { "type": "string" }, "coupon": { "type": "string" }, "maturity": { "type": "string" }, "rate_type": { "type": "string" }, "issue_date": { "type": "string" }, "effective_rate": { "type": "string" }, "gross_carrying_amount": { "type": "string" }, "original_issue_amount": { "type": "string" } } }, "issuer_role": { "type": "null" }, "object_kind": { "type": "string" }, "disclosed_at": { "type": "string", "format": "date-time" }, "document_ref": { "type": "string" }, "classification": { "type": "string" }, "identity_state": { "type": "string" }, "term_conflicts": { "type": "array", "items": {} }, "terms_documents": { "type": "array", "items": { "type": "string" } }, "observation_date": { "type": "string", "format": "date" }, "observation_kind": { "type": "string" }, "prior_disclosure": { "type": "boolean" }, "denomination_currency": { "type": "string" }, "description_source_id": { "type": "string" }, "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" } } }, "stale": { "type": "boolean" }, "amount_key": { "type": "string" } } } }, "facilities": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "events": { "type": "array", "items": {} }, "fields": { "type": "object", "properties": { "drawn_principal": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "programme_capacity": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } } } }, "issuer": { "type": "null" }, "status": { "type": "string" }, "object_id": { "type": "string" }, "description": { "type": "string" }, "disclosures": { "type": "array", "items": { "type": "object", "properties": { "document_ref": { "type": "string" }, "snapshot_kind": { "type": "string" }, "observation_date": { "type": "string", "format": "date" } } } }, "field_roles": { "type": "object", "properties": { "drawn_principal": { "type": "string" }, "programme_capacity": { "type": "string" } } }, "issuer_role": { "type": "null" }, "object_kind": { "type": "string" }, "disclosed_at": { "type": "string", "format": "date-time" }, "document_ref": { "type": "string" }, "classification": { "type": "string" }, "identity_state": { "type": "string" }, "term_conflicts": { "type": "array", "items": {} }, "terms_documents": { "type": "array", "items": {} }, "observation_date": { "type": "string", "format": "date" }, "observation_kind": { "type": "string" }, "prior_disclosure": { "type": "boolean" }, "description_source_id": { "type": "string" }, "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" } } }, "stale": { "type": "boolean" }, "denomination_currency": { "type": "null" }, "amount_key": { "type": "string" } } } }, "totals": { "type": "object", "properties": { "Net carrying amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "Less short-term portion": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "Total long-term portion": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "Unamortized debt discount and issuance costs": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } } } }, "filed_ladder": { "type": "array", "items": { "type": "object", "properties": { "basis": { "type": "string" }, "label": { "type": "string" }, "scope": { "type": "string" }, "amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "anchor_date": { "type": "string", "format": "date" } } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "source_id": { "type": "string" }, "document_ref": { "type": "string" }, "source_url": { "type": "string" }, "source_published_at": { "type": "string", "format": "date-time" }, "locator": { "type": "object", "properties": { "row_index": { "type": "integer" }, "text_hash": { "type": "string" }, "attachment": { "type": "string" }, "table_index": { "type": "integer" }, "entity": { "type": "string" }, "concept": { "type": "string" }, "fact_id": { "type": "string" }, "decimals": { "type": "null" }, "context_id": { "type": "string" }, "dimensions": { "type": "object", "properties": { "{http://fasb.org/us-gaap/2026}DebtInstrumentAxis": { "type": "string" }, "{http://fasb.org/us-gaap/2026}LongtermDebtTypeAxis": { "type": "string" } } }, "input_unit": { "type": "string" }, "period_end": { "type": "string", "format": "date" }, "period_kind": { "type": "string" }, "period_start": { "type": "null" } } }, "raw_excerpt": { "type": "string" }, "context_excerpt": { "type": "string" } } } }, "issuers": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "individual_instruments": { "type": "integer" }, "coverage": { "type": "string" } } } }, "currencies": { "type": "array", "items": { "type": "string" } }, "as_of": { "type": "null" }, "page_info": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": [ "string", "null" ] }, "next_cursor": { "type": [ "string", "null" ] } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "debt": { "company": { "cik": "0001045810", "name": "NVIDIA CORP", "ticker": "NVDA" }, "coverage": "partial", "coverage_note": "Disclosed senior notes and commercial paper programme. Balances are reported before unallocated discounts and issuance costs; exact contractual terms come from the note forms filed with the SEC.", "scope": "Senior notes disclosed in the debt note", "observation_date": "2026-07-26", "instruments": [ { "kind": "note", "events": [], "fields": { "isin": { "unit": null, "basis": null, "value": "US67066GAM69", "precision": null, "source_id": "f557223e-6a78-5f53-8678-09153d70f171", "null_reason": null }, "cusip": { "unit": null, "basis": null, "value": "67066GAM6", "precision": null, "source_id": "f557223e-6a78-5f53-8678-09153d70f171", "null_reason": null }, "coupon": { "unit": "percent", "basis": "stated_coupon", "value": "1.550", "precision": null, "source_id": "4a394170-cffb-56e2-accf-dfc8b146fe21", "null_reason": null }, "maturity": { "unit": null, "basis": null, "value": "2028-06-15", "precision": "day", "source_id": "1d8a90d4-b0d1-54ca-88f5-f9d83495b055", "null_reason": null }, "rate_type": { "unit": null, "basis": null, "value": "fixed", "precision": null, "source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "null_reason": null }, "issue_date": { "unit": null, "basis": "interest_accrual_start", "value": "2021-06-16", "precision": "day", "source_id": "4a394170-cffb-56e2-accf-dfc8b146fe21", "null_reason": null }, "effective_rate": { "unit": "percent", "basis": "reported_effective_rate", "value": "1.64", "precision": null, "source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "null_reason": null }, "gross_carrying_amount": { "unit": "USD", "basis": "before_unallocated_discount_and_issuance_costs", "value": "1250000000", "precision": null, "source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "null_reason": null }, "original_issue_amount": { "unit": "USD", "basis": "initial_series_principal_in_officers_certificate", "value": "1250000000", "precision": null, "source_id": "9a8e143e-d4bc-57d2-ae62-718e9ca289e5", "null_reason": null } }, "issuer": { "name": "NVIDIA Corporation", "role": "issuer", "source_id": "8afa6871-8402-5fd1-88a8-da4742f07c91", "review_state": "reviewed" }, "status": "reported", "object_id": "06a08cef-c351-50a4-9461-f98598b62600", "description": "1.55% Notes Due 2028", "disclosures": [ { "document_ref": "0001045810-26-000075", "snapshot_kind": "financial_statement", "observation_date": "2026-07-26" }, { "document_ref": "0001045810-26-000052", "snapshot_kind": "financial_statement", "observation_date": "2026-04-26" } ], "field_roles": { "isin": "term", "cusip": "term", "coupon": "term", "maturity": "term", "rate_type": "term", "issue_date": "term", "effective_rate": "observation", "gross_carrying_amount": "observation", "original_issue_amount": "term" }, "issuer_role": null, "object_kind": "individual", "disclosed_at": "2026-08-26T20:36:00.000Z", "document_ref": "0001045810-26-000075", "classification": "liability", "identity_state": "reviewed", "term_conflicts": [], "terms_documents": [ "0001045810-26-000075", "SEC-TERM-000119312521192149-d80739dex42" ], "observation_date": "2026-07-26", "observation_kind": "financial_statement", "prior_disclosure": false, "denomination_currency": "USD", "description_source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "company": { "cik": "0001045810", "name": "NVIDIA CORP", "ticker": "NVDA" }, "stale": false, "amount_key": "gross_carrying_amount" }, { "kind": "note", "events": [], "fields": { "isin": { "unit": null, "basis": null, "value": "US67066GAP90", "precision": null, "source_id": "129532c3-df10-5f46-bfd5-c4890bb18499", "null_reason": null }, "cusip": { "unit": null, "basis": null, "value": "67066GAP9", "precision": null, "source_id": "129532c3-df10-5f46-bfd5-c4890bb18499", "null_reason": null }, "coupon": { "unit": "percent", "basis": "stated_coupon", "value": "4.250", "precision": null, "source_id": "9bfcf3f8-bcf8-57ef-9b8e-44f9f30318fd", "null_reason": null }, "maturity": { "unit": null, "basis": null, "value": "2028-06-15", "precision": "day", "source_id": "5cc16c69-7b68-5cce-bc0d-fb2bc32d33c1", "null_reason": null }, "rate_type": { "unit": null, "basis": null, "value": "fixed", "precision": null, "source_id": "0d00ada2-a6f3-5245-bdcb-80b68f253751", "null_reason": null }, "issue_date": { "unit": null, "basis": "interest_accrual_start", "value": "2026-06-18", "precision": "day", "source_id": "9bfcf3f8-bcf8-57ef-9b8e-44f9f30318fd", "null_reason": null }, "effective_rate": { "unit": "percent", "basis": "reported_effective_rate", "value": "4.39", "precision": null, "source_id": "0d00ada2-a6f3-5245-bdcb-80b68f253751", "null_reason": null }, "gross_carrying_amount": { "unit": "USD", "basis": "before_unallocated_discount_and_issuance_costs", "value": "3500000000", "precision": null, "source_id": "0d00ada2-a6f3-5245-bdcb-80b68f253751", "null_reason": null }, "original_issue_amount": { "unit": "USD", "basis": "initial_series_principal_in_officers_certificate", "value": "3500000000", "precision": null, "source_id": "7d09d8e2-606a-5e97-a07a-1592960bf302", "null_reason": null } }, "issuer": { "name": "NVIDIA Corporation", "role": "issuer", "source_id": "abd59a94-0142-558f-87a7-9b6523284178", "review_state": "reviewed" }, "status": "reported", "object_id": "f843b56e-6c3c-5e12-ba4f-f1cf66c53b67", "description": "4.25% Notes Due 2028", "disclosures": [ { "document_ref": "0001045810-26-000075", "snapshot_kind": "financial_statement", "observation_date": "2026-07-26" }, { "document_ref": "SEC-TERM-000119312526275783-d48176dex42", "snapshot_kind": "supplement", "observation_date": "2026-06-18" } ], "field_roles": { "isin": "term", "cusip": "term", "coupon": "term", "maturity": "term", "rate_type": "term", "issue_date": "term", "effective_rate": "observation", "gross_carrying_amount": "observation", "original_issue_amount": "term" }, "issuer_role": null, "object_kind": "individual", "disclosed_at": "2026-08-26T20:36:00.000Z", "document_ref": "0001045810-26-000075", "classification": "liability", "identity_state": "reviewed", "term_conflicts": [], "terms_documents": [ "0001045810-26-000075", "SEC-TERM-000119312526275783-d48176dex42" ], "observation_date": "2026-07-26", "observation_kind": "financial_statement", "prior_disclosure": false, "denomination_currency": "USD", "description_source_id": "0d00ada2-a6f3-5245-bdcb-80b68f253751", "company": { "cik": "0001045810", "name": "NVIDIA CORP", "ticker": "NVDA" }, "stale": false, "amount_key": "gross_carrying_amount" } ], "facilities": [ { "kind": "commercial_paper_programme", "events": [], "fields": { "drawn_principal": { "unit": "USD", "basis": null, "value": "0", "precision": null, "source_id": "1a80b29c-dee9-5f2b-bdac-4183c89b77db", "null_reason": null }, "programme_capacity": { "unit": "USD", "basis": null, "value": "25000000000.0", "precision": null, "source_id": "5e17a9b6-9de3-566b-9b3f-f8e6b343445f", "null_reason": null } }, "issuer": null, "status": "reported", "object_id": "7fae2f8e-4943-57c0-b1f2-6fcadcce2492", "description": "Commercial paper programme", "disclosures": [ { "document_ref": "0001045810-26-000075", "snapshot_kind": "financial_statement", "observation_date": "2026-07-26" }, { "document_ref": "0001045810-26-000052", "snapshot_kind": "financial_statement", "observation_date": "2026-04-26" } ], "field_roles": { "drawn_principal": "observation", "programme_capacity": "observation" }, "issuer_role": null, "object_kind": "group", "disclosed_at": "2026-08-26T20:36:00.000Z", "document_ref": "0001045810-26-000075", "classification": "liability", "identity_state": "reviewed", "term_conflicts": [], "terms_documents": [], "observation_date": "2026-07-26", "observation_kind": "financial_statement", "prior_disclosure": false, "description_source_id": "5e17a9b6-9de3-566b-9b3f-f8e6b343445f", "company": { "cik": "0001045810", "name": "NVIDIA CORP", "ticker": "NVDA" }, "stale": false, "denomination_currency": null, "amount_key": "drawn_principal" } ], "totals": { "Net carrying amount": { "unit": "USD", "basis": null, "value": "33366000000", "precision": null, "source_id": "1523161f-48c1-5b66-82b3-72bd5c28d758", "null_reason": null }, "Less short-term portion": { "unit": "USD", "basis": null, "value": "-1000000000", "precision": null, "source_id": "e4d9e176-d540-5699-8929-4acc14af9e0e", "null_reason": null }, "Total long-term portion": { "unit": "USD", "basis": null, "value": "32366000000", "precision": null, "source_id": "134c0a6b-ff74-58d1-a750-9d6b24efd4ab", "null_reason": null }, "Unamortized debt discount and issuance costs": { "unit": "USD", "basis": null, "value": "-134000000", "precision": null, "source_id": "a3411393-9e0c-53c2-9bda-b9c3197e306e", "null_reason": null } }, "filed_ladder": [ { "basis": "reported_debt_before_discount", "label": "Due in one year", "scope": "Senior notes disclosed in the debt note", "amount": { "unit": "USD", "basis": null, "value": "1000000000", "precision": null, "source_id": "65cb1a5e-7ece-56c8-bed6-2f65b8a1862b", "null_reason": null }, "anchor_date": "2026-07-26" }, { "basis": "reported_debt_before_discount", "label": "Due in one to five years", "scope": "Senior notes disclosed in the debt note", "amount": { "unit": "USD", "basis": null, "value": "15000000000", "precision": null, "source_id": "458a3464-cf60-56c4-945c-e506fc8d5d7e", "null_reason": null }, "anchor_date": "2026-07-26" } ], "sources": [ { "source_id": "0d00ada2-a6f3-5245-bdcb-80b68f253751", "document_ref": "0001045810-26-000075", "source_url": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000075/nvda-20260726.htm", "source_published_at": "2026-08-26T20:36:00.000Z", "locator": { "row_index": 6, "text_hash": "4817ad41fd9a9dcebee6804957f942f6713d8211c33b05a5fc9d6f0769518000", "attachment": "nvda-20260726.htm", "table_index": 27 }, "raw_excerpt": "4.25% Notes Due 2028 | | 1.9 | | 4.39% | | 3,500 | | | — | ", "context_excerpt": "ExpectedRemaining Term (years)EffectiveInterest RateJul 26, 2026Jan 25, 2026(In millions)3.20% Notes Due 20260.13.31%$1,000 $1,000 4.25% Notes Due 20281.94.39%3,500 — 1.55% Notes Due 20281.91.64%1,250…" }, { "source_id": "1a80b29c-dee9-5f2b-bdac-4183c89b77db", "document_ref": "0001045810-26-000075", "source_url": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000075/nvda-20260726.htm", "source_published_at": "2026-08-26T20:36:00.000Z", "locator": { "entity": "0001045810", "concept": "{http://fasb.org/us-gaap/2026}CommercialPaper", "fact_id": "f-823", "decimals": null, "text_hash": "5feceb66ffc86f38d952786c6d696c79c2dbc239dd4e91b46729d73a27fb57e9", "attachment": "nvda-20260726_htm.xml", "context_id": "c-224", "dimensions": { "{http://fasb.org/us-gaap/2026}DebtInstrumentAxis": "{http://www.nvidia.com/20260726}CommercialPaperProgramMember", "{http://fasb.org/us-gaap/2026}LongtermDebtTypeAxis": "{http://fasb.org/us-gaap/2026}CommercialPaperMember" }, "input_unit": "USD", "period_end": "2026-07-26", "period_kind": "instant", "period_start": null }, "raw_excerpt": "0", "context_excerpt": "Commercial paper programme; capacity does not establish committed availability." } ], "issuers": [ { "cik": "0001045810", "name": "NVIDIA CORP", "individual_instruments": 14, "coverage": "partial" } ], "currencies": [ "USD" ], "as_of": null, "page_info": { "total": 13, "limit": 2, "hasMore": true, "nextCursor": "eyJyZXZpc2lvbiI6ImRiOTkxNDJiMjg2MzE3NjZlMzg5NjU0ZmFmODQwYjZjIiwiZmlsdGVycyI6IjYzMDhjMjZiZGMzYzA4OTU5MDNlZmZmZTUwN2E1ZTQ1Iiwia2V5IjpbMCwiMjAyOC0wNi0xNSIsImY4NDNiNTZlLTZjM2MtNWUxMi1iYTRmLWYxY2Y2NmM1M2I2…", "next_cursor": "eyJyZXZpc2lvbiI6ImRiOTkxNDJiMjg2MzE3NjZlMzg5NjU0ZmFmODQwYjZjIiwiZmlsdGVycyI6IjYzMDhjMjZiZGMzYzA4OTU5MDNlZmZmZTUwN2E1ZTQ1Iiwia2V5IjpbMCwiMjAyOC0wNi0xNSIsImY4NDNiNTZlLTZjM2MtNWUxMi1iYTRmLWYxY2Y2NmM1M2I2…" } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/debt/{instrumentId}": { "get": { "summary": "Instrument disclosure history and evidence, scoped to its reporting company.", "operationId": "get-instrument-disclosure-history-and-evidence-scoped-to-its-reporting-company", "tags": [ "companies" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "instrumentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "as_of", "in": "query", "description": "Public information through this UTC date, YYYY-MM-DD.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "instrument": { "type": "object", "properties": { "object_id": { "type": "string" }, "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" } } }, "history": { "type": "array", "items": { "type": "object", "properties": { "document_ref": { "type": "string" }, "observation_date": { "type": "string", "format": "date" }, "disclosed_at": { "type": "string", "format": "date-time" }, "snapshot_kind": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "object", "properties": { "coupon": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "maturity": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "rate_type": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "effective_rate": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "gross_carrying_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "isin": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "cusip": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "issue_date": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "string" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "original_issue_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } } } }, "status": { "type": "string" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "status": { "type": "string" }, "locator": { "type": "object", "properties": { "row_index": { "type": "integer" }, "text_hash": { "type": "string" }, "attachment": { "type": "string" }, "table_index": { "type": "integer" }, "section": { "type": "string" }, "text_end": { "type": "integer" }, "text_start": { "type": "integer" } } }, "source_id": { "type": "string" }, "source_url": { "type": "string" }, "raw_excerpt": { "type": "string" }, "source_kind": { "type": "string" }, "document_ref": { "type": "string" }, "document_hash": { "type": "string" }, "capture_method": { "type": "string" }, "context_excerpt": { "type": "string" }, "document_hash_basis": { "type": "string" }, "source_published_at": { "type": "string", "format": "date-time" }, "publication_time_precision": { "type": "string" } } } }, "issuer": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" }, "source_id": { "type": "string" }, "review_state": { "type": "string" } } } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "instrument": { "object_id": "06a08cef-c351-50a4-9461-f98598b62600", "company": { "cik": "0001045810", "name": "NVIDIA CORP" }, "history": [ { "document_ref": "0001045810-26-000075", "observation_date": "2026-07-26", "disclosed_at": "2026-08-26T20:36:00+00:00", "snapshot_kind": "financial_statement", "description": "1.55% Notes Due 2028", "fields": { "coupon": { "unit": "percent", "basis": "stated_coupon", "value": "1.55", "precision": null, "source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "null_reason": null }, "maturity": { "unit": null, "basis": null, "value": "2028", "precision": "year", "source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "null_reason": null }, "rate_type": { "unit": null, "basis": null, "value": "fixed", "precision": null, "source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "null_reason": null }, "effective_rate": { "unit": "percent", "basis": "reported_effective_rate", "value": "1.64", "precision": null, "source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "null_reason": null }, "gross_carrying_amount": { "unit": "USD", "basis": "before_unallocated_discount_and_issuance_costs", "value": "1250000000", "precision": null, "source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "null_reason": null } }, "status": "reported", "sources": [ { "cik": "0001045810", "status": "eligible", "locator": { "row_index": 7, "text_hash": "7f73e6c8a016f6dcf1c9cb38720dff224c1b63e8e5d49547bae4dd634e2db7e5", "attachment": "nvda-20260726.htm", "table_index": 27 }, "source_id": "7f07f5e2-3b5a-536e-8c0f-b8c9053da547", "source_url": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000075/nvda-20260726.htm", "raw_excerpt": "1.55% Notes Due 2028 | | 1.9 | | 1.64% | | 1,250 | | | 1,250 | ", "source_kind": "html", "document_ref": "0001045810-26-000075", "document_hash": "27de5f3a6af821a4cfc029811cf4a5724c0f71d63d6d7892abc8ab7d0a959e07", "capture_method": "original_bytes", "context_excerpt": "ExpectedRemaining Term (years)EffectiveInterest RateJul 26, 2026Jan 25, 2026(In millions)3.20% Notes Due 20260.13.31%$1,000 $1,000 4.25% Notes Due 20281.94.39%3,500 — 1.55% Notes Due 20281.91.64%1,250…", "document_hash_basis": "original_bytes", "source_published_at": "2026-08-26T20:36:00+00:00", "publication_time_precision": "instant" } ] }, { "document_ref": "SEC-TERM-000119312521192149-d80739dex42", "observation_date": "2021-06-16", "disclosed_at": "2021-06-16T20:27:01+00:00", "snapshot_kind": "supplement", "description": "1.550% Notes due 2028", "fields": { "isin": { "unit": null, "basis": null, "value": "US67066GAM69", "precision": null, "source_id": "f557223e-6a78-5f53-8678-09153d70f171", "null_reason": null }, "cusip": { "unit": null, "basis": null, "value": "67066GAM6", "precision": null, "source_id": "f557223e-6a78-5f53-8678-09153d70f171", "null_reason": null }, "coupon": { "unit": "percent", "basis": "stated_coupon", "value": "1.550", "precision": null, "source_id": "4a394170-cffb-56e2-accf-dfc8b146fe21", "null_reason": null }, "maturity": { "unit": null, "basis": null, "value": "2028-06-15", "precision": "day", "source_id": "1d8a90d4-b0d1-54ca-88f5-f9d83495b055", "null_reason": null }, "rate_type": { "unit": null, "basis": null, "value": "fixed", "precision": null, "source_id": "4a394170-cffb-56e2-accf-dfc8b146fe21", "null_reason": null }, "issue_date": { "unit": null, "basis": "interest_accrual_start", "value": "2021-06-16", "precision": "day", "source_id": "4a394170-cffb-56e2-accf-dfc8b146fe21", "null_reason": null }, "original_issue_amount": { "unit": "USD", "basis": "initial_series_principal_in_officers_certificate", "value": "1250000000", "precision": null, "source_id": "9a8e143e-d4bc-57d2-ae62-718e9ca289e5", "null_reason": null } }, "issuer": { "name": "NVIDIA Corporation", "role": "issuer", "source_id": "8afa6871-8402-5fd1-88a8-da4742f07c91", "review_state": "reviewed" }, "status": "outstanding_unconfirmed", "sources": [ { "cik": "0001045810", "status": "eligible", "locator": { "section": "Preamble", "text_end": 506, "text_hash": "43e836ecedec64d24d815a7c26e92ba35717b4b63e821ce6f7f2cb78c57ade3e", "text_start": 73 }, "source_id": "8afa6871-8402-5fd1-88a8-da4742f07c91", "source_url": "https://www.sec.gov/Archives/edgar/data/1045810/000119312521192149/d80739dex42.htm", "raw_excerpt": "The undersigned, NVIDIA Corporation, a Delaware corporation (the “Company”), hereby certifies through Colette M. Kress, its Executive Vice President and Chief Financial Officer, and Chris Ginieczki, i…", "source_kind": "html", "document_ref": "SEC-TERM-000119312521192149-d80739dex42", "document_hash": "590d48c72c803750396af72ec90e25bf5162e67b19cf78ef9d2812e2edef65c1", "capture_method": "original_bytes", "context_excerpt": "", "document_hash_basis": "original_bytes", "source_published_at": "2021-06-16T20:27:01+00:00", "publication_time_precision": "instant" }, { "cik": "0001045810", "status": "eligible", "locator": { "section": "Annex C", "text_end": 120694, "text_hash": "1ab7a398638072c4b7a29ac9fc1938bd70783025f0badf835adca1c8f41cb162", "text_start": 120615 }, "source_id": "726d4f3a-4c8d-5fa2-9403-e75e22f7f6b7", "source_url": "https://www.sec.gov/Archives/edgar/data/1045810/000119312521192149/d80739dex42.htm", "raw_excerpt": "The designation of the securities is “1.550% Notes due 2028” (the “2028 Notes”)", "source_kind": "html", "document_ref": "SEC-TERM-000119312521192149-d80739dex42", "document_hash": "590d48c72c803750396af72ec90e25bf5162e67b19cf78ef9d2812e2edef65c1", "capture_method": "original_bytes", "context_excerpt": "", "document_hash_basis": "original_bytes", "source_published_at": "2021-06-16T20:27:01+00:00", "publication_time_precision": "instant" } ] } ] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/debt/sources/{sourceId}": { "get": { "summary": "Debt source evidence", "description": "Original debt evidence with immutable document hash, locator and excerpt; scoped to the reporting company.", "operationId": "get-debt-source-evidence", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "sourceId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "object", "properties": { "cik": { "type": "string" }, "source_id": { "type": "string" }, "document_ref": { "type": "string" }, "document_hash": { "type": "string" }, "source_kind": { "type": "string" }, "locator": { "type": "object", "properties": { "row_index": { "type": "integer" }, "text_hash": { "type": "string" }, "attachment": { "type": "string" }, "table_index": { "type": "integer" } } }, "raw_excerpt": { "type": "string" }, "context_excerpt": { "type": "string" }, "source_url": { "type": "string" }, "source_published_at": { "type": "string", "format": "date-time" }, "publication_time_precision": { "type": "string" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "source": { "cik": "0001045810", "source_id": "1523161f-48c1-5b66-82b3-72bd5c28d758", "document_ref": "0001045810-26-000075", "document_hash": "27de5f3a6af821a4cfc029811cf4a5724c0f71d63d6d7892abc8ab7d0a959e07", "source_kind": "html", "locator": { "row_index": 20, "text_hash": "d678628416898bfa24708301bf5e10cc1f47d5884bd2ff0bc97d71e5e998e7d6", "attachment": "nvda-20260726.htm", "table_index": 27 }, "raw_excerpt": "Net carrying amount | | | | | | $ | 33,366 | | | $ | 8,468 | ", "context_excerpt": "ExpectedRemaining Term (years)EffectiveInterest RateJul 26, 2026Jan 25, 2026(In millions)3.20% Notes Due 20260.13.31%$1,000 $1,000 4.25% Notes Due 20281.94.39%3,500 — 1.55% Notes Due 20281.91.64%1,250…", "source_url": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000075/nvda-20260726.htm", "source_published_at": "2026-08-26T20:36:00.000Z", "publication_time_precision": "instant" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/debt/issuers": { "get": { "summary": "Bond issuer screener", "description": "Corporate bond screener grouped by reporting company, with bond counts, maturity span, coupon range and denominations. Largest market cap first by default; issuer disclosures, not market prices or yields.", "operationId": "get-bond-issuer-screener", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "as_of", "in": "query", "description": "Public information through this UTC date, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Instrument or issuer contains; max 100 characters.", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Native ISO currency in upper case, e.g. USD.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Instrument kind: note includes subordinated, Tier 2 and AT1 notes; sukuk includes AT1 sukuk; loan is term loans and loans; capital is equity-classified capital instruments.", "schema": { "type": "string", "enum": [ "bond", "note", "sukuk", "loan", "capital", "group" ] } }, { "name": "include_prior", "in": "query", "description": "Include prior-only disclosures; these do not establish current outstanding status.", "schema": { "type": "boolean", "default": true } }, { "name": "include_matured", "in": "query", "description": "Include matured instruments and those the issuer shows as repaid or redeemed or the exchange delisted; default excludes them without deleting their evidence.", "schema": { "type": "boolean", "default": false } }, { "name": "sort", "in": "query", "description": "Company sort order.", "schema": { "type": "string", "enum": [ "market_cap", "bonds", "issuer", "maturity", "coupon" ], "default": "market_cap" } }, { "name": "direction", "in": "query", "description": "Sort direction; default desc for market_cap and bonds, asc otherwise.", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "company", "in": "query", "description": "Repeat for up to 50 exact CIKs or platform keys.", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "debt": { "type": "object", "properties": { "issuers": { "type": "array", "items": { "type": "object", "properties": { "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" } } }, "market_cap_usd": { "type": "integer" }, "instruments": { "type": "integer" }, "prior": { "type": "integer" }, "next_maturity": { "type": [ "object", "null" ], "properties": { "value": { "type": "string", "format": "date" }, "precision": { "type": "string" } } }, "final_maturity": { "type": [ "object", "null" ], "properties": { "value": { "type": "string", "format": "date" }, "precision": { "type": "string" } } }, "perpetual": { "type": "boolean" }, "coupon_min": { "type": [ "string", "null" ] }, "coupon_max": { "type": [ "string", "null" ] }, "currencies": { "type": "array", "items": { "type": "string" } }, "kinds": { "type": "array", "items": { "type": "string" } } } } }, "instruments": { "type": "integer" }, "coverage_note": { "type": "string" }, "options": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" } } } }, "currencies": { "type": "array", "items": { "type": "string" } } } }, "as_of": { "type": "null" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "debt": { "issuers": [ { "company": { "cik": "0000320193", "name": "Apple Inc.", "ticker": "AAPL" }, "market_cap_usd": 5034686918690, "instruments": 50, "prior": 0, "next_maturity": { "value": "2026-11-10", "precision": "day" }, "final_maturity": { "value": "2062-08-08", "precision": "day" }, "perpetual": false, "coupon_min": "0.500", "coupon_max": "4.850", "currencies": [ "CHF", "EUR" ], "kinds": [ "note" ] }, { "company": { "cik": "XSAU000063", "name": "Al Rajhi Bank", "ticker": "1120" }, "market_cap_usd": 98297526822, "instruments": 8, "prior": 1, "next_maturity": null, "final_maturity": null, "perpetual": true, "coupon_min": null, "coupon_max": null, "currencies": [ "SAR", "USD" ], "kinds": [ "at1_sukuk" ] } ], "instruments": 560, "coverage_note": "Reviewed issuer disclosures. Includes sukuk and separately labelled equity-classified capital instruments. Original issue amounts are not current balances. Prices, yields and ratings are not covered.", "options": { "companies": [ { "cik": "XADS000009", "name": "Abu Dhabi Commercial Bank" }, { "cik": "XADS000024", "name": "Aldar Properties PJSC" } ], "currencies": [ "AED", "AUD" ] }, "as_of": null } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/debt/instruments": { "get": { "summary": "Corporate bond screener", "description": "Corporate bond disclosure screener: individually disclosed bonds, notes, sukuk and labelled capital instruments. No borrowing groups, market prices, yields or ratings; partial pilot coverage.", "operationId": "get-corporate-bond-screener", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "as_of", "in": "query", "description": "Public information through this UTC date, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Instrument or issuer contains; max 100 characters.", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Native ISO currency in upper case, e.g. USD.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Instrument kind: note includes subordinated, Tier 2 and AT1 notes; sukuk includes AT1 sukuk; loan is term loans and loans; capital is equity-classified capital instruments.", "schema": { "type": "string", "enum": [ "bond", "note", "sukuk", "loan", "capital", "group" ] } }, { "name": "include_prior", "in": "query", "description": "Include prior-only disclosures; these do not establish current outstanding status.", "schema": { "type": "boolean", "default": true } }, { "name": "include_matured", "in": "query", "description": "Include matured instruments and those the issuer shows as repaid or redeemed or the exchange delisted; default excludes them without deleting their evidence.", "schema": { "type": "boolean", "default": false } }, { "name": "sort", "in": "query", "description": "Amounts sort by their USD value at the cutoff (daily reference rates); an amount whose currency has no rate sorts last.", "schema": { "type": "string", "enum": [ "maturity", "coupon", "amount", "issuer" ], "default": "maturity" } }, { "name": "direction", "in": "query", "description": "Sort direction.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "limit", "in": "query", "description": "Instruments per page, 1–100 (above 100 is a 400). Each instrument brings its cited sources, ~6 KB.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "cursor", "in": "query", "description": "`page_info.nextCursor` from the previous page (`next_cursor` is its deprecated alias); `page_info.hasMore` is false on the last page. Revision-bound: restart from the first page if the data or filters change.", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Repeat for up to 50 exact CIKs or platform keys.", "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "debt": { "type": "object", "properties": { "company": { "type": "null" }, "coverage": { "type": "string" }, "coverage_note": { "type": "string" }, "scope": { "type": "null" }, "observation_date": { "type": "null" }, "instruments": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "events": { "type": "array", "items": {} }, "fields": { "type": "object", "properties": { "isin": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "coupon": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "maturity": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "rate_type": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "issue_date": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "listing_date": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "string" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "listed_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "listed_currency": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "original_issue_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "common_code": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } } } }, "issuer": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" }, "source_id": { "type": "string" }, "review_state": { "type": "string" } } }, "status": { "type": "string" }, "object_id": { "type": "string" }, "description": { "type": "string" }, "disclosures": { "type": "array", "items": { "type": "object", "properties": { "document_ref": { "type": "string" }, "snapshot_kind": { "type": "string" }, "observation_date": { "type": "string", "format": "date" } } } }, "field_roles": { "type": "object", "properties": { "isin": { "type": "string" }, "coupon": { "type": "string" }, "maturity": { "type": "string" }, "rate_type": { "type": "string" }, "issue_date": { "type": "string" }, "listing_date": { "type": "string" }, "listed_amount": { "type": "string" }, "listed_currency": { "type": "string" }, "original_issue_amount": { "type": "string" }, "common_code": { "type": "string" } } }, "issuer_role": { "type": "null" }, "object_kind": { "type": "string" }, "disclosed_at": { "type": "string", "format": "date-time" }, "document_ref": { "type": "string" }, "classification": { "type": "string" }, "identity_state": { "type": "string" }, "term_conflicts": { "type": "array", "items": {} }, "terms_documents": { "type": "array", "items": { "type": "string" } }, "observation_date": { "type": "string", "format": "date" }, "observation_kind": { "type": "string" }, "prior_disclosure": { "type": "boolean" }, "source_description": { "type": "string" }, "denomination_currency": { "type": "string" }, "description_source_id": { "type": "string" }, "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" } } }, "stale": { "type": "boolean" }, "amount_key": { "type": "string" } } } }, "facilities": { "type": "array", "items": {} }, "totals": { "type": "object" }, "filed_ladder": { "type": "array", "items": {} }, "sources": { "type": "array", "items": { "type": "object", "properties": { "source_id": { "type": "string" }, "document_ref": { "type": "string" }, "source_url": { "type": "string" }, "source_published_at": { "type": "string", "format": "date-time" }, "locator": { "type": "object", "properties": { "series": { "type": "string" }, "section": { "type": "string" }, "text_end": { "type": "integer" }, "text_hash": { "type": "string" }, "text_start": { "type": "integer" }, "issue_date": { "type": "string", "format": "date" }, "issue_label": { "type": "string" }, "capture_method": { "type": "string" } } }, "raw_excerpt": { "type": "string" }, "context_excerpt": { "type": "string" } } } }, "issuers": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "individual_instruments": { "type": "integer" }, "coverage": { "type": "string" } } } }, "currencies": { "type": "array", "items": { "type": "string" } }, "as_of": { "type": "null" }, "page_info": { "type": "object", "properties": { "total": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextCursor": { "type": "string" }, "next_cursor": { "type": "string" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "debt": { "company": null, "coverage": "partial", "coverage_note": "Reviewed issuer disclosures. Includes sukuk and separately labelled equity-classified capital instruments. Original issue amounts are not current balances. Prices, yields and ratings are not covered.", "scope": null, "observation_date": null, "instruments": [ { "kind": "sukuk", "events": [], "fields": { "isin": { "unit": null, "basis": null, "value": "XS2392596180", "precision": null, "source_id": "2bb7c84d-6932-5c82-994c-3603ff9faa16", "null_reason": null }, "coupon": { "unit": "percent", "basis": "listed_profit_rate", "value": "2.082", "precision": null, "source_id": "e145dae1-12fa-5406-b35d-1c325fa1bc2f", "null_reason": null }, "maturity": { "unit": null, "basis": null, "value": "2026-11-02", "precision": "day", "source_id": "7a58bd19-9e57-580b-834f-0b48575ba93b", "null_reason": null }, "rate_type": { "unit": null, "basis": null, "value": "fixed", "precision": null, "source_id": "e145dae1-12fa-5406-b35d-1c325fa1bc2f", "null_reason": null }, "issue_date": { "unit": null, "basis": null, "value": "2021-11-02", "precision": "day", "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "null_reason": null }, "listing_date": { "unit": null, "basis": "exchange_listing_date", "value": "2021-11-02", "precision": "day", "source_id": "8f875721-154a-5f90-8a87-d94c2fb8f251", "null_reason": null }, "listed_amount": { "unit": "USD", "basis": "exchange_listed_issue_size", "value": "500000000", "precision": null, "source_id": "f89972d3-4f04-5092-84d7-97dc9e8281cc", "null_reason": null }, "listed_currency": { "unit": null, "basis": "exchange_currency_field", "value": "USD", "precision": null, "source_id": "c48049db-97d1-5112-af8f-cc8d6033415d", "null_reason": null }, "original_issue_amount": { "unit": "USD", "basis": "amount_at_issuance", "value": "500000000", "precision": null, "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "null_reason": null } }, "issuer": { "name": "EI Sukuk Company Limited", "role": "issuer", "source_id": "493ee8df-d718-5027-b6ab-7f1ada3e14de", "review_state": "reviewed" }, "status": "outstanding_unconfirmed", "object_id": "f63448bf-2d38-5f8b-bff8-0668ed6575c3", "description": "2.082% Sukuk due 2 Nov 2026 (USD)", "disclosures": [ { "document_ref": "NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6", "snapshot_kind": "supplement", "observation_date": "2026-09-21" }, { "document_ref": "ENBD-2026-09-19-ISSUANCES", "snapshot_kind": "supplement", "observation_date": "2026-09-19" } ], "field_roles": { "isin": "term", "coupon": "term", "maturity": "term", "rate_type": "term", "issue_date": "term", "listing_date": "observation", "listed_amount": "observation", "listed_currency": "observation", "original_issue_amount": "term" }, "issuer_role": null, "object_kind": "individual", "disclosed_at": "2026-09-21T17:56:00.555Z", "document_ref": "NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6", "classification": "liability", "identity_state": "reviewed", "term_conflicts": [], "terms_documents": [ "ENBD-2026-09-19-ISSUANCES", "NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6" ], "observation_date": "2026-09-21", "observation_kind": "supplement", "prior_disclosure": false, "source_description": "EI Sukuk Company Ltd. Nov 2026", "denomination_currency": "USD", "description_source_id": "2bb7c84d-6932-5c82-994c-3603ff9faa16", "company": { "cik": "XDFM000003", "name": "Emirates NBD Bank PJSC", "ticker": "EMIRATESNBD" }, "stale": false, "amount_key": "listed_amount" }, { "kind": "note", "events": [], "fields": { "isin": { "unit": null, "basis": null, "value": "XS1135337498", "precision": null, "source_id": "8fcbfcc2-2dfc-5c43-a2d1-cb21c9072ca7", "null_reason": null }, "coupon": { "unit": "percent", "basis": "stated_coupon", "value": "1.625", "precision": null, "source_id": "a35ad215-e64c-5deb-988f-59b083ddc26f", "null_reason": null }, "maturity": { "unit": null, "basis": null, "value": "2026-11-10", "precision": "day", "source_id": "3e338a42-1959-5e5f-a18c-de3cb482bb72", "null_reason": null }, "rate_type": { "unit": null, "basis": null, "value": "fixed", "precision": null, "source_id": "a35ad215-e64c-5deb-988f-59b083ddc26f", "null_reason": null }, "common_code": { "unit": null, "basis": null, "value": "113533749", "precision": null, "source_id": "8fcbfcc2-2dfc-5c43-a2d1-cb21c9072ca7", "null_reason": null }, "original_issue_amount": { "unit": "EUR", "basis": "initial_series_principal_in_establishing_document", "value": "1400000000", "precision": null, "source_id": "007650c6-317b-5d57-804e-e3ef70865058", "null_reason": null } }, "issuer": { "name": "Apple Inc.", "role": "issuer", "source_id": "7fb47609-49ca-5729-8d61-8ee0ef592367", "review_state": "reviewed" }, "status": "outstanding_unconfirmed", "object_id": "7c3ce40f-0ae4-55c1-a260-99b5bf61857b", "description": "1.625% Notes due 2026 (EUR)", "disclosures": [ { "document_ref": "SEC-TERM-000119312514406296-d816414dex41", "snapshot_kind": "supplement", "observation_date": "2014-11-10" } ], "field_roles": { "isin": "term", "coupon": "term", "maturity": "term", "rate_type": "term", "common_code": "term", "original_issue_amount": "term" }, "issuer_role": null, "object_kind": "individual", "disclosed_at": "2014-11-10T22:05:54.000Z", "document_ref": "SEC-TERM-000119312514406296-d816414dex41", "classification": "liability", "identity_state": "reviewed", "term_conflicts": [], "terms_documents": [ "SEC-TERM-000119312514406296-d816414dex41" ], "observation_date": "2014-11-10", "observation_kind": "supplement", "prior_disclosure": false, "denomination_currency": "EUR", "description_source_id": "007650c6-317b-5d57-804e-e3ef70865058", "company": { "cik": "0000320193", "name": "Apple Inc.", "ticker": "AAPL" }, "stale": true, "amount_key": "original_issue_amount" } ], "facilities": [], "totals": {}, "filed_ladder": [], "sources": [ { "source_id": "007650c6-317b-5d57-804e-e3ef70865058", "document_ref": "SEC-TERM-000119312514406296-d816414dex41", "source_url": "https://www.sec.gov/Archives/edgar/data/320193/000119312514406296/d816414dex41.htm", "source_published_at": "2014-11-10T22:05:54.000Z", "locator": { "series": "1.625% Notes due 2026", "section": "Terms", "text_end": 6033, "text_hash": "7ed21188dc01a4b6e679edaba051f6684df22561b6d703cf66d085e32b3b9dfe", "text_start": 5979 }, "raw_excerpt": "Aggregate Principal Amount at Maturity. €1,400,000,000", "context_excerpt": "" }, { "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "document_ref": "ENBD-2026-09-19-ISSUANCES", "source_url": "https://www.emiratesnbd.com/en/investor-relations/debt-and-ratings", "source_published_at": "2026-09-19T00:54:36.119Z", "locator": { "section": "public_issuance_table", "text_hash": "a8e1b992cabd447eb807324f43c2b4a7e1797f4ec22309a6a6be8f4b4069eaa1", "issue_date": "2021-11-02", "issue_label": "USD 500mn Sukuk", "capture_method": "web_text_extract" }, "raw_excerpt": "L1946: USD 500mn Sukuk | 5 years | 2-Nov-21 | 2-Nov-26 | 2.082% | USD | 500 | 500 |", "context_excerpt": "Historical issuance terms. Current outstanding amount and redemption status are not established by this catalog." } ], "issuers": [ { "cik": "XADS000009", "name": "Abu Dhabi Commercial Bank", "individual_instruments": 3, "coverage": "partial" }, { "cik": "XADS000024", "name": "Aldar Properties PJSC", "individual_instruments": 10, "coverage": "partial" } ], "currencies": [ "AED", "AUD" ], "as_of": null, "page_info": { "total": 560, "limit": 2, "hasMore": true, "nextCursor": "eyJyZXZpc2lvbiI6ImRiOTkxNDJiMjg2MzE3NjZlMzg5NjU0ZmFmODQwYjZjIiwiZmlsdGVycyI6ImE5NWNmNDU5ZWVhOGFmZmI2YWUwMjY3OWYzNjM1NjI3Iiwia2V5IjpbMCwiMjAyNi0xMS0xMCIsIjdjM2NlNDBmLTBhZTQtNTVjMS1hMjYwLTk5YjViZjYxODU3…", "next_cursor": "eyJyZXZpc2lvbiI6ImRiOTkxNDJiMjg2MzE3NjZlMzg5NjU0ZmFmODQwYjZjIiwiZmlsdGVycyI6ImE5NWNmNDU5ZWVhOGFmZmI2YWUwMjY3OWYzNjM1NjI3Iiwia2V5IjpbMCwiMjAyNi0xMS0xMCIsIjdjM2NlNDBmLTBhZTQtNTVjMS1hMjYwLTk5YjViZjYxODU3…" } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/debt/instruments/{instrumentId}": { "get": { "summary": "Debt instrument detail", "description": "One bond, note or sukuk as its own instrument: current record (issuer, disclosed terms, latest disclosure, prior flag) and every filing that disclosed it with evidence. Issuer disclosures only; no market prices, yields or ratings.", "operationId": "get-debt-instrument-detail", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "instrumentId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "as_of", "in": "query", "description": "Public information through this UTC date, YYYY-MM-DD.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "instrument": { "type": "object", "properties": { "bond": { "type": "object", "properties": { "kind": { "type": "string" }, "events": { "type": "array", "items": {} }, "fields": { "type": "object", "properties": { "isin": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "coupon": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "maturity": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "rate_type": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "issue_date": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "listing_date": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "string" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "listed_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "listed_currency": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "original_issue_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } } } }, "issuer": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" }, "source_id": { "type": "string" }, "review_state": { "type": "string" } } }, "status": { "type": "string" }, "object_id": { "type": "string" }, "description": { "type": "string" }, "disclosures": { "type": "array", "items": { "type": "object", "properties": { "document_ref": { "type": "string" }, "snapshot_kind": { "type": "string" }, "observation_date": { "type": "string", "format": "date" } } } }, "field_roles": { "type": "object", "properties": { "isin": { "type": "string" }, "coupon": { "type": "string" }, "maturity": { "type": "string" }, "rate_type": { "type": "string" }, "issue_date": { "type": "string" }, "listing_date": { "type": "string" }, "listed_amount": { "type": "string" }, "listed_currency": { "type": "string" }, "original_issue_amount": { "type": "string" } } }, "issuer_role": { "type": "null" }, "object_kind": { "type": "string" }, "disclosed_at": { "type": "string", "format": "date-time" }, "document_ref": { "type": "string" }, "classification": { "type": "string" }, "identity_state": { "type": "string" }, "term_conflicts": { "type": "array", "items": {} }, "terms_documents": { "type": "array", "items": { "type": "string" } }, "observation_date": { "type": "string", "format": "date" }, "observation_kind": { "type": "string" }, "prior_disclosure": { "type": "boolean" }, "source_description": { "type": "string" }, "denomination_currency": { "type": "string" }, "description_source_id": { "type": "string" }, "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" } } }, "stale": { "type": "boolean" }, "amount_key": { "type": "string" } } }, "history": { "type": "array", "items": { "type": "object", "properties": { "document_ref": { "type": "string" }, "observation_date": { "type": "string", "format": "date" }, "disclosed_at": { "type": "string", "format": "date-time" }, "snapshot_kind": { "type": "string" }, "description": { "type": "string" }, "fields": { "type": "object", "properties": { "isin": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "coupon": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "maturity": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "rate_type": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "listing_date": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "string" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "listed_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "listed_currency": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "issue_date": { "type": "object", "properties": { "unit": { "type": "null" }, "basis": { "type": "null" }, "value": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } }, "original_issue_amount": { "type": "object", "properties": { "unit": { "type": "string" }, "basis": { "type": "string" }, "value": { "type": "string" }, "precision": { "type": "null" }, "source_id": { "type": "string" }, "null_reason": { "type": "null" } } } } }, "issuer": { "type": "object", "properties": { "name": { "type": [ "string", "null" ] }, "role": { "type": "string" }, "source_id": { "type": "string" }, "review_state": { "type": "string" } } }, "status": { "type": "string" }, "events": { "type": "array", "items": {} }, "sources": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "status": { "type": "string" }, "locator": { "type": "object", "properties": { "text_hash": { "type": "string" }, "record_field": { "type": "string" }, "record_source": { "type": "string" }, "section": { "type": "string" }, "issue_date": { "type": "string", "format": "date" }, "issue_label": { "type": "string" }, "capture_method": { "type": "string" } } }, "source_id": { "type": "string" }, "source_url": { "type": "string" }, "raw_excerpt": { "type": "string" }, "source_kind": { "type": "string" }, "document_ref": { "type": "string" }, "document_hash": { "type": "string" }, "capture_method": { "type": "string" }, "context_excerpt": { "type": "string" }, "document_hash_basis": { "type": "string" }, "source_published_at": { "type": "string", "format": "date-time" }, "publication_time_precision": { "type": "string" } } } } } } }, "sources": { "type": "array", "items": {} } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "instrument": { "bond": { "kind": "sukuk", "events": [], "fields": { "isin": { "unit": null, "basis": null, "value": "XS2392596180", "precision": null, "source_id": "2bb7c84d-6932-5c82-994c-3603ff9faa16", "null_reason": null }, "coupon": { "unit": "percent", "basis": "listed_profit_rate", "value": "2.082", "precision": null, "source_id": "e145dae1-12fa-5406-b35d-1c325fa1bc2f", "null_reason": null }, "maturity": { "unit": null, "basis": null, "value": "2026-11-02", "precision": "day", "source_id": "7a58bd19-9e57-580b-834f-0b48575ba93b", "null_reason": null }, "rate_type": { "unit": null, "basis": null, "value": "fixed", "precision": null, "source_id": "e145dae1-12fa-5406-b35d-1c325fa1bc2f", "null_reason": null }, "issue_date": { "unit": null, "basis": null, "value": "2021-11-02", "precision": "day", "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "null_reason": null }, "listing_date": { "unit": null, "basis": "exchange_listing_date", "value": "2021-11-02", "precision": "day", "source_id": "8f875721-154a-5f90-8a87-d94c2fb8f251", "null_reason": null }, "listed_amount": { "unit": "USD", "basis": "exchange_listed_issue_size", "value": "500000000", "precision": null, "source_id": "f89972d3-4f04-5092-84d7-97dc9e8281cc", "null_reason": null }, "listed_currency": { "unit": null, "basis": "exchange_currency_field", "value": "USD", "precision": null, "source_id": "c48049db-97d1-5112-af8f-cc8d6033415d", "null_reason": null }, "original_issue_amount": { "unit": "USD", "basis": "amount_at_issuance", "value": "500000000", "precision": null, "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "null_reason": null } }, "issuer": { "name": "EI Sukuk Company Limited", "role": "issuer", "source_id": "493ee8df-d718-5027-b6ab-7f1ada3e14de", "review_state": "reviewed" }, "status": "outstanding_unconfirmed", "object_id": "f63448bf-2d38-5f8b-bff8-0668ed6575c3", "description": "2.082% Sukuk due 2 Nov 2026 (USD)", "disclosures": [ { "document_ref": "NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6", "snapshot_kind": "supplement", "observation_date": "2026-09-21" }, { "document_ref": "ENBD-2026-09-19-ISSUANCES", "snapshot_kind": "supplement", "observation_date": "2026-09-19" } ], "field_roles": { "isin": "term", "coupon": "term", "maturity": "term", "rate_type": "term", "issue_date": "term", "listing_date": "observation", "listed_amount": "observation", "listed_currency": "observation", "original_issue_amount": "term" }, "issuer_role": null, "object_kind": "individual", "disclosed_at": "2026-09-21T17:56:00.555Z", "document_ref": "NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6", "classification": "liability", "identity_state": "reviewed", "term_conflicts": [], "terms_documents": [ "ENBD-2026-09-19-ISSUANCES", "NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6" ], "observation_date": "2026-09-21", "observation_kind": "supplement", "prior_disclosure": false, "source_description": "EI Sukuk Company Ltd. Nov 2026", "denomination_currency": "USD", "description_source_id": "2bb7c84d-6932-5c82-994c-3603ff9faa16", "company": { "cik": "XDFM000003", "name": "Emirates NBD Bank PJSC", "ticker": "EMIRATESNBD" }, "stale": false, "amount_key": "listed_amount" }, "history": [ { "document_ref": "NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6", "observation_date": "2026-09-21", "disclosed_at": "2026-09-21T17:56:00.555259+00:00", "snapshot_kind": "supplement", "description": "EI Sukuk Company Ltd. Nov 2026", "fields": { "isin": { "unit": null, "basis": null, "value": "XS2392596180", "precision": null, "source_id": "2bb7c84d-6932-5c82-994c-3603ff9faa16", "null_reason": null }, "coupon": { "unit": "percent", "basis": "listed_profit_rate", "value": "2.082", "precision": null, "source_id": "e145dae1-12fa-5406-b35d-1c325fa1bc2f", "null_reason": null }, "maturity": { "unit": null, "basis": null, "value": "2026-11-02", "precision": "day", "source_id": "7a58bd19-9e57-580b-834f-0b48575ba93b", "null_reason": null }, "rate_type": { "unit": null, "basis": null, "value": "fixed", "precision": null, "source_id": "e145dae1-12fa-5406-b35d-1c325fa1bc2f", "null_reason": null }, "listing_date": { "unit": null, "basis": "exchange_listing_date", "value": "2021-11-02", "precision": "day", "source_id": "8f875721-154a-5f90-8a87-d94c2fb8f251", "null_reason": null }, "listed_amount": { "unit": "USD", "basis": "exchange_listed_issue_size", "value": "500000000", "precision": null, "source_id": "f89972d3-4f04-5092-84d7-97dc9e8281cc", "null_reason": null }, "listed_currency": { "unit": null, "basis": "exchange_currency_field", "value": "USD", "precision": null, "source_id": "c48049db-97d1-5112-af8f-cc8d6033415d", "null_reason": null } }, "issuer": { "name": "EI Sukuk Company Limited", "role": "issuer", "source_id": "493ee8df-d718-5027-b6ab-7f1ada3e14de", "review_state": "reviewed" }, "status": "outstanding_unconfirmed", "events": [], "sources": [ { "cik": "XDFM000003", "status": "eligible", "locator": { "text_hash": "3cdcac333240b95b20d29cc39649d1a5f80fa1246250bcb33eb45828075b9691", "record_field": "isin", "record_source": "nasdaq_dubai" }, "source_id": "2bb7c84d-6932-5c82-994c-3603ff9faa16", "source_url": "https://feeds.nasdaqdubai.com/apps/sso/source/security_detail3?id=2cb89d7e-359a-4bb3-b4b0-0d247b311ee6", "raw_excerpt": "isin: XS2392596180", "source_kind": "json", "document_ref": "NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6", "document_hash": "79b2f51da1af7d3d79d4ba4850802e9c9b327f48dc990e2a5e39c1081f20193c", "capture_method": "api_record_projection", "context_excerpt": "nasdaq_dubai listing record XS2392596180", "document_hash_basis": "original_bytes", "source_published_at": "2026-09-21T17:56:00.555259+00:00", "publication_time_precision": "instant" }, { "cik": "XDFM000003", "status": "eligible", "locator": { "text_hash": "7874a3e083cec2adb21edb9656581ca54652a11676911ae5ddc31c2d4b0d7e0d", "record_field": "currency", "record_source": "nasdaq_dubai" }, "source_id": "c48049db-97d1-5112-af8f-cc8d6033415d", "source_url": "https://feeds.nasdaqdubai.com/apps/sso/source/security_detail3?id=2cb89d7e-359a-4bb3-b4b0-0d247b311ee6", "raw_excerpt": "currency: USD", "source_kind": "json", "document_ref": "NDX-2cb89d7e-359a-4bb3-b4b0-0d247b311ee6", "document_hash": "79b2f51da1af7d3d79d4ba4850802e9c9b327f48dc990e2a5e39c1081f20193c", "capture_method": "api_record_projection", "context_excerpt": "nasdaq_dubai listing record XS2392596180", "document_hash_basis": "original_bytes", "source_published_at": "2026-09-21T17:56:00.555259+00:00", "publication_time_precision": "instant" } ] }, { "document_ref": "ENBD-2026-09-19-ISSUANCES", "observation_date": "2026-09-19", "disclosed_at": "2026-09-19T00:54:36.119592+00:00", "snapshot_kind": "supplement", "description": "USD 500mn Sukuk — 2021-11-02", "fields": { "coupon": { "unit": "percent", "basis": "stated_coupon", "value": "2.082", "precision": null, "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "null_reason": null }, "maturity": { "unit": null, "basis": null, "value": "2026-11-02", "precision": "day", "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "null_reason": null }, "rate_type": { "unit": null, "basis": null, "value": "fixed", "precision": null, "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "null_reason": null }, "issue_date": { "unit": null, "basis": null, "value": "2021-11-02", "precision": "day", "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "null_reason": null }, "original_issue_amount": { "unit": "USD", "basis": "amount_at_issuance", "value": "500000000", "precision": null, "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "null_reason": null } }, "issuer": { "name": null, "role": "issuer", "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "review_state": "unresolved" }, "status": "outstanding_unconfirmed", "sources": [ { "cik": "XDFM000003", "status": "eligible", "locator": { "section": "public_issuance_table", "text_hash": "a8e1b992cabd447eb807324f43c2b4a7e1797f4ec22309a6a6be8f4b4069eaa1", "issue_date": "2021-11-02", "issue_label": "USD 500mn Sukuk", "capture_method": "web_text_extract" }, "source_id": "ba7c33ec-95b4-52bb-9b69-47c06c8bbd4b", "source_url": "https://www.emiratesnbd.com/en/investor-relations/debt-and-ratings", "raw_excerpt": "L1946: USD 500mn Sukuk | 5 years | 2-Nov-21 | 2-Nov-26 | 2.082% | USD | 500 | 500 |", "source_kind": "json", "document_ref": "ENBD-2026-09-19-ISSUANCES", "document_hash": "9556639f603b763379aaf3c42f4b21ca589f6944b1ca9bf31bbc194e10edea5e", "capture_method": "web_text_extract", "context_excerpt": "Historical issuance terms. Current outstanding amount and redemption status are not established by this catalog.", "document_hash_basis": "captured_text", "source_published_at": "2026-09-19T00:54:36.119592+00:00", "publication_time_precision": "instant" } ] } ], "sources": [] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/health": { "get": { "summary": "Health check", "description": "Liveness probe.", "operationId": "get-health-check", "tags": [ "Search & Meta" ], "x-tier": "public", "security": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string" }, "version": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "status": "healthy", "version": "1.0.0", "timestamp": "2026-11-01T12:47:31.075Z" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/landing/stats": { "get": { "summary": "Coverage stats", "description": "Headline counts shown on the landing page: economies, companies, their combined USD market value, people, commodities, indices, observations and narratives.", "operationId": "get-coverage-stats", "tags": [ "Search & Meta" ], "x-tier": "public", "security": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "economies": { "type": "integer" }, "companies": { "type": "integer" }, "marketValueUsd": { "type": "integer" }, "people": { "type": "integer" }, "commodities": { "type": "integer" }, "indices": { "type": "integer" }, "observations": { "type": "integer" }, "narratives": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "economies": 213, "companies": 1697, "marketValueUsd": 87316126802854, "people": 24240, "commodities": 82, "indices": 38, "observations": 878889, "narratives": 7158 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/landing/coverage": { "get": { "summary": "Coverage inventory", "description": "The live coverage inventory — what Astreus holds right now, straight from the serving tables, refreshed hourly. Universe totals (companies by sector and exchange, filings by year and type, facts, prices, macro series, transcripts, observations, narratives, guidance commitments, central-bank documents) plus `markets[]`: for every country served, its exchanges, published companies, the earliest reporting period held, the median completeness score, served note tables, and for each data type (financial statements, segments & KPIs, report documents, filing notes, earnings releases, transcripts, audio, investor presentations, 13F holdings) the reporting periods held versus the periods that exist. Ask this before answering \"what is your coverage of market X?\".", "operationId": "get-coverage-inventory", "tags": [ "Search & Meta" ], "x-tier": "public", "security": [], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "generatedAt": { "type": "string", "format": "date-time" }, "companies": { "type": "object", "properties": { "covered": { "type": "integer" }, "knownToEdgar": { "type": "integer" }, "bySector": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "count": { "type": "integer" } } } }, "byExchange": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "count": { "type": "integer" } } } } } }, "filings": { "type": "object", "properties": { "total": { "type": "integer" }, "parsed": { "type": "integer" }, "firstYear": { "type": "integer" }, "lastYear": { "type": "integer" }, "byType": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "count": { "type": "integer" } } } } } }, "facts": { "type": "object", "properties": { "financialApprox": { "type": "integer" }, "segment": { "type": "integer" } } }, "ownership": { "type": "object", "properties": { "insiderTransactions": { "type": "integer" }, "institutionalHoldings": { "type": "integer" }, "eightKEvents": { "type": "integer" } } }, "prices": { "type": "object", "properties": { "rows": { "type": "integer" }, "securities": { "type": "integer" }, "firstDate": { "type": "string", "format": "date" }, "lastDate": { "type": "string", "format": "date" } } }, "macro": { "type": "object", "properties": { "economies": { "type": "integer" }, "series": { "type": "integer" }, "observations": { "type": "integer" }, "firstDate": { "type": "string", "format": "date" }, "lastDate": { "type": "string", "format": "date" }, "byProvider": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "count": { "type": "integer" } } } } } }, "intelligence": { "type": "object", "properties": { "observations": { "type": "integer" }, "narratives": { "type": "integer" }, "claimEdges": { "type": "integer" }, "guidanceCommitments": { "type": "integer" }, "transcripts": { "type": "integer" }, "transcriptCompanies": { "type": "integer" }, "transcriptFirstDate": { "type": "string", "format": "date" }, "transcriptLastDate": { "type": "string", "format": "date" }, "centralBankDocuments": { "type": "integer" } } }, "markets": { "type": "array", "items": { "type": "object", "properties": { "countryCode": { "type": "string" }, "exchanges": { "type": "array", "items": { "type": "string" } }, "companies": { "type": "integer" }, "earliestPeriod": { "type": [ "string", "null" ], "format": "date" }, "medianScore": { "type": [ "integer", "null" ] }, "noteTables": { "type": "integer" }, "measuredAt": { "type": "string", "format": "date" }, "rows": { "type": "object", "properties": { "audio": { "type": "object", "properties": { "held": { "type": "integer" }, "expected": { "type": "integer" } } }, "documents": { "type": "object", "properties": { "held": { "type": "integer" }, "expected": { "type": "integer" } } }, "earnings_release": { "type": "object", "properties": { "held": { "type": "integer" }, "expected": { "type": "integer" } } }, "filing_notes": { "type": "object", "properties": { "held": { "type": "integer" }, "expected": { "type": "integer" } } }, "financials": { "type": "object", "properties": { "held": { "type": "integer" }, "expected": { "type": "integer" } } }, "holdings_13f": { "type": "object", "properties": { "held": { "type": "integer" }, "expected": { "type": "integer" } } }, "presentation": { "type": "object", "properties": { "held": { "type": "integer" }, "expected": { "type": "integer" } } }, "segments": { "type": "object", "properties": { "held": { "type": "integer" }, "expected": { "type": "integer" } } }, "transcript": { "type": "object", "properties": { "held": { "type": "integer" }, "expected": { "type": "integer" } } } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "generatedAt": "2026-11-01T11:36:49.726Z", "companies": { "covered": 901, "knownToEdgar": 1172, "bySector": [ { "name": "Technology", "count": 206 }, { "name": "Industrials", "count": 140 } ], "byExchange": [ { "name": "NYSE", "count": 505 }, { "name": "Nasdaq", "count": 297 } ] }, "filings": { "total": 71723, "parsed": 71564, "firstYear": 1994, "lastYear": 2026, "byType": [ { "name": "10-Q", "count": 34965 }, { "name": "DEF 14A", "count": 16233 } ] }, "facts": { "financialApprox": 60512264, "segment": 2159469 }, "ownership": { "insiderTransactions": 3852115, "institutionalHoldings": 16249875, "eightKEvents": 174059 }, "prices": { "rows": 9710608, "securities": 2211, "firstDate": "1962-01-02", "lastDate": "2026-10-30" }, "macro": { "economies": 213, "series": 9758, "observations": 10660777, "firstDate": "1854-12-01", "lastDate": "2026-11-01", "byProvider": [ { "name": "WIKIDATA", "count": 2539 }, { "name": "CBUAE", "count": 1427 } ] }, "intelligence": { "observations": 878889, "narratives": 7158, "claimEdges": 8522, "guidanceCommitments": 72582, "transcripts": 36552, "transcriptCompanies": 1893, "transcriptFirstDate": "2007-04-20", "transcriptLastDate": "2026-10-30", "centralBankDocuments": 5652 }, "markets": [ { "countryCode": "US", "exchanges": [ "NYSE", "Nasdaq" ], "companies": 629, "earliestPeriod": "1991-03-31", "medianScore": 47, "noteTables": 5523, "measuredAt": "2026-10-05", "rows": { "audio": { "held": 237, "expected": 60116 }, "documents": { "held": 74532, "expected": 75044 }, "earnings_release": { "held": 8889, "expected": 60116 }, "filing_notes": { "held": 46186, "expected": 75044 }, "financials": { "held": 46675, "expected": 75044 }, "holdings_13f": { "held": 26505, "expected": 29832 }, "presentation": { "held": 15210, "expected": 60116 }, "segments": { "held": 41900, "expected": 75044 }, "transcript": { "held": 12485, "expected": 60116 } } }, { "countryCode": "EG", "exchanges": [ "EGX" ], "companies": 1, "earliestPeriod": null, "medianScore": null, "noteTables": 4, "measuredAt": "2026-10-05", "rows": {} } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/search": { "get": { "summary": "Search", "description": "Global search across companies (public and private), macro series and countries. Companies are matched on any listed symbol, name, legal/former names and curated aliases (\"chatgpt\" finds OpenAI), with typo tolerance. `scope` adds the other entities. Alternatively pass `domains` (no `q`) to resolve brand web domains to covered companies.", "operationId": "get-search", "tags": [ "Search & Meta" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "q", "in": "query", "description": "Search text.", "schema": { "type": "string" } }, { "name": "domains", "in": "query", "description": "Comma-separated brand domains to resolve when `q` is empty; domains beyond the 8th are ignored; at most 6 companies return.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "1–20, default 8.", "schema": { "type": "integer", "minimum": 1, "maximum": 20, "default": 8 } }, { "name": "scope", "in": "query", "description": "`curated` (default): companies, the series a country page opens, countries. `all`: every national and first-level-regional series that holds data, each with `geo` and `id` (GEO:KEY, read with /countries/{geo}/series?key=), plus `commodities`, `fx_pairs`, `people`, `conflicts`, `organisations` and `bonds`, each row with the `id` its route takes and a `score`. `terminal`: the curated series, those six and `crypto` and `indices` (names and ids only, the rows of the terminal's search box). `all` and `terminal` add `interpretations`: what the whole query reads as, by plain rules (\"nvda earnings\" → NVIDIA's Earnings tab, \"uae inflation\" → that country's series, \"war in the middle east\" → conflicts there), each with a `target` naming the page it opens.", "schema": { "type": "string", "enum": [ "curated", "all", "terminal" ], "default": "curated" } }, { "name": "country", "in": "query", "description": "Series: only this ISO alpha-2 country and its regions.", "schema": { "type": "string" } }, { "name": "natural", "in": "query", "description": "1 = a submitted query, perhaps a typed question: when the literal query finds little, rows from the words that carry it join in, and rows scoring under 50 are dropped.", "schema": { "type": "string", "enum": [ "1" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string" }, "companies": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "navId": { "type": "string" }, "cik": { "type": "string" }, "name": { "type": "string" }, "exchange": { "type": "string" }, "countryCode": { "type": "string" }, "sector": { "type": "string" }, "isPrivate": { "type": "boolean" }, "website": { "type": "string" }, "brandMark": { "type": "string" }, "brandMarkChecked": { "type": "boolean" }, "logoUrl": { "type": [ "string", "null" ] }, "match": { "type": "null" }, "score": { "type": "integer" } } } }, "series": { "type": "array", "items": {} }, "countries": { "type": "array", "items": {} } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "query": "nvidia", "companies": [ { "ticker": "NVDA", "navId": "NVDA", "cik": "0001045810", "name": "NVIDIA CORP", "exchange": "Nasdaq", "countryCode": "US", "sector": "Technology", "isPrivate": false, "website": "https://www.nvidia.com", "brandMark": "https://cdn.brandfetch.io/nvidia.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brandMarkChecked": true, "logoUrl": "/api/v1/companies/NVDA/logo", "match": null, "score": 92 } ], "series": [], "countries": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/search/content": { "get": { "summary": "Search news, themes and transcripts", "description": "What a query finds in news, market themes and call transcripts, by its words and by its meaning: each section merges a keyword search with a search of the stored document vectors (Cohere Embed v4), ranked together; `meaning` false says that section is words only (search syntax, a company + topic query, or the meaning search was unavailable). Call rows found by meaning are verified quotes with `matchedBy` \"meaning\". A typed question is reduced to the words that carry it (`terms`), and quoted phrases, OR and -exclusion are honoured as typed. A company and a topic (\"nvda earnings\") are searched within that company. A section with `relaxed` true holds looser rows, because no row had every word and meaning found nothing: all but one of the words, or the company's rows without the topic word. `failed` true means that section's search failed. News rows with the words in the headline lead. Transcripts look back 12 months.", "operationId": "get-search-news-themes-and-transcripts", "tags": [ "Search & Meta" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "q", "in": "query", "description": "Search text.", "schema": { "type": "string", "required": true } }, { "name": "section", "in": "query", "description": "Only this section; all three when omitted.", "schema": { "type": "string", "enum": [ "news", "themes", "transcripts" ] } }, { "name": "limit", "in": "query", "description": "1–20 per section, default 8.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/me": { "get": { "summary": "Who am I", "description": "The calling key's account, plan, limits and live usage — the only account surface an API key can read. Returns the key's display prefix (never the secret), effective plan, per-minute/day/month limits and how much of each remains.", "operationId": "get-who-am-i", "tags": [ "Search & Meta" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "object", "properties": { "prefix": { "type": "string" }, "name": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "lastUsedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "type": "null" } } }, "account": { "type": "object", "properties": { "email": { "type": "string" }, "via": { "type": "string" } } }, "plan": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "perMinute": { "type": "integer" }, "perDay": { "type": "null" }, "monthlyQuota": { "type": "null" }, "purchasable": { "type": "boolean" }, "display": { "type": "object", "properties": { "price": { "type": "string" }, "period": { "type": "string" }, "blurb": { "type": "string" } } } } }, "rate": { "type": "object", "properties": { "limit": { "type": "integer" }, "remaining": { "type": "integer" }, "resetsAt": { "type": "string", "format": "date-time" } } }, "today": { "type": "null" }, "quota": { "type": "null" }, "upgradeUrl": { "type": "null" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "key": { "prefix": "pk_live_M0V1", "name": "Testing", "createdAt": "2026-08-31T05:20:10.435Z", "lastUsedAt": "2026-11-01T12:46:36.171Z", "expiresAt": null }, "account": { "email": "saifmalik.1@outlook.com", "via": "api_key" }, "plan": { "slug": "scale", "name": "Scale", "perMinute": 600, "perDay": null, "monthlyQuota": null, "purchasable": false, "display": { "price": "Custom", "period": "", "blurb": "Custom volume, limits, SLAs and delivery. Talk to us." } }, "rate": { "limit": 600, "remaining": 553, "resetsAt": "2026-11-01T12:48:00.000Z" }, "today": null, "quota": null, "upgradeUrl": null } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies": { "get": { "summary": "List companies", "description": "List published companies. The response carries `total` and a per-country `countries[]` facet. Each row's `routeKey` (ticker for an SEC registrant, else the platform key = `cik`) is the identifier to pass to /companies/{id}; `id` is an internal record id (the primary security's, or the company's when it has no quote) that no route accepts.", "operationId": "get-list-companies", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "country", "in": "query", "description": "ISO-2 country code (US, SA, AE, JP, …); an invalid code is ignored.", "schema": { "type": "string" } }, { "name": "sector", "in": "query", "description": "Filter by sector name.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Name, legal name or ticker contains, plus the global search's top 25 matches (aliases, typos).", "schema": { "type": "string" } }, { "name": "scope", "in": "query", "description": "public (default) = listed companies; private = the private-company lane (XPRV keys); all = both; delisted = listed issuers with a recorded delisting date. Another value is a 400.", "schema": { "type": "string", "enum": [ "public", "private", "all", "delisted" ], "default": "public" } }, { "name": "sort", "in": "query", "description": "Sort column; default market-cap ranking.", "schema": { "type": "string", "enum": [ "name", "price", "net_change", "change", "volume", "market_cap", "pe" ] } }, { "name": "direction", "in": "query", "description": "asc or desc (default).", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "desc" } }, { "name": "limit", "in": "query", "description": "1–1000, default 100; above 1000 is a 400 (page with offset).", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 100 } }, { "name": "offset", "in": "query", "description": "Default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "legal_name": { "type": "string" }, "cik": { "type": "string" }, "ticker": { "type": "string" }, "exchange": { "type": "string" }, "country_code": { "type": "string" }, "sector": { "type": "string" }, "industry": { "type": [ "string", "null" ] }, "price": { "type": "number" }, "listing_currency": { "type": "string" }, "change_percent": { "type": "number" }, "volume": { "type": "integer" }, "market_cap": { "type": "integer" }, "pe_ratio": { "type": "number" }, "fx_per_usd": { "type": [ "number", "null" ] }, "logo_png_s3_key": { "type": [ "string", "null" ] }, "website": { "type": "string" }, "latest_filing_date": { "type": [ "string", "null" ], "format": "date" }, "brand_mark": { "type": "string" }, "brand_mark_checked": { "type": "boolean" }, "share_classes": { "type": "null" }, "routeKey": { "type": "string" } } } }, "total": { "type": "integer" }, "countries": { "type": "array", "items": { "type": "object", "properties": { "country_code": { "type": "string" }, "count": { "type": "integer" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "companies": [ { "id": "33c210d5-7e67-436a-b240-96ba73998b12", "name": "Apple Inc.", "legal_name": "Apple Inc.", "cik": "0000320193", "ticker": "AAPL", "exchange": "Nasdaq", "country_code": "US", "sector": "Technology", "industry": "Consumer Electronics", "price": 344.63, "listing_currency": "USD", "change_percent": -1.22668, "volume": 67842804, "market_cap": 5034686918690, "pe_ratio": 39.5672, "fx_per_usd": null, "logo_png_s3_key": "logos/cik=0000320193/512.png", "website": "https://www.apple.com", "latest_filing_date": "2026-07-31", "brand_mark": "https://cdn.brandfetch.io/apple.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brand_mark_checked": true, "share_classes": null, "routeKey": "AAPL" }, { "id": "3dc3b782-6b1c-455e-80ff-d4e8f07a09f3", "name": "NVIDIA CORP", "legal_name": "NVIDIA CORP", "cik": "0001045810", "ticker": "NVDA", "exchange": "Nasdaq", "country_code": "US", "sector": "Technology", "industry": "Semiconductors", "price": 204.64, "listing_currency": "USD", "change_percent": -4.22166, "volume": 165923799, "market_cap": 4941442080000, "pe_ratio": 25.871, "fx_per_usd": null, "logo_png_s3_key": "logos/cik=0001045810/512.png", "website": "https://www.nvidia.com", "latest_filing_date": "2026-08-26", "brand_mark": "https://cdn.brandfetch.io/nvidia.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brand_mark_checked": true, "share_classes": null, "routeKey": "NVDA" } ], "total": 1665, "countries": [ { "country_code": "US", "count": 623 }, { "country_code": "SA", "count": 376 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/sparklines": { "get": { "summary": "Price sparklines", "description": "Compact price sparklines for up to 500 companies, keyed by the identifier sent in upper case. Identifiers that resolve to nothing are left out.", "operationId": "get-price-sparklines", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "ids", "in": "query", "description": "Comma-separated tickers, CIKs or platform keys (XADS000003). A bare ticker shared across exchanges resolves to the EDGAR issuer; address others by key.", "schema": { "type": "string" } }, { "name": "tickers", "in": "query", "description": "Alias of ids (older clients).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "sparklines": { "type": "object", "properties": { "NVDA": { "type": "array", "items": { "type": "number" } }, "AAPL": { "type": "array", "items": { "type": "number" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "sparklines": { "NVDA": [ 132.759995, 177 ], "AAPL": [ 225.910004, 311 ] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}": { "get": { "summary": "Company profile", "description": "Company profile: identity, sector, latest filing, quote, key metrics, corporate lineage. Pass `routeKey` (the ticker for an SEC registrant, else the platform key, = `cik`) or `cik` back to every /companies/{id} route; `id` is an internal record id that no route accepts. Missing values are null, never 0 or \"N/A\": `price`, `change`, `changePercent`, `prevClose`, `open` are null without a quote, and the `afterHours*` fields are null where the market has no post-market session (every Gulf exchange). Prices are in `listing_currency`; `change` is in that currency and `changePercent` in percent (1.5 = 1.5%). `marketCap`, `marketCapFull`, `volume`, `avgVolume`, `range52w`, `employees`, `float` and `ipoDate` are display strings; the numbers are `marketCapValue` (listing currency, `marketCapCurrency`) and `marketCapUsd` (at the latest stored reference rate; null without one), and the date is `ipoDateIso` (YYYY-MM-DD, or YYYY-MM / YYYY per `ipoDatePrecision`; null when no source dates the first listing). `peRatio` is the trailing P/E (fresh key metrics only), `beta` the vendor beta, `eps` trailing diluted EPS in the listing currency. `dividendYield` is the platform's trailing-12-month dividends per share (this security's dividend record, split-adjusted) ÷ latest quote, in percent (0.13 = 0.13%; null without a dividend record or quote); `statistics.dps` is that same trailing DPS and `statistics.payout` is DPS × listed-share equivalents ÷ TTM net income (not cash-flow dividends paid). Operands in `statistics.calc.dividendYield` / `.dps` / `.payout`.", "operationId": "get-company-profile", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "company": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": "string" }, "symbol": { "type": "string" }, "ticker": { "type": "string" }, "logoUrl": { "type": "string" }, "brandMark": { "type": "string" }, "brandMarkChecked": { "type": "boolean" }, "domain": { "type": "string" }, "routeKey": { "type": "string" }, "country": { "type": "string" }, "sector": { "type": "string" }, "exchange": { "type": "string" }, "listing_currency": { "type": "string" }, "hasQuote": { "type": "boolean" }, "delisting_date": { "type": "null" }, "price": { "type": "number" }, "change": { "type": "number" }, "changePercent": { "type": "number" }, "afterHoursPrice": { "type": [ "number", "null" ] }, "afterHoursChange": { "type": [ "number", "null" ] }, "afterHoursChangePercent": { "type": [ "number", "null" ] }, "parent_registrant": { "type": "null" }, "legal_name": { "type": "string" }, "country_code": { "type": "string" }, "secondary_offerings": { "type": "array", "items": {} }, "subsidiaries": { "type": "array", "items": {} }, "lineage_events": { "type": "array", "items": {} }, "prevClose": { "type": "number" }, "open": { "type": "number" }, "dayHigh": { "type": "number" }, "dayLow": { "type": "number" }, "marketCap": { "type": "string" }, "marketCapFull": { "type": "string" }, "marketCapValue": { "type": "integer" }, "marketCapCurrency": { "type": "string" }, "marketCapUsd": { "type": "number" }, "reporting_currency": { "type": "string" }, "primary_accounting_basis": { "type": "string" }, "accounting_bases": { "type": "array", "items": { "type": "object", "properties": { "basis": { "type": "string" }, "rulebook": { "type": "string" }, "regulator": { "type": "string" }, "label": { "type": "string" }, "cik": { "type": "string" }, "is_primary": { "type": "boolean" } } } }, "fiscal_label_style": { "type": "string" }, "volume": { "type": "string" }, "avgVolume": { "type": "string" }, "range52w": { "type": "string" }, "industry": { "type": "string" }, "description": { "type": "string" }, "ipoDate": { "type": "string" }, "ipoDateIso": { "type": "string", "format": "date" }, "ipoDatePrecision": { "type": "string" }, "listing": { "type": "object", "properties": { "listedSince": { "type": "string", "format": "date" }, "listedSincePrecision": { "type": "string" }, "firstListingMarket": { "type": "null" }, "currentMarket": { "type": "null" }, "marketTransferDate": { "type": "null" }, "offeringDate": { "type": "null" }, "source": { "type": "string" } } }, "listingStatus": { "type": "string" }, "gics": { "type": "null" }, "ceo": { "type": "string" }, "employees": { "type": [ "string", "null" ] }, "float": { "type": "string" }, "peRatio": { "type": "number" }, "dividendYield": { "type": "number" }, "beta": { "type": "number" }, "eps": { "type": "number" }, "revenue": { "type": "integer" }, "statistics": { "type": "object", "properties": { "fundamentalsAsOf": { "type": "string", "format": "date" }, "currency": { "type": "string" }, "enterpriseValue": { "type": "number" }, "sharesOutstanding": { "type": "integer" }, "ttmRevenue": { "type": "number" }, "grossMargin": { "type": "number" }, "ebitdaMargin": { "type": "number" }, "operatingMargin": { "type": "number" }, "preTaxMargin": { "type": "number" }, "netMargin": { "type": "number" }, "fcfMargin": { "type": "number" }, "roa": { "type": "number" }, "roe": { "type": "number" }, "roce": { "type": "number" }, "roic": { "type": "number" }, "peTtm": { "type": "number" }, "pb": { "type": "number" }, "psTtm": { "type": "number" }, "evSales": { "type": "number" }, "evEbitda": { "type": "number" }, "pFcf": { "type": "number" }, "evGrossProfit": { "type": "number" }, "priceTarget": { "type": "number" }, "peNtm": { "type": "number" }, "peg": { "type": [ "number", "null" ] }, "cash": { "type": "number" }, "netDebt": { "type": "number" }, "debtEquity": { "type": "number" }, "ebitInterest": { "type": "number" }, "revGrowthYoY": { "type": "number" }, "epsGrowthYoY": { "type": "number" }, "revCagr3y": { "type": "number" }, "epsCagr3y": { "type": "number" }, "payout": { "type": "number" }, "dps": { "type": "number" }, "calc": { "type": "object", "properties": { "peTtm": { "type": "object", "properties": { "formula": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "number" }, "format": { "type": "string" }, "qualifier": { "type": "string" } } } }, "note": { "type": "string" }, "asOf": { "type": "string" } } }, "ev": { "type": "object", "properties": { "formula": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "number" }, "format": { "type": "string" }, "qualifier": { "type": "string" } } } }, "note": { "type": "string" }, "asOf": { "type": "string" } } }, "ttmRevenue": { "type": "object", "properties": { "formula": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "number" }, "format": { "type": "string" } } } }, "note": { "type": "string" }, "asOf": { "type": "string" } } }, "grossMargin": { "type": "object", "properties": { "formula": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "number" }, "format": { "type": "string" } } } }, "note": { "type": "string" }, "asOf": { "type": "string" } } }, "ebitdaMargin": { "type": "object", "properties": { "formula": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "number" }, "format": { "type": "string" } } } }, "note": { "type": "string" }, "asOf": { "type": "string" } } }, "operatingMargin": { "type": "object", "properties": { "formula": { "type": "string" }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "number" }, "format": { "type": "string" } } } }, "note": { "type": "string" }, "asOf": { "type": "string" } } } } } } }, "business_summary": { "type": "string" }, "employee_count": { "type": [ "integer", "null" ] }, "incorporation_date": { "type": "null" }, "net_income": { "type": [ "integer", "null" ] }, "total_assets": { "type": [ "integer", "null" ] }, "total_equity": { "type": [ "integer", "null" ] }, "shares_outstanding": { "type": "integer" }, "latest_filing": { "type": [ "object", "null" ], "properties": { "fiscal_year": { "type": "integer" }, "fiscal_quarter": { "type": "integer" }, "period_end_date": { "type": "string", "format": "date-time" }, "filing_type": { "type": "string" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "company": { "id": "69d1debf-37a7-4959-b4e5-6030b5ac1a84", "name": "NVIDIA CORP", "cik": "0001045810", "symbol": "NVDA", "ticker": "NVDA", "logoUrl": "/api/v1/companies/NVDA/logo", "brandMark": "https://cdn.brandfetch.io/nvidia.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brandMarkChecked": true, "domain": "https://www.nvidia.com", "routeKey": "NVDA", "country": "US", "sector": "Technology", "exchange": "Nasdaq", "listing_currency": "USD", "hasQuote": true, "delisting_date": null, "price": 204.64, "change": -9.02, "changePercent": -4.22166, "afterHoursPrice": 205.2499, "afterHoursChange": 0.609894, "afterHoursChangePercent": 0.298033, "parent_registrant": null, "legal_name": "NVIDIA CORP", "country_code": "US", "secondary_offerings": [], "subsidiaries": [], "lineage_events": [], "prevClose": 213.66, "open": 208.88, "dayHigh": 209.05, "dayLow": 200.9199, "marketCap": "$4.94T", "marketCapFull": "4,941,441,662,976", "marketCapValue": 4941441662976, "marketCapCurrency": "USD", "marketCapUsd": 4941441662976, "reporting_currency": "USD", "primary_accounting_basis": "us-gaap", "accounting_bases": [ { "basis": "us-gaap", "rulebook": "US GAAP", "regulator": "SEC 10-K", "label": "SEC 10-K · US GAAP", "cik": "0001045810", "is_primary": true } ], "fiscal_label_style": "end_year", "volume": "165.92M", "avgVolume": "113.67M", "range52w": "164.27 – 243.37", "industry": "Semiconductors", "description": "NVIDIA Corporation operates as a data center scale AI infrastructure company in the United States, Taiwan, China, Hong Kong, Europe, and internationally. It operates through Compute & Networking, and …", "ipoDate": "Jan 22, 1999", "ipoDateIso": "1999-01-22", "ipoDatePrecision": "day", "listing": { "listedSince": "1999-01-22", "listedSincePrecision": "day", "firstListingMarket": null, "currentMarket": null, "marketTransferDate": null, "offeringDate": null, "source": "sec_prospectus" }, "listingStatus": "listed", "gics": null, "ceo": "Jen-Hsun Huang", "employees": "42,000", "float": "23.13B shares", "peRatio": 25.871, "dividendYield": 0.13193901485535575, "beta": 2.216, "eps": 7.91, "revenue": 177837000000, "statistics": { "fundamentalsAsOf": "2026-07-26", "currency": "USD", "enterpriseValue": 4918222080000, "sharesOutstanding": 24147000000, "ttmRevenue": 302969000000, "grossMargin": 74.6746, "ebitdaMargin": 66.4312, "operatingMargin": 65.2143, "preTaxMargin": 75.8309, "netMargin": 63.6629, "fcfMargin": 41.9205, "roa": 60.2235, "roe": 84.2325, "roce": 71.2631, "roic": 80.6143, "peTtm": 25.871, "pb": 21.5799, "psTtm": 16.3101, "evSales": 16.2334, "evEbitda": 24.4364, "pFcf": 38.9072, "evGrossProfit": 21.7389, "priceTarget": 328.95346, "peNtm": 12.8586, "peg": 0.2606, "cash": 56586000000, "netDebt": -23220000000, "debtEquity": 0.1457, "ebitInterest": 426.7365, "revGrowthYoY": 83.3753, "epsGrowthYoY": 124.7159, "revCagr3y": 100.0451, "epsCagr3y": 204.2395, "payout": 3.3801969110167516, "dps": 0.27, "calc": { "peTtm": { "formula": "Price ÷ EPS (TTM, diluted)", "inputs": [ { "label": "Price", "value": 204.64, "format": "price", "qualifier": "primary listing; fresher of latest close vs live quote" }, { "label": "EPS (TTM)", "value": 7.91, "format": "per_share", "qualifier": "diluted, split-adjusted; sum of last 4 fiscal quarters" } ], "note": "TTM = sum of the last 4 distinct fiscal quarters as known on the metric date (a fiscal Q4 not separately reported is derived as FY minus Q1–Q3).", "asOf": "price as of 2026-10-30 · fundamentals through 2026-07-26" }, "ev": { "formula": "Market Cap + Total Debt − Cash & ST Investments", "inputs": [ { "label": "Market Cap", "value": 4941442080000, "format": "currency" }, { "label": "Total Debt", "value": 33366000000, "format": "currency", "qualifier": "long-term debt incl. current portion" } ], "note": "Balance-sheet figures are from the latest filed balance sheet (period end 2026-07-26).", "asOf": "price as of 2026-10-30 · fundamentals through 2026-07-26" }, "ttmRevenue": { "formula": "Sum of the last 4 fiscal quarters' revenue", "inputs": [ { "label": "Revenue (TTM)", "value": 302969000000, "format": "currency" } ], "note": "TTM = sum of the last 4 distinct fiscal quarters as known on the metric date (a fiscal Q4 not separately reported is derived as FY minus Q1–Q3).", "asOf": "price as of 2026-10-30 · fundamentals through 2026-07-26" }, "grossMargin": { "formula": "Gross Profit (TTM) ÷ Revenue (TTM)", "inputs": [ { "label": "Gross Profit (TTM)", "value": 226241000000, "format": "currency" }, { "label": "Revenue (TTM)", "value": 302969000000, "format": "currency" } ], "note": "TTM = sum of the last 4 distinct fiscal quarters as known on the metric date (a fiscal Q4 not separately reported is derived as FY minus Q1–Q3).", "asOf": "price as of 2026-10-30 · fundamentals through 2026-07-26" }, "ebitdaMargin": { "formula": "EBITDA (TTM) ÷ Revenue (TTM)", "inputs": [ { "label": "EBITDA (TTM)", "value": 201266000000, "format": "currency" }, { "label": "Revenue (TTM)", "value": 302969000000, "format": "currency" } ], "note": "EBITDA = operating income + depreciation & amortization. TTM = sum of the last 4 distinct fiscal quarters as known on the metric date (a fiscal Q4 not separately reported is derived as FY minus Q1–Q3)…", "asOf": "price as of 2026-10-30 · fundamentals through 2026-07-26" }, "operatingMargin": { "formula": "Operating Income (TTM) ÷ Revenue (TTM)", "inputs": [ { "label": "Operating Income (TTM)", "value": 197579000000, "format": "currency" }, { "label": "Revenue (TTM)", "value": 302969000000, "format": "currency" } ], "note": "TTM = sum of the last 4 distinct fiscal quarters as known on the metric date (a fiscal Q4 not separately reported is derived as FY minus Q1–Q3).", "asOf": "price as of 2026-10-30 · fundamentals through 2026-07-26" } } }, "business_summary": "NVIDIA Corporation operates as a data center scale AI infrastructure company in the United States, Taiwan, China, Hong Kong, Europe, and internationally. It operates through Compute & Networking, and …", "employee_count": 42000, "incorporation_date": null, "net_income": 45197000000, "total_assets": 206803000000, "total_equity": 83843000000, "shares_outstanding": 24147000000, "latest_filing": { "fiscal_year": 2027, "fiscal_quarter": 2, "period_end_date": "2026-07-26T00:00:00.000Z", "filing_type": "10-Q" } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/logo": { "get": { "summary": "Company logo", "description": "Company emblem image.", "operationId": "get-company-logo", "tags": [ "Company Data" ], "x-tier": "public", "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/financials": { "get": { "summary": "Financial statements", "description": "Standardized income statement, balance sheet and cash flow, and on request ratios, the segments & KPIs statement and the as-filed XBRL trees; each cell traceable to its source fact (fact-source). Periods are newest first by period end: `limit` periods (default 10) after skipping `period_offset`, plus the trailing-twelve-month column (TTM) in the newest window; `periods` says how much history exists (`available`) and `next_period_offset` reads the next older window (null on the last). `statements` picks the sections (default the three primary statements); `include_calc` adds each ratio cell's formula and inputs. Rows are keyed std:; columns are period labels described in period_meta. Latest restated vintage; the as-filed view is financials/as-filed. A cell absent from `values` is withheld or never reported, not zero. `cik` is the resolved company; `company_id` echoes the id sent.", "operationId": "get-financial-statements", "tags": [ "Financial Statements" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "period_type", "in": "query", "description": "annual, semiannual (H1 = the filer's six-month figures, H2 = FY − H1 derived) or quarterly.", "schema": { "type": "string", "enum": [ "annual", "semiannual", "quarterly" ], "default": "annual" } }, { "name": "reporting_basis", "in": "query", "description": "Quarterly / semiannual only: latest_restated (default; `individual` is the same) = the discrete quarter; as_reported = the cumulative year-to-date column as printed. A period basis — the as-filed view is financials/as-filed.", "schema": { "type": "string", "enum": [ "latest_restated", "individual", "as_reported" ], "default": "latest_restated" } }, { "name": "basis", "in": "query", "description": "Accounting basis to serve (us-gaap, ifrs-iasb, ifrs-tw, k-ifrs, ifrs-eu, cas, …). Default = the company's primary basis; other values must be one of the bases advertised in the company payload (accounting_bases) — e.g. ifrs-tw returns TSMC's Taiwan statutory statements beside its 20-F. One response never mixes bases.", "schema": { "type": "string" } }, { "name": "statements", "in": "query", "description": "Comma-separated sections: income_statement, balance_sheet, cash_flow_statement, ratios, segments_kpis, income_statement_reported, balance_sheet_reported, cash_flow_statement_reported (the *_reported trees exist for XBRL filers only), or all. Default income_statement,balance_sheet,cash_flow_statement. An unknown name is a 400.", "schema": { "type": "string", "default": "income_statement,balance_sheet,cash_flow_statement" } }, { "name": "include_calc", "in": "query", "description": "Add each ratio cell's formula and inputs (`calc`); requires ratios in `statements`. Large; default false.", "schema": { "type": "boolean", "default": false } }, { "name": "limit", "in": "query", "description": "Newest periods to return, by period end, after `period_offset`: 1–200, default 10. Above 200 is a 400.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 10 } }, { "name": "period_offset", "in": "query", "description": "Skip this many newest periods first: the previous reply's periods.next_period_offset. 0–1000, default 0.", "schema": { "type": "integer", "minimum": 0, "maximum": 1000, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "company_id": { "type": "string" }, "cik": { "type": "string" }, "period_type": { "type": "string" }, "reporting_basis": { "type": "string" }, "statements": { "type": "array", "items": { "type": "string" } }, "periods": { "type": "object", "properties": { "returned": { "type": "array", "items": { "type": "string" } }, "newest_first": { "type": "boolean" }, "available": { "type": "integer" }, "newest_available": { "type": "string" }, "oldest_available": { "type": "string" }, "period_offset": { "type": "integer" }, "next_period_offset": { "type": "integer" } } }, "financials": { "type": "object", "properties": { "income_statement": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "values": { "type": "object", "properties": { "2024": { "type": "number" }, "2025": { "type": "number" }, "Q2 2027": { "type": "number" }, "Q1 2027": { "type": "number" }, "TTM": { "type": "number" } } }, "sort_order": { "type": "integer" }, "depth": { "type": "integer" }, "is_header": { "type": "boolean" }, "is_total": { "type": "boolean" }, "computed": { "type": "boolean" }, "default_collapsed": { "type": "boolean" }, "negated": { "type": "boolean" }, "no_scale": { "type": "boolean" }, "parent_key": { "type": "string" }, "percent": { "type": "boolean" }, "ratio_numerator": { "type": "string" }, "ratio_denominator": { "type": "string" }, "merged_from": { "type": "array", "items": { "type": "string" } } } } } } }, "balance_sheet": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "values": { "type": "object", "properties": { "2024": { "type": "integer" }, "2025": { "type": "integer" }, "Q2 2027": { "type": "integer" }, "Q1 2027": { "type": "integer" } } }, "sort_order": { "type": "integer" }, "depth": { "type": "integer" }, "is_header": { "type": "boolean" }, "computed": { "type": "boolean" }, "default_collapsed": { "type": "boolean" }, "negated": { "type": "boolean" }, "no_scale": { "type": "boolean" }, "parent_key": { "type": "string" }, "is_total": { "type": "boolean" }, "combined_from": { "type": "object", "properties": { "Q2 2027": { "type": "array", "items": { "type": "string" } }, "Q1 2027": { "type": "array", "items": { "type": "string" } } } } } } } } }, "cash_flow_statement": { "type": "object", "properties": { "data": { "type": "object", "additionalProperties": { "type": "object", "properties": { "label": { "type": "string" }, "values": { "type": "object", "properties": { "2024": { "type": "integer" }, "2025": { "type": "integer" }, "Q2 2027": { "type": "integer" }, "Q1 2027": { "type": "integer" } } }, "sort_order": { "type": "integer" }, "depth": { "type": "integer" }, "is_header": { "type": "boolean" }, "computed": { "type": "boolean" }, "default_collapsed": { "type": "boolean" }, "negated": { "type": "boolean" }, "no_scale": { "type": "boolean" }, "parent_key": { "type": "string" }, "combined_from": { "type": "object", "properties": { "Q1 2027": { "type": "array", "items": { "type": "string" } }, "Q2 2027": { "type": "array", "items": { "type": "string" } } } }, "is_total": { "type": "boolean" } } } } } }, "period_meta": { "type": "object", "properties": { "2024": { "type": "object", "properties": { "end_date": { "type": "string", "format": "date" }, "fiscal_year": { "type": "integer" }, "fiscal_quarter": { "type": "null" }, "source": { "type": "string" } } }, "2025": { "type": "object", "properties": { "end_date": { "type": "string", "format": "date" }, "fiscal_year": { "type": "integer" }, "fiscal_quarter": { "type": "null" }, "source": { "type": "string" } } }, "Q2 2027": { "type": "object", "properties": { "end_date": { "type": "string", "format": "date" }, "fiscal_year": { "type": "integer" }, "fiscal_quarter": { "type": "integer" } } }, "Q1 2027": { "type": "object", "properties": { "end_date": { "type": "string", "format": "date" }, "fiscal_year": { "type": "integer" }, "fiscal_quarter": { "type": "integer" } } } } }, "reporting_currency": { "type": "string" }, "accounting_basis": { "type": "string" }, "accounting_basis_label": { "type": "string" }, "accounting_bases": { "type": "array", "items": { "type": "object", "properties": { "basis": { "type": "string" }, "rulebook": { "type": "string" }, "regulator": { "type": "string" }, "label": { "type": "string" }, "cik": { "type": "string" }, "is_primary": { "type": "boolean" } } } }, "interim_cadence": { "type": "string" }, "ttm_cadence": { "type": [ "string", "null" ] }, "ttm_period_end": { "type": [ "string", "null" ], "format": "date" }, "fx_usd_rates": { "type": "object", "properties": { "2022": { "type": "number" }, "2023": { "type": "number" }, "2024": { "type": "number" }, "2025": { "type": "number" }, "TTM": { "type": "number" } } } } }, "total_periods": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "company_id": "NVDA", "cik": "0001045810", "period_type": "quarterly", "reporting_basis": "individual", "statements": [ "income_statement", "balance_sheet" ], "periods": { "returned": [ "Q2 2027", "Q1 2027" ], "newest_first": true, "available": 114, "newest_available": "Q2 2027", "oldest_available": "Q1 1997", "period_offset": 0, "next_period_offset": 2 }, "financials": { "income_statement": { "data": { "std:revenue": { "label": "Total Revenue", "values": { "Q2 2027": 96221000000, "Q1 2027": 81615000000 }, "sort_order": 0, "depth": 1, "is_header": false, "is_total": true, "computed": false, "default_collapsed": true }, "us-gaap:Revenues": { "label": "Revenue", "values": { "Q2 2027": 96221000000, "Q1 2027": 81615000000 }, "sort_order": 1, "depth": 2, "is_header": false, "negated": false, "no_scale": false, "parent_key": "std:revenue" }, "std:cost_of_revenue": { "label": "Cost of Revenue", "values": { "Q2 2027": 24079000000, "Q1 2027": 20458000000 }, "sort_order": 2, "depth": 1, "is_header": false, "computed": false, "default_collapsed": true }, "us-gaap:CostOfRevenue": { "label": "Cost of revenue", "values": { "Q2 2027": 24079000000, "Q1 2027": 20458000000 }, "sort_order": 3, "depth": 2, "is_header": false, "negated": false, "no_scale": false, "parent_key": "std:cost_of_revenue" }, "std:gross_margin": { "label": "Gross Margin", "values": { "Q2 2027": 0.7497531723844068, "Q1 2027": 0.749335293757275 }, "sort_order": 6, "depth": 1, "is_header": false, "percent": true, "no_scale": true, "computed": true, "default_collapsed": false, "ratio_numerator": "std:gross_profit", "ratio_denominator": "std:revenue" }, "us-gaap:InterestExpenseNonoperating": { "label": "Interest expense", "values": { "Q2 2027": -227000000, "Q1 2027": -102000000 }, "sort_order": 19, "depth": 2, "is_header": false, "negated": true, "no_scale": false, "merged_from": [ "Interest expense" ], "parent_key": "std:interest_expense" } } }, "balance_sheet": { "data": { "std:h_current_assets": { "label": "Current Assets", "values": {}, "sort_order": 0, "depth": 0, "is_header": true }, "std:cash": { "label": "Cash & Cash Equivalents", "values": { "Q2 2027": 22443000000, "Q1 2027": 13237000000 }, "sort_order": 1, "depth": 1, "is_header": false, "computed": false, "default_collapsed": true }, "us-gaap:CashAndCashEquivalentsAtCarryingValue": { "label": "Cash and cash equivalents", "values": { "Q2 2027": 22443000000, "Q1 2027": 13237000000 }, "sort_order": 2, "depth": 2, "is_header": false, "negated": false, "no_scale": false, "parent_key": "std:cash" }, "std:cash_and_sti": { "label": "Total Cash & Short-Term Investments", "values": { "Q2 2027": 22443000000, "Q1 2027": 13237000000 }, "sort_order": 5, "depth": 1, "is_header": false, "is_total": true, "computed": false, "default_collapsed": false }, "std:receivables": { "label": "Accounts Receivable", "values": { "Q2 2027": 63059000000, "Q1 2027": 40710000000 }, "sort_order": 6, "depth": 1, "is_header": false, "computed": false, "default_collapsed": true }, "std:common_stock_apic": { "label": "Common Stock & Paid-in Capital", "values": { "Q2 2027": 9852000000, "Q1 2027": 10299000000 }, "sort_order": 60, "depth": 1, "is_header": false, "computed": false, "default_collapsed": true, "combined_from": { "Q2 2027": [ "Common stock", "Additional paid-in capital" ], "Q1 2027": [ "Common stock", "Additional paid-in capital" ] } } } }, "cash_flow_statement": { "data": { "std:h_operating": { "label": "Operating Activities", "values": {}, "sort_order": 0, "depth": 0, "is_header": true }, "std:cfs_net_income": { "label": "Net Income", "values": { "Q2 2027": 59688000000, "Q1 2027": 58321000000 }, "sort_order": 1, "depth": 1, "is_header": false, "computed": false, "default_collapsed": true }, "us-gaap:NetIncomeLoss": { "label": "Net income", "values": { "Q2 2027": 59688000000, "Q1 2027": 58321000000 }, "sort_order": 2, "depth": 2, "is_header": false, "negated": false, "no_scale": false, "parent_key": "std:cfs_net_income" }, "std:dna": { "label": "Depreciation & Amortization", "values": { "Q2 2027": 1127000000, "Q1 2027": 997000000 }, "sort_order": 3, "depth": 1, "is_header": false, "computed": false, "default_collapsed": true }, "std:chg_other_wc": { "label": "Changes in Other Working Capital", "values": { "Q1 2027": 234000000, "Q2 2027": -4744000000 }, "sort_order": 22, "depth": 1, "is_header": false, "computed": false, "default_collapsed": true, "combined_from": { "Q1 2027": [ "Prepaid expenses and other assets", "Other long-term liabilities" ], "Q2 2027": [ "Prepaid expenses and other assets", "Other long-term liabilities" ] } }, "std:cfo": { "label": "Cash from Operating Activities", "values": { "Q2 2027": 24077000000, "Q1 2027": 50344000000 }, "sort_order": 26, "depth": 1, "is_header": false, "is_total": true, "computed": false, "default_collapsed": true } } }, "period_meta": { "Q2 2027": { "end_date": "2026-07-26", "fiscal_year": 2027, "fiscal_quarter": 2 }, "Q1 2027": { "end_date": "2026-04-26", "fiscal_year": 2027, "fiscal_quarter": 1 } }, "reporting_currency": "USD", "accounting_basis": "us-gaap", "accounting_basis_label": "SEC 10-K · US GAAP", "accounting_bases": [ { "basis": "us-gaap", "rulebook": "US GAAP", "regulator": "SEC 10-K", "label": "SEC 10-K · US GAAP", "cik": "0001045810", "is_primary": true } ], "interim_cadence": "quarterly", "ttm_cadence": null, "ttm_period_end": null }, "total_periods": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/financials/as-filed": { "get": { "summary": "Statements as filed", "description": "The statement exactly as the company filed it, across its whole history: every line item it ever printed (one row per printed caption — a renamed line is a new row, a discontinued line keeps its row and the period it was last used), one column per reporting period, values in units as filed. Captions, order and section headers come from the filing's own rendered statement page for inline-XBRL filings (2019→) and from its label linkbase before that; printed PDF / HTML statements serve through the same shape.", "operationId": "get-statements-as-filed", "tags": [ "Financial Statements" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "statement", "in": "query", "description": "income_statement | comprehensive_income | balance_sheet | balance_sheet_parenthetical | cash_flow_statement | equity | all (all = every statement the company has, empty ones omitted).", "schema": { "type": "string", "enum": [ "income_statement", "comprehensive_income", "balance_sheet", "balance_sheet_parenthetical", "cash_flow_statement", "equity", "all" ] }, "required": true }, { "name": "period_type", "in": "query", "description": "annual, semiannual or quarterly.", "schema": { "type": "string", "enum": [ "annual", "semiannual", "quarterly" ], "default": "annual" } }, { "name": "reporting_basis", "in": "query", "description": "Quarterly / semiannual: individual (default) = the discrete period; as_reported = the cumulative year-to-date column as printed.", "schema": { "type": "string", "enum": [ "individual", "as_reported" ], "default": "individual" } }, { "name": "vintage", "in": "query", "description": "original = each period from the filing the company made for it (what it first reported); latest = each period from the newest filing that carries it (restated comparatives).", "schema": { "type": "string", "enum": [ "original", "latest" ], "default": "original" } }, { "name": "format", "in": "query", "description": "json, csv or xlsx (csv/xlsx stream a download; with statement=all, one block or sheet per statement, xlsx adds a Provenance sheet).", "schema": { "type": "string", "enum": [ "json", "csv", "xlsx" ], "default": "json" } }, { "name": "from", "in": "query", "description": "First period end, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last period end, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Latest N columns in range, 1–200 (else 400); adds `window`. Omitted = every column.", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "lane": { "type": "string" }, "statement": { "type": "string" }, "periodType": { "type": "string" }, "reportingBasis": { "type": "string" }, "vintage": { "type": "string" }, "currency": { "type": [ "string", "null" ] }, "columns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "null" }, "ownDocRef": { "type": "string" } } } }, "rows": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "caption": { "type": "string" }, "depth": { "type": "integer" }, "isHeader": { "type": "boolean" }, "isTotal": { "type": "boolean" }, "concept": { "type": [ "string", "null" ] }, "concepts": { "type": "array", "items": { "type": "string" } }, "member": { "type": "null" }, "labelRole": { "type": "null" }, "noScale": { "type": "boolean" }, "firstPeriod": { "type": "string" }, "lastPeriod": { "type": "string" }, "mapped": { "type": [ "boolean", "null" ] }, "cells": { "type": "object", "properties": { "2024": { "type": "object", "properties": { "value": { "type": "number" }, "raw": { "type": "string" }, "docRef": { "type": "string" }, "vintage": { "type": "string" }, "page": { "type": "integer" }, "durationBasis": { "type": "string" } } }, "2025": { "type": "object", "properties": { "value": { "type": "number" }, "docRef": { "type": "string" }, "vintage": { "type": "string" }, "concept": { "type": "string" }, "raw": { "type": "string" }, "page": { "type": "integer" }, "durationBasis": { "type": "string" } } }, "2026": { "type": "object", "properties": { "value": { "type": "number" }, "docRef": { "type": "string" }, "vintage": { "type": "string" }, "concept": { "type": "string" } } } } } } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "docRef": { "type": "string" }, "filingType": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "null" }, "publishedDate": { "type": "string", "format": "date" }, "lane": { "type": "string" }, "certified": { "type": "boolean" } } } }, "lanes": { "type": "array", "items": { "type": "string" } }, "window": { "type": "object", "properties": { "from": { "type": "null" }, "to": { "type": "null" }, "limit": { "type": "integer" }, "totalColumns": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "lane": "xbrl", "statement": "income_statement", "periodType": "annual", "reportingBasis": "individual", "vintage": "original", "currency": null, "columns": [ { "key": "2025", "periodEnd": "2025-01-26", "fiscalYear": 2025, "fiscalQuarter": null, "ownDocRef": "0001045810-25-000023" }, { "key": "2026", "periodEnd": "2026-01-25", "fiscalYear": 2026, "fiscalQuarter": null, "ownDocRef": "0001045810-26-000021" } ], "rows": [ { "id": "L|revenue", "caption": "Revenue", "depth": 0, "isHeader": false, "isTotal": true, "concept": "us-gaap:Revenues", "concepts": [ "us-gaap:Revenues", "us-gaap:RevenueFromContractWithCustomerExcludingAssessedTax" ], "member": null, "labelRole": null, "noScale": false, "firstPeriod": "2002", "lastPeriod": "2026", "mapped": null, "cells": { "2025": { "value": 130497000000, "docRef": "0001045810-25-000023", "vintage": "own", "concept": "us-gaap:Revenues" }, "2026": { "value": 215938000000, "docRef": "0001045810-26-000021", "vintage": "own", "concept": "us-gaap:Revenues" } } }, { "id": "L|basic~netincomepershare|us-gaap:EarningsPerShareBasic", "caption": "Basic", "depth": 0, "isHeader": false, "isTotal": false, "concept": "us-gaap:EarningsPerShareBasic", "concepts": [ "us-gaap:EarningsPerShareBasic" ], "member": null, "labelRole": null, "noScale": true, "firstPeriod": "2020", "lastPeriod": "2026", "mapped": null, "cells": { "2025": { "value": 2.97, "docRef": "0001045810-25-000023", "vintage": "own", "concept": "us-gaap:EarningsPerShareBasic" }, "2026": { "value": 4.93, "docRef": "0001045810-26-000021", "vintage": "own", "concept": "us-gaap:EarningsPerShareBasic" } } } ], "documents": [ { "docRef": "0001045810-26-000021", "filingType": "10-K", "periodEnd": "2026-01-25", "fiscalYear": 2026, "fiscalQuarter": null, "publishedDate": "2026-02-25", "lane": "xbrl", "certified": true }, { "docRef": "0001045810-25-000023", "filingType": "10-K", "periodEnd": "2025-01-26", "fiscalYear": 2025, "fiscalQuarter": null, "publishedDate": "2025-02-26", "lane": "xbrl", "certified": true } ], "lanes": [ "xbrl", "printed" ], "window": { "from": null, "to": null, "limit": 2, "totalColumns": 31 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/fact-source": { "get": { "summary": "Fact provenance", "description": "Provenance for one cell: the fact(s) (or the printed cell and page for PDF-sourced issuers), the filing accession or document reference, and the arithmetic behind derived values.", "operationId": "get-fact-provenance", "tags": [ "Financial Statements" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "statement", "in": "query", "description": "Required. Which statement the row belongs to; an unknown one is a 404.", "schema": { "type": "string", "enum": [ "income_statement", "balance_sheet", "cash_flow_statement", "segments_kpis", "supply_chain" ] }, "required": true }, { "name": "key", "in": "query", "description": "The row key exactly as /financials returned it: std: (std:revenue), a raw XBRL tag (us-gaap:Revenues), a segment row seg::::::, a KPI row kpi::, or a supply-chain metric rel:::::: (provenance.fact_source_key on /supply-chain).", "schema": { "type": "string" }, "required": true }, { "name": "end_date", "in": "query", "description": "The column's period end date, YYYY-MM-DD (from period_meta).", "schema": { "type": "string" }, "required": true }, { "name": "period_type", "in": "query", "description": "Must match the /financials call being cited.", "schema": { "type": "string", "enum": [ "annual", "semiannual", "quarterly" ], "default": "annual" } }, { "name": "basis", "in": "query", "description": "Must match the reporting_basis of the /financials call being cited.", "schema": { "type": "string", "enum": [ "individual", "as_reported" ], "default": "individual" } }, { "name": "accounting_basis", "in": "query", "description": "Accounting basis the cited cell was shown under (see financials `basis`); default = primary.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "provenance": { "type": "string" }, "std_value": { "type": [ "integer", "null" ] }, "source_tags": { "type": "array", "items": { "type": "string" } }, "filing": { "type": [ "object", "null" ], "properties": { "accession_number": { "type": "string" }, "document_ref": { "type": "string" }, "filing_type": { "type": "string" }, "filing_date": { "type": "string", "format": "date" }, "fiscal_year": { "type": "integer" }, "fiscal_quarter": { "type": "integer" }, "period_end_date": { "type": "string", "format": "date" } } }, "facts": { "type": "array", "items": { "type": "object", "properties": { "tag_name": { "type": "string" }, "context_id": { "type": "string" }, "label_as_reported": { "type": "string" }, "raw_value": { "type": "integer" }, "selected_value": { "type": "integer" }, "value_is_derived": { "type": "boolean" }, "unit": { "type": "string" }, "decimals": { "type": "integer" }, "value_type": { "type": "string" }, "start_date": { "type": "string", "format": "date" }, "end_date": { "type": "string", "format": "date" }, "instant_date": { "type": "null" }, "revisions": { "type": "array", "items": { "type": "object", "properties": { "accession_number": { "type": "string" }, "filing_type": { "type": "string" }, "filing_date": { "type": "string", "format": "date" }, "fiscal_year": { "type": "integer" }, "fiscal_quarter": { "type": "integer" }, "context_id": { "type": "string" }, "raw_value": { "type": "integer" } } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "provenance": "filed", "std_value": 35082000000, "source_tags": [ "us-gaap:Revenues" ], "filing": { "accession_number": "0001045810-25-000230", "document_ref": "0001045810-25-000230", "filing_type": "10-Q", "filing_date": "2025-11-19", "fiscal_year": 2026, "fiscal_quarter": 3, "period_end_date": "2025-10-26" }, "facts": [ { "tag_name": "us-gaap:Revenues", "context_id": "c-4", "label_as_reported": "Revenues", "raw_value": 35082000000, "selected_value": 35082000000, "value_is_derived": false, "unit": "iso4217:USD", "decimals": -6, "value_type": "duration", "start_date": "2024-07-29", "end_date": "2024-10-27", "instant_date": null, "revisions": [ { "accession_number": "0001045810-24-000316", "filing_type": "10-Q", "filing_date": "2024-11-20", "fiscal_year": 2025, "fiscal_quarter": 3, "context_id": "c-3", "raw_value": 35082000000 }, { "accession_number": "0001045810-25-000230", "filing_type": "10-Q", "filing_date": "2025-11-19", "fiscal_year": 2026, "fiscal_quarter": 3, "context_id": "c-4", "raw_value": 35082000000 } ] } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/prices": { "get": { "summary": "Stock prices", "description": "Daily OHLCV bars of the company's listed security (the share class of a ticker), in its listing `currency`. Bars run from the first trading day of `range` to the latest; `lookback` adds earlier bars for moving averages. `coverageFrom` is the first day held; `note` says when the history starts after the range's first day or no bar falls inside it. Bar times `t` are epoch ms at UTC midnight. An unknown company is a 404.", "operationId": "get-stock-prices", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "Window of bars served: from the range's first day (1M = 31 days back, YTD = 1 January) to the latest bar; ALL is the whole history. `rangeFrom` echoes the first day; `displayFrom` is the epoch ms of the first bar inside the range.", "schema": { "type": "string", "enum": [ "1M", "3M", "6M", "YTD", "1Y", "2Y", "5Y", "ALL" ], "default": "1Y", "x-case-insensitive": true } }, { "name": "lookback", "in": "query", "description": "Bars to add before the range's first day, e.g. 200 to draw a 200-day moving average from the first bar. Default 0: only bars inside the range. `lookbackBars` says how many were added.", "schema": { "type": "integer", "minimum": 0, "maximum": 1000, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string" }, "bars": { "type": "array", "items": { "type": "object", "properties": { "t": { "type": "integer" }, "o": { "type": "number" }, "h": { "type": "number" }, "l": { "type": "number" }, "c": { "type": "number" }, "v": { "type": "integer" }, "adj": { "type": "number" } } } }, "displayFrom": { "type": "integer" }, "currency": { "type": "string" }, "range": { "type": "string" }, "rangeFrom": { "type": "string", "format": "date" }, "lookbackBars": { "type": "integer" }, "coverageFrom": { "type": "string", "format": "date" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "symbol": "NVDA", "bars": [ { "t": 1790812800000, "o": 229.979996, "h": 232.289993, "l": 228.160004, "c": 230.860001, "v": 98591400, "adj": 230.860001 }, { "t": 1792972800000, "o": 213.110001, "h": 217.75, "l": 212.610001, "c": 216, "v": 90829300, "adj": 216 } ], "displayFrom": 1790812800000, "currency": "USD", "range": "1M", "rangeFrom": "2026-10-01", "lookbackBars": 0, "coverageFrom": "1999-01-22" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/filings": { "get": { "summary": "Company filings", "description": "The company's document index: SEC filings (accession numbers) and documents published outside EDGAR (exchange disclosures, IR publications; their document reference in `accessionNumber`, `documentKind` pdf), newest filing date first, undated documents last. Page with `limit` / `offset` (the reply's `nextOffset`; also `total`, `hasMore`) or with `page` / `pageSize` (`totalPages`); `typeCounts` always counts the whole unfiltered index.", "operationId": "get-company-filings", "tags": [ "SEC Filings" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Rows per page, 1–100 (default 50). With `offset`, replaces page/pageSize.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip: the previous reply's `nextOffset`.", "schema": { "type": "integer", "minimum": 0 } }, { "name": "page", "in": "query", "description": "1-based page number, default 1.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "pageSize", "in": "query", "description": "Rows per page, 1–100, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "types", "in": "query", "description": "Comma-separated exact form codes, e.g. 10-K,10-Q,8-K or FS-A,FS-Q (typeCounts lists the company's).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "array", "items": { "type": "string" } }, "filings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "accessionNumber": { "type": "string" }, "filingType": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "fileSizeBytes": { "type": "integer" }, "cik": { "type": "string" }, "title": { "type": [ "string", "null" ] }, "documentKind": { "type": "string" } } } }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "totalPages": { "type": "integer" }, "typeCounts": { "type": "object", "additionalProperties": { "type": "integer" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": [ "0001045810" ], "filings": [ { "id": 4849207, "accessionNumber": "0002152188-26-000007", "filingType": "4/A", "filingDate": "2026-10-13", "fileSizeBytes": 5819, "cik": "0001045810", "title": null, "documentKind": "html" }, { "id": 4779372, "accessionNumber": "0001197647-26-000011", "filingType": "4", "filingDate": "2026-10-09", "fileSizeBytes": 6863, "cik": "0001045810", "title": null, "documentKind": "html" } ], "page": 1, "pageSize": 2, "totalCount": 2446, "totalPages": 1223, "typeCounts": { "3": 25, "4": 1414, "5": 25, "144": 247, "5/A": 5, "AR": 16 }, "limit": 2, "offset": 0, "total": 2446, "hasMore": true, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/filings/{accession}": { "get": { "summary": "Filing detail", "description": "One listed document. By default the document itself: an SEC filing's primary document as sanitized HTML, or a source document's stored PDF, HTML, announcement, package or media (`accession` = the SEC accession or the document reference as the filings index lists it, e.g. DFM-EMAAR-2026Q2-FS). With `format=text`, its text as JSON: `{ document: { id, cik, title, form, type, date, source_url, pages, part, slides? }, parts? (SEC: the submission's readable documents), text_source (html | sgml_text | json | pdf_extracted | stored_extraction | ocr), stored_as?, page_from, page_to, pages_in_text, pages_without_text?, text, offset, next_offset, total_chars, truncated?, note?, source }`. Paged documents mark each page \"[page N]\" (the PDF page, the filing's own HTML page breaks, or the slide). A document with no text to read (slide images, an un-OCR'd scan, a recording) answers 200 with `text: null` and `text_unavailable: { reason, detail, page_images?, document_route }`; text is never reconstructed.", "operationId": "get-filing-detail", "tags": [ "SEC Filings" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "accession", "in": "path", "required": true, "description": "SEC accession number (0001045810-25-000023) or source-document reference (EMAARIR-2026Q2-PRES), as the filings index lists it.", "schema": { "type": "string" } }, { "name": "format", "in": "query", "description": "`text` = the document's text as paged JSON (see above); omit for the document itself.", "schema": { "type": "string", "enum": [ "text" ] } }, { "name": "part", "in": "query", "description": "format=text, SEC filings: one document of the submission by its type (EX-99.1) or file name, from `parts`; default the primary document.", "schema": { "type": "string" } }, { "name": "page_from", "in": "query", "description": "format=text: first page to read (paged documents).", "schema": { "type": "integer", "minimum": 1, "maximum": 5000 } }, { "name": "page_to", "in": "query", "description": "format=text: last page to read (default the last).", "schema": { "type": "integer", "minimum": 1, "maximum": 5000 } }, { "name": "offset", "in": "query", "description": "format=text: character offset into the selected pages; the previous `next_offset`.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "max_chars", "in": "query", "description": "format=text: characters to return, 1,000–200,000.", "schema": { "type": "integer", "minimum": 1000, "maximum": 200000, "default": 50000 } } ], "responses": { "200": { "description": "OK", "content": { "text/html": { "schema": { "type": "string", "description": "The document as sanitized HTML." } }, "application/json": { "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "id": { "type": "string" }, "cik": { "type": "string" }, "company": { "type": "string" }, "title": { "type": "string" }, "form": { "type": "string" }, "part": { "type": "object", "properties": { "part": { "type": "string" }, "filename": { "type": "string" }, "description": { "type": "string" } } }, "date": { "type": "string", "format": "date" }, "source_url": { "type": "string" }, "pages": { "type": "integer" } } }, "parts": { "type": "array", "items": { "type": "object", "properties": { "part": { "type": "string" }, "filename": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string" }, "primary": { "type": "boolean" } } } }, "source": { "type": "string" }, "text_source": { "type": "string" }, "page_from": { "type": "integer" }, "page_to": { "type": "integer" }, "pages_in_text": { "type": "object", "properties": { "first": { "type": "integer" }, "last": { "type": "integer" } } }, "text": { "type": "string" }, "offset": { "type": "integer" }, "next_offset": { "type": "integer" }, "total_chars": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "document": { "id": "0001045810-26-000075", "cik": "0001045810", "company": "NVIDIA CORP", "title": "10-Q", "form": "10-Q", "part": { "part": "10-Q", "filename": "nvda-20260726.htm", "description": "10-Q" }, "date": "2026-08-26", "source_url": "https://www.sec.gov/Archives/edgar/data/1045810/000104581026000075/nvda-20260726.htm", "pages": 43 }, "parts": [ { "part": "10-Q", "filename": "nvda-20260726.htm", "description": "10-Q", "kind": "html", "primary": true }, { "part": "EX-10.1", "filename": "nvda2027q2ex101.htm", "description": "EX-10.1", "kind": "html", "primary": false } ], "source": "SEC EDGAR, Form 10-Q, accession 0001045810-26-000075", "text_source": "html", "page_from": 1, "page_to": 43, "pages_in_text": { "first": 1, "last": 1 }, "text": "[page 1]\nUNITED STATES\n\nSECURITIES AND EXCHANGE COMMISSION\n\nWashington, D.C. 20549\n\nFORM 10-Q\n\n☒ | QUARTERLY REPORT PURSUANT TO SECTION 13 OR 15(d) OF THE SECURITIES EXCHANGE ACT OF 1934\n\nFor the quar…", "offset": 0, "next_offset": 839, "total_chars": 151079 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/filing-notes": { "get": { "summary": "Filing sections", "description": "Every parsed filing (10-K, 10-Q, 20-F, DEF 14A, S-1 and exchange-lane reports) with its narrative sections — Business, Risk Factors, MD&A, … — newest filing first, sections in item order; section text at /filing-notes/{sectionId}. Paged by filing: `total`, `limit`, `offset`, `hasMore`, `nextOffset`; `filingTypes` and `sectionTypes` count what the whole index holds (before filters), and `emptyReason` says why an empty page is empty. The index lists what has been parsed, not everything filed.", "operationId": "get-filing-sections", "tags": [ "SEC Filings" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Filings per page, 1–500 (above 500 is a 400).", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 10 } }, { "name": "offset", "in": "query", "description": "Filings to skip: the previous reply's `nextOffset`.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "document", "in": "query", "description": "One filing: its accession number (dashed or not) or document reference, as listed.", "schema": { "type": "string" } }, { "name": "types", "in": "query", "description": "Comma-separated filing form codes, e.g. 10-K,10-Q or FS-A,AR (case-insensitive).", "schema": { "type": "string" } }, { "name": "section_types", "in": "query", "description": "Comma-separated section types, e.g. item_7,item_1a or fs_note (at most 20); a filing keeps only these sections and drops out when none is left.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "array", "items": { "type": "string" } }, "filings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "accessionNumber": { "type": "string" }, "filingType": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "integer" }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "sectionType": { "type": "string" }, "itemLabel": { "type": "string" }, "title": { "type": "string" }, "wordCount": { "type": "integer" } } } } } } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" }, "filingTypes": { "type": "object", "properties": { "10-Q": { "type": "integer" }, "DEF 14A": { "type": "integer" }, "10-K": { "type": "integer" }, "S-1/A": { "type": "integer" }, "S-1": { "type": "integer" }, "DISC": { "type": "integer" }, "AR": { "type": "integer" }, "FS-A": { "type": "integer" } } }, "sectionTypes": { "type": "object", "properties": { "item_1": { "type": "integer" }, "item_2": { "type": "integer" }, "proxy_governance": { "type": "integer" }, "proxy_cdna": { "type": "integer" }, "proxy_summary_comp": { "type": "integer" }, "proxy_director_comp": { "type": "integer" }, "proxy_beneficial_ownership": { "type": "integer" }, "proxy_audit_fees": { "type": "integer" }, "item_1a": { "type": "integer" }, "item_1c": { "type": "integer" }, "item_3": { "type": "integer" }, "item_5": { "type": "integer" }, "item_7": { "type": "integer" }, "item_7a": { "type": "integer" }, "item_8": { "type": "integer" }, "item_9a": { "type": "integer" }, "item_9b": { "type": "integer" }, "item_9c": { "type": "integer" }, "item_10": { "type": "integer" }, "item_11": { "type": "integer" }, "item_12": { "type": "integer" }, "item_13": { "type": "integer" }, "item_14": { "type": "integer" }, "item_15": { "type": "integer" }, "item_16": { "type": "integer" }, "proxy_say_on_pay": { "type": "integer" }, "item_6": { "type": "integer" }, "item_9": { "type": "integer" }, "s1_summary": { "type": "integer" }, "s1_risk_factors": { "type": "integer" }, "s1_use_of_proceeds": { "type": "integer" }, "s1_dilution": { "type": "integer" }, "s1_mdna": { "type": "integer" }, "s1_business": { "type": "integer" }, "s1_management": { "type": "integer" }, "s1_exec_comp": { "type": "integer" }, "s1_principal_stockholders": { "type": "integer" }, "s1_underwriting": { "type": "integer" }, "fs_note": { "type": "integer" }, "ir_chairman": { "type": "integer" }, "ir_about": { "type": "integer" }, "ir_strategy": { "type": "integer" }, "ir_market_context": { "type": "integer" }, "ir_financial_review": { "type": "integer" }, "ir_business_review": { "type": "integer" }, "ir_sustainability": { "type": "integer" }, "ir_governance": { "type": "integer" }, "ir_risk": { "type": "integer" }, "ir_auditors_report": { "type": "integer" }, "ir_financial_statements": { "type": "integer" }, "ir_other": { "type": "integer" }, "ir_ceo_review": { "type": "integer" }, "ir_year_in_review": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": [ "0001045810" ], "filings": [ { "id": 60135, "accessionNumber": "0001045810-26-000075", "filingType": "10-Q", "filingDate": "2026-08-26", "fiscalYear": 2027, "fiscalQuarter": 2, "sections": [ { "id": 277125, "sectionType": "item_1", "itemLabel": "Item 1", "title": "Financial Statements", "wordCount": 11172 }, { "id": 277126, "sectionType": "item_2", "itemLabel": "Item 2", "title": "MD&A", "wordCount": 6317 } ] }, { "id": 35, "accessionNumber": "0001045810-26-000052", "filingType": "10-Q", "filingDate": "2026-05-20", "fiscalYear": 2027, "fiscalQuarter": 1, "sections": [ { "id": 8838, "sectionType": "item_1", "itemLabel": "Item 1", "title": "Financial Statements", "wordCount": 8941 }, { "id": 8839, "sectionType": "item_2", "itemLabel": "Item 2", "title": "MD&A", "wordCount": 4804 } ] } ], "total": 107, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2, "filingTypes": { "10-Q": 53, "DEF 14A": 28, "10-K": 18, "S-1/A": 7, "S-1": 1 }, "sectionTypes": { "item_1": 71, "item_2": 71, "proxy_governance": 24, "proxy_cdna": 20, "proxy_summary_comp": 28, "proxy_director_comp": 22, "proxy_beneficial_ownership": 27, "proxy_audit_fees": 24, "item_1a": 18, "item_1c": 3, "item_3": 18, "item_5": 18, "item_7": 18, "item_7a": 18, "item_8": 18, "item_9a": 18, "item_9b": 12, "item_9c": 5, "item_10": 18, "item_11": 18, "item_12": 18, "item_13": 18, "item_14": 18, "item_15": 18, "item_16": 6, "proxy_say_on_pay": 3, "item_6": 13, "item_9": 5, "s1_summary": 8, "s1_risk_factors": 8, "s1_use_of_proceeds": 8, "s1_dilution": 8, "s1_mdna": 8, "s1_business": 8, "s1_management": 8, "s1_exec_comp": 8, "s1_principal_stockholders": 8, "s1_underwriting": 8 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/filing-notes/tables": { "get": { "summary": "Note tables index", "description": "Tabular filing notes: families with their served tables (gate verdicts, no grid) and the documents they come from. Paged by table, in index order (family by family, newest first within a family): without `view`, the first `limit` tables (default 100) with `total`, `limit`, `offset`, `hasMore` and `nextOffset`; read on with `offset` = `nextOffset`. `family` and/or `document` narrow the tables (every match when `limit` is omitted). `view=summary` is one line per family (table count, first and last period) plus the documents, the smallest answer; `view=full` is every table in one reply, not paged (large: 3 MB for a bank with twenty years of notes). One table's grid: /filing-notes/tables/{tableId}; one family over time: /filing-notes/series.", "operationId": "get-note-tables-index", "tags": [ "SEC Filings" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "`summary`: one line per family plus the documents. `full`: every table in one reply. Omit for the paged list of tables.", "schema": { "type": "string", "enum": [ "summary", "full" ] } }, { "name": "family", "in": "query", "description": "Only this family's tables, the key exactly as listed.", "schema": { "type": "string" } }, { "name": "document", "in": "query", "description": "Only this document's tables (doc_ref).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Tables per page, 1–200 (above 200 is a 400); not with `view`.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 } }, { "name": "offset", "in": "query", "description": "Tables to skip: the previous reply's `nextOffset`; not with `view`.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "kind", "in": "query", "description": "Which tables: `notes` (the notes to the statements, the default), `presentations` (investor-deck tables) or `guidance` (deck guidance tables).", "schema": { "type": "string", "enum": [ "notes", "presentations", "guidance" ], "default": "notes" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "array", "items": { "type": "string" } }, "families": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "tables": { "type": "integer" }, "firstPeriodEnd": { "type": [ "string", "null" ], "format": "date" }, "lastPeriodEnd": { "type": [ "string", "null" ], "format": "date" } } } }, "documents": { "type": "array", "items": { "type": "object", "properties": { "documentRef": { "type": "string" }, "sourceKind": { "type": "string" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": [ "integer", "null" ] }, "formType": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "tables": { "type": "integer" }, "ok": { "type": "integer" }, "hold": { "type": "integer" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": [ "0001045810" ], "families": [ { "key": "INVENTORY_COMPOSITION", "label": "Inventories", "tables": 74, "firstPeriodEnd": "1999-01-31", "lastPeriodEnd": "2026-07-26" }, { "key": "PPE_BY_CLASS", "label": "Property, plant & equipment", "tables": 44, "firstPeriodEnd": "1999-01-31", "lastPeriodEnd": "2026-01-25" } ], "documents": [ { "documentRef": "0001045810-26-000075", "sourceKind": "ixbrl", "fiscalYear": 2027, "fiscalQuarter": 2, "formType": "10-Q", "periodEnd": "2026-07-26", "tables": 36, "ok": 36, "hold": 0 }, { "documentRef": "0001045810-26-000021", "sourceKind": "ixbrl", "fiscalYear": 2026, "fiscalQuarter": null, "formType": "10-K", "periodEnd": "2026-01-25", "tables": 46, "ok": 46, "hold": 0 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/filing-notes/series": { "get": { "summary": "Note family series", "description": "Canonical time series of one note family across filings (lines × period ends, each point citing its document; reported vs comparative; later vintages; quarterly cadence derives Q4 for flow lines).", "operationId": "get-note-family-series", "tags": [ "SEC Filings" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "family", "in": "query", "description": "Required. An UPPER_SNAKE notes family, e.g. INVENTORY_COMPOSITION. Investor-presentation families have no series (400): read their tables via /filing-notes/tables?kind=presentations&family=.", "schema": { "type": "string" }, "required": true }, { "name": "cadence", "in": "query", "description": "annual (default) or quarterly.", "schema": { "type": "string", "enum": [ "annual", "quarterly" ], "default": "annual" } }, { "name": "from", "in": "query", "description": "First period end, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last period end, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Latest N periods in range, 1–200; adds `series.window`.", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "array", "items": { "type": "string" } }, "family": { "type": "string" }, "cadence": { "type": "string" }, "series": { "type": "object", "properties": { "family": { "type": "string" }, "cadence": { "type": "string" }, "periods": { "type": "array", "items": { "type": "string", "format": "date" } }, "lines": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "canonical": { "type": "boolean" }, "isTotal": { "type": "boolean" }, "unit": { "type": "string" }, "values": { "type": "object", "properties": { "2025-01-26": { "type": "object", "properties": { "value": { "type": "integer" }, "documentRef": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "tableId": { "type": "integer" }, "own": { "type": "boolean" } } }, "2026-01-25": { "type": "object", "properties": { "value": { "type": "integer" }, "documentRef": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "tableId": { "type": "integer" }, "own": { "type": "boolean" } } }, "2024-12-31": { "type": "object", "properties": { "value": { "type": "integer" }, "documentRef": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "tableId": { "type": "integer" }, "own": { "type": "boolean" } } }, "2025-12-31": { "type": "object", "properties": { "value": { "type": "integer" }, "documentRef": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "tableId": { "type": "integer" }, "own": { "type": "boolean" } } } } } } } }, "currency": { "type": "string" }, "window": { "type": "object", "properties": { "from": { "type": "null" }, "to": { "type": "null" }, "limit": { "type": "integer" }, "totalPeriods": { "type": "integer" } } }, "fxUsdRates": { "type": [ "object", "null" ], "properties": { "2024-12-31": { "type": "number" }, "2025-12-31": { "type": "number" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": [ "0001045810" ], "family": "INVENTORY_COMPOSITION", "cadence": "annual", "series": { "family": "INVENTORY_COMPOSITION", "cadence": "annual", "periods": [ "2025-01-26", "2026-01-25" ], "lines": [ { "key": "raw_materials", "label": "Raw materials", "canonical": true, "isTotal": false, "unit": "money", "values": { "2025-01-26": { "value": 3408000000, "documentRef": "nvda-fy2025-10k-pdf", "filingDate": "2025-02-26", "tableId": 82632, "own": true }, "2026-01-25": { "value": 3807000000, "documentRef": "0001045810-26-000021", "filingDate": "2026-02-25", "tableId": 110889, "own": true } } }, { "key": "work_in_process", "label": "Work in process", "canonical": true, "isTotal": false, "unit": "money", "values": { "2025-01-26": { "value": 3399000000, "documentRef": "nvda-fy2025-10k-pdf", "filingDate": "2025-02-26", "tableId": 82632, "own": true }, "2026-01-25": { "value": 8822000000, "documentRef": "0001045810-26-000021", "filingDate": "2026-02-25", "tableId": 110889, "own": true } } } ], "currency": "USD", "window": { "from": null, "to": null, "limit": 2, "totalPeriods": 30 }, "fxUsdRates": null } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/filing-notes/tables/{tableId}": { "get": { "summary": "Note table", "description": "One note table as filed: columns, rows, cells with source evidence and gate results.", "operationId": "get-note-table", "tags": [ "SEC Filings" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "tableId", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "integer" }, "tableKey": { "type": "string" }, "sourceKind": { "type": "string" }, "documentRef": { "type": "string" }, "familyKey": { "type": "string" }, "shape": { "type": "string" }, "title": { "type": "string" }, "noteNumber": { "type": "null" }, "noteTitle": { "type": "null" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "integer" }, "formType": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "scale": { "type": "integer" }, "currency": { "type": "string" }, "gates": { "type": "array", "items": { "type": "object", "properties": { "gate": { "type": "string" }, "status": { "type": "string" }, "detail": { "type": "string" }, "hard": { "type": "boolean" } } } }, "qualityStatus": { "type": "string" }, "holdReason": { "type": "null" }, "verification": { "type": "string" }, "cellCount": { "type": "integer" }, "columns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "periodKind": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "periodStart": { "type": [ "string", "null" ], "format": "date" } } } }, "provenance": { "type": "object", "properties": { "oracle": { "type": "object", "properties": { "rfile": { "type": "string" }, "details": { "type": "array", "items": {} }, "matched": { "type": "integer" }, "mismatched": { "type": "integer" }, "not_in_sec": { "type": "integer" }, "missing_in_ours": { "type": "integer" } } }, "role_uri": { "type": "string" }, "form_type": { "type": "string" }, "definition": { "type": "string" }, "filing_date": { "type": "string", "format": "date" }, "menu_category": { "type": "string" }, "family_evidence": { "type": "array", "items": { "type": "string" } }, "period_of_report": { "type": "string", "format": "date" } } }, "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "concept": { "type": "string" }, "canonicalLine": { "type": [ "string", "null" ] }, "depth": { "type": "integer" }, "isHeader": { "type": "boolean" }, "isTotal": { "type": "boolean" }, "dims": { "type": "object" }, "cells": { "type": "object", "properties": { "2026-04-27..2026-07-26": { "type": "object", "properties": { "value": { "type": "integer" }, "raw": { "type": "string" }, "source": { "type": "object", "properties": { "unit": { "type": "string" }, "concept": { "type": "string" }, "fact_id": { "type": "string" }, "decimals": { "type": "integer" }, "raw_value": { "type": "string" }, "context_id": { "type": "string" }, "period_end": { "type": "string", "format": "date" }, "period_start": { "type": "string", "format": "date" } } }, "flags": { "type": "array", "items": {} } } }, "2025-04-28..2025-07-27": { "type": "object", "properties": { "value": { "type": "integer" }, "raw": { "type": "string" }, "source": { "type": "object", "properties": { "unit": { "type": "string" }, "concept": { "type": "string" }, "fact_id": { "type": "string" }, "decimals": { "type": "integer" }, "raw_value": { "type": "string" }, "context_id": { "type": "string" }, "period_end": { "type": "string", "format": "date" }, "period_start": { "type": "string", "format": "date" } } }, "flags": { "type": "array", "items": {} } } }, "2026-01-26..2026-07-26": { "type": "object", "properties": { "value": { "type": "integer" }, "raw": { "type": "string" }, "source": { "type": "object", "properties": { "unit": { "type": "string" }, "concept": { "type": "string" }, "fact_id": { "type": "string" }, "decimals": { "type": "integer" }, "raw_value": { "type": "string" }, "context_id": { "type": "string" }, "period_end": { "type": "string", "format": "date" }, "period_start": { "type": "string", "format": "date" } } }, "flags": { "type": "array", "items": {} } } }, "2025-01-27..2025-07-27": { "type": "object", "properties": { "value": { "type": "integer" }, "raw": { "type": "string" }, "source": { "type": "object", "properties": { "unit": { "type": "string" }, "concept": { "type": "string" }, "fact_id": { "type": "string" }, "decimals": { "type": "integer" }, "raw_value": { "type": "string" }, "context_id": { "type": "string" }, "period_end": { "type": "string", "format": "date" }, "period_start": { "type": "string", "format": "date" } } }, "flags": { "type": "array", "items": {} } } } } } } } }, "fxUsdRates": { "type": "null" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "id": 111000, "tableKey": "0001045810-26-000075::SupplementalFinancialStatementInformationScheduleofInventoryDetails", "sourceKind": "ixbrl", "documentRef": "0001045810-26-000075", "familyKey": "INVENTORY_COMPOSITION", "shape": "composition", "title": "Supplemental Financial Statement Information - Schedule of Inventory (Details)", "noteNumber": null, "noteTitle": null, "fiscalYear": 2027, "fiscalQuarter": 2, "formType": "10-Q", "periodEnd": "2026-07-26", "scale": 1000000, "currency": "USD", "gates": [ { "gate": "N1_footing", "status": "n/a", "detail": "", "hard": true }, { "gate": "N1b_member_footing", "status": "n/a", "detail": "", "hard": false } ], "qualityStatus": "ok", "holdReason": null, "verification": "proven", "cellCount": 12, "columns": [ { "key": "2026-04-27..2026-07-26", "label": "3 Months Ended Jul. 26, 2026", "periodKind": "duration", "periodEnd": "2026-07-26", "periodStart": "2026-04-27" }, { "key": "2026-01-25", "label": "Jan. 25, 2026", "periodKind": "instant", "periodEnd": "2026-01-25", "periodStart": null } ], "provenance": { "oracle": { "rfile": "R45.htm", "details": [], "matched": 10, "mismatched": 0, "not_in_sec": 0, "missing_in_ours": 0 }, "role_uri": "http://www.nvidia.com/role/SupplementalFinancialStatementInformationScheduleofInventoryDetails", "form_type": "10-Q", "definition": "9955533 - Disclosure - Supplemental Financial Statement Information - Schedule of Inventory (Details)", "filing_date": "2026-08-26", "menu_category": "Details", "family_evidence": [ "concept InventoryRawMaterialsNetOfReserves", "title /inventor/" ], "period_of_report": "2026-07-26" }, "rows": [ { "key": "::us-gaap:OrganizationConsolidationAndPresentationOfFinancialStatementsAbstract/us-gaap:InventoryNetAbstract", "label": "Inventories", "concept": "us-gaap:InventoryNetAbstract", "canonicalLine": null, "depth": 1, "isHeader": true, "isTotal": false, "dims": {}, "cells": {} }, { "key": "::us-gaap:OrganizationConsolidationAndPresentationOfFinancialStatementsAbstract/us-gaap:InventoryNetAbstract/us-gaap:InventoryWriteDown::terseLabel", "label": "Inventory reserve expense", "concept": "us-gaap:InventoryWriteDown", "canonicalLine": "inventory_provisions_expense", "depth": 2, "isHeader": false, "isTotal": false, "dims": {}, "cells": { "2026-04-27..2026-07-26": { "value": 784000000, "raw": "784000000", "source": { "unit": "USD", "concept": "us-gaap:InventoryWriteDown", "fact_id": "f-637", "decimals": -6, "raw_value": "784000000", "context_id": "c-3", "period_end": "2026-07-26", "period_start": "2026-04-27" }, "flags": [] }, "2025-04-28..2025-07-27": { "value": 886000000, "raw": "886000000", "source": { "unit": "USD", "concept": "us-gaap:InventoryWriteDown", "fact_id": "f-638", "decimals": -6, "raw_value": "886000000", "context_id": "c-4", "period_end": "2025-07-27", "period_start": "2025-04-28" }, "flags": [] }, "2026-01-26..2026-07-26": { "value": 1600000000, "raw": "1600000000", "source": { "unit": "USD", "concept": "us-gaap:InventoryWriteDown", "fact_id": "f-639", "decimals": -8, "raw_value": "1600000000", "context_id": "c-1", "period_end": "2026-07-26", "period_start": "2026-01-26" }, "flags": [] }, "2025-01-27..2025-07-27": { "value": 3200000000, "raw": "3200000000", "source": { "unit": "USD", "concept": "us-gaap:InventoryWriteDown", "fact_id": "f-640", "decimals": -8, "raw_value": "3200000000", "context_id": "c-5", "period_end": "2025-07-27", "period_start": "2025-01-27" }, "flags": [] } } } ], "fxUsdRates": null } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/filing-notes/{sectionId}": { "get": { "summary": "Section text", "description": "Plain text of one filing section, read in windows: `max_chars` characters (default 50,000) from `offset`, ending at a paragraph or line break near the end. As text/plain (default) the window's place is in the headers `X-Text-Offset`, `X-Text-Total-Chars` and `X-Text-Next-Offset` (empty at the end of the text); with `format=json` the reply is `{ cik, sectionId, text, offset, maxChars, totalChars, hasMore, nextOffset }`. Read on with `offset` = the next offset until it is empty / null.", "operationId": "get-section-text", "tags": [ "SEC Filings" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "sectionId", "in": "path", "required": true, "description": "Numeric section id from /filing-notes.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Character offset to start at: the previous window's next offset.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "max_chars", "in": "query", "description": "Characters per window, 1,000–200,000.", "schema": { "type": "integer", "minimum": 1000, "maximum": 200000, "default": 50000 } }, { "name": "format", "in": "query", "description": "`text` (default): text/plain; `json`: the window and its offsets as JSON.", "schema": { "type": "string", "enum": [ "text", "json" ], "default": "text" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/events": { "get": { "summary": "Company 8-K events", "description": "The company's 8-K items (an exchange issuer's disclosures classified the same way, with the document reference in `accessionNumber`): one row per item, newest filing first, undated rows last (`sort=oldest` reverses the dates). Rows carry no family field: filter with `family`. The reply carries `total` (after filters), `unfilteredTotal`, `limit`, `offset`, `hasMore` and `nextOffset`.", "operationId": "get-company-8-k-events", "tags": [ "8-K Events" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Rows per page, 1–500. Omitted = every matching row.", "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "offset", "in": "query", "description": "Rows to skip: the previous reply's `nextOffset`. Default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "family", "in": "query", "description": "One or more event families, comma-separated: keeps items whose SEC item code defines the family (5.02 leadership, 2.02 earnings, 1.01 agreement, 2.01 mna, 5.07 governance_vote, …) or whose span-verified facts belong to it. dividend, buyback, guidance, stock_split and legal_regulatory have no item of their own and match only extracted facts. Values: dividend, stock_split, guidance, earnings, mna, debt_financing, equity_financing, buyback, restatement_non_reliance, cyber_incident, restructuring, impairment, leadership, governance_vote, agreement, legal_regulatory, listing_compliance, other.", "schema": { "type": "string" } }, { "name": "query", "in": "query", "description": "2–200 characters, case-insensitive: item names and codes, and the headline, summary, quote and subject of the item's extracted facts.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First filing date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last filing date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "sort", "in": "query", "description": "Filing-date order; undated rows sort last either way.", "schema": { "type": "string", "enum": [ "newest", "oldest" ], "default": "newest" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "array", "items": { "type": "string" } }, "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "accessionNumber": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "itemCode": { "type": [ "string", "null" ] }, "itemName": { "type": "string" }, "textSource": { "type": "string" }, "wordCount": { "type": [ "integer", "null" ] } } } }, "total": { "type": "integer" }, "unfilteredTotal": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" }, "sort": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": [ "0001045810" ], "events": [ { "id": 435693, "accessionNumber": "0001045810-26-000078", "filingDate": "2026-09-03", "itemCode": "8.01", "itemName": "Other Events", "textSource": "body", "wordCount": 801 }, { "id": 435694, "accessionNumber": "0001045810-26-000078", "filingDate": "2026-09-03", "itemCode": "9.01", "itemName": "Financial Statements and Exhibits", "textSource": "body", "wordCount": 46 } ], "total": 614, "unfilteredTotal": 614, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2, "sort": "newest" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/events/{accession}": { "get": { "summary": "8-K item text", "description": "The extracted plain text of one 8-K item, or of an exchange disclosure by its document reference (e.g. DFM-EMAAR-20261013-DISC, as the events index lists it). With `item` omitted the item is chosen: the filing's only coded item, else the only one left once Item 9.01 (exhibits) is set aside, else its uncoded item; when several substantive items remain the reply is a 400 (`code` missing_parameter, `param` item) listing them in `items`. An accession the company does not list is a 404 (`code` not_found); a listed exchange document with no extracted item text is a 404 whose `readWith` names the document text route. Paged: `max_chars` characters from `offset`. `format=text` (default) answers text/plain with the window in the headers X-Item-Code, X-Text-Offset, X-Text-Total-Chars and X-Text-Next-Offset (empty at the end); `format=json` answers { cik, accession, item, itemName, itemPicked, items, text, offset, maxChars, totalChars, hasMore, nextOffset }.", "operationId": "get-8-k-item-text", "tags": [ "8-K Events" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "accession", "in": "path", "required": true, "description": "SEC accession number, e.g. 0001045810-25-000023.", "schema": { "type": "string" } }, { "name": "item", "in": "query", "description": "8-K item code from the events index (e.g. 2.02, 1.01). Omit it to have the item chosen as described above.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Character offset: the previous reply's next offset. Default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "max_chars", "in": "query", "description": "Characters per reply, 1,000–200,000.", "schema": { "type": "integer", "minimum": 1000, "maximum": 200000, "default": 50000 } }, { "name": "format", "in": "query", "description": "text = text/plain (default); json = the window and item as JSON.", "schema": { "type": "string", "enum": [ "text", "json" ], "default": "text" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/segment-revenue": { "get": { "summary": "Segment revenue", "description": "The latest served revenue breakdown on the first business axis that has one (product, then operating segment, brand, channel), from the gated segment layer, with its source. A filer with no revenue breakdown gets its segment top line (premiums earned, net interest income, lease income).", "operationId": "get-segment-revenue", "tags": [ "Financial Statements" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "segment_revenue": { "type": "object", "properties": { "priorFiscalYear": { "type": "integer" }, "priorItems": { "type": "array", "items": { "type": "object", "properties": { "member": { "type": "string" }, "value": { "type": "integer" } } } }, "label": { "type": "string" }, "axis": { "type": "string" }, "metricKey": { "type": "string" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "null" }, "periodEndDate": { "type": "string", "format": "date" }, "consolidatedRevenue": { "type": "integer" }, "source": { "type": "object", "properties": { "accession": { "type": "string" }, "filingType": { "type": "string" }, "filingDate": { "type": [ "string", "null" ], "format": "date" }, "sourceTag": { "type": "string" }, "vintage": { "type": "string" }, "q4Provenance": { "type": "null" } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer" }, "member": { "type": "string" } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "segment_revenue": { "priorFiscalYear": 2025, "priorItems": [ { "member": "nvda:ComputeMember", "value": 102196000000 }, { "member": "nvda:NetworkingMember", "value": 12990000000 } ], "label": "Revenue by Product", "axis": "PRODUCT", "metricKey": "REVENUE", "fiscalYear": 2026, "fiscalQuarter": null, "periodEndDate": "2026-01-25", "consolidatedRevenue": 215938000000, "source": { "accession": "0001045810-26-000021", "filingType": "10-K", "filingDate": "2026-02-25", "sourceTag": "us-gaap:Revenues", "vintage": "current", "q4Provenance": null }, "items": [ { "name": "Compute", "value": 162361000000, "member": "nvda:ComputeMember" }, { "name": "Networking", "value": 31376000000, "member": "nvda:NetworkingMember" } ] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/regional-revenue": { "get": { "summary": "Regional revenue", "description": "The latest served revenue breakdown by geography, from the gated segment layer, with its source.", "operationId": "get-regional-revenue", "tags": [ "Financial Statements" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "regional_revenue": { "type": [ "object", "null" ], "properties": { "priorFiscalYear": { "type": "integer" }, "priorItems": { "type": "array", "items": { "type": "object", "properties": { "member": { "type": "string" }, "value": { "type": "integer" } } } }, "label": { "type": "string" }, "axis": { "type": "string" }, "metricKey": { "type": "string" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "null" }, "periodEndDate": { "type": "string", "format": "date" }, "consolidatedRevenue": { "type": "integer" }, "source": { "type": "object", "properties": { "accession": { "type": "string" }, "filingType": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "sourceTag": { "type": "string" }, "vintage": { "type": "string" }, "q4Provenance": { "type": "null" } } }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "integer" }, "member": { "type": "string" } } } } } }, "emptyReason": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "regional_revenue": { "priorFiscalYear": 2025, "priorItems": [ { "member": "country:US", "value": 61257000000 }, { "member": "country:SG", "value": 23684000000 } ], "label": "Revenue by Region", "axis": "GEOGRAPHY", "metricKey": "REVENUE", "fiscalYear": 2026, "fiscalQuarter": null, "periodEndDate": "2026-01-25", "consolidatedRevenue": 215938000000, "source": { "accession": "0001045810-26-000021", "filingType": "10-K", "filingDate": "2026-02-25", "sourceTag": "us-gaap:Revenues", "vintage": "current", "q4Provenance": null }, "items": [ { "name": "United States", "value": 149617000000, "member": "country:US" }, { "name": "Taiwan", "value": 42345000000, "member": "country:TW" } ] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/supply-chain": { "get": { "summary": "Supply chain", "description": "Disclosed suppliers, customers and competitors with source-backed metrics. Partners are not served (owner, 2026-11-12): a partnership cannot be evidenced reliably, unlike a supplier or customer. Every metric states whose figure it is (`whose`), the measurement period, the filing (`provenance.accession`) and, when withheld, the reason codes — cite those, never a bare percentage. `coverage` is the disclosed-customer share of the company's own revenue for one filing and period (never an estimate of the whole network). Anonymous customers (\"Customer One\") are filing-scoped and never unified across filings; labels a later report superseded are omitted unless `include_historical=true`. Every relationship carries `evidence_basis`: filed_structured (the filer's XBRL facts), company_published (a supplier/customer/partner list the company itself publishes), human_certified (filing text, human-audited), model_extracted (filing text incl. 8-K Item 1.01, quote-anchored, model-extracted under an active serving policy) call_transcript (an earnings-call passage) or analyst_curated (a competitor chosen by Astreus analysts, not named in any filing; it carries `curation` {rank, arena, rationale, products: [{member, label, arena, rationale, strength}] — the product lines it competes in, by the revenue member the company files, strength 3 major, 2 medium, 1 low, null ungraded —, sources, curated_at}, `direction` curated and no metrics) — cite it as such. When a company has a curated competitor list, that list replaces its filing-derived competitors on its own page only. Curated supply chain: any supplier or customer may carry `supply_curation` {items: [{origin (subject = this company's own curated list, counterparty = the other company's list, shown here with the role flipped), curated_on {cik, name}, member and label (the curating company's revenue member, null = company-wide), product_rank, flow (what is supplied or bought), rationale, strength (dependence of that line on the counterparty: 3 critical, 2 material, 1 minor), evidence_kind and sources [{kind: subject_document, counterparty_document, earnings_call or credible_report; title; url; date}], figure ({basis: reported, text, value, unit pct/usd/units, of, period, source} or null)}], curated_at}. It sits beside the disclosures and never changes a disclosed relationship's basis or metrics; a curated supplier or customer no filing lane holds has evidence_basis analyst_curated, direction curated and no metrics. A figure is a number the cited source states: reported, never a disclosed metric, never in `coverage`. A curated customer may be a segment rather than an entity: other_party.kind customer_segment, counterparty_id 0, `segment` {code (e.g. consumer.gaming), label, audience}. When a company has its own curated supply chain, that list is its supply chain: suppliers and customers it does not map to a business unit are not returned for it (partners and competitors are unaffected; other companies keep their own record). With `include_estimates=true`, metrics of state `estimate` (`counterparty_revenue_pct_est`) attribute a counterparty's undisclosed top-customer share by rule; they are estimates, never disclosed figures, and never enter `coverage`. Counterparties of kind named_unlinked are named in the filing but matched to no company page. `status` distinguishes not_processed, no_disclosures_found, partial and ok; `as_of` returns what was public through that UTC date under today's rules.", "operationId": "get-supply-chain", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "customers, suppliers, competitors or all (default).", "schema": { "type": "string", "enum": [ "customers", "suppliers", "competitors", "all" ], "default": "all" } }, { "name": "quantified_only", "in": "query", "description": "true = only relationships with at least one eligible metric.", "schema": { "type": "string", "enum": [ "true", "false" ], "default": "false" } }, { "name": "as_of", "in": "query", "description": "YYYY-MM-DD: public information through the end of that UTC date.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "company_exposure (default; the company's own metric), relationship_exposure (the other party's metric) or name. Metrics missing sort last, ties by edge key.", "schema": { "type": "string", "enum": [ "company_exposure", "relationship_exposure", "name" ], "default": "company_exposure" } }, { "name": "limit", "in": "query", "description": "Relationships per page, 1–5000, default 50 (5000 reads a company's whole set at once, as the CSV export does); page on with `cursor`.", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 50 } }, { "name": "cursor", "in": "query", "description": "Opaque cursor bound to all filters and the data revision; restart on 409.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Counterparty name or ticker contains.", "schema": { "type": "string" } }, { "name": "named_only", "in": "query", "description": "Exclude anonymous and grouped counterparties.", "schema": { "type": "string", "enum": [ "true", "false" ] } }, { "name": "country", "in": "query", "description": "Two-letter country code.", "schema": { "type": "string" } }, { "name": "sector", "in": "query", "description": "Exact sector name.", "schema": { "type": "string" } }, { "name": "display_currency", "in": "query", "description": "Three-letter display currency; original amounts retained; historical FX unavailable.", "schema": { "type": "string" } }, { "name": "include_historical", "in": "query", "description": "true = also return filing-scoped anonymous labels that a later report superseded.", "schema": { "type": "string", "enum": [ "true", "false" ], "default": "false" } }, { "name": "include_estimates", "in": "query", "description": "true = include estimate-tier metrics (state=estimate), attributed by rule, never disclosed figures.", "schema": { "type": "string", "enum": [ "true", "false" ], "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "supply_chain": { "type": "object", "properties": { "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" } } }, "status": { "type": "string" }, "data_revision": { "type": "string" }, "as_of": { "type": "null" }, "as_of_policy": { "type": "string" }, "freshness": { "type": "object", "properties": { "latest_source_public_at": { "type": "string", "format": "date-time" }, "pending_refresh": { "type": "boolean" } } }, "coverage": { "type": [ "object", "null" ], "properties": { "benchmark": { "type": "string" }, "period_start": { "type": "string", "format": "date" }, "period_end": { "type": "string", "format": "date" }, "accession": { "type": "string" }, "denominator_source": { "type": "string" }, "disclosed_pct": { "type": "string" }, "total_pct": { "type": "string" }, "state": { "type": "string" }, "scope_note": { "type": "string" }, "contributing_edge_keys": { "type": "array", "items": { "type": "string" } }, "excluded": { "type": "array", "items": { "type": "object", "properties": { "edge_key": { "type": "string" }, "reason": { "type": "string" } } } } } }, "relationships": { "type": "array", "items": { "type": "object", "properties": { "edge_key": { "type": "string" }, "kind": { "type": "string" }, "role_for_subject": { "type": "string" }, "scope": { "type": "string" }, "other_party": { "type": "object", "properties": { "counterparty_id": { "type": "integer" }, "kind": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": [ "string", "null" ] }, "ticker": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "sector": { "type": [ "string", "null" ] }, "anonymous_scope": { "type": "object", "properties": { "accession": { "type": "string" }, "member": { "type": "string" } } }, "market_cap": { "type": "integer" }, "logo_key": { "type": "string" } } }, "direction": { "type": "string" }, "evidence_basis": { "type": "string" }, "assertion_basis": { "type": "object", "properties": { "filed_structured": { "type": "integer" }, "company_published": { "type": "integer" }, "human_certified": { "type": "integer" }, "model_extracted": { "type": "integer" }, "call_transcript": { "type": "integer" } } }, "assertion_count": { "type": "integer" }, "latest_period_end": { "type": "string", "format": "date" }, "freshness": { "type": "object", "properties": { "latest_public_at": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "superseded": { "type": "boolean" } } }, "metrics": { "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string" }, "whose": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" } } }, "period_start": { "type": "string", "format": "date" }, "period_end": { "type": "string", "format": "date" }, "periodicity": { "type": "string" }, "value": { "type": [ "string", "null" ] }, "unit": { "type": "string" }, "approximate": { "type": "boolean" }, "scope_dimensions": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "state": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "array", "items": {} }, "provenance": { "type": "object", "properties": { "discloser_cik": { "type": "string" }, "accession": { "type": "string" }, "public_at": { "type": "string", "format": "date-time" }, "evidence_id": { "type": "integer" }, "quant_id": { "type": "integer" }, "fact_source_key": { "type": "string" } } }, "low": { "type": "string" }, "high": { "type": "string" } } } } } } }, "graph": { "type": "object", "properties": { "customers": { "type": "array", "items": { "type": "object", "properties": { "edge_key": { "type": "string" }, "kind": { "type": "string" }, "role_for_subject": { "type": "string" }, "scope": { "type": "string" }, "other_party": { "type": "object", "properties": { "counterparty_id": { "type": "integer" }, "kind": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": [ "string", "null" ] }, "ticker": { "type": [ "string", "null" ] }, "country": { "type": "string" }, "sector": { "type": [ "string", "null" ] }, "market_cap": { "type": "integer" }, "logo_key": { "type": "string" }, "government": { "type": "object", "properties": { "entity_code": { "type": "string" }, "name": { "type": "string" }, "short_name": { "type": "string" }, "kind": { "type": "string" }, "level": { "type": "string" }, "country": { "type": "string" } } } } }, "direction": { "type": "string" }, "evidence_basis": { "type": "string" }, "assertion_basis": { "type": "object", "properties": { "filed_structured": { "type": "integer" }, "company_published": { "type": "integer" }, "human_certified": { "type": "integer" }, "model_extracted": { "type": "integer" }, "call_transcript": { "type": "integer" } } }, "assertion_count": { "type": "integer" }, "latest_period_end": { "type": "string", "format": "date" }, "freshness": { "type": "object", "properties": { "latest_public_at": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "superseded": { "type": "boolean" } } }, "metrics": { "type": "array", "items": {} }, "supply_curation": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "origin": { "type": "string" }, "curated_on": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" } } }, "member": { "type": "string" }, "label": { "type": "string" }, "product_rank": { "type": "integer" }, "flow": { "type": "string" }, "rationale": { "type": "string" }, "strength": { "type": "integer" }, "evidence_kind": { "type": "string" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "date": { "type": "string" } } } }, "figure": { "type": "null" } } } }, "curated_at": { "type": "string", "format": "date-time" } } } } } }, "suppliers": { "type": "array", "items": { "type": "object", "properties": { "edge_key": { "type": "string" }, "kind": { "type": "string" }, "role_for_subject": { "type": "string" }, "scope": { "type": "string" }, "other_party": { "type": "object", "properties": { "counterparty_id": { "type": "integer" }, "kind": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": [ "string", "null" ] }, "ticker": { "type": [ "string", "null" ] }, "country": { "type": [ "string", "null" ] }, "sector": { "type": [ "string", "null" ] }, "market_cap": { "type": "integer" }, "logo_key": { "type": "string" }, "anonymous_scope": { "type": "object", "properties": { "accession": { "type": "string" }, "member": { "type": "string" } } } } }, "direction": { "type": "string" }, "evidence_basis": { "type": "string" }, "assertion_basis": { "type": "object", "properties": { "filed_structured": { "type": "integer" }, "company_published": { "type": "integer" }, "human_certified": { "type": "integer" }, "model_extracted": { "type": "integer" }, "call_transcript": { "type": "integer" } } }, "assertion_count": { "type": "integer" }, "latest_period_end": { "type": "string", "format": "date" }, "freshness": { "type": "object", "properties": { "latest_public_at": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "superseded": { "type": "boolean" } } }, "metrics": { "type": "array", "items": {} } } } }, "competitors": { "type": "array", "items": { "type": "object", "properties": { "edge_key": { "type": "string" }, "kind": { "type": "string" }, "role_for_subject": { "type": "string" }, "scope": { "type": "string" }, "other_party": { "type": "object", "properties": { "counterparty_id": { "type": "integer" }, "kind": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": "string" }, "ticker": { "type": "string" }, "country": { "type": "string" }, "sector": { "type": "string" }, "market_cap": { "type": "integer" }, "logo_key": { "type": "string" } } }, "direction": { "type": "string" }, "evidence_basis": { "type": "string" }, "assertion_basis": { "type": "object", "properties": { "filed_structured": { "type": "integer" }, "company_published": { "type": "integer" }, "human_certified": { "type": "integer" }, "model_extracted": { "type": "integer" }, "call_transcript": { "type": "integer" } } }, "assertion_count": { "type": "integer" }, "latest_period_end": { "type": "null" }, "freshness": { "type": "object", "properties": { "latest_public_at": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "superseded": { "type": "boolean" } } }, "metrics": { "type": "array", "items": {} }, "curation": { "type": "object", "properties": { "rank": { "type": "integer" }, "arena": { "type": "string" }, "rationale": { "type": [ "string", "null" ] }, "products": { "type": "array", "items": { "type": "object", "properties": { "member": { "type": "string" }, "label": { "type": "string" }, "arena": { "type": "string" }, "rationale": { "type": "string" }, "strength": { "type": "integer" } } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "url": { "type": "string" } } } }, "curated_at": { "type": "string", "format": "date-time" } } } } } } } }, "counts": { "type": "object", "properties": { "customers": { "type": "integer" }, "suppliers": { "type": "integer" }, "competitors": { "type": "integer" }, "quantified": { "type": "integer" }, "total": { "type": "integer" } } }, "page_info": { "type": "object", "properties": { "limit": { "type": "integer" }, "offset": { "type": "integer" }, "total": { "type": "integer" }, "next_cursor": { "type": "string" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "supply_chain": { "company": { "cik": "0001045810", "name": "NVIDIA CORP", "ticker": "NVDA" }, "status": "ok", "data_revision": "d5bbd1a557033c517b32c24358f2e3e50ccf8a5c373d72b20aa5dbf9d5ce3e03", "as_of": null, "as_of_policy": "public_by_cutoff_current_rules", "freshness": { "latest_source_public_at": "2026-11-12T00:45:12.172Z", "pending_refresh": false }, "coverage": { "benchmark": "revenue", "period_start": "2025-01-27", "period_end": "2026-01-25", "accession": "0001045810-26-000021", "denominator_source": "discloser_filing", "disclosed_pct": "36", "total_pct": "36", "state": "measured", "scope_note": "us-gaap:StatementBusinessSegmentsAxis=nvda:ComputeAndNetworkingSegmentMember", "contributing_edge_keys": [ "3629338af105d0275fbc821e173ce0f1551214c9", "ba71219fed543852843124535daa4b50fe6d3c28" ], "excluded": [ { "edge_key": "7d8572e648830d9e34c19cfdcd76040701bd937d", "reason": "indirect_scope" } ] }, "relationships": [ { "edge_key": "3629338af105d0275fbc821e173ce0f1551214c9", "kind": "supply", "role_for_subject": "customer", "scope": "direct_commercial", "other_party": { "counterparty_id": 11727, "kind": "anonymous", "name": "Customer One", "cik": null, "ticker": null, "country": null, "sector": null, "anonymous_scope": { "accession": "0001045810-26-000021", "member": "nvda:CustomerOneMember" } }, "direction": "disclosed_by_subject", "evidence_basis": "filed_structured", "assertion_basis": { "filed_structured": 5, "company_published": 0, "human_certified": 0, "model_extracted": 0, "call_transcript": 0 }, "assertion_count": 5, "latest_period_end": "2026-01-25", "freshness": { "latest_public_at": "2026-02-25T21:42:19.000Z", "stale": false, "superseded": false }, "metrics": [ { "metric": "discloser_revenue_pct", "whose": { "cik": "0001045810", "name": "NVIDIA CORP" }, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "value": "22", "unit": "pct", "approximate": true, "scope_dimensions": [ [ "us-gaap:StatementBusinessSegmentsAxis", "nvda:ComputeAndNetworkingSegmentMember" ] ], "state": "eligible", "reasons": [], "notes": [], "provenance": { "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "public_at": "2026-02-25T21:42:19.000Z", "evidence_id": 32272, "quant_id": 51185, "fact_source_key": "rel::3629338af105d0275fbc821e173ce0f1551214c9::discloser_revenue_pct::51185" }, "low": "21.5", "high": "22.5" }, { "metric": "attributed_revenue_amount", "whose": { "cik": "0001045810", "name": "NVIDIA CORP" }, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "value": null, "unit": "pct", "approximate": true, "scope_dimensions": [ [ "us-gaap:StatementBusinessSegmentsAxis", "nvda:ComputeAndNetworkingSegmentMember" ] ], "state": "withheld", "reasons": [ "benchmark_scope_attached" ], "notes": [], "provenance": { "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "public_at": "2026-02-25T21:42:19.000Z", "evidence_id": 32272, "quant_id": 51186, "fact_source_key": "rel::3629338af105d0275fbc821e173ce0f1551214c9::attributed_revenue_amount::51186" } } ] }, { "edge_key": "ba71219fed543852843124535daa4b50fe6d3c28", "kind": "supply", "role_for_subject": "customer", "scope": "direct_commercial", "other_party": { "counterparty_id": 11729, "kind": "anonymous", "name": "Customer Two", "cik": null, "ticker": null, "country": null, "sector": null, "anonymous_scope": { "accession": "0001045810-26-000021", "member": "nvda:CustomerTwoMember" } }, "direction": "disclosed_by_subject", "evidence_basis": "filed_structured", "assertion_basis": { "filed_structured": 4, "company_published": 0, "human_certified": 0, "model_extracted": 0, "call_transcript": 0 }, "assertion_count": 4, "latest_period_end": "2026-01-25", "freshness": { "latest_public_at": "2026-02-25T21:42:19.000Z", "stale": false, "superseded": false }, "metrics": [ { "metric": "discloser_revenue_pct", "whose": { "cik": "0001045810", "name": "NVIDIA CORP" }, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "value": "14", "unit": "pct", "approximate": true, "scope_dimensions": [ [ "us-gaap:StatementBusinessSegmentsAxis", "nvda:ComputeAndNetworkingSegmentMember" ] ], "state": "eligible", "reasons": [], "notes": [], "provenance": { "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "public_at": "2026-02-25T21:42:19.000Z", "evidence_id": 32273, "quant_id": 51187, "fact_source_key": "rel::ba71219fed543852843124535daa4b50fe6d3c28::discloser_revenue_pct::51187" }, "low": "13.5", "high": "14.5" }, { "metric": "attributed_revenue_amount", "whose": { "cik": "0001045810", "name": "NVIDIA CORP" }, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "value": null, "unit": "pct", "approximate": true, "scope_dimensions": [ [ "us-gaap:StatementBusinessSegmentsAxis", "nvda:ComputeAndNetworkingSegmentMember" ] ], "state": "withheld", "reasons": [ "benchmark_scope_attached" ], "notes": [], "provenance": { "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "public_at": "2026-02-25T21:42:19.000Z", "evidence_id": 32273, "quant_id": 51188, "fact_source_key": "rel::ba71219fed543852843124535daa4b50fe6d3c28::attributed_revenue_amount::51188" } } ] } ], "graph": { "customers": [ { "edge_key": "9e0b7e2f4c5dfd4e169ce7efc2e879d333f22234", "kind": "supply", "role_for_subject": "customer", "scope": "direct_commercial", "other_party": { "counterparty_id": 572, "kind": "public_company", "name": "MICROSOFT CORP", "cik": "0000789019", "ticker": "MSFT", "country": "US", "sector": "Technology", "market_cap": 3870395375000, "logo_key": "0000789019" }, "direction": "both", "evidence_basis": "call_transcript", "assertion_basis": { "filed_structured": 0, "company_published": 0, "human_certified": 0, "model_extracted": 0, "call_transcript": 7 }, "assertion_count": 7, "latest_period_end": "2026-05-20", "freshness": { "latest_public_at": "2026-05-20T21:00:00.000Z", "stale": false, "superseded": false }, "metrics": [], "supply_curation": { "items": [ { "origin": "counterparty", "curated_on": { "cik": "0000789019", "name": "MICROSOFT CORP" }, "member": "msft:ServerProductsAndCloudServicesMember", "label": "Server products and cloud services", "product_rank": 1, "flow": "GPU systems (GB200/GB300 NVL72) and InfiniBand networking for Azure AI clusters", "rationale": "Microsoft's Azure blog describes a production cluster of more than 4,600 NVIDIA GB300 NVL72 systems on NVIDIA InfiniBand, the first of hundreds of thousands of Blackwell Ultra GPUs.", "strength": 3, "evidence_kind": "subject_document", "sources": [ { "kind": "subject_document", "title": "Azure blog: first large-scale cluster with NVIDIA GB300 NVL72 for OpenAI workloads (4,600+ systems, NVIDIA InfiniBand)", "url": "https://azure.microsoft.com/en-us/blog/microsoft-azure-delivers-the-first-large-scale-cluster-with-nvidia-gb300-nvl72-for-openai-workloads/", "date": "2025-10-09" }, { "kind": "earnings_call", "title": "Microsoft FY2026 Q2 earnings call (Microsoft's): commercial RPO $625bn, ~45% from OpenAI; fleet of NVIDIA, AMD and Maia", "url": "https://www.fool.com/earnings/call-transcripts/2026/01/28/microsoft-msft-q2-2026-earnings-call-transcript/", "date": "2026-01-28" } ], "figure": null } ], "curated_at": "2026-11-12T00:08:03.495Z" } }, { "edge_key": "3a3bfa18eb743c78143e0866f3152c989cf18ecb", "kind": "supply", "role_for_subject": "customer", "scope": "direct_commercial", "other_party": { "counterparty_id": 4071, "kind": "public_company", "name": "Alphabet Inc.", "cik": "0001652044", "ticker": "GOOGL", "country": "US", "sector": "Communication Services", "market_cap": 3591941520000, "logo_key": "0001652044" }, "direction": "both", "evidence_basis": "call_transcript", "assertion_basis": { "filed_structured": 0, "company_published": 0, "human_certified": 0, "model_extracted": 0, "call_transcript": 5 }, "assertion_count": 5, "latest_period_end": "2026-07-22", "freshness": { "latest_public_at": "2026-07-22T20:30:00.000Z", "stale": false, "superseded": false }, "metrics": [] } ], "suppliers": [ { "edge_key": "1fc5cfbdb3674a8287d97f52778ac9c4756c1035", "kind": "supply", "role_for_subject": "supplier", "scope": "direct_commercial", "other_party": { "counterparty_id": 1014, "kind": "public_company", "name": "TAIWAN SEMICONDUCTOR MANUFACTURING CO LTD", "cik": "0001046179", "ticker": "TSM", "country": "TW", "sector": "Technology", "market_cap": 2056345464338, "logo_key": "0001046179" }, "direction": "disclosed_by_subject", "evidence_basis": "model_extracted", "assertion_basis": { "filed_structured": 0, "company_published": 0, "human_certified": 0, "model_extracted": 1, "call_transcript": 1 }, "assertion_count": 2, "latest_period_end": "2026-01-25", "freshness": { "latest_public_at": "2026-02-25T21:42:19.000Z", "stale": false, "superseded": false }, "metrics": [] }, { "edge_key": "70ebd7a076f358a41fe2e93a4c13b1cf043d8798", "kind": "supply", "role_for_subject": "supplier", "scope": "direct_commercial", "other_party": { "counterparty_id": 424, "kind": "public_company", "name": "Samsung Electronics Co., Ltd.", "cik": "XKRX000002", "ticker": "005930", "country": "KR", "sector": "Technology", "market_cap": 901803215488, "logo_key": "XKRX000002" }, "direction": "disclosed_by_subject", "evidence_basis": "model_extracted", "assertion_basis": { "filed_structured": 0, "company_published": 0, "human_certified": 0, "model_extracted": 2, "call_transcript": 0 }, "assertion_count": 2, "latest_period_end": "2026-01-25", "freshness": { "latest_public_at": "2026-02-25T21:42:19.000Z", "stale": false, "superseded": false }, "metrics": [] } ], "competitors": [ { "edge_key": "d79225bb6d604eba7a4434e8c33ca494518e2d41", "kind": "competition", "role_for_subject": "competitor", "scope": "general", "other_party": { "counterparty_id": 971, "kind": "public_company", "name": "Apple Inc.", "cik": "0000320193", "ticker": "AAPL", "country": "US", "sector": "Technology", "market_cap": 5168107268170, "logo_key": "0000320193" }, "direction": "curated", "evidence_basis": "analyst_curated", "assertion_basis": { "filed_structured": 0, "company_published": 0, "human_certified": 0, "model_extracted": 0, "call_transcript": 0 }, "assertion_count": 0, "latest_period_end": null, "freshness": { "latest_public_at": "2026-11-12T00:01:12.140Z", "stale": false, "superseded": false }, "metrics": [], "curation": { "rank": 14, "arena": "Professional Visualization", "rationale": "Mac Studio and MacBook Pro with M-series GPUs against RTX PRO workstations and DGX Spark for creative and local-AI work.", "products": [ { "member": "nvda:ProfessionalVisualizationMember", "label": "Professional Visualization", "arena": "Creative and local-AI workstations", "rationale": "Mac Studio and MacBook Pro with M-series GPUs against RTX PRO workstations and DGX Spark for creative and local-AI work.", "strength": 1 } ], "sources": [], "curated_at": "2026-11-12T00:01:12.140Z" } }, { "edge_key": "d2335f3204b22efa94002f938742b466f6d27481", "kind": "competition", "role_for_subject": "competitor", "scope": "general", "other_party": { "counterparty_id": 572, "kind": "public_company", "name": "MICROSOFT CORP", "cik": "0000789019", "ticker": "MSFT", "country": "US", "sector": "Technology", "market_cap": 3870395375000, "logo_key": "0000789019" }, "direction": "curated", "evidence_basis": "analyst_curated", "assertion_basis": { "filed_structured": 0, "company_published": 0, "human_certified": 0, "model_extracted": 0, "call_transcript": 0 }, "assertion_count": 0, "latest_period_end": null, "freshness": { "latest_public_at": "2026-11-12T00:01:12.140Z", "stale": false, "superseded": false }, "metrics": [], "curation": { "rank": 7, "arena": "Compute · Gaming", "rationale": null, "products": [ { "member": "nvda:ComputeMember", "label": "Compute", "arena": "AI accelerators (Maia)", "rationale": "Maia accelerators in Azure, ramping by 2027 per Counterpoint; Microsoft is also one of NVIDIA's largest customers.", "strength": 1 }, { "member": "nvda:GamingMember", "label": "Gaming", "arena": "Cloud gaming", "rationale": "Xbox Cloud Gaming against GeForce NOW.", "strength": 1 } ], "sources": [ { "title": "Counterpoint Research, January 2026: AI server compute ASIC shipments to triple by 2027 (Google 64% and AWS 36% of 2024 shipments; Broadcom ~60% design-partner share in 2027, Marvell ~8%; Meta and Mic…", "url": "https://counterpointresearch.com/de/insights/AI-Server-Compute-ASIC-Shipments-to-Triple-by-2027" } ], "curated_at": "2026-11-12T00:01:12.140Z" } } ] }, "counts": { "customers": 65, "suppliers": 20, "competitors": 18, "quantified": 5, "total": 103 }, "page_info": { "limit": 2, "offset": 0, "total": 103, "next_cursor": "eyJvZmZzZXQiOjIsInNvcnQiOiJjb21wYW55X2V4cG9zdXJlIiwicm9sZSI6ImFsbCIsImFzT2YiOm51bGwsInJldmlzaW9uIjoiZDViYmQxYTU1NzAzM2M1MTdiMzJjMjQzNThmMmUzZTUwY2NmOGE1YzM3M2Q3MmIyMGFhNWRiZjlkNWNlM2UwMyIsInF1YW50aWZp…" } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/supply-chain/{edgeKey}": { "get": { "summary": "Supply-chain relationship", "description": "One relationship in full: current metrics, every served measurement period (eligible and withheld with reasons) and the evidence rows behind it (discloser, accession, XBRL context, quote locator). An analyst-curated competitor (evidence_basis analyst_curated) returns its `curation` with empty history and evidence; a curated supplier or customer returns its `supply_curation` (with empty history and evidence when no filing lane holds it). The edge must belong to the company in the path.", "operationId": "get-supply-chain-relationship", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "edgeKey", "in": "path", "required": true, "schema": { "type": "string" }, "description": "edge_key from the supply-chain list." }, { "name": "as_of", "in": "query", "description": "YYYY-MM-DD: public information through the end of that UTC date.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "supply_chain_edge": { "type": "object", "properties": { "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" } } }, "relationship": { "type": "object", "properties": { "edge_key": { "type": "string" }, "kind": { "type": "string" }, "role_for_subject": { "type": "string" }, "scope": { "type": "string" }, "other_party": { "type": "object", "properties": { "counterparty_id": { "type": "integer" }, "kind": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": "null" }, "ticker": { "type": "null" }, "country": { "type": "null" }, "sector": { "type": "null" }, "anonymous_scope": { "type": "object", "properties": { "accession": { "type": "string" }, "member": { "type": "string" } } } } }, "direction": { "type": "string" }, "evidence_basis": { "type": "string" }, "assertion_basis": { "type": "object", "properties": { "filed_structured": { "type": "integer" }, "company_published": { "type": "integer" }, "human_certified": { "type": "integer" }, "model_extracted": { "type": "integer" }, "call_transcript": { "type": "integer" } } }, "assertion_count": { "type": "integer" }, "latest_period_end": { "type": "string", "format": "date" }, "freshness": { "type": "object", "properties": { "latest_public_at": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "superseded": { "type": "boolean" } } }, "metrics": { "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string" }, "whose": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" } } }, "period_start": { "type": "string", "format": "date" }, "period_end": { "type": "string", "format": "date" }, "periodicity": { "type": "string" }, "value": { "type": "string" }, "unit": { "type": "string" }, "approximate": { "type": "boolean" }, "scope_dimensions": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "state": { "type": "string" }, "reasons": { "type": "array", "items": {} }, "notes": { "type": "array", "items": {} }, "provenance": { "type": "object", "properties": { "discloser_cik": { "type": "string" }, "accession": { "type": "string" }, "public_at": { "type": "string", "format": "date-time" }, "evidence_id": { "type": "integer" }, "quant_id": { "type": "integer" }, "fact_source_key": { "type": "string" } } }, "low": { "type": "string" }, "high": { "type": "string" } } } } } }, "as_of": { "type": "null" }, "history": { "type": "array", "items": { "type": "object", "properties": { "metric": { "type": "string" }, "whose": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" } } }, "period_start": { "type": "string", "format": "date" }, "period_end": { "type": "string", "format": "date" }, "periodicity": { "type": "string" }, "value": { "type": [ "string", "null" ] }, "unit": { "type": "string" }, "approximate": { "type": "boolean" }, "scope_dimensions": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "state": { "type": "string" }, "reasons": { "type": "array", "items": { "type": "string" } }, "notes": { "type": "array", "items": {} }, "provenance": { "type": "object", "properties": { "discloser_cik": { "type": "string" }, "accession": { "type": "string" }, "public_at": { "type": "string", "format": "date-time" }, "evidence_id": { "type": "integer" }, "quant_id": { "type": "integer" }, "fact_source_key": { "type": "string" } } }, "low": { "type": "string" }, "high": { "type": "string" } } } }, "evidence": { "type": "array", "items": { "type": "object", "properties": { "evidence_id": { "type": "integer" }, "discloser_cik": { "type": "string" }, "accession": { "type": "string" }, "source_kind": { "type": "string" }, "serving_basis": { "type": "string" }, "quote": { "type": "null" }, "subtype": { "type": "null" }, "subject_role": { "type": "string" }, "other_party_raw": { "type": "string" }, "other_party_kind": { "type": "string" }, "scope": { "type": "string" }, "benchmark": { "type": "string" }, "benchmark_family": { "type": "string" }, "pct": { "type": "string" }, "pct_precision_pp": { "type": "string" }, "amount": { "type": "null" }, "currency": { "type": "null" }, "bound": { "type": "null" }, "period_start": { "type": "string", "format": "date" }, "period_end": { "type": "string", "format": "date" }, "periodicity": { "type": "string" }, "scope_dimensions": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "public_at": { "type": "string", "format": "date-time" }, "public_precision": { "type": "string" }, "locator": { "type": "object", "properties": { "concept": { "type": "string" }, "context_id": { "type": "string" }, "context_hash": { "type": "string" }, "source_fact_id": { "type": "integer" } } } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "supply_chain_edge": { "company": { "cik": "0001045810", "name": "NVIDIA CORP", "ticker": "NVDA" }, "relationship": { "edge_key": "3629338af105d0275fbc821e173ce0f1551214c9", "kind": "supply", "role_for_subject": "customer", "scope": "direct_commercial", "other_party": { "counterparty_id": 11727, "kind": "anonymous", "name": "Customer One", "cik": null, "ticker": null, "country": null, "sector": null, "anonymous_scope": { "accession": "0001045810-26-000021", "member": "nvda:CustomerOneMember" } }, "direction": "disclosed_by_subject", "evidence_basis": "filed_structured", "assertion_basis": { "filed_structured": 5, "company_published": 0, "human_certified": 0, "model_extracted": 0, "call_transcript": 0 }, "assertion_count": 5, "latest_period_end": "2026-01-25", "freshness": { "latest_public_at": "2026-02-25T21:42:19.000Z", "stale": false, "superseded": false }, "metrics": [ { "metric": "discloser_revenue_pct", "whose": { "cik": "0001045810", "name": "NVIDIA CORP" }, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "value": "22", "unit": "pct", "approximate": true, "scope_dimensions": [ [ "us-gaap:StatementBusinessSegmentsAxis", "nvda:ComputeAndNetworkingSegmentMember" ] ], "state": "eligible", "reasons": [], "notes": [], "provenance": { "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "public_at": "2026-02-25T21:42:19.000Z", "evidence_id": 32272, "quant_id": 51185, "fact_source_key": "rel::3629338af105d0275fbc821e173ce0f1551214c9::discloser_revenue_pct::51185" }, "low": "21.5", "high": "22.5" }, { "metric": "receivables_pct", "whose": { "cik": "0001045810", "name": "NVIDIA CORP" }, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "value": "25", "unit": "pct", "approximate": true, "scope_dimensions": [], "state": "eligible", "reasons": [], "notes": [], "provenance": { "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "public_at": "2026-02-25T21:42:19.000Z", "evidence_id": 32268, "quant_id": 51180, "fact_source_key": "rel::3629338af105d0275fbc821e173ce0f1551214c9::receivables_pct::51180" }, "low": "24.5", "high": "25.5" } ] }, "as_of": null, "history": [ { "metric": "attributed_revenue_amount", "whose": { "cik": "0001045810", "name": "NVIDIA CORP" }, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "value": null, "unit": "pct", "approximate": true, "scope_dimensions": [ [ "us-gaap:StatementBusinessSegmentsAxis", "nvda:ComputeAndNetworkingSegmentMember" ] ], "state": "withheld", "reasons": [ "benchmark_scope_attached" ], "notes": [], "provenance": { "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "public_at": "2026-02-25T21:42:19.000Z", "evidence_id": 32272, "quant_id": 51186, "fact_source_key": "rel::3629338af105d0275fbc821e173ce0f1551214c9::attributed_revenue_amount::51186" } }, { "metric": "discloser_revenue_pct", "whose": { "cik": "0001045810", "name": "NVIDIA CORP" }, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "value": "22", "unit": "pct", "approximate": true, "scope_dimensions": [ [ "us-gaap:StatementBusinessSegmentsAxis", "nvda:ComputeAndNetworkingSegmentMember" ] ], "state": "eligible", "reasons": [], "notes": [], "provenance": { "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "public_at": "2026-02-25T21:42:19.000Z", "evidence_id": 32272, "quant_id": 51185, "fact_source_key": "rel::3629338af105d0275fbc821e173ce0f1551214c9::discloser_revenue_pct::51185" }, "low": "21.5", "high": "22.5" } ], "evidence": [ { "evidence_id": 32272, "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "source_kind": "xbrl_pct", "serving_basis": "filed_structured", "quote": null, "subtype": null, "subject_role": "supplier", "other_party_raw": "nvda:CustomerOneMember", "other_party_kind": "anonymous", "scope": "direct_commercial", "benchmark": "us-gaap:SalesRevenueNetMember", "benchmark_family": "revenue", "pct": "22", "pct_precision_pp": "0.5", "amount": null, "currency": null, "bound": null, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "scope_dimensions": [ [ "us-gaap:StatementBusinessSegmentsAxis", "nvda:ComputeAndNetworkingSegmentMember" ] ], "public_at": "2026-02-25T21:42:19.000Z", "public_precision": "instant", "locator": { "concept": "us-gaap:ConcentrationRiskPercentage1", "context_id": "c-227", "context_hash": "ad3dfcf569aa5106473f18678c4838fbd4374ec4e65a12b233b35176b87e0ee1", "source_fact_id": 2166195 } }, { "evidence_id": 32268, "discloser_cik": "0001045810", "accession": "0001045810-26-000021", "source_kind": "xbrl_pct", "serving_basis": "filed_structured", "quote": null, "subtype": null, "subject_role": "supplier", "other_party_raw": "nvda:CustomerOneMember", "other_party_kind": "anonymous", "scope": "direct_commercial", "benchmark": "us-gaap:AccountsReceivableMember", "benchmark_family": "receivables", "pct": "25", "pct_precision_pp": "0.5", "amount": null, "currency": null, "bound": null, "period_start": "2025-01-27", "period_end": "2026-01-25", "periodicity": "annual", "scope_dimensions": [], "public_at": "2026-02-25T21:42:19.000Z", "public_precision": "instant", "locator": { "concept": "us-gaap:ConcentrationRiskPercentage1", "context_id": "c-126", "context_hash": "a924c8170195da990c24acdc9b9847b64fb44b60268f7261fbb0199ecab34f20", "source_fact_id": 2165810 } } ] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/assets": { "get": { "summary": "Company assets (map)", "description": "The company's physical assets as GeoJSON — buildings, malls, hotels, toll gates, plants, ports, cables, data centres — each with the company's role on it (owner, operator, developer, concessionaire, grantor, tenant, partner…) and share where disclosed, lifecycle status (announced, under_construction, suspended, operating, …) as of `as_of`, the declared location precision (`precision` exact | approximate | locality | region | country, with `precision_m` the error radius in metres — draw it, never a pin of false certainty), the registry `layer` that draws it and its label `anchor_lon`/`anchor_lat`. Only reviewed, sourced assets appear; cite the per-asset sources from /geo/features/{key}. Pilot coverage, starting with curated UAE issuers: an empty `features` list means no reviewed assets yet, not that the company has none. `attribution` lists what the licences require you to display (e.g. © OpenStreetMap contributors for ODbL geometry). The map view is paged by feature: `limit` features (default 50) from `offset`, with `total`, `limit`, `offset`, `hasMore` and `nextOffset`; `bbox`, `layers` and `counts` describe the whole map, and `former` (assets no longer held) comes on the first page only, up to `limit` of them (`formerTotal` counts them all; page them with view=attributes&holding=former).", "operationId": "get-company-assets-map", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "as_of", "in": "query", "description": "YYYY-MM-DD: the map as it stood that day — assets not yet announced drop out and only parties valid on that day count. Default today.", "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "`geojson` (default): the map, paged by feature. `attributes`: no geometry — `summary` counts (level, kind, country, status) and one page of `assets`, each with `geometry_licence` and `location` (null with `location_withheld` when the licence is share-alike or unrecorded). The attributes filters (kind, status, level, q, country, holding) are a 400 on the map view.", "schema": { "type": "string", "enum": [ "geojson", "attributes" ], "default": "geojson" } }, { "name": "kind", "in": "query", "description": "attributes: asset kind codes, comma-separated, at most 30.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "attributes: lifecycle statuses, comma-separated.", "schema": { "type": "string" } }, { "name": "level", "in": "query", "description": "attributes: register level, asset | component | all (default all).", "schema": { "type": "string", "enum": [ "asset", "component", "all" ] } }, { "name": "q", "in": "query", "description": "attributes: words in the name.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "attributes: ISO alpha-2 codes, comma-separated.", "schema": { "type": "string" } }, { "name": "holding", "in": "query", "description": "attributes: current (default) = assets held now; former = assets no longer held.", "schema": { "type": "string", "enum": [ "current", "former" ] } }, { "name": "limit", "in": "query", "description": "Page size, default 50: map view 1–5,000 features; attributes 1–200 rows. Above the maximum is a 400.", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip: map view, the previous `nextOffset`; attributes, the previous `next_offset`.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "consolidated", "in": "query", "description": "1 adds the assets the company holds through its listed subsidiaries, each with the subsidiary it comes through and the stake.", "schema": { "type": "string", "enum": [ "1", "0" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" } } }, "as_of": { "type": "string", "format": "date" }, "preview": { "type": "boolean" }, "bbox": { "type": "array", "items": { "type": "number" } }, "layers": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "group": { "type": "string" }, "sourceType": { "type": "string" }, "sourceConfig": { "type": "object" }, "symbology": { "type": "object", "properties": { "color": { "type": "string" }, "label": { "type": "object", "properties": { "min_zoom": { "type": "integer" }, "property": { "type": "string" } } }, "marker": { "type": "string" }, "marker_size": { "type": "number" } } }, "minZoom": { "type": "integer" }, "maxZoom": { "type": "integer" }, "defaultVisible": { "type": "boolean" }, "displayOrder": { "type": "integer" }, "minTier": { "type": "string" }, "licence": { "type": "string" }, "attribution": { "type": "null" }, "kinds": { "type": "array", "items": { "type": "string" } } } } }, "counts": { "type": "object", "properties": { "infrastructure.toll_gates": { "type": "integer" } } }, "features": { "type": "object", "properties": { "type": { "type": "string" }, "features": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "geometry": { "type": "object", "properties": { "type": { "type": "string" }, "coordinates": { "type": "array", "items": { "type": "number" } } } }, "properties": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "name_ar": { "type": "string" }, "kind": { "type": "string" }, "kind_title": { "type": "string" }, "family": { "type": "string" }, "layer": { "type": "string" }, "status": { "type": "string" }, "status_since": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "precision_m": { "type": "null" }, "height_m": { "type": "null" }, "base_height_m": { "type": "null" }, "country": { "type": "string" }, "parent_key": { "type": "null" }, "register_level": { "type": "string" }, "asset_key": { "type": "string" }, "anchor_lon": { "type": "number" }, "anchor_lat": { "type": "number" }, "roles": { "type": "string" }, "share_pct": { "type": "null" }, "primary": { "type": "boolean" }, "servable": { "type": "boolean" }, "gate": { "type": "string" }, "brand_cik": { "type": "string" }, "brand_mark": { "type": "null" }, "attributes": { "type": "object", "properties": { "road": { "type": "string" }, "location_note": { "type": "string" } } }, "operating_since": { "type": "object", "properties": { "on": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "bound": { "type": "string" } } }, "holding": { "type": "object", "properties": { "current": { "type": "boolean" }, "former_roles": { "type": "array", "items": {} }, "held_from": { "type": "string", "format": "date" }, "held_to": { "type": "null" }, "via": { "type": "null" }, "through": { "type": "null" } } } } } } } } } }, "former": { "type": "array", "items": {} }, "inside": { "type": "array", "items": {} }, "consolidated": { "type": "boolean" }, "group": { "type": "object", "properties": { "parents": { "type": "array", "items": {} }, "subsidiaries": { "type": "array", "items": {} } } }, "attribution": { "type": "array", "items": { "type": "string" } }, "formerTotal": { "type": "integer" }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "company": { "cik": "XDFM000029", "name": "Salik Company PJSC", "ticker": "SALIK" }, "as_of": "2026-11-01", "preview": false, "bbox": [ 55.101447, 25.0278993 ], "layers": [ { "code": "infrastructure.toll_gates", "title": "Toll gates", "description": "Road-toll gantries.", "group": "transport", "sourceType": "features", "sourceConfig": {}, "symbology": { "color": "cyan", "label": { "min_zoom": 10, "property": "name" }, "marker": "diamond", "marker_size": 1.15 }, "minZoom": 0, "maxZoom": 24, "defaultVisible": true, "displayOrder": 200, "minTier": "free", "licence": "proprietary", "attribution": null, "kinds": [ "toll_gate" ] } ], "counts": { "infrastructure.toll_gates": 10 }, "features": { "type": "FeatureCollection", "features": [ { "type": "Feature", "id": "ae.dubai.salik.gate.airport-tunnel", "geometry": { "type": "Point", "coordinates": [ 55.3871587, 25.2491601 ] }, "properties": { "key": "ae.dubai.salik.gate.airport-tunnel", "name": "Airport Tunnel toll gate", "name_ar": "بوابة نفق المطار", "kind": "toll_gate", "kind_title": "Toll gate", "family": "transport", "layer": "infrastructure.toll_gates", "status": "operating", "status_since": "2013-04-15", "precision": "exact", "precision_m": null, "height_m": null, "base_height_m": null, "country": "AE", "parent_key": null, "register_level": "asset", "asset_key": "ae.dubai.salik.gate.airport-tunnel", "anchor_lon": 55.3871587, "anchor_lat": 25.2491601, "roles": "concessionaire", "share_pct": null, "primary": true, "servable": true, "gate": "", "brand_cik": "XDFM000029", "brand_mark": null, "attributes": { "road": "Beirut Street (Airport Tunnel)", "location_note": "2 gantries mapped in OpenStreetMap; the gate spans 29 m" }, "operating_since": { "on": "2013-04-15", "precision": "day", "bound": "on" }, "holding": { "current": true, "former_roles": [], "held_from": "2022-07-01", "held_to": null, "via": null, "through": null } } }, { "type": "Feature", "id": "ae.dubai.salik.gate.al-barsha", "geometry": { "type": "Point", "coordinates": [ 55.1922592, 25.1161965 ] }, "properties": { "key": "ae.dubai.salik.gate.al-barsha", "name": "Al Barsha toll gate", "name_ar": "بوابة البرشاء", "kind": "toll_gate", "kind_title": "Toll gate", "family": "transport", "layer": "infrastructure.toll_gates", "status": "operating", "status_since": "2007-07-01", "precision": "exact", "precision_m": null, "height_m": null, "base_height_m": null, "country": "AE", "parent_key": null, "register_level": "asset", "asset_key": "ae.dubai.salik.gate.al-barsha", "anchor_lon": 55.1922592, "anchor_lat": 25.1161965, "roles": "concessionaire", "share_pct": null, "primary": true, "servable": true, "gate": "", "brand_cik": "XDFM000029", "brand_mark": null, "attributes": { "road": "Sheikh Zayed Road", "location_note": "2 gantries mapped in OpenStreetMap; the gate spans 119 m" }, "operating_since": { "on": "2007-07-01", "precision": "day", "bound": "on" }, "holding": { "current": true, "former_roles": [], "held_from": "2022-07-01", "held_to": null, "via": null, "through": null } } } ] }, "former": [], "inside": [], "consolidated": false, "group": { "parents": [], "subsidiaries": [] }, "attribution": [ "Astreus · building outlines via Overture Maps Foundation", "© OpenStreetMap contributors (ODbL)" ], "formerTotal": 0, "total": 10, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/geo/layers": { "get": { "summary": "Map layers", "description": "The map layer registry: every layer your plan can see, its declarative symbology (colour token, marker shape, extrusion, label), the asset kinds it draws, zoom range, licence and attribution. A new layer is a registry row — render whatever this returns.", "operationId": "get-map-layers", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "layers": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "group": { "type": "string" }, "sourceType": { "type": "string" }, "sourceConfig": { "type": "object" }, "symbology": { "type": "object", "properties": { "color": { "type": "string" }, "label": { "type": "object", "properties": { "min_zoom": { "type": "integer" }, "property": { "type": "string" } } }, "marker": { "type": "string" }, "extrude": { "type": "boolean" }, "fill_opacity": { "type": "number" }, "marker_size": { "type": "number" }, "logo_min_zoom": { "type": "integer" } } }, "minZoom": { "type": "integer" }, "maxZoom": { "type": "integer" }, "defaultVisible": { "type": "boolean" }, "displayOrder": { "type": "integer" }, "minTier": { "type": "string" }, "licence": { "type": "string" }, "attribution": { "type": "null" }, "kinds": { "type": "array", "items": { "type": "string" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "layers": [ { "code": "assets.real_estate", "title": "Real estate", "description": "Master developments, communities, towers and buildings.", "group": "company_assets", "sourceType": "features", "sourceConfig": {}, "symbology": { "color": "amber", "label": { "min_zoom": 13, "property": "name" }, "marker": "square", "extrude": true, "fill_opacity": 0.14 }, "minZoom": 0, "maxZoom": 24, "defaultVisible": true, "displayOrder": 100, "minTier": "free", "licence": "proprietary", "attribution": null, "kinds": [ "land_bank", "master_development" ] }, { "code": "assets.restaurants", "title": "Restaurants & cafés", "description": "Restaurant, café and food outlets, marked with their brand's logo.", "group": "company_assets", "sourceType": "features", "sourceConfig": {}, "symbology": { "color": "red", "label": { "min_zoom": 15, "property": "name" }, "marker": "circle", "marker_size": 0.8, "logo_min_zoom": 9 }, "minZoom": 0, "maxZoom": 24, "defaultVisible": true, "displayOrder": 115, "minTier": "free", "licence": "proprietary", "attribution": null, "kinds": [ "restaurant" ] } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/geo/countries": { "get": { "summary": "Countries with mapped assets", "description": "The countries that have mapped assets on some layers, with how many each (`layer`, ISO alpha-2 `country`, `count`) — what a per-country overlay lists. Only reviewed assets count.", "operationId": "get-countries-with-mapped-assets", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "layers", "in": "query", "description": "Required. Comma-separated layer codes from /geo/layers, at most 50.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "countries": { "type": "array", "items": {} } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "countries": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/geo/features": { "get": { "summary": "Assets in an area", "description": "Served assets inside a bounding box, or in some countries, as GeoJSON (the GeoJSON path for global layers; same feature properties as /companies/{id}/assets without the company role fields). `truncated` is true when more features exist than `limit` — narrow the box, the countries or the layers. Pilot coverage: only reviewed assets appear.", "operationId": "get-assets-in-an-area", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "bbox", "in": "query", "description": "west,south,east,north in degrees (EPSG:4326); at most 60° per side; split boxes that cross the antimeridian. Required unless `countries` is given.", "schema": { "type": "string" } }, { "name": "countries", "in": "query", "description": "Comma-separated ISO 3166-1 alpha-2 codes (e.g. AE,SA), at most 60: only assets in these countries, wherever they are — with no `bbox`, the whole country.", "schema": { "type": "string" } }, { "name": "layers", "in": "query", "description": "Comma-separated layer codes from /geo/layers, at most 50 (default: every feature layer).", "schema": { "type": "string" } }, { "name": "cik", "in": "query", "description": "Only this company's assets (SEC CIK or platform key).", "schema": { "type": "string" } }, { "name": "as_of", "in": "query", "description": "YYYY-MM-DD; default today.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "1–5000, default 2000; with view=attributes the page size, 1–200, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 5000, "default": 2000 } }, { "name": "view", "in": "query", "description": "`attributes`: no geometry — `summary` counts and one page of `assets` with `geometry_licence` and `location` (withheld when the licence is share-alike or unrecorded); works with `countries` or `bbox`.", "schema": { "type": "string", "enum": [ "attributes" ] } }, { "name": "kind", "in": "query", "description": "attributes: asset kind codes, comma-separated, at most 30.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "attributes: lifecycle statuses, comma-separated.", "schema": { "type": "string" } }, { "name": "level", "in": "query", "description": "attributes: register level, asset | component | all (default all).", "schema": { "type": "string", "enum": [ "asset", "component", "all" ] } }, { "name": "q", "in": "query", "description": "attributes: words in the name.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "attributes: rows to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "as_of": { "type": "string", "format": "date" }, "bbox": { "type": "array", "items": { "type": "number" } }, "truncated": { "type": "boolean" }, "layers": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "group": { "type": "string" }, "sourceType": { "type": "string" }, "sourceConfig": { "type": "object" }, "symbology": { "type": "object", "properties": { "color": { "type": "string" }, "label": { "type": "object", "properties": { "min_zoom": { "type": "integer" }, "property": { "type": "string" } } }, "marker": { "type": "string" }, "marker_size": { "type": "number" } } }, "minZoom": { "type": "integer" }, "maxZoom": { "type": "integer" }, "defaultVisible": { "type": "boolean" }, "displayOrder": { "type": "integer" }, "minTier": { "type": "string" }, "licence": { "type": "string" }, "attribution": { "type": "null" }, "kinds": { "type": "array", "items": { "type": "string" } } } } }, "counts": { "type": "object", "properties": { "infrastructure.toll_gates": { "type": "integer" } } }, "features": { "type": "object", "properties": { "type": { "type": "string" }, "features": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string" }, "id": { "type": "string" }, "geometry": { "type": "object", "properties": { "type": { "type": "string" }, "coordinates": { "type": "array", "items": { "type": "number" } } } }, "properties": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "name_ar": { "type": "string" }, "kind": { "type": "string" }, "kind_title": { "type": "string" }, "family": { "type": "string" }, "layer": { "type": "string" }, "status": { "type": "string" }, "status_since": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "precision_m": { "type": "null" }, "height_m": { "type": "null" }, "base_height_m": { "type": "null" }, "country": { "type": "string" }, "parent_key": { "type": "null" }, "register_level": { "type": "string" }, "asset_key": { "type": "string" }, "anchor_lon": { "type": "number" }, "anchor_lat": { "type": "number" }, "roles": { "type": "string" }, "share_pct": { "type": "null" }, "primary": { "type": "boolean" }, "servable": { "type": "boolean" }, "gate": { "type": "string" }, "brand_cik": { "type": "string" }, "brand_mark": { "type": "null" }, "attributes": { "type": "object", "properties": { "road": { "type": "string" }, "location_note": { "type": "string" } } }, "operating_since": { "type": "object", "properties": { "on": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "bound": { "type": "string" } } } } } } } } } }, "attribution": { "type": "array", "items": { "type": "string" } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "as_of": "2026-11-01", "bbox": [ 54.9, 24.8 ], "truncated": true, "layers": [ { "code": "infrastructure.toll_gates", "title": "Toll gates", "description": "Road-toll gantries.", "group": "transport", "sourceType": "features", "sourceConfig": {}, "symbology": { "color": "cyan", "label": { "min_zoom": 10, "property": "name" }, "marker": "diamond", "marker_size": 1.15 }, "minZoom": 0, "maxZoom": 24, "defaultVisible": true, "displayOrder": 200, "minTier": "free", "licence": "proprietary", "attribution": null, "kinds": [ "toll_gate" ] } ], "counts": { "infrastructure.toll_gates": 2 }, "features": { "type": "FeatureCollection", "features": [ { "type": "Feature", "id": "ae.dubai.salik.gate.al-garhoud-bridge", "geometry": { "type": "Point", "coordinates": [ 55.3356401, 25.2308221 ] }, "properties": { "key": "ae.dubai.salik.gate.al-garhoud-bridge", "name": "Al Garhoud Bridge toll gate", "name_ar": "بوابة جسر القرهود", "kind": "toll_gate", "kind_title": "Toll gate", "family": "transport", "layer": "infrastructure.toll_gates", "status": "operating", "status_since": "2007-07-01", "precision": "exact", "precision_m": null, "height_m": null, "base_height_m": null, "country": "AE", "parent_key": null, "register_level": "asset", "asset_key": "ae.dubai.salik.gate.al-garhoud-bridge", "anchor_lon": 55.3356401, "anchor_lat": 25.2308221, "roles": "", "share_pct": null, "primary": false, "servable": true, "gate": "", "brand_cik": "XDFM000029", "brand_mark": null, "attributes": { "road": "Al Garhoud Bridge", "location_note": "2 gantries mapped in OpenStreetMap; the gate spans 39 m" }, "operating_since": { "on": "2007-07-01", "precision": "day", "bound": "on" } } }, { "type": "Feature", "id": "ae.dubai.salik.gate.al-barsha", "geometry": { "type": "Point", "coordinates": [ 55.1922592, 25.1161965 ] }, "properties": { "key": "ae.dubai.salik.gate.al-barsha", "name": "Al Barsha toll gate", "name_ar": "بوابة البرشاء", "kind": "toll_gate", "kind_title": "Toll gate", "family": "transport", "layer": "infrastructure.toll_gates", "status": "operating", "status_since": "2007-07-01", "precision": "exact", "precision_m": null, "height_m": null, "base_height_m": null, "country": "AE", "parent_key": null, "register_level": "asset", "asset_key": "ae.dubai.salik.gate.al-barsha", "anchor_lon": 55.1922592, "anchor_lat": 25.1161965, "roles": "", "share_pct": null, "primary": false, "servable": true, "gate": "", "brand_cik": "XDFM000029", "brand_mark": null, "attributes": { "road": "Sheikh Zayed Road", "location_note": "2 gantries mapped in OpenStreetMap; the gate spans 119 m" }, "operating_since": { "on": "2007-07-01", "precision": "day", "bound": "on" } } } ] }, "attribution": [ "Astreus · building outlines via Overture Maps Foundation", "© OpenStreetMap contributors (ODbL)" ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/geo/features/{key}": { "get": { "summary": "Asset detail", "description": "One asset in full: kind, status and dated lifecycle, location precision, geometry type, bbox, area or length, kind-specific attributes, every party with role, share and validity, containment (parent, children), typed links to other assets, external identifiers with links (OpenStreetMap, Wikidata, Overture GERS) and the sources behind each fact with what each supports (existence, location, ownership, attributes, lifecycle).", "operationId": "get-asset-detail", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Stable asset key from the `key` property of an assets / features response, e.g. ae.dubai.emaar.burj-khalifa." }, { "name": "as_of", "in": "query", "description": "YYYY-MM-DD: status as of that day; default today.", "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "`attributes`: `anchor` and `bbox` become `location` and `extent`, both null with `location_withheld` when the licence is share-alike or unrecorded.", "schema": { "type": "string", "enum": [ "attributes" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "names": { "type": "object", "properties": { "ar": { "type": "string" } } }, "description": { "type": "string" }, "kind": { "type": "string" }, "kind_title": { "type": "string" }, "family": { "type": "string" }, "layer": { "type": "string" }, "status": { "type": "string" }, "status_since": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "precision_m": { "type": "null" }, "height_m": { "type": "null" }, "base_height_m": { "type": "null" }, "country": { "type": "string" }, "attributes": { "type": "object", "properties": { "road": { "type": "string" }, "location_note": { "type": "string" } } }, "geometry_type": { "type": "string" }, "anchor": { "type": "array", "items": { "type": "number" } }, "bbox": { "type": "array", "items": { "type": "number" } }, "area_m2": { "type": "null" }, "length_m": { "type": "null" }, "geometry_source": { "type": "string" }, "geometry_licence": { "type": "string" }, "parent": { "type": "null" }, "children": { "type": "array", "items": {} }, "parties": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "role": { "type": "string" }, "via": { "type": "null" }, "share_pct": { "type": "null" }, "valid_from": { "type": "string", "format": "date" }, "valid_to": { "type": [ "string", "null" ], "format": "date" }, "primary": { "type": "boolean" }, "note": { "type": [ "string", "null" ] }, "ticker": { "type": [ "string", "null" ] } } } }, "lifecycle": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string" }, "on": { "type": "string", "format": "date" }, "precision": { "type": "string" }, "bound": { "type": "string" }, "note": { "type": "null" }, "source_key": { "type": "string" } } } }, "links": { "type": "array", "items": {} }, "external_ids": { "type": "array", "items": { "type": "object", "properties": { "namespace": { "type": "string" }, "id": { "type": "string" }, "relation": { "type": "string" }, "url": { "type": "string" } } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "type": { "type": "string" }, "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" }, "doc_ref": { "type": "null" }, "published_on": { "type": "null" }, "accessed_on": { "type": [ "string", "null" ], "format": "date" }, "page": { "type": "null" }, "excerpt": { "type": [ "string", "null" ] }, "supports": { "type": "array", "items": { "type": "string" } } } } }, "attribution": { "type": "array", "items": { "type": "string" } }, "servable": { "type": "boolean" }, "gate_reasons": { "type": "array", "items": {} } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "key": "ae.dubai.salik.gate.al-garhoud-bridge", "name": "Al Garhoud Bridge toll gate", "names": { "ar": "بوابة جسر القرهود" }, "description": "Salik toll gate on Al Garhoud Bridge; the point is the centre of its 2 mapped gantries (one per carriageway).", "kind": "toll_gate", "kind_title": "Toll gate", "family": "transport", "layer": "infrastructure.toll_gates", "status": "operating", "status_since": "2007-07-01", "precision": "exact", "precision_m": null, "height_m": null, "base_height_m": null, "country": "AE", "attributes": { "road": "Al Garhoud Bridge", "location_note": "2 gantries mapped in OpenStreetMap; the gate spans 39 m" }, "geometry_type": "POINT", "anchor": [ 55.3356401, 25.2308221 ], "bbox": [ 55.3356401, 25.2308221 ], "area_m2": null, "length_m": null, "geometry_source": "osm:n4444444078", "geometry_licence": "odbl-1.0", "parent": null, "children": [], "parties": [ { "cik": "XDFM000029", "name": "Salik Company PJSC", "role": "concessionaire", "via": null, "share_pct": null, "valid_from": "2022-07-01", "valid_to": "2071-07-01", "primary": true, "note": "Exclusive 49-year tolling concession granted by the RTA, effective 1 July 2022.", "ticker": "SALIK" }, { "cik": null, "name": "Roads and Transport Authority (RTA), Government of Dubai", "role": "grantor", "via": null, "share_pct": null, "valid_from": "2022-07-01", "valid_to": null, "primary": false, "note": null, "ticker": null } ], "lifecycle": [ { "status": "operating", "on": "2007-07-01", "precision": "day", "bound": "on", "note": null, "source_key": "news.khaleejtimes.salik-19-years-2026" } ], "links": [], "external_ids": [ { "namespace": "osm", "id": "n4444444077", "relation": "part", "url": "https://www.openstreetmap.org/node/4444444077" }, { "namespace": "osm", "id": "n4444444078", "relation": "part", "url": "https://www.openstreetmap.org/node/4444444078" } ], "sources": [ { "key": "salik.investors.overview", "type": "issuer_website", "title": "Salik investor relations overview (49-year RTA concession from 1 July 2022)", "publisher": "Salik", "url": "https://www.salik.ae/en/Investors/Overview", "doc_ref": null, "published_on": null, "accessed_on": null, "page": null, "excerpt": null, "supports": [ "ownership" ] }, { "key": "osm.n4444444077", "type": "dataset", "title": "OpenStreetMap node 4444444077 — Al Garhoud Bridge toll gantry (Daylight Map Distribution v1.58 (OpenStreetMap, Nov 2024), read 2026-10-06)", "publisher": "OpenStreetMap contributors", "url": "https://www.openstreetmap.org/node/4444444077", "doc_ref": null, "published_on": null, "accessed_on": "2026-10-06", "page": null, "excerpt": "highway=toll_gantry; name=Al Garhoud Bridge Salik Toll Gate; name:en=Al Garhoud Bridge Salik Toll Gate; operator=RTA SALIK", "supports": [ "location" ] } ], "attribution": [ "Astreus · building outlines via Overture Maps Foundation", "© OpenStreetMap contributors (ODbL)" ], "servable": true, "gate_reasons": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/geo/features/{key}/data": { "get": { "summary": "Asset alt data", "description": "Alternative data collected on one asset (construction progress, satellite change) as time series. An unknown asset key is a 404; a `view` other than `series` is a 400.", "operationId": "get-asset-alt-data", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Stable asset key, e.g. ae.dubai.emaar.burj-khalifa." }, { "name": "view", "in": "query", "description": "`series`: each series names its sources (publisher, link, licence) and the attribution they require; leaves out toll-gate traffic and rows that are non-commercial or cite no source.", "schema": { "type": "string", "enum": [ "series" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tracking/vessels": { "get": { "summary": "Live vessels", "description": "Live vessel positions (AIS) inside a bounding box: the last report of every vessel heard in the last 24 hours, newest first, as column-oriented rows — `fields` names the columns (mmsi, lon, lat, cog, sog, heading, category, name, flag, ageS, navStatus, lengthM). `ageS` is the age of each position: a live map shows last-known positions. `sources` lists each feed with its coverage and health — coverage is regional until a global satellite feed is licensed, so an empty sea means not heard, not empty (`coverageNote`). `attribution` lists the credits to display. Paged newest first: `limit`, `offset`, `hasMore`, `nextOffset` (`truncated` is the same as `hasMore`); a whole viewport for a map is one call with `limit=15000`.", "operationId": "get-live-vessels", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "bbox", "in": "query", "description": "west,south,east,north in degrees; default the world.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Comma-separated: tanker, cargo, passenger, fishing, service, high_speed, pleasure, military, other, unknown.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Rows per page, 1–20000, default 2000.", "schema": { "type": "integer", "minimum": 1, "maximum": 20000, "default": 2000 } }, { "name": "offset", "in": "query", "description": "Rows to skip (the previous `nextOffset`), 0–200000, default 0. Positions move between calls, so a later page can repeat or miss a vessel.", "schema": { "type": "integer", "minimum": 0, "maximum": 200000, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string" }, "asOf": { "type": "string", "format": "date-time" }, "bbox": { "type": "array", "items": { "type": "integer" } }, "count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" }, "truncated": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "coverageNote": { "type": "string" }, "attribution": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "domain": { "type": "string" }, "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" }, "licence": { "type": "string" }, "attribution": { "type": "string" }, "coverage": { "type": "string" }, "enabled": { "type": "boolean" }, "healthy": { "type": "boolean" }, "lastOkAt": { "type": [ "string", "null" ], "format": "date-time" }, "objects": { "type": [ "integer", "null" ] } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "kind": "vessel", "asOf": "2026-11-01T12:48:47.640Z", "bbox": [ -180, -90 ], "count": 2, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2, "truncated": true, "fields": [ "mmsi", "lon" ], "rows": [ [ 461000260, 28.48448 ], [ 311001572, 25.33116 ] ], "coverageNote": "Positions come only from where the feeds in `sources` hear (each source's `coverage`); an area with no rows is not an empty sea or sky.", "attribution": [ "Vessels: aisstream.io", "Vessels: Fintraffic / digitraffic.fi, CC BY 4.0" ], "sources": [ { "code": "aisstream", "domain": "vessel", "title": "aisstream.io global AIS", "publisher": "aisstream.io (worldwide community and coastal receivers)", "url": "https://aisstream.io/", "licence": "aisstream.io (no published licence or terms)", "attribution": "Vessels: aisstream.io", "coverage": "Worldwide coasts, ports, straits and busy seaways within reach of a shore receiver; open ocean only where a ship passes near one.", "enabled": true, "healthy": true, "lastOkAt": "2026-11-01T12:48:42.357Z", "objects": 44062 }, { "code": "kystverket", "domain": "vessel", "title": "Kystverket open AIS", "publisher": "Norwegian Coastal Administration (Kystverket)", "url": "https://www.kystverket.no/en/sea-transport-and-ports/ais/access-to-ais-data/", "licence": "Norwegian Licence for Open Government Data 2.0", "attribution": "Vessels: Norwegian Coastal Administration, NLOD 2.0", "coverage": "Norwegian economic zone, Svalbard and Jan Mayen (excludes fishing vessels under 15 m and leisure craft under 45 m).", "enabled": false, "healthy": false, "lastOkAt": null, "objects": null } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tracking/vessels/{mmsi}": { "get": { "summary": "Vessel detail", "description": "One vessel: identity (IMO, name, call sign, AIS type, flag from its MMSI, length and beam), voyage as broadcast (destination, ETA, draught), last position with age, its path over the last 24 hours (`track.coordinates`: lon, lat, epoch seconds), recent port calls with dwell and draught in/out, and earlier identities (renames, re-flags). 404 when not heard in 24 hours.", "operationId": "get-vessel-detail", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "mmsi", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Maritime Mobile Service Identity, 1–9 digits." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "mmsi": { "type": "integer" }, "imo": { "type": "integer" }, "name": { "type": "string" }, "callsign": { "type": "string" }, "shipType": { "type": "integer" }, "category": { "type": "string" }, "flag": { "type": "string" }, "flagName": { "type": "string" }, "lengthM": { "type": "integer" }, "beamM": { "type": "integer" }, "destination": { "type": "string" }, "eta": { "type": "string", "format": "date-time" }, "draughtM": { "type": "number" }, "position": { "type": "object", "properties": { "lon": { "type": "number" }, "lat": { "type": "number" }, "sog": { "type": "number" }, "cog": { "type": "number" }, "heading": { "type": "integer" }, "navStatus": { "type": "integer" }, "reportedAt": { "type": "string", "format": "date-time" }, "ageS": { "type": "integer" } } }, "track": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "hasAltitude": { "type": "boolean" } } }, "portCalls": { "type": "array", "items": {} }, "formerIdentities": { "type": "array", "items": {} }, "source": { "type": "string" }, "attribution": { "type": "array", "items": { "type": "string" } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "mmsi": 461000260, "imo": 9360130, "name": "ZALIV VOSTOK", "callsign": "A4DW3", "shipType": 80, "category": "tanker", "flag": "OM", "flagName": "Oman", "lengthM": 244, "beamM": 42, "destination": "RU ULU", "eta": "2026-10-31T15:15:00.000Z", "draughtM": 10.3, "position": { "lon": 28.48448, "lat": 60.019343, "sog": 4.4, "cog": 183.1, "heading": 173, "navStatus": 0, "reportedAt": "2026-11-01T12:48:39.752Z", "ageS": 10 }, "track": { "coordinates": [ [ 29.18545, 1793451022 ], [ 29.1367, 1793451453 ] ], "hasAltitude": false }, "portCalls": [], "formerIdentities": [], "source": "digitraffic", "attribution": [ "Vessels: Fintraffic / digitraffic.fi, CC BY 4.0" ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tracking/aircraft": { "get": { "summary": "Live aircraft", "description": "Live aircraft positions (ADS-B / MLAT) inside a bounding box: every aircraft heard in the last 10 minutes, newest first, as column-oriented rows — `fields` names the columns (icao24, lon, lat, track, gs, alt, onGround, callsign, type, registration, airline, ageS, military, vrate). Positions refresh every one to ten minutes depending on type; extrapolate along `track` at `gs` for short gaps. Aircraft in the FAA LADD and privacy-address programmes are never served. Paged newest first: `limit`, `offset`, `hasMore`, `nextOffset` (`truncated` is the same as `hasMore`); an empty sky means not heard (`coverageNote`, `sources`).", "operationId": "get-live-aircraft", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "bbox", "in": "query", "description": "west,south,east,north in degrees; default the world.", "schema": { "type": "string" } }, { "name": "military", "in": "query", "description": "1 = military aircraft only; 0 (default) = all.", "schema": { "type": "string", "enum": [ "0", "1", "true", "false" ], "default": "0" } }, { "name": "limit", "in": "query", "description": "Rows per page, 1–20000, default 2000.", "schema": { "type": "integer", "minimum": 1, "maximum": 20000, "default": 2000 } }, { "name": "offset", "in": "query", "description": "Rows to skip (the previous `nextOffset`), 0–200000, default 0.", "schema": { "type": "integer", "minimum": 0, "maximum": 200000, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string" }, "asOf": { "type": "string", "format": "date-time" }, "bbox": { "type": "array", "items": { "type": "integer" } }, "count": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" }, "truncated": { "type": "boolean" }, "fields": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "array", "items": { "type": [ "number", "string" ] } } }, "coverageNote": { "type": "string" }, "attribution": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "domain": { "type": "string" }, "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" }, "licence": { "type": "string" }, "attribution": { "type": "string" }, "coverage": { "type": "string" }, "enabled": { "type": "boolean" }, "healthy": { "type": "boolean" }, "lastOkAt": { "type": [ "string", "null" ], "format": "date-time" }, "objects": { "type": [ "integer", "null" ] } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "kind": "aircraft", "asOf": "2026-11-01T12:48:49.022Z", "bbox": [ -180, -90 ], "count": 2, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2, "truncated": true, "fields": [ "icao24", "lon" ], "rows": [ [ "00b089", 22.53219 ], [ "010109", 31.36289 ] ], "coverageNote": "Positions come only from where the feeds in `sources` hear (each source's `coverage`); an area with no rows is not an empty sea or sky.", "attribution": [ "Aircraft: adsb.lol contributors, ODbL 1.0" ], "sources": [ { "code": "adsbhub", "domain": "aircraft", "title": "ADSBHub", "publisher": "ADSBHub (community ADS-B data exchange)", "url": "https://www.adsbhub.org/", "licence": "ADSBHub data exchange terms", "attribution": "Aircraft: ADSBHub contributors", "coverage": "Wherever an ADSBHub contributor's receiver hears the aircraft; real time (not polled).", "enabled": false, "healthy": false, "lastOkAt": null, "objects": null }, { "code": "adsb_lol", "domain": "aircraft", "title": "adsb.lol", "publisher": "adsb.lol (community ADS-B/MLAT receivers)", "url": "https://www.adsb.lol/", "licence": "Open Database License 1.0", "attribution": "Aircraft: adsb.lol contributors, ODbL 1.0", "coverage": "Wherever a community receiver hears the aircraft: dense over North America, Europe and parts of Asia and the Gulf; sparse over oceans and much of Africa.", "enabled": true, "healthy": true, "lastOkAt": "2026-11-01T12:48:45.716Z", "objects": 18244 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tracking/aircraft/{icao24}": { "get": { "summary": "Aircraft detail", "description": "One aircraft by its 24-bit ICAO address: registration, type, owner/operator, airline (with its company `cik` when the airline is a covered company), last position, the current flight leg (origin and destination airports, take-off and landing times, highest altitude) with its path (`path.coordinates`: lon, lat, altitude m, epoch seconds), and recent legs. 404 when not heard in 10 minutes.", "operationId": "get-aircraft-detail", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "icao24", "in": "path", "required": true, "schema": { "type": "string" }, "description": "ICAO 24-bit address, 6 hex digits (e.g. 896123)." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "icao24": { "type": "string" }, "registration": { "type": "string" }, "typeCode": { "type": "string" }, "typeDesc": { "type": "null" }, "ownerOperator": { "type": "null" }, "military": { "type": "boolean" }, "callsign": { "type": "string" }, "airline": { "type": "object", "properties": { "icao": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": "null" } } }, "position": { "type": "object", "properties": { "lon": { "type": "number" }, "lat": { "type": "number" }, "altFt": { "type": "integer" }, "onGround": { "type": "boolean" }, "gs": { "type": "number" }, "track": { "type": "number" }, "vrate": { "type": "integer" }, "squawk": { "type": "string" }, "emergency": { "type": "null" }, "reportedAt": { "type": "string", "format": "date-time" }, "ageS": { "type": "integer" } } }, "leg": { "type": "object", "properties": { "flightId": { "type": "integer" }, "callsign": { "type": "string" }, "airline": { "type": "object", "properties": { "icao": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": "null" } } }, "status": { "type": "string" }, "firstSeenAt": { "type": "string", "format": "date-time" }, "lastSeenAt": { "type": "string", "format": "date-time" }, "tookOffAt": { "type": "null" }, "landedAt": { "type": "null" }, "origin": { "type": "null" }, "destination": { "type": "null" }, "maxAltFt": { "type": "integer" } } }, "path": { "type": "object", "properties": { "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } }, "hasAltitude": { "type": "boolean" } } }, "recentLegs": { "type": "array", "items": { "type": "object", "properties": { "flightId": { "type": "integer" }, "callsign": { "type": "string" }, "airline": { "type": "object", "properties": { "icao": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": "null" } } }, "status": { "type": "string" }, "firstSeenAt": { "type": "string", "format": "date-time" }, "lastSeenAt": { "type": "string", "format": "date-time" }, "tookOffAt": { "type": "null" }, "landedAt": { "type": [ "string", "null" ], "format": "date-time" }, "origin": { "type": "null" }, "destination": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "iata": { "type": "string" }, "icao": { "type": "string" } } }, "maxAltFt": { "type": "integer" } } } }, "source": { "type": "string" }, "attribution": { "type": "array", "items": { "type": "string" } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "icao24": "00b089", "registration": "ZS-SJG", "typeCode": "B738", "typeDesc": null, "ownerOperator": null, "military": false, "callsign": "SFR296", "airline": { "icao": "SFR", "name": "Safair", "cik": null }, "position": { "lon": 22.53219, "lat": -30.828568, "altFt": 37975, "onGround": false, "gs": 408.9, "track": 226.8, "vrate": 0, "squawk": "0424", "emergency": null, "reportedAt": "2026-11-01T12:48:39.000Z", "ageS": 12 }, "leg": { "flightId": 2438383, "callsign": "SFR296", "airline": { "icao": "SFR", "name": "Safair", "cik": null }, "status": "active", "firstSeenAt": "2026-11-01T11:50:22.501Z", "lastSeenAt": "2026-11-01T12:48:39.000Z", "tookOffAt": null, "landedAt": null, "origin": null, "destination": null, "maxAltFt": 38000 }, "path": { "coordinates": [ [ 28.06627, 3749 ], [ 27.68658, 6927 ] ], "hasAltitude": true }, "recentLegs": [ { "flightId": 2428665, "callsign": "SFR287", "airline": { "icao": "SFR", "name": "Safair", "cik": null }, "status": "lost", "firstSeenAt": "2026-11-01T10:06:29.195Z", "lastSeenAt": "2026-11-01T10:34:11.066Z", "tookOffAt": null, "landedAt": null, "origin": null, "destination": null, "maxAltFt": 34000 }, { "flightId": 2313757, "callsign": "SFR218", "airline": { "icao": "SFR", "name": "Safair", "cik": null }, "status": "landed", "firstSeenAt": "2026-10-31T14:57:18.440Z", "lastSeenAt": "2026-10-31T16:42:48.715Z", "tookOffAt": null, "landedAt": "2026-10-31T16:42:48.715Z", "origin": null, "destination": { "key": "airport.fact", "name": "Cape Town International Airport", "iata": "CPT", "icao": "FACT" }, "maxAltFt": 38000 } ], "source": "adsb_lol", "attribution": [ "Aircraft: adsb.lol contributors, ODbL 1.0" ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tracking/chokepoints": { "get": { "summary": "Chokepoint transits", "description": "Maritime chokepoints (Hormuz, Bab-el-Mandeb, Suez, Panama, Singapore Strait, Gibraltar, Dover, Skagen, Øresund, Great Belt, Gulf of Finland, Cape Agulhas) with their crossing lines and the vessel transits detected: today, last 7 days by direction and vessel category, and a daily series. Each gate says whether the feeds cover it (`covered`, `coverage` { status covered | partial | none, daysWithTransits7d, firstDayWithTransits, note }): covered = transits recorded on each of the last 7 complete UTC days. Where not covered, `transitsToday`, `transits7d` and zero days in `daily` are null (unknown, not zero) and `recorded` { today, last7d } holds what was seen, a lower bound. Covered counts are what the feeds heard, so a feed that hears part of a strait undercounts it.", "operationId": "get-chokepoint-transits", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "days", "in": "query", "description": "1–90, default 30.", "schema": { "type": "integer", "minimum": 1, "maximum": 90, "default": 30 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "asOf": { "type": "string", "format": "date-time" }, "gates": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "region": { "type": "string" }, "geometry": { "type": "object", "properties": { "type": { "type": "string" }, "coordinates": { "type": "array", "items": { "type": "array", "items": { "type": "number" } } } } }, "positiveDirection": { "type": "string" }, "negativeDirection": { "type": "string" }, "note": { "type": "string" }, "covered": { "type": "boolean" }, "coverage": { "type": "object", "properties": { "status": { "type": "string" }, "daysWithTransits7d": { "type": "integer" }, "firstDayWithTransits": { "type": [ "string", "null" ], "format": "date" }, "note": { "type": "string" } } }, "transitsToday": { "type": [ "integer", "null" ] }, "transits7d": { "type": [ "integer", "null" ] }, "recorded": { "type": "object", "properties": { "today": { "type": "integer" }, "last7d": { "type": "integer" } } }, "byDirection7d": { "type": "array", "items": { "type": "object", "properties": { "direction": { "type": "string" }, "transits": { "type": "integer" } } } }, "byCategory7d": { "type": "array", "items": { "type": "object", "properties": { "category": { "type": "string" }, "transits": { "type": "integer" } } } }, "daily": { "type": "array", "items": { "type": "object", "properties": { "day": { "type": "string", "format": "date" }, "transits": { "type": [ "integer", "null" ] } } } } } } }, "attribution": { "type": "array", "items": { "type": "string" } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "domain": { "type": "string" }, "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" }, "licence": { "type": "string" }, "attribution": { "type": "string" }, "coverage": { "type": "string" }, "enabled": { "type": "boolean" }, "healthy": { "type": "boolean" }, "lastOkAt": { "type": [ "string", "null" ], "format": "date-time" }, "objects": { "type": [ "integer", "null" ] } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "asOf": "2026-11-01T12:48:50.615Z", "gates": [ { "code": "bab_el_mandeb", "name": "Bab-el-Mandeb", "region": "Red Sea", "geometry": { "type": "LineString", "coordinates": [ [ 43.2674, 12.4994 ], [ 43.4717, 12.6988 ] ] }, "positiveDirection": "into the Gulf of Aden", "negativeDirection": "into the Red Sea", "note": "Djibouti to Yemen, across both channels either side of Perim.", "covered": false, "coverage": { "status": "none", "daysWithTransits7d": 0, "firstDayWithTransits": null, "note": "No transit recorded here in the last 30 days: no served feed covers this strait, so the counts are null (unknown, not zero)." }, "transitsToday": null, "transits7d": null, "recorded": { "today": 0, "last7d": 0 }, "byDirection7d": [], "byCategory7d": [], "daily": [ { "day": "2026-10-03", "transits": null }, { "day": "2026-10-04", "transits": null } ] }, { "code": "cape_good_hope", "name": "Cape Agulhas meridian", "region": "Southern Africa", "geometry": { "type": "LineString", "coordinates": [ [ 20, -38.5 ], [ 20, -34.81 ] ] }, "positiveDirection": "eastbound", "negativeDirection": "westbound", "note": "South from Cape Agulhas: every Cape routing crosses it.", "covered": true, "coverage": { "status": "covered", "daysWithTransits7d": 7, "firstDayWithTransits": "2026-10-13", "note": "Transits recorded on each of the last 7 days, so the counts are served: they are what the feeds heard, and a feed that hears only part of the strait undercounts it." }, "transitsToday": 7, "transits7d": 443, "recorded": { "today": 7, "last7d": 443 }, "byDirection7d": [ { "direction": "westbound", "transits": 269 }, { "direction": "eastbound", "transits": 174 } ], "byCategory7d": [ { "category": "cargo", "transits": 271 }, { "category": "unknown", "transits": 91 } ], "daily": [ { "day": "2026-10-03", "transits": null }, { "day": "2026-10-13", "transits": 8 } ] } ], "attribution": [ "Vessels: aisstream.io", "Vessels: Fintraffic / digitraffic.fi, CC BY 4.0" ], "sources": [ { "code": "aisstream", "domain": "vessel", "title": "aisstream.io global AIS", "publisher": "aisstream.io (worldwide community and coastal receivers)", "url": "https://aisstream.io/", "licence": "aisstream.io (no published licence or terms)", "attribution": "Vessels: aisstream.io", "coverage": "Worldwide coasts, ports, straits and busy seaways within reach of a shore receiver; open ocean only where a ship passes near one.", "enabled": true, "healthy": true, "lastOkAt": "2026-11-01T12:48:42.357Z", "objects": 44062 }, { "code": "kystverket", "domain": "vessel", "title": "Kystverket open AIS", "publisher": "Norwegian Coastal Administration (Kystverket)", "url": "https://www.kystverket.no/en/sea-transport-and-ports/ais/access-to-ais-data/", "licence": "Norwegian Licence for Open Government Data 2.0", "attribution": "Vessels: Norwegian Coastal Administration, NLOD 2.0", "coverage": "Norwegian economic zone, Svalbard and Jan Mayen (excludes fishing vessels under 15 m and leisure craft under 45 m).", "enabled": false, "healthy": false, "lastOkAt": null, "objects": null } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tracking/ports/{key}": { "get": { "summary": "Port activity", "description": "Vessel activity at a port (map feature key from /geo/features, e.g. port.wpi.48276 — Jebel Ali): vessels in port now (tankers, cargo), arrivals and departures over 24 hours and 7 days, median dwell over 30 days, the vessels in port and recent departures. A call opens when a vessel is slow inside the port's zone for 10 minutes. `covered` is true when the feeds reported a vessel there in the last 24 hours; otherwise (`coverage.status` lapsed, with `lastActivityAt`) the counts are null (unknown, not zero) and `recorded` holds what was seen. 404 when no call was recorded there in 30 days.", "operationId": "get-port-activity", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Port feature key." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "featureKey": { "type": "string" }, "name": { "type": "string" }, "covered": { "type": "boolean" }, "coverage": { "type": "object", "properties": { "status": { "type": "string" }, "lastActivityAt": { "type": "string", "format": "date-time" }, "note": { "type": "string" } } }, "inPortNow": { "type": "null" }, "tankersInPort": { "type": "null" }, "cargoInPort": { "type": "null" }, "arrivals24h": { "type": "null" }, "departures24h": { "type": "null" }, "arrivals7d": { "type": "null" }, "recorded": { "type": "object", "properties": { "inPortNow": { "type": "integer" }, "tankersInPort": { "type": "integer" }, "cargoInPort": { "type": "integer" }, "arrivals24h": { "type": "integer" }, "departures24h": { "type": "integer" }, "arrivals7d": { "type": "integer" } } }, "medianDwellS30d": { "type": "integer" }, "lastActivityAt": { "type": "string", "format": "date-time" }, "inPort": { "type": "array", "items": {} }, "recentCalls": { "type": "array", "items": { "type": "object", "properties": { "callId": { "type": "integer" }, "portKey": { "type": "string" }, "portName": { "type": "string" }, "countryCode": { "type": "string" }, "arrivedAt": { "type": "string", "format": "date-time" }, "departedAt": { "type": "string", "format": "date-time" }, "dwellS": { "type": "integer" }, "arrivalDraughtM": { "type": "number" }, "departureDraughtM": { "type": [ "integer", "null" ] }, "mmsi": { "type": "integer" }, "vesselName": { "type": "string" }, "category": { "type": "string" } } } }, "attribution": { "type": "array", "items": { "type": "string" } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "featureKey": "port.wpi.48276", "name": "Mina Jabal Ali", "covered": false, "coverage": { "status": "lapsed", "lastActivityAt": "2026-10-22T06:16:26.999Z", "note": "The feeds have reported no vessel at this port since 2026-10-22T06:16:26.999Z: coverage has lapsed, so the counts are null (unknown, not zero); `recorded` holds what was seen." }, "inPortNow": null, "tankersInPort": null, "cargoInPort": null, "arrivals24h": null, "departures24h": null, "arrivals7d": null, "recorded": { "inPortNow": 0, "tankersInPort": 0, "cargoInPort": 0, "arrivals24h": 0, "departures24h": 0, "arrivals7d": 0 }, "medianDwellS30d": 85076, "lastActivityAt": "2026-10-22T06:16:26.999Z", "inPort": [], "recentCalls": [ { "callId": 30482, "portKey": "port.wpi.48276", "portName": "Mina Jabal Ali", "countryCode": "AE", "arrivedAt": "2026-10-12T22:48:35.036Z", "departedAt": "2026-10-22T06:16:26.999Z", "dwellS": 804472, "arrivalDraughtM": 4.4, "departureDraughtM": null, "mmsi": 576391000, "vesselName": "DAY TIDE", "category": "other" }, { "callId": 143694, "portKey": "port.wpi.48276", "portName": "Mina Jabal Ali", "countryCode": "AE", "arrivedAt": "2026-10-22T03:29:42.007Z", "departedAt": "2026-10-22T06:15:54.017Z", "dwellS": 9972, "arrivalDraughtM": 5, "departureDraughtM": 5, "mmsi": 620999291, "vesselName": "YEKTA 2", "category": "cargo" } ], "attribution": [ "Vessels: aisstream.io", "Vessels: Fintraffic / digitraffic.fi, CC BY 4.0" ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tracking/airports/{key}": { "get": { "summary": "Airport activity", "description": "Flight activity at an airport (map feature key, e.g. airport.omdb — Dubai): departures and arrivals detected in the last 24 hours with the flights.", "operationId": "get-airport-activity", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Airport feature key." } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "featureKey": { "type": "string" }, "name": { "type": "string" }, "iata": { "type": "string" }, "icao": { "type": "string" }, "departures24h": { "type": "integer" }, "arrivals24h": { "type": "integer" }, "recent": { "type": "array", "items": { "type": "object", "properties": { "flightId": { "type": "integer" }, "callsign": { "type": "string" }, "airline": { "type": "object", "properties": { "icao": { "type": "string" }, "name": { "type": "string" }, "cik": { "type": "null" } } }, "status": { "type": "string" }, "firstSeenAt": { "type": "string", "format": "date-time" }, "lastSeenAt": { "type": "string", "format": "date-time" }, "tookOffAt": { "type": [ "string", "null" ], "format": "date-time" }, "landedAt": { "type": [ "string", "null" ], "format": "date-time" }, "origin": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "iata": { "type": "string" }, "icao": { "type": "string" } } }, "destination": { "type": [ "object", "null" ], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "iata": { "type": "string" }, "icao": { "type": "string" } } }, "maxAltFt": { "type": "integer" }, "icao24": { "type": "string" }, "direction": { "type": "string" } } } }, "attribution": { "type": "array", "items": { "type": "string" } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "featureKey": "airport.omdb", "name": "Dubai International Airport", "iata": "DXB", "icao": "OMDB", "departures24h": 350, "arrivals24h": 351, "recent": [ { "flightId": 2444352, "callsign": "FDB4TQ", "airline": { "icao": "FDB", "name": "Fly Dubai", "cik": null }, "status": "active", "firstSeenAt": "2026-11-01T12:44:28.442Z", "lastSeenAt": "2026-11-01T12:44:48.674Z", "tookOffAt": "2026-11-01T12:44:48.674Z", "landedAt": null, "origin": { "key": "airport.omdb", "name": "Dubai International Airport", "iata": "DXB", "icao": "OMDB" }, "destination": null, "maxAltFt": 0, "icao24": "896531", "direction": "departure" }, { "flightId": 2435385, "callsign": "FDB1BH", "airline": { "icao": "FDB", "name": "Fly Dubai", "cik": null }, "status": "landed", "firstSeenAt": "2026-11-01T11:19:08.035Z", "lastSeenAt": "2026-11-01T12:37:12.490Z", "tookOffAt": null, "landedAt": "2026-11-01T12:37:12.490Z", "origin": null, "destination": { "key": "airport.omdb", "name": "Dubai International Airport", "iata": "DXB", "icao": "OMDB" }, "maxAltFt": 37000, "icao24": "89660a", "direction": "arrival" } ], "attribution": [ "Aircraft: adsb.lol contributors, ODbL 1.0" ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tracking/sources": { "get": { "summary": "Live feeds", "description": "The live feeds served, per domain (vessel, aircraft): publisher, licence, credit line, coverage in words, and whether each is delivering now.", "operationId": "get-live-feeds", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "vessel": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "domain": { "type": "string" }, "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" }, "licence": { "type": "string" }, "attribution": { "type": "string" }, "coverage": { "type": "string" }, "enabled": { "type": "boolean" }, "healthy": { "type": "boolean" }, "lastOkAt": { "type": [ "string", "null" ], "format": "date-time" }, "objects": { "type": [ "integer", "null" ] } } } }, "aircraft": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "domain": { "type": "string" }, "title": { "type": "string" }, "publisher": { "type": "string" }, "url": { "type": "string" }, "licence": { "type": "string" }, "attribution": { "type": "string" }, "coverage": { "type": "string" }, "enabled": { "type": "boolean" }, "healthy": { "type": "boolean" }, "lastOkAt": { "type": [ "string", "null" ], "format": "date-time" }, "objects": { "type": [ "integer", "null" ] } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "vessel": [ { "code": "aisstream", "domain": "vessel", "title": "aisstream.io global AIS", "publisher": "aisstream.io (worldwide community and coastal receivers)", "url": "https://aisstream.io/", "licence": "aisstream.io (no published licence or terms)", "attribution": "Vessels: aisstream.io", "coverage": "Worldwide coasts, ports, straits and busy seaways within reach of a shore receiver; open ocean only where a ship passes near one.", "enabled": true, "healthy": true, "lastOkAt": "2026-11-01T12:48:52.668Z", "objects": 44063 }, { "code": "kystverket", "domain": "vessel", "title": "Kystverket open AIS", "publisher": "Norwegian Coastal Administration (Kystverket)", "url": "https://www.kystverket.no/en/sea-transport-and-ports/ais/access-to-ais-data/", "licence": "Norwegian Licence for Open Government Data 2.0", "attribution": "Vessels: Norwegian Coastal Administration, NLOD 2.0", "coverage": "Norwegian economic zone, Svalbard and Jan Mayen (excludes fishing vessels under 15 m and leisure craft under 45 m).", "enabled": false, "healthy": false, "lastOkAt": null, "objects": null } ], "aircraft": [ { "code": "adsbhub", "domain": "aircraft", "title": "ADSBHub", "publisher": "ADSBHub (community ADS-B data exchange)", "url": "https://www.adsbhub.org/", "licence": "ADSBHub data exchange terms", "attribution": "Aircraft: ADSBHub contributors", "coverage": "Wherever an ADSBHub contributor's receiver hears the aircraft; real time (not polled).", "enabled": false, "healthy": false, "lastOkAt": null, "objects": null }, { "code": "adsb_lol", "domain": "aircraft", "title": "adsb.lol", "publisher": "adsb.lol (community ADS-B/MLAT receivers)", "url": "https://www.adsb.lol/", "licence": "Open Database License 1.0", "attribution": "Aircraft: adsb.lol contributors, ODbL 1.0", "coverage": "Wherever a community receiver hears the aircraft: dense over North America, Europe and parts of Asia and the Gulf; sparse over oceans and much of Africa.", "enabled": true, "healthy": true, "lastOkAt": "2026-11-01T12:48:50.716Z", "objects": 18244 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/fleet": { "get": { "summary": "Company live fleet", "description": "The company's aircraft in the air now: each airline designator linked to the company (its own airline and consolidated subsidiaries, with the basis of the link), live aircraft and flights started in the last 24 hours per airline, and the live aircraft as column-oriented rows (same fields as /tracking/aircraft).", "operationId": "get-company-live-fleet", "tags": [ "Geo & Assets" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" } } }, "airlines": { "type": "array", "items": {} }, "aircraft": { "type": "array", "items": {} }, "fields": { "type": "array", "items": { "type": "string" } }, "attribution": { "type": "array", "items": {} } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "company": { "cik": "XDFM000029", "name": "Salik Company PJSC" }, "airlines": [], "aircraft": [], "fields": [ "icao24", "lon" ], "attribution": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/capital-structure": { "get": { "summary": "Capital structure", "description": "Annual cash, total debt and total equity per fiscal year end, oldest first (`capital_structure.series[]`: period, cash, debt, equity). cash = cash and short-term investments, else cash; debt = short-term + long-term debt. `capital_structure` is null when the company has none.", "operationId": "get-capital-structure", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "capital_structure": { "type": "object", "properties": { "series": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "cash": { "type": "integer" }, "debt": { "type": [ "integer", "null" ] }, "equity": { "type": "integer" } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "capital_structure": { "series": [ { "period": "1996-12-31", "cash": 3133000, "debt": null, "equity": 1037000 }, { "period": "2000-01-30", "cash": 61560000, "debt": 500000, "equity": 124563000 } ] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/overview-series": { "get": { "summary": "Overview series", "description": "Overview chart series: annual revenue, diluted EPS and free cash flow, plus the income-statement subtotals (revenue, gross profit, operating, pretax, net) per fiscal year and discrete quarter that feed the revenue-to-profit waterfall, and debt / free cash flow / cash per period for the debt-coverage chart.", "operationId": "get-overview-series", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "overview_series": { "type": "object", "properties": { "revenueEps": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "revenue": { "type": "integer" }, "eps": { "type": [ "number", "null" ] } } } }, "fcf": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "fcf": { "type": "integer" } } } }, "profitConversion": { "type": "object", "properties": { "annual": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "label": { "type": "string" }, "revenue": { "type": "integer" }, "costOfRevenue": { "type": "integer" }, "grossProfit": { "type": "integer" }, "operatingIncome": { "type": "integer" }, "pretaxIncome": { "type": "integer" }, "incomeTax": { "type": "integer" }, "netIncome": { "type": "integer" }, "rnd": { "type": [ "integer", "null" ] }, "sga": { "type": "integer" }, "otherOpex": { "type": [ "integer", "null" ] } } } }, "quarterly": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "label": { "type": "string" }, "revenue": { "type": "integer" }, "costOfRevenue": { "type": "integer" }, "grossProfit": { "type": "integer" }, "operatingIncome": { "type": "integer" }, "pretaxIncome": { "type": "integer" }, "incomeTax": { "type": "integer" }, "netIncome": { "type": "integer" }, "rnd": { "type": [ "integer", "null" ] }, "sga": { "type": "integer" }, "otherOpex": { "type": [ "integer", "null" ] } } } } } }, "debtCoverage": { "type": "object", "properties": { "annual": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "label": { "type": "string" }, "debt": { "type": "integer" }, "debt_basis": { "type": "string" }, "fcf": { "type": [ "integer", "null" ] }, "cash": { "type": "integer" }, "cash_basis": { "type": "string" } } } }, "quarterly": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "label": { "type": "string" }, "debt": { "type": [ "integer", "null" ] }, "debt_basis": { "type": "string" }, "fcf": { "type": "integer" }, "cash": { "type": "integer" }, "cash_basis": { "type": "string" } } } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "overview_series": { "revenueEps": [ { "period": "1995-12-31", "revenue": 1182000, "eps": -0.56 }, { "period": "2000-01-30", "revenue": 374505000, "eps": null } ], "fcf": [ { "period": "1995-12-31", "fcf": -6138000 }, { "period": "1996-12-31", "fcf": -288000 } ], "profitConversion": { "annual": [ { "period": "2019-01-27", "label": "FY2019", "revenue": 11716000000, "costOfRevenue": 4545000000, "grossProfit": 7171000000, "operatingIncome": 3804000000, "pretaxIncome": 3896000000, "incomeTax": -245000000, "netIncome": 4141000000, "rnd": 2376000000, "sga": 991000000, "otherOpex": null }, { "period": "2023-01-29", "label": "FY2023", "revenue": 26974000000, "costOfRevenue": 11618000000, "grossProfit": 15356000000, "operatingIncome": 4224000000, "pretaxIncome": 4181000000, "incomeTax": -187000000, "netIncome": 4368000000, "rnd": 7339000000, "sga": 2440000000, "otherOpex": 1353000000 } ], "quarterly": [ { "period": "2024-10-27", "label": "Q3 FY2025", "revenue": 35082000000, "costOfRevenue": 8926000000, "grossProfit": 26156000000, "operatingIncome": 21869000000, "pretaxIncome": 22316000000, "incomeTax": 3007000000, "netIncome": 19309000000, "rnd": 3390000000, "sga": 897000000, "otherOpex": null }, { "period": "2025-01-26", "label": "Q4 FY2025", "revenue": 39331000000, "costOfRevenue": 10609000000, "grossProfit": 28722000000, "operatingIncome": 24033000000, "pretaxIncome": 25217000000, "incomeTax": 3126000000, "netIncome": 22091000000, "rnd": 3714000000, "sga": 975000000, "otherOpex": null } ] }, "debtCoverage": { "annual": [ { "period": "2021-01-31", "label": "FY2021", "debt": 6963000000, "debt_basis": "short_plus_long", "fcf": null, "cash": 11561000000, "cash_basis": "cash_and_short_term_investments" }, { "period": "2022-01-30", "label": "FY2022", "debt": 10946000000, "debt_basis": "short_plus_long", "fcf": 8132000000, "cash": 21208000000, "cash_basis": "cash_and_short_term_investments" } ], "quarterly": [ { "period": "2024-10-27", "label": "Q3 FY2025", "debt": 8462000000, "debt_basis": "short_plus_long", "fcf": 16814000000, "cash": 38487000000, "cash_basis": "cash_and_short_term_investments" }, { "period": "2025-04-27", "label": "Q1 FY2026", "debt": null, "debt_basis": "short_plus_long", "fcf": 26187000000, "cash": 53691000000, "cash_basis": "cash_and_short_term_investments" } ] } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/monthly-revenue": { "get": { "summary": "Monthly revenue", "description": "Regulator-mandated monthly revenue (Taiwan issuers), current vintage, as filed, with the open-data licence attribution. 404 when the company has no monthly mandate.", "operationId": "get-monthly-revenue", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "monthly_revenue": { "type": "object", "properties": { "currency": { "type": "string" }, "points": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "value": { "type": "integer" }, "yoy": { "type": [ "number", "null" ] }, "note": { "type": [ "string", "null" ] } } } }, "attribution": { "type": "string" }, "licenseUrl": { "type": "string" }, "providerName": { "type": "string" }, "latestSourceDate": { "type": "string", "format": "date" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "monthly_revenue": { "currency": "TWD", "points": [ { "period": "2025-07-31", "value": 613864601000, "yoy": null, "note": null }, { "period": "2026-07-31", "value": 946512543000, "yoy": 0.5418913901503827, "note": "主要受惠於伺服器產品需求提升及出貨成長所致" } ], "attribution": "提供機關／金融監督管理委員會證券期貨局 — 上市公司每月營業收入彙總表 / 上市公司基本資料 — 此開放資料依政府資料開放授權條款 (Open Government Data License) 進行公眾釋出，使用者於遵守本條款各項規定之前提下，得利用之。政府資料開放授權條款：https://data.gov.tw/license", "licenseUrl": "https://data.gov.tw/license", "providerName": "Taiwan Stock Exchange OpenAPI (Open Government Data)", "latestSourceDate": "2026-10-15" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/dividends": { "get": { "summary": "Dividends", "description": "Cash dividend history by ex-date: as-paid and split-adjusted amounts, trailing-12-month total, change vs the prior payment, and each payment's yield AT THE TIME on two price bases — `yieldAtExDatePct` (TTM ÷ the last split-adjusted close before the ex-date) and `yieldPeriodAvgPct` (TTM ÷ the average close from the previous ex-date to the day before this one). `summary` carries the current trailing and indicated yield, cadence and DPS growth; `yieldSeries` is the month-end trailing-yield history. `events` are ordered by ex-date, oldest first by default (`order=desc` for newest first); `from` / `to` (ex-date), `limit` and `offset` window `events` and add `total`, `limit`, `offset`, `hasMore` and `nextOffset`, while `summary`, `announced`, `undated` and `yieldSeries` always describe the whole record. Yields are in percent (3.2 = 3.2%).", "operationId": "get-dividends", "tags": [ "Financial Statements" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "`declared`: exchange-notice and filing rows with their proof only — no vendor rows, yields, prices or split-adjusted amounts; adds `omittedVendorRows`.", "schema": { "type": "string", "enum": [ "declared" ] } }, { "name": "order", "in": "query", "description": "Ex-date order of `events`.", "schema": { "type": "string", "enum": [ "asc", "desc" ], "default": "asc" } }, { "name": "from", "in": "query", "description": "First ex-date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last ex-date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Events per page, 1–500. Omitted = every event.", "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "offset", "in": "query", "description": "Events to skip: the previous reply's `nextOffset`.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "symbol": { "type": "string" }, "currency": { "type": "string" }, "events": { "type": "array", "items": { "type": "object", "properties": { "exDate": { "type": "string", "format": "date" }, "type": { "type": "string" }, "kind": { "type": "string" }, "declaredDate": { "type": [ "string", "null" ], "format": "date" }, "lastEntitlementDate": { "type": [ "string", "null" ], "format": "date" }, "recordDate": { "type": [ "string", "null" ], "format": "date" }, "paymentDate": { "type": [ "string", "null" ], "format": "date" }, "source": { "type": "string" }, "accession": { "type": [ "string", "null" ] }, "proof": { "type": [ "object", "null" ], "properties": { "primary": { "type": "object", "properties": { "docRef": { "type": "string" }, "role": { "type": "string" }, "date": { "type": "string", "format": "date" }, "page": { "type": [ "integer", "null" ] }, "printed": { "type": "string" }, "headline": { "type": "string" }, "ocr": { "type": "boolean" } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "docRef": { "type": "string" }, "role": { "type": "string" }, "date": { "type": "string", "format": "date" }, "page": { "type": [ "integer", "null" ] }, "printed": { "type": "string" }, "headline": { "type": "string" }, "ocr": { "type": "boolean" } } } } } }, "amount": { "type": "number" }, "amountSplitAdj": { "type": "number" }, "ttm": { "type": "number" }, "changePct": { "type": [ "number", "null" ] }, "yieldAtExDatePct": { "type": "number" }, "yieldPeriodAvgPct": { "type": "number" } } } }, "announced": { "type": "array", "items": {} }, "undated": { "type": "array", "items": {} }, "yieldSeries": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "price": { "type": "number" }, "ttm": { "type": "number" }, "yieldPct": { "type": "number" } } } }, "summary": { "type": "object", "properties": { "count": { "type": "integer" }, "latestAmount": { "type": "number" }, "latestExDate": { "type": "string", "format": "date" }, "ttmTotal": { "type": "number" }, "lastPrice": { "type": "number" }, "trailingYieldPct": { "type": "number" }, "indicatedYieldPct": { "type": "number" }, "growth1y": { "type": "integer" }, "growth3y": { "type": "number" }, "cadence": { "type": "string" } } }, "order": { "type": "string" }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "nextOffset": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "symbol": "NVDA", "currency": "USD", "events": [ { "exDate": "2012-11-20", "type": "Cash", "kind": "unspecified", "declaredDate": "2012-11-08", "lastEntitlementDate": null, "recordDate": "2012-11-23", "paymentDate": "2012-12-14", "source": "exchange_notice", "accession": "0001045810-12-000055", "proof": { "primary": { "docRef": "0001045810-12-000055", "role": "approved", "date": "2012-11-08", "page": null, "printed": "0.075", "headline": "NVIDIA declared a quarterly cash dividend of $0.075 per share.", "ocr": false }, "sources": [ { "docRef": "0001045810-12-000055", "role": "approved", "date": "2012-11-08", "page": null, "printed": "0.075", "headline": "NVIDIA declared a quarterly cash dividend of $0.075 per share.", "ocr": false } ] }, "amount": 0.075, "amountSplitAdj": 0.001875, "ttm": 0.001875, "changePct": null, "yieldAtExDatePct": 0.641026, "yieldPeriodAvgPct": 0.57326 }, { "exDate": "2013-02-26", "type": "Cash", "kind": "unspecified", "declaredDate": null, "lastEntitlementDate": null, "recordDate": null, "paymentDate": null, "source": "yahoo", "accession": null, "proof": null, "amount": 0.075, "amountSplitAdj": 0.001875, "ttm": 0.00375, "changePct": 0, "yieldAtExDatePct": 0.609756, "yieldPeriodAvgPct": 0.609177 } ], "announced": [], "undated": [], "yieldSeries": [ { "date": "2012-11-30", "price": 0.29925, "ttm": 0.001875, "yieldPct": 0.6265664160401002 }, { "date": "2025-11-28", "price": 177, "ttm": 0.04, "yieldPct": 0.022598870056497175 } ], "summary": { "count": 55, "latestAmount": 0.25, "latestExDate": "2026-09-10", "ttmTotal": 0.27, "lastPrice": 204.639999, "trailingYieldPct": 0.13193901550009293, "indicatedYieldPct": 0.4886630203707145, "growth1y": 575, "growth3y": 156.49639200150452, "cadence": "Quarterly" }, "order": "asc", "total": 55, "offset": 0, "nextOffset": 2, "limit": 2, "hasMore": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/calendar": { "get": { "summary": "Company events calendar", "description": "The company's dated disclosure events, newest first: 8-K items on their event date (earnings releases, dividend declarations, leadership changes, annual meetings, other filing events) and dividend ex-dates, each with kind, item code, label, accession and severity; `isEarnings` marks 8-K Item 2.02 rows. Also `fiscalYearEnd`. Paged, newest event date first: `limit` (default 100) and `offset`; the body carries `total`, `limit`, `offset`, `hasMore` and `nextOffset` (a large issuer holds 700+ events). No scheduled or estimated results dates: use /earnings/calendar?cik=.", "operationId": "get-earnings-calendar", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Events per page, 1–500, default 100.", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 } }, { "name": "offset", "in": "query", "description": "Events to skip (the previous `nextOffset`), default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "from", "in": "query", "description": "First event date, YYYY-MM-DD (inclusive).", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Last event date, YYYY-MM-DD (inclusive).", "schema": { "type": "string" } }, { "name": "earnings", "in": "query", "description": "true = only 8-K Item 2.02 (results) events.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "itemCode": { "type": [ "string", "null" ] }, "label": { "type": "string" }, "accessionNumber": { "type": [ "string", "null" ] }, "severity": { "type": "null" }, "isEarnings": { "type": "boolean" }, "fiscalYear": { "type": "null" }, "fiscalQuarter": { "type": "null" } } } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" }, "fiscalYearEnd": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "events": [ { "date": "2026-09-10", "kind": "dividend", "itemCode": null, "label": "Dividend ex-date: $0.25 per share", "accessionNumber": null, "severity": null, "isEarnings": false, "fiscalYear": null, "fiscalQuarter": null }, { "date": "2026-09-03", "kind": "filing_event", "itemCode": "9.01", "label": "8-K filed — Financial Statements and Exhibits", "accessionNumber": "0001045810-26-000078", "severity": null, "isEarnings": false, "fiscalYear": null, "fiscalQuarter": null } ], "total": 709, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2, "fiscalYearEnd": "0131" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/earnings/calendar": { "get": { "summary": "Earnings calendar (all companies)", "description": "Results dates in a window, worldwide: issuer-confirmed, issuer-tentative, estimated from reporting history (status `estimated`, with the basis in `explanation`), or reported (with the filing). Dates are issuer-local. Up to 93 days, or ten years with `cik`. `view=compact` drops logos, websites, the quoted disclosure sentence and revision bookkeeping.", "operationId": "get-earnings-calendar-all-companies", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "from", "in": "query", "description": "First day, YYYY-MM-DD (default today).", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Last day, YYYY-MM-DD (default `from`).", "schema": { "type": "string" } }, { "name": "cik", "in": "query", "description": "Numeric CIK (1–10 digits) or platform key (letters then digits, at most 10 characters): that company's dates; widens the window limit to ten years.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Uppercase ISO alpha-2 market codes, comma-separated, up to 80 (e.g. AE,SA). Lowercase codes answer 400.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Only this status.", "schema": { "type": "string", "enum": [ "estimated", "issuer_tentative", "confirmed", "elapsed", "reported", "postponed", "cancelled", "disputed" ] } }, { "name": "search", "in": "query", "description": "Company name or ticker contains; max 100 characters.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "1–1000, default 500.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 500 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "view", "in": "query", "description": "`compact` drops display-only fields (logos, websites).", "schema": { "type": "string", "enum": [ "full", "compact" ], "default": "full" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "cik": { "type": "string" }, "company": { "type": "string" }, "ticker": { "type": "string" }, "country": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "date": { "type": "string", "format": "date" }, "status": { "type": "string" }, "session": { "type": "null" }, "timeText": { "type": "null" }, "windowStart": { "type": "string", "format": "date" }, "windowEnd": { "type": "string", "format": "date" }, "sampleSize": { "type": "integer" }, "explanation": { "type": "string" }, "docRef": { "type": "null" }, "sourceUrl": { "type": "null" }, "quote": { "type": "null" }, "sourcePublishedAt": { "type": "null" }, "updatedAt": { "type": "string", "format": "date-time" }, "revision": { "type": "string" }, "reason": { "type": "string" }, "marketCap": { "type": "integer" }, "exchange": { "type": "string" }, "website": { "type": "string" }, "brandMark": { "type": "string" }, "brandMarkChecked": { "type": "boolean" }, "broadcast": { "type": "null" } } } }, "markets": { "type": "array", "items": { "type": "string" } }, "total": { "type": "integer" }, "summary": { "type": "object", "properties": { "confirmed": { "type": "integer" }, "estimated": { "type": "integer" }, "reported": { "type": "integer" } } }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "generatedAt": { "type": "string", "format": "date-time" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "from": "2026-11-01", "to": "2026-11-01", "events": [ { "id": "43656", "cik": "XSAU000040", "company": "Al Majed Oud Co.", "ticker": "4165", "country": "SA", "periodEnd": "2026-09-30", "kind": "results", "date": "2026-11-01", "status": "estimated", "session": null, "timeText": null, "windowStart": "2026-10-24", "windowEnd": "2026-11-10", "sampleSize": 9, "explanation": "Based on 9 prior releases, including 2 for fiscal Q3. Recent reporting dates carry more weight. This range is an estimate, not an issuer schedule.", "docRef": null, "sourceUrl": null, "quote": null, "sourcePublishedAt": null, "updatedAt": "2026-11-01T00:16:05.759Z", "revision": "376933", "reason": "model_refresh", "marketCap": 778792932, "exchange": "TADAWUL", "website": "http://www.almajed4oud.com", "brandMark": "https://cdn.brandfetch.io/almajed4oud.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brandMarkChecked": true, "broadcast": null }, { "id": "109082", "cik": "XSAU000262", "company": "Al-Rajhi Company for Cooperative Insurance", "ticker": "8230", "country": "SA", "periodEnd": "2026-09-30", "kind": "results", "date": "2026-11-01", "status": "estimated", "session": null, "timeText": null, "windowStart": "2026-10-26", "windowEnd": "2026-11-25", "sampleSize": 59, "explanation": "Based on 59 prior releases, including 14 for fiscal Q3. Recent reporting dates carry more weight. This range is an estimate, not an issuer schedule.", "docRef": null, "sourceUrl": null, "quote": null, "sourcePublishedAt": null, "updatedAt": "2026-11-01T00:16:18.165Z", "revision": "377882", "reason": "model_refresh", "marketCap": 2556877753, "exchange": "TADAWUL", "website": "https://www.alrajhitakaful.com/ar", "brandMark": "https://cdn.brandfetch.io/alrajhitakaful.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brandMarkChecked": true, "broadcast": null } ], "markets": [ "AE", "AT" ], "total": 29, "summary": { "confirmed": 1, "estimated": 8, "reported": 15 }, "offset": 0, "limit": 2, "generatedAt": "2026-11-01T12:49:02.816Z" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/earnings/calendar/recordings": { "post": { "summary": "Call recordings for calendar events", "description": "Which calendar events have a stored call recording: for each `{ id, cik, dates }` (up to 600 events; `id` at most 120 characters, `cik` 1–12 letters or digits, `dates` 1–3 YYYY-MM-DD days), `recordings[id]` gives the transcript id, date partition, whether video exists and the quarter label. Events without a recording are absent.", "operationId": "post-call-recordings-for-calendar-events", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "events" ], "properties": { "events": { "type": "array", "maxItems": 600, "items": { "type": "object", "required": [ "id", "cik", "dates" ], "properties": { "id": { "type": "string" }, "cik": { "type": "string" }, "dates": { "type": "array", "items": { "type": "string", "format": "date" } } } } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/earnings/calendar/{id}": { "get": { "summary": "Earnings date detail", "description": "One results date: the event, the revisions of its date with the evidence for each (newest first, at most 100), the company's past results dates, and the headline results once reported. The estimator re-saves an unchanged estimate on every run: `revisions=changes` keeps only the revisions that changed the date, status or evidence, each with `repeated` (identical re-saves that followed it) and `lastConfirmedAt` (the last one's time), and adds `revisionsTotal` and `revisionsCollapsed`.", "operationId": "get-earnings-date-detail", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The event id as the calendar returned it.", "schema": { "type": "string" } }, { "name": "revisions", "in": "query", "description": "all (default): every revision. changes: only those that changed the date, status or evidence.", "schema": { "type": "string", "enum": [ "all", "changes" ], "default": "all" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "object", "properties": { "id": { "type": "string" }, "cik": { "type": "string" }, "company": { "type": "string" }, "ticker": { "type": "string" }, "country": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "date": { "type": "string", "format": "date" }, "status": { "type": "string" }, "session": { "type": "null" }, "timeText": { "type": "null" }, "windowStart": { "type": "string", "format": "date" }, "windowEnd": { "type": "string", "format": "date" }, "sampleSize": { "type": "integer" }, "explanation": { "type": "string" }, "docRef": { "type": "null" }, "sourceUrl": { "type": "null" }, "quote": { "type": "null" }, "sourcePublishedAt": { "type": "null" }, "updatedAt": { "type": "string", "format": "date-time" }, "revision": { "type": "string" }, "reason": { "type": "string" }, "marketCap": { "type": "integer" }, "exchange": { "type": "string" }, "website": { "type": "string" }, "brandMark": { "type": "string" }, "brandMarkChecked": { "type": "boolean" }, "broadcast": { "type": "null" } } }, "revisions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "date": { "type": "string", "format": "date" }, "reason": { "type": "string" }, "createdAt": { "type": "string", "format": "date-time" }, "docRef": { "type": "null" }, "sourceUrl": { "type": "null" }, "quote": { "type": "null" } } } }, "history": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "cik": { "type": "string" }, "company": { "type": "string" }, "ticker": { "type": "string" }, "country": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "date": { "type": "string", "format": "date" }, "status": { "type": "string" }, "session": { "type": "null" }, "timeText": { "type": "null" }, "windowStart": { "type": "null" }, "windowEnd": { "type": "null" }, "sampleSize": { "type": "null" }, "explanation": { "type": "null" }, "docRef": { "type": "string" }, "sourceUrl": { "type": "string" }, "quote": { "type": "string" }, "sourcePublishedAt": { "type": "null" }, "updatedAt": { "type": "string", "format": "date-time" }, "revision": { "type": "string" }, "reason": { "type": "string" } } } }, "results": { "type": "null" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "event": { "id": "43656", "cik": "XSAU000040", "company": "Al Majed Oud Co.", "ticker": "4165", "country": "SA", "periodEnd": "2026-09-30", "kind": "results", "date": "2026-11-01", "status": "estimated", "session": null, "timeText": null, "windowStart": "2026-10-24", "windowEnd": "2026-11-10", "sampleSize": 9, "explanation": "Based on 9 prior releases, including 2 for fiscal Q3. Recent reporting dates carry more weight. This range is an estimate, not an issuer schedule.", "docRef": null, "sourceUrl": null, "quote": null, "sourcePublishedAt": null, "updatedAt": "2026-11-01T00:16:05.759Z", "revision": "376933", "reason": "model_refresh", "marketCap": 778792932, "exchange": "TADAWUL", "website": "http://www.almajed4oud.com", "brandMark": "https://cdn.brandfetch.io/almajed4oud.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brandMarkChecked": true, "broadcast": null }, "revisions": [ { "id": "376933", "status": "estimated", "date": "2026-11-01", "reason": "model_refresh", "createdAt": "2026-11-01T00:16:05.759Z", "docRef": null, "sourceUrl": null, "quote": null }, { "id": "370833", "status": "estimated", "date": "2026-11-01", "reason": "model_refresh", "createdAt": "2026-10-31T00:16:01.562Z", "docRef": null, "sourceUrl": null, "quote": null } ], "history": [ { "id": "13211", "cik": "XSAU000040", "company": "Al Majed Oud Co.", "ticker": "4165", "country": "SA", "periodEnd": "2026-06-30", "kind": "results", "date": "2026-08-05", "status": "reported", "session": null, "timeText": null, "windowStart": null, "windowEnd": null, "sampleSize": null, "explanation": null, "docRef": "SAU-4165-20260805-PR", "sourceUrl": "https://www.saudiexchange.sa/wps/portal/saudiexchange/newsandreports/issuer-news/issuer-announcements/issuer-announcements-details/?anId=97261&anCat=1&cs=4165&locale=en", "quote": "Al Majed Oud Co. announces its Interim Financial results for the Period Ending on 2026-06-30 ( Six Months )", "sourcePublishedAt": null, "updatedAt": "2026-09-15T14:03:26.799Z", "revision": "12533", "reason": "issuer_evidence" }, { "id": "13208", "cik": "XSAU000040", "company": "Al Majed Oud Co.", "ticker": "4165", "country": "SA", "periodEnd": "2026-03-31", "kind": "results", "date": "2026-04-30", "status": "reported", "session": null, "timeText": null, "windowStart": null, "windowEnd": null, "sampleSize": null, "explanation": null, "docRef": "SAU-4165-20260430-PR", "sourceUrl": "https://www.saudiexchange.sa/wps/portal/saudiexchange/newsandreports/issuer-news/issuer-announcements/issuer-announcements-details/?anId=94809&anCat=1&cs=4165&locale=en", "quote": "Al Majed Oud Co. announces its Interim Financial results for the Period Ending on 2026-03-31 ( Three Months )", "sourcePublishedAt": null, "updatedAt": "2026-09-15T14:03:23.116Z", "revision": "12530", "reason": "issuer_evidence" } ], "results": null } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/earnings/live": { "get": { "summary": "Live earnings calls", "description": "The earnings calls being streamed now, largest company first; `calls: []` when none is live.", "operationId": "get-live-earnings-calls", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "calls": { "type": "array", "items": {} } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "calls": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/economic/calendar": { "get": { "summary": "Economic calendar", "description": "Scheduled statistical releases and central-bank decisions in a window (up to 400 days) from every stored release calendar (US today; each event names its `country`), cancelled dates excluded, each with its importance, status and, once released, the headline series' print (actual, prior, year-ago). `importance` is a floor. Without `limit`/`offset` the whole window, at most 1,500 dates read before `search` and `importance` filter them; `truncated` says the window held more. `status`: scheduled, released (the headline print is held), awaiting (the date has passed, or the agency has published, and the headline print is not in our copy yet; served so for 45 days after the date), or cancelled. `summary.awaiting` counts those and `stale` is true when any is served. The reply echoes the window as `from` / `to` (default today).", "operationId": "get-economic-calendar", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "from", "in": "query", "description": "First day, YYYY-MM-DD (default today).", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Last day, YYYY-MM-DD (default `from`).", "schema": { "type": "string" } }, { "name": "importance", "in": "query", "description": "Minimum importance.", "schema": { "type": "string", "enum": [ "high", "medium", "low" ] } }, { "name": "search", "in": "query", "description": "Release name, short name, source agency or headline series title/id contains (case-insensitive); max 100 characters.", "schema": { "type": "string" } }, { "name": "release", "in": "query", "description": "One release id.", "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "Page size, 1–500 (500 when only `offset` is given); with `offset`, pages the window (`nextOffset` names the next page). Without both, the whole window.", "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "releaseId": { "type": "integer" }, "provider": { "type": "string" }, "externalReleaseId": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "source": { "type": "string" }, "link": { "type": "string" }, "country": { "type": "string" }, "date": { "type": "string", "format": "date" }, "time": { "type": "null" }, "timezone": { "type": "null" }, "releaseAt": { "type": "null" }, "importance": { "type": "string" }, "status": { "type": "string" }, "kind": { "type": "string" }, "referencePeriod": { "type": "null" }, "pressConference": { "type": "boolean" }, "projections": { "type": "boolean" }, "seriesCount": { "type": "integer" }, "headline": { "type": "object", "properties": { "seriesId": { "type": "string" }, "externalId": { "type": "string" }, "title": { "type": "string" }, "units": { "type": "string" }, "frequency": { "type": "string" }, "actual": { "type": "null" }, "prior": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "value": { "type": "number" } } }, "yearAgo": { "type": "null" } } }, "updatedAt": { "type": "string", "format": "date-time" } } } }, "total": { "type": "integer" }, "summary": { "type": "object", "properties": { "high": { "type": "integer" }, "medium": { "type": "integer" }, "low": { "type": "integer" }, "released": { "type": "integer" }, "awaiting": { "type": "integer" } } }, "stale": { "type": "boolean" }, "truncated": { "type": "boolean" }, "generatedAt": { "type": "string", "format": "date-time" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "from": "2026-11-01", "to": "2026-11-01", "events": [ { "id": "89603", "releaseId": 441, "provider": "FRED", "externalReleaseId": "441", "name": "Coinbase Cryptocurrencies", "shortName": "Coinbase Cryptocurrencies", "source": "Coinbase", "link": "https://www.coinbase.com/charts?locale=en-US", "country": "US", "date": "2026-11-01", "time": null, "timezone": null, "releaseAt": null, "importance": "low", "status": "scheduled", "kind": "release", "referencePeriod": null, "pressConference": false, "projections": false, "seriesCount": 1, "headline": { "seriesId": "6732", "externalId": "CBBTCUSD", "title": "Coinbase Bitcoin", "units": "U.S. $", "frequency": "D", "actual": null, "prior": { "period": "2026-10-31", "value": 77403.92 }, "yearAgo": null }, "updatedAt": "2026-10-26T02:21:42.218Z" }, { "id": "86554", "releaseId": 101, "provider": "FRED", "externalReleaseId": "101", "name": "FOMC Press Release", "shortName": "FOMC Press Release", "source": "Board of Governors of the Federal Reserve System (US)", "link": "http://www.federalreserve.gov/fomc/", "country": "US", "date": "2026-11-01", "time": null, "timezone": null, "releaseAt": null, "importance": "low", "status": "scheduled", "kind": "release", "referencePeriod": null, "pressConference": false, "projections": false, "seriesCount": 2, "headline": { "seriesId": "6404", "externalId": "DFEDTARU", "title": "Federal Funds Target Range - Upper Limit", "units": "%", "frequency": "D", "actual": null, "prior": { "period": "2026-10-31", "value": 4 }, "yearAgo": null }, "updatedAt": "2026-10-26T02:20:34.556Z" } ], "total": 3, "summary": { "high": 0, "medium": 0, "low": 3, "released": 0, "awaiting": 0 }, "stale": false, "truncated": false, "generatedAt": "2026-11-01T12:49:07.722Z", "offset": 0, "limit": 2, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/economic/calendar/{id}": { "get": { "summary": "Economic release detail", "description": "One release event: its series with their prints and the release's next scheduled dates.", "operationId": "get-economic-release-detail", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The event id as the calendar returned it.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "object", "properties": { "id": { "type": "string" }, "releaseId": { "type": "integer" }, "provider": { "type": "string" }, "externalReleaseId": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "source": { "type": "string" }, "link": { "type": "string" }, "country": { "type": "string" }, "date": { "type": "string", "format": "date" }, "time": { "type": "null" }, "timezone": { "type": "null" }, "releaseAt": { "type": "null" }, "importance": { "type": "string" }, "status": { "type": "string" }, "kind": { "type": "string" }, "referencePeriod": { "type": "null" }, "pressConference": { "type": "boolean" }, "projections": { "type": "boolean" }, "seriesCount": { "type": "integer" }, "headline": { "type": "object", "properties": { "seriesId": { "type": "string" }, "externalId": { "type": "string" }, "title": { "type": "string" }, "units": { "type": "string" }, "frequency": { "type": "string" }, "actual": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "value": { "type": "number" } } }, "prior": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "value": { "type": "number" } } }, "yearAgo": { "type": "null" } } }, "updatedAt": { "type": "string", "format": "date-time" } } }, "series": { "type": "array", "items": { "type": "object", "properties": { "seriesId": { "type": "string" }, "externalId": { "type": "string" }, "title": { "type": "string" }, "units": { "type": "string" }, "frequency": { "type": "string" }, "actual": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "value": { "type": "number" } } }, "prior": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "value": { "type": "number" } } }, "yearAgo": { "type": "null" }, "seasonalAdjustment": { "type": "string" } } } }, "schedule": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date" }, "referencePeriod": { "type": "null" }, "status": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "event": { "id": "89572", "releaseId": 441, "provider": "FRED", "externalReleaseId": "441", "name": "Coinbase Cryptocurrencies", "shortName": "Coinbase Cryptocurrencies", "source": "Coinbase", "link": "https://www.coinbase.com/charts?locale=en-US", "country": "US", "date": "2026-10-01", "time": null, "timezone": null, "releaseAt": null, "importance": "low", "status": "released", "kind": "release", "referencePeriod": null, "pressConference": false, "projections": false, "seriesCount": 1, "headline": { "seriesId": "6732", "externalId": "CBBTCUSD", "title": "Coinbase Bitcoin", "units": "U.S. $", "frequency": "D", "actual": { "period": "2026-10-01", "value": 84759.64 }, "prior": { "period": "2026-09-30", "value": 83482.51 }, "yearAgo": null }, "updatedAt": "2026-10-26T02:21:42.218Z" }, "series": [ { "seriesId": "6732", "externalId": "CBBTCUSD", "title": "Coinbase Bitcoin", "units": "U.S. $", "frequency": "D", "actual": { "period": "2026-10-01", "value": 84759.64 }, "prior": { "period": "2026-09-30", "value": 83482.51 }, "yearAgo": null, "seasonalAdjustment": "NSA" } ], "schedule": [ { "id": "89566", "date": "2026-09-25", "referencePeriod": null, "status": "released" }, { "id": "89567", "date": "2026-09-26", "referencePeriod": null, "status": "released" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/corporate/calendar": { "get": { "summary": "Corporate events calendar", "description": "Dated corporate events from issuer disclosure in a window (up to 93 days): shareholder meetings, leadership changes, dividends (declared, record and pay dates), capital actions and deals, exchange listings. Each row names its filing (accession, sourceUrl).", "operationId": "get-corporate-events-calendar", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "from", "in": "query", "description": "First day, YYYY-MM-DD (default today).", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Last day, YYYY-MM-DD (default `from`).", "schema": { "type": "string" } }, { "name": "kinds", "in": "query", "description": "Comma-separated: meeting, leadership, dividend, capital, listing, other.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Uppercase ISO alpha-2 market codes, comma-separated, up to 80 (e.g. AE,SA). Lowercase codes answer 400.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Company name, ticker or CIK contains (also matches company-name search aliases); max 100 characters. Event text is not searched.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size, 1–500 (500 when only `offset` is given); with `offset`, pages the window (`nextOffset` names the next page). Without both, the whole window.", "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "view", "in": "query", "description": "`compact` drops display-only fields (logos, websites).", "schema": { "type": "string", "enum": [ "full", "compact" ], "default": "full" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" }, "events": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "company": { "type": "string" }, "ticker": { "type": "string" }, "country": { "type": "string" }, "detail": { "type": "string" }, "itemCode": { "type": "string" }, "accession": { "type": "string" }, "sourceUrl": { "type": "string" }, "dateBasis": { "type": "string" }, "trustStatus": { "type": "string" }, "amount": { "type": "null" }, "currency": { "type": "null" }, "dividend": { "type": "null" }, "id": { "type": "string" }, "date": { "type": "string", "format": "date" }, "kind": { "type": "string" }, "subkind": { "type": "string" }, "label": { "type": "string" }, "marketCap": { "type": "integer" }, "exchange": { "type": "string" }, "website": { "type": "string" }, "brandMark": { "type": "string" }, "brandMarkChecked": { "type": "boolean" } } } }, "total": { "type": "integer" }, "summary": { "type": "object", "properties": { "meeting": { "type": "integer" }, "leadership": { "type": "integer" }, "dividend": { "type": "integer" }, "capital": { "type": "integer" }, "listing": { "type": "integer" }, "other": { "type": "integer" } } }, "truncated": { "type": "boolean" }, "generatedAt": { "type": "string", "format": "date-time" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "from": "2026-11-01", "to": "2026-11-01", "events": [ { "cik": "0000018230", "company": "CATERPILLAR INC", "ticker": "CAT", "country": "US", "detail": "Derrick York appointed group president of Resource Industries", "itemCode": "8.01", "accession": "0001104659-26-116198", "sourceUrl": "https://www.sec.gov/Archives/edgar/data/18230/000110465926116198/0001104659-26-116198-index.html", "dateBasis": "evidence_backed_item_date", "trustStatus": "verified", "amount": null, "currency": null, "dividend": null, "id": "8k:184144", "date": "2026-11-01", "kind": "leadership", "subkind": "officer_appointed", "label": "Appointed: Derrick York", "marketCap": 286278175000, "exchange": "NYSE", "website": "https://www.caterpillar.com", "brandMark": "https://cdn.brandfetch.io/caterpillar.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brandMarkChecked": true }, { "cik": "0000035527", "company": "FIFTH THIRD BANCORP", "ticker": "FITB", "country": "US", "detail": "Fifth Third Bancorp redeems $500M senior notes due 2027", "itemCode": "8.01", "accession": "0000035527-26-000224", "sourceUrl": "https://www.sec.gov/Archives/edgar/data/35527/000003552726000224/0000035527-26-000224-index.html", "dateBasis": "evidence_backed_item_date", "trustStatus": "verified", "amount": null, "currency": null, "dividend": null, "id": "8k:176099", "date": "2026-11-01", "kind": "capital", "subkind": "debt_redemption", "label": "Debt Redemption: 1.707% Fixed Rate/Floating Rate Senior Notes due 2027", "marketCap": 48854302423, "exchange": "NYSE", "website": "https://www.53.com", "brandMark": "https://cdn.brandfetch.io/53.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brandMarkChecked": true } ], "total": 5, "summary": { "meeting": 0, "leadership": 4, "dividend": 0, "capital": 1, "listing": 0, "other": 0 }, "truncated": false, "generatedAt": "2026-11-01T12:49:08.791Z", "offset": 0, "limit": 2, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/congressional/calendar": { "get": { "summary": "Congressional calendar", "description": "US House and Senate committee meetings in a window (up to 93 days, Washington days), each chamber's session days, and how far each chamber's published calendar reaches. Cancelled and postponed meetings keep their status. `limit`/`offset` page the meetings; session days are always whole.", "operationId": "get-congressional-calendar", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "from", "in": "query", "description": "First day, YYYY-MM-DD (default today).", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Last day, YYYY-MM-DD (default `from`).", "schema": { "type": "string" } }, { "name": "chamber", "in": "query", "description": "One chamber: house or senate (joint meetings are returned only when no chamber is given).", "schema": { "type": "string", "enum": [ "house", "senate" ] } }, { "name": "kinds", "in": "query", "description": "Comma-separated: hearing, markup, business.", "schema": { "type": "string" } }, { "name": "committee", "in": "query", "description": "Committee system code, e.g. ssbk00.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Meeting title or location contains (case-insensitive); max 100 characters.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size, 1–500 (500 when only `offset` is given); with `offset`, pages the window (`nextOffset` names the next page). Without both, the whole window.", "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "chamber": { "type": "string" }, "eventId": { "type": "string" }, "congress": { "type": "integer" }, "date": { "type": "string", "format": "date" }, "meetingAt": { "type": "string", "format": "date-time" }, "time": { "type": "string" }, "title": { "type": "string" }, "kind": { "type": "string" }, "meetingType": { "type": "string" }, "closed": { "type": "boolean" }, "status": { "type": "string" }, "location": { "type": "string" }, "committees": { "type": "array", "items": { "type": "object", "properties": { "systemCode": { "type": "string" }, "name": { "type": "string" }, "parentSystemCode": { "type": "string" } } } }, "witnessCount": { "type": "integer" }, "url": { "type": "string" } } } }, "days": { "type": "array", "items": { "type": "object", "properties": { "chamber": { "type": "string" }, "date": { "type": "string", "format": "date" }, "status": { "type": "string" }, "conveneAt": { "type": [ "string", "null" ], "format": "date-time" }, "conveneText": { "type": [ "string", "null" ] }, "adjournedAt": { "type": [ "string", "null" ], "format": "date-time" }, "adjournedText": { "type": [ "string", "null" ] }, "ranPastMidnight": { "type": "boolean" }, "statusFrom": { "type": "null" }, "program": { "type": "null" }, "basis": { "type": "string" }, "bases": { "type": "array", "items": { "type": "string" } }, "observedOn": { "type": "string", "format": "date" }, "sourceRef": { "type": "string" } } } }, "horizon": { "type": "object", "properties": { "house": { "type": "object", "properties": { "publishedThrough": { "type": "string", "format": "date" }, "note": { "type": "string" } } }, "senate": { "type": "object", "properties": { "publishedThrough": { "type": "string", "format": "date" }, "note": { "type": "string" } } } } }, "summary": { "type": "object", "properties": { "hearing": { "type": "integer" }, "markup": { "type": "integer" }, "business": { "type": "integer" } } }, "total": { "type": "integer" }, "truncated": { "type": "boolean" }, "generatedAt": { "type": "string", "format": "date-time" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "events": [ { "id": "house:119515", "chamber": "house", "eventId": "119515", "congress": 119, "date": "2026-09-01", "meetingAt": "2026-09-01T14:00:00.000Z", "time": "10:00 AM", "title": "Countering Houthi Terrorism: Protecting U.S. Interests and Security in the Red Sea", "kind": "hearing", "meetingType": "Hearing", "closed": false, "status": "scheduled", "location": "Rayburn House Office Building 2172", "committees": [ { "systemCode": "hsfa13", "name": "House Subcommittee on the Middle East and North Africa", "parentSystemCode": "hsfa00" } ], "witnessCount": 2, "url": "https://www.congress.gov/event/119th-congress/house-event/119515" }, { "id": "house:119516", "chamber": "house", "eventId": "119516", "congress": 119, "date": "2026-09-01", "meetingAt": "2026-09-01T14:00:00.000Z", "time": "10:00 AM", "title": "“Sanctuary Policies, Tragic Consequences”", "kind": "hearing", "meetingType": "Hearing", "closed": false, "status": "scheduled", "location": "Rayburn House Office Building 2141", "committees": [ { "systemCode": "hsju01", "name": "House Subcommittee on Immigration Integrity, Security, and Enforcement", "parentSystemCode": "hsju00" } ], "witnessCount": 4, "url": "https://www.congress.gov/event/119th-congress/house-event/119516" } ], "days": [ { "chamber": "house", "date": "2026-09-01", "status": "in_session", "conveneAt": "2026-09-01T15:00:00.000Z", "conveneText": "11 a.m.", "adjournedAt": "2026-09-02T00:23:00.000Z", "adjournedText": "8:23 p.m.", "ranPastMidnight": false, "statusFrom": null, "program": null, "basis": "congressional_record", "bases": [ "annual_calendar", "congressional_record" ], "observedOn": "2026-09-01", "sourceRef": "CREC-2026-09-01-pt1-PgD854-3" }, { "chamber": "senate", "date": "2026-09-02", "status": "not_in_session", "conveneAt": null, "conveneText": null, "adjournedAt": null, "adjournedText": null, "ranPastMidnight": false, "statusFrom": null, "program": null, "basis": "congressional_record", "bases": [ "congressional_record" ], "observedOn": "2026-09-02", "sourceRef": "CREC-2026-09-02-pt1-PgD859" } ], "horizon": { "house": { "publishedThrough": "2026-12-31", "note": "The House publishes an annual calendar of session days and district work periods, and the Daily Digest announces each sitting the day before." }, "senate": { "publishedThrough": "2026-11-02", "note": "The Senate publishes no machine-readable forward calendar — senate.gov refuses automated access — so its days come from the Congressional Record and reach only as far as the last Daily Digest's announ…" } }, "summary": { "hearing": 82, "markup": 11, "business": 17 }, "total": 110, "truncated": false, "generatedAt": "2026-11-01T12:49:09.510Z", "offset": 0, "limit": 2, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/congressional/calendar/{id}": { "get": { "summary": "Congressional meeting", "description": "One committee meeting, e.g. house:119515: committees, witnesses, location and the publisher's page.", "operationId": "get-congressional-meeting", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "The event id as the calendar returned it.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "chamber": { "type": "string" }, "eventId": { "type": "string" }, "congress": { "type": "integer" }, "date": { "type": "string", "format": "date" }, "meetingAt": { "type": "string", "format": "date-time" }, "time": { "type": "string" }, "title": { "type": "string" }, "kind": { "type": "string" }, "meetingType": { "type": "string" }, "closed": { "type": "boolean" }, "status": { "type": "string" }, "location": { "type": "string" }, "committees": { "type": "array", "items": { "type": "object", "properties": { "systemCode": { "type": "string" }, "name": { "type": "string" }, "parentSystemCode": { "type": "string" } } } }, "witnessCount": { "type": "integer" }, "url": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "id": "house:119515", "chamber": "house", "eventId": "119515", "congress": 119, "date": "2026-09-01", "meetingAt": "2026-09-01T14:00:00.000Z", "time": "10:00 AM", "title": "Countering Houthi Terrorism: Protecting U.S. Interests and Security in the Red Sea", "kind": "hearing", "meetingType": "Hearing", "closed": false, "status": "scheduled", "location": "Rayburn House Office Building 2172", "committees": [ { "systemCode": "hsfa13", "name": "House Subcommittee on the Middle East and North Africa", "parentSystemCode": "hsfa00" } ], "witnessCount": 2, "url": "https://www.congress.gov/event/119th-congress/house-event/119515" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/management": { "get": { "summary": "Management & votes", "description": "Officers, directors, leadership changes and shareholder votes.", "operationId": "get-management-votes", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "officers": { "type": "array", "items": { "type": "object", "properties": { "ownerCik": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "officerTitle": { "type": "string" }, "isDirector": { "type": "boolean" }, "isOfficer": { "type": "boolean" }, "firstFilingDate": { "type": "string", "format": "date" }, "lastFilingDate": { "type": "string", "format": "date" }, "totalShares": { "type": [ "integer", "null" ] }, "asOfDate": { "type": [ "string", "null" ], "format": "date" }, "electionSupportPct": { "type": [ "number", "null" ] }, "electionDate": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" }, "photoUrl": { "type": [ "string", "null" ] }, "boardCategory": { "type": [ "string", "null" ] }, "independence": { "type": [ "string", "null" ] }, "appointedOn": { "type": "null" }, "otherPositions": { "type": "array", "items": {} }, "committees": { "type": "array", "items": {} }, "statusAsOf": { "type": [ "string", "null" ], "format": "date" }, "statusDocRef": { "type": [ "string", "null" ] }, "cSuite": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "abbr": { "type": "string" }, "label": { "type": "string" }, "rank": { "type": "integer" }, "interim": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "divisionalRole": { "type": "boolean" } } } }, "directors": { "type": "array", "items": { "type": "object", "properties": { "ownerCik": { "type": "string" }, "name": { "type": "string" }, "displayName": { "type": "string" }, "officerTitle": { "type": [ "string", "null" ] }, "isDirector": { "type": "boolean" }, "isOfficer": { "type": "boolean" }, "firstFilingDate": { "type": "string", "format": "date" }, "lastFilingDate": { "type": "string", "format": "date" }, "totalShares": { "type": [ "integer", "null" ] }, "asOfDate": { "type": [ "string", "null" ], "format": "date" }, "electionSupportPct": { "type": [ "number", "null" ] }, "electionDate": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" }, "photoUrl": { "type": "string" }, "boardCategory": { "type": [ "string", "null" ] }, "independence": { "type": [ "string", "null" ] }, "appointedOn": { "type": [ "string", "null" ], "format": "date" }, "otherPositions": { "type": "array", "items": {} }, "committees": { "type": "array", "items": {} }, "statusAsOf": { "type": [ "string", "null" ], "format": "date" }, "statusDocRef": { "type": [ "string", "null" ] }, "cSuite": { "type": [ "object", "null" ], "properties": { "code": { "type": "string" }, "abbr": { "type": "string" }, "label": { "type": "string" }, "rank": { "type": "integer" }, "interim": { "type": "boolean" }, "roles": { "type": "array", "items": { "type": "string" } } } }, "divisionalRole": { "type": "boolean" } } } }, "events": { "type": "array", "items": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "personName": { "type": "string" }, "roleTitle": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "effectiveDate": { "type": [ "string", "null" ], "format": "date" }, "confidence": { "type": "string" }, "excerpt": { "type": "string" }, "isPublishable": { "type": "boolean" } } } }, "meetings": { "type": "array", "items": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "meetingDate": { "type": [ "string", "null" ], "format": "date" }, "proposals": { "type": "array", "items": { "type": "object", "properties": { "proposalNo": { "type": "integer" }, "proposalText": { "type": "string" }, "outcome": { "type": "string" }, "votesFor": { "type": [ "integer", "null" ] }, "votesAgainst": { "type": [ "integer", "null" ] }, "votesWithheld": { "type": [ "integer", "null" ] }, "votesAbstain": { "type": [ "integer", "null" ] }, "brokerNonVotes": { "type": [ "integer", "null" ] }, "extra": { "type": "null" }, "nominees": { "type": "array", "items": { "type": "object", "properties": { "nominee": { "type": "string" }, "votesFor": { "type": "integer" }, "votesAgainst": { "type": [ "integer", "null" ] }, "votesWithheld": { "type": [ "integer", "null" ] }, "votesAbstain": { "type": "integer" }, "supportPct": { "type": "number" } } } } } } } } } }, "governance": { "type": [ "object", "null" ], "properties": { "fiscalYear": { "type": "integer" }, "docRef": { "type": "string" }, "auditorFirm": { "type": "string" }, "auditPartner": { "type": "string" }, "auditorTenureYears": { "type": "null" }, "auditFees": { "type": "integer" }, "otherAuditorFees": { "type": "integer" }, "nonAuditorFees": { "type": "null" }, "currency": { "type": "string" }, "boardSize": { "type": "integer" }, "boardMeetings": { "type": "integer" }, "boardRemunerationTotal": { "type": "integer" }, "committeeAllowances": { "type": "null" }, "committees": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "members": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" } } } } } } } } }, "relatedParties": { "type": "array", "items": { "type": "object", "properties": { "fiscalYear": { "type": "integer" }, "counterparty": { "type": "string" }, "relationship": { "type": "string" }, "nature": { "type": "string" }, "kind": { "type": "string" }, "amount": { "type": "integer" }, "priorAmount": { "type": "null" }, "currency": { "type": "string" }, "docRef": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "officers": [ { "ownerCik": "0001197649", "name": "HUANG JEN HSUN", "displayName": "Jen-Hsun Huang", "officerTitle": "President and CEO", "isDirector": true, "isOfficer": true, "firstFilingDate": "2003-05-05", "lastFilingDate": "2026-09-18", "totalShares": 811521160, "asOfDate": "2026-09-17", "electionSupportPct": 99.01240829570848, "electionDate": "2026-06-30", "isCurrent": true, "photoUrl": "/api/v1/people/0001197649/photo", "boardCategory": null, "independence": null, "appointedOn": null, "otherPositions": [], "committees": [], "statusAsOf": null, "statusDocRef": null, "cSuite": { "code": "ceo", "abbr": "CEO", "label": "Chief Executive Officer", "rank": 10, "interim": false, "roles": [ "CEO", "President" ] }, "divisionalRole": false }, { "ownerCik": "0001197653", "name": "SHANNON DAVID M", "displayName": "David M. Shannon", "officerTitle": "SVP, Human Resources", "isDirector": false, "isOfficer": true, "firstFilingDate": "2003-05-06", "lastFilingDate": "2017-03-15", "totalShares": null, "asOfDate": null, "electionSupportPct": null, "electionDate": null, "isCurrent": false, "photoUrl": null, "boardCategory": null, "independence": null, "appointedOn": null, "otherPositions": [], "committees": [], "statusAsOf": null, "statusDocRef": null, "cSuite": null, "divisionalRole": false } ], "directors": [ { "ownerCik": "0001197647", "name": "COXE TENCH", "displayName": "Tench Coxe", "officerTitle": null, "isDirector": true, "isOfficer": false, "firstFilingDate": "2003-08-05", "lastFilingDate": "2026-10-09", "totalShares": 28581218, "asOfDate": "2026-10-07", "electionSupportPct": 91.6737300224847, "electionDate": "2026-06-30", "isCurrent": true, "photoUrl": "/api/v1/people/0001197647/photo", "boardCategory": null, "independence": null, "appointedOn": null, "otherPositions": [], "committees": [], "statusAsOf": null, "statusDocRef": null, "cSuite": null, "divisionalRole": false }, { "ownerCik": "0001197649", "name": "HUANG JEN HSUN", "displayName": "Jen-Hsun Huang", "officerTitle": "President and CEO", "isDirector": true, "isOfficer": true, "firstFilingDate": "2003-05-05", "lastFilingDate": "2026-09-18", "totalShares": 811521160, "asOfDate": "2026-09-17", "electionSupportPct": 99.01240829570848, "electionDate": "2026-06-30", "isCurrent": true, "photoUrl": "/api/v1/people/0001197649/photo", "boardCategory": null, "independence": null, "appointedOn": null, "otherPositions": [], "committees": [], "statusAsOf": null, "statusDocRef": null, "cSuite": { "code": "ceo", "abbr": "CEO", "label": "Chief Executive Officer", "rank": 10, "interim": false, "roles": [ "CEO", "President" ] }, "divisionalRole": false } ], "events": [ { "accessionNumber": "0001045810-26-000060", "filingDate": "2026-07-02", "personName": "Ajay K. Puri", "roleTitle": "Executive Vice President, Worldwide Field Operations", "action": "retired", "effectiveDate": null, "confidence": "verified", "excerpt": "On June 28, 2026, Ajay K. Puri, Executive Vice President, Worldwide Field Operations of NVIDIA Corporation, or the Company, notified the Company of his intention to retire from his role effective upon…", "isPublishable": true }, { "accessionNumber": "0001045810-26-000028", "filingDate": "2026-05-08", "personName": "Suzanne Nora Johnson", "roleTitle": null, "action": "appointed", "effectiveDate": "2026-07-13", "confidence": "verified", "excerpt": "On May 7, 2026, the Board of Directors, or the Board, of NVIDIA Corporation appointed Suzanne Nora Johnson as a member of the Board and as a member of the Audit Committee of the Board and the number o…", "isPublishable": true } ], "meetings": [ { "accessionNumber": "0001045810-26-000056", "filingDate": "2026-06-30", "meetingDate": null, "proposals": [ { "proposalNo": 1, "proposalText": "Stockholders approved the election of each of our ten (10) director nominees to hold office until the 2027 Annual Meeting of Stockholders of NVIDIA Corporation and until his or her successor is electe…", "outcome": "elected", "votesFor": null, "votesAgainst": null, "votesWithheld": null, "votesAbstain": null, "brokerNonVotes": null, "extra": null, "nominees": [ { "nominee": "Tench Coxe", "votesFor": 15411252412, "votesAgainst": 1399727580, "votesWithheld": null, "votesAbstain": 45709394, "supportPct": 91.6737300224847 }, { "nominee": "John O. Dabiri", "votesFor": 16400706983, "votesAgainst": 397037222, "votesWithheld": null, "votesAbstain": 58945181, "supportPct": 97.63636582891995 } ] }, { "proposalNo": 2, "proposalText": "Stockholders approved, on an advisory basis, the compensation of our named executive officers as disclosed in our definitive proxy statement on Schedule 14A for the 2026 Annual Meeting filed with the …", "outcome": "approved", "votesFor": 15706336853, "votesAgainst": 1071224151, "votesWithheld": null, "votesAbstain": 79128382, "brokerNonVotes": 2829718733, "extra": null, "nominees": [] } ] }, { "accessionNumber": "0001045810-13-000046", "filingDate": "2013-05-21", "meetingDate": "2013-05-15", "proposals": [ { "proposalNo": 1, "proposalText": "The election of six (6) directors to serve for a one-year term until the 2014 Annual Meeting of Stockholders of NVIDIA Corporation. The results of the voting were as follows:", "outcome": "elected", "votesFor": null, "votesAgainst": null, "votesWithheld": null, "votesAbstain": null, "brokerNonVotes": null, "extra": null, "nominees": [ { "nominee": "Tench Coxe", "votesFor": 371515009, "votesAgainst": null, "votesWithheld": 2324009, "votesAbstain": 21300484, "supportPct": 99.37833963601949 }, { "nominee": "James C. Gaither", "votesFor": 371346862, "votesAgainst": null, "votesWithheld": 2517326, "votesAbstain": 21275314, "supportPct": 99.32667367434507 } ] }, { "proposalNo": 2, "proposalText": "The reapproval of the amendment and restatement of the NVIDIA Corporation 2007 Equity Incentive Plan. The results of the voting were as follows:", "outcome": "approved", "votesFor": 361092373, "votesAgainst": null, "votesWithheld": 26980154, "votesAbstain": 7066975, "brokerNonVotes": 99558827, "extra": null, "nominees": [] } ] } ], "governance": null, "relatedParties": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/ownership": { "get": { "summary": "Ownership summary", "description": "Insider positions (with the licence attribution when they come from an open-data register, e.g. Taiwan), up to 50 Form 144 notices, the top 50 13F institutional holders, and the shareholder nationality split where the source publishes one (empty for US issuers). Transactions: /ownership/transactions.", "operationId": "get-ownership-summary", "tags": [ "Ownership & Insiders" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "insiders": { "type": "array", "items": { "type": "object", "properties": { "ownerCik": { "type": "string" }, "name": { "type": "string" }, "isDirector": { "type": "boolean" }, "isOfficer": { "type": "boolean" }, "isTenPercentOwner": { "type": "boolean" }, "officerTitle": { "type": [ "string", "null" ] }, "totalShares": { "type": "integer" }, "directShares": { "type": "integer" }, "indirectShares": { "type": "integer" }, "asOfDate": { "type": "string", "format": "date" }, "lastFilingDate": { "type": "string", "format": "date" }, "accessionNumber": { "type": "string" } } } }, "insidersAttribution": { "type": "null" }, "notices": { "type": "array", "items": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "personName": { "type": "string" }, "relationships": { "type": "array", "items": { "type": "string" } }, "matchedOwnerCik": { "type": [ "string", "null" ] }, "unitsToSell": { "type": "integer" }, "aggregateMarketValue": { "type": "number" }, "approxSaleDate": { "type": "string", "format": "date" }, "planAdoptionDate": { "type": [ "string", "null" ], "format": "date" }, "brokerName": { "type": "string" } } } }, "institutions": { "type": "array", "items": { "type": "object", "properties": { "source": { "type": "string" }, "pctOutstanding": { "type": [ "integer", "null" ] }, "sharesSource": { "type": [ "string", "null" ] }, "sharesEstimated": { "type": "boolean" }, "sharesDerivation": { "type": [ "object", "null" ], "properties": { "note": { "type": "string" }, "estimated": { "type": "boolean" }, "denominator": { "type": "integer" }, "denominatorAsOf": { "type": "null" }, "denominatorType": { "type": "string" }, "denominatorSource": { "type": "string" } } }, "managerCik": { "type": "string" }, "managerName": { "type": "string" }, "periodOfReport": { "type": "string", "format": "date" }, "accessionNumber": { "type": "string" }, "shares": { "type": "integer" }, "valueUsd": { "type": [ "integer", "null" ] }, "pctOfSharesOut": { "type": "number" } } } }, "nationality": { "type": "array", "items": { "type": "object", "properties": { "bucket": { "type": "string" }, "permittedPct": { "type": "integer" }, "actualPct": { "type": "number" }, "availablePct": { "type": "number" }, "note": { "type": "string" }, "asOfDate": { "type": "string", "format": "date" }, "source": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "insiders": [ { "ownerCik": "0001197649", "name": "HUANG JEN HSUN", "isDirector": true, "isOfficer": true, "isTenPercentOwner": false, "officerTitle": "President and CEO", "totalShares": 811521160, "directShares": 70100666, "indirectShares": 741420494, "asOfDate": "2026-09-17", "lastFilingDate": "2026-09-18", "accessionNumber": "0001197649-26-000012" }, { "ownerCik": "0001197647", "name": "COXE TENCH", "isDirector": true, "isOfficer": false, "isTenPercentOwner": false, "officerTitle": null, "totalShares": 28581218, "directShares": 57378, "indirectShares": 28523840, "asOfDate": "2026-10-07", "lastFilingDate": "2026-10-09", "accessionNumber": "0001197647-26-000011" } ], "insidersAttribution": null, "notices": [ { "accessionNumber": "0001921094-26-001040", "filingDate": "2026-09-21", "personName": "Teter Timothy S.", "relationships": [ "Officer" ], "matchedOwnerCik": "0001696841", "unitsToSell": 30460, "aggregateMarketValue": 6786532, "approxSaleDate": "2026-09-21", "planAdoptionDate": "2026-05-22", "brokerName": "Charles Schwab & Co., Inc." }, { "accessionNumber": "0001628280-25-057153", "filingDate": "2025-12-15", "personName": "HARVEY C JONES", "relationships": [ "DIRECTOR" ], "matchedOwnerCik": null, "unitsToSell": 250000, "aggregateMarketValue": 44323451.25, "approxSaleDate": "2025-12-15", "planAdoptionDate": null, "brokerName": "Merrill Lynch" } ], "institutions": [ { "source": "13F", "pctOutstanding": null, "sharesSource": null, "sharesEstimated": false, "sharesDerivation": null, "managerCik": "0002012383", "managerName": "BlackRock, Inc.", "periodOfReport": "2026-06-30", "accessionNumber": "0002012383-26-003238", "shares": 1941918386, "valueUsd": 388558449933, "pctOfSharesOut": 8.0421 }, { "source": "13F", "pctOutstanding": null, "sharesSource": null, "sharesEstimated": false, "sharesDerivation": null, "managerCik": "0002100119", "managerName": "VANGUARD CAPITAL MANAGEMENT LLC", "periodOfReport": "2026-06-30", "accessionNumber": "0002100119-26-001527", "shares": 1540816358, "valueUsd": 308301945072, "pctOfSharesOut": 6.381 } ], "nationality": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/ownership/transactions": { "get": { "summary": "Insider transactions", "description": "Insider transactions (Forms 3/4/5), newest first.", "operationId": "get-insider-transactions", "tags": [ "Ownership & Insiders" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "filter", "in": "query", "description": "Transaction kind; any other value is a 400.", "schema": { "type": "string", "enum": [ "All", "Sales", "Purchases", "Awards", "Other" ], "default": "All" } }, { "name": "derivatives", "in": "query", "description": "true to include derivative-security rows.", "schema": { "type": "string", "enum": [ "true", "false" ], "default": "false" } }, { "name": "page", "in": "query", "description": "1-based, default 1.", "schema": { "type": "integer", "minimum": 1, "default": 1 } }, { "name": "pageSize", "in": "query", "description": "1–100, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "from", "in": "query", "description": "First transaction date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last transaction date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "owner", "in": "query", "description": "Reporting-owner CIKs, comma-separated.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "array", "items": { "type": "string" } }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "transactionDate": { "type": "string", "format": "date" }, "filingDate": { "type": "string", "format": "date" }, "ownerCik": { "type": "string" }, "ownerName": { "type": "string" }, "officerTitle": { "type": [ "string", "null" ] }, "isDirector": { "type": "boolean" }, "formType": { "type": "string" }, "transactionCode": { "type": "string" }, "acquiredDisposed": { "type": "string" }, "shares": { "type": "integer" }, "pricePerShare": { "type": "number" }, "sharesOwnedFollowing": { "type": "integer" }, "directOrIndirect": { "type": "string" }, "isDerivative": { "type": "boolean" }, "securityTitle": { "type": "string" }, "is10b51": { "type": "boolean" } } } }, "page": { "type": "integer" }, "pageSize": { "type": "integer" }, "totalCount": { "type": "integer" }, "totalPages": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": [ "0001045810" ], "transactions": [ { "accessionNumber": "0001197647-26-000011", "transactionDate": "2026-10-07", "filingDate": "2026-10-09", "ownerCik": "0001197647", "ownerName": "COXE TENCH", "officerTitle": null, "isDirector": true, "formType": "4", "transactionCode": "G", "acquiredDisposed": "D", "shares": 500000, "pricePerShare": 0, "sharesOwnedFollowing": 23671360, "directOrIndirect": "I", "isDerivative": false, "securityTitle": "Common", "is10b51": true }, { "accessionNumber": "0001696841-26-000014", "transactionDate": "2026-09-21", "filingDate": "2026-09-23", "ownerCik": "0001696841", "ownerName": "Teter Timothy S.", "officerTitle": "EVP, General Counsel and Sec", "isDirector": false, "formType": "4", "transactionCode": "S", "acquiredDisposed": "D", "shares": 12483, "pricePerShare": 222.1932, "sharesOwnedFollowing": 2705637, "directOrIndirect": "I", "isDerivative": false, "securityTitle": "Common Stock", "is10b51": true } ], "page": 1, "pageSize": 2, "totalCount": 4464, "totalPages": 2232 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/ownership/insider-history": { "get": { "summary": "Insider position history", "description": "Every served position snapshot of the company's current insiders, restated on today's share basis, with the splits applied. Not paged: `limit` or `offset` answers 400.", "operationId": "get-insider-position-history", "tags": [ "Ownership & Insiders" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "owner", "in": "query", "description": "Reporting-owner CIKs, comma-separated.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First snapshot date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last snapshot date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "insiders": { "type": "array", "items": { "type": "object", "properties": { "ownerCik": { "type": "string" }, "points": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "total": { "type": "integer" }, "direct": { "type": "integer" }, "indirect": { "type": "integer" }, "form": { "type": "string" } } } }, "skipped": { "type": "integer" }, "ownerName": { "type": "string" } } } }, "splits": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "ratio": { "type": "number" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "insiders": [ { "ownerCik": "0001190270", "points": [ { "date": "2005-05-17", "total": 0, "direct": 0, "indirect": 0, "form": "3" }, { "date": "2008-01-18", "total": 2000000, "direct": 2000000, "indirect": 0, "form": "4" } ], "skipped": 1, "ownerName": "PERRY MARK L" }, { "ownerCik": "0001197647", "points": [ { "date": "2004-08-17", "total": 140015280, "direct": 62965440, "indirect": 77049840, "form": "4" }, { "date": "2004-08-18", "total": 154291320, "direct": 62965440, "indirect": 91325880, "form": "4" } ], "skipped": 3, "ownerName": "COXE TENCH" } ], "splits": [ { "date": "2000-06-27", "ratio": 2 }, { "date": "2007-09-11", "ratio": 1.5 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/ownership/nationality-history": { "get": { "summary": "Foreign ownership history", "description": "Stored foreign-ownership snapshots, oldest first.", "operationId": "get-foreign-ownership-history", "tags": [ "Ownership & Insiders" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First snapshot date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last snapshot date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Page size, 1–5000.", "schema": { "type": "integer", "minimum": 1, "maximum": 5000 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "points": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "actualPct": { "type": "number" }, "permittedPct": { "type": "integer" }, "availablePct": { "type": "number" } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "points": [ { "date": "2026-08-27", "actualPct": 4.24, "permittedPct": 49, "availablePct": 44.76 }, { "date": "2026-08-31", "actualPct": 4.24, "permittedPct": 49, "availablePct": 44.76 } ], "total": 28, "offset": 0, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/signals": { "get": { "summary": "Company signals", "description": "Deterministic signals from filings: insider open-market buys (newest 100), director-election dissent, red-flag 8-Ks, board interlocks, 13F holder rotation for the latest reported quarter (`rotation.period`; counts per change and the 15 largest moves; a manager counts in a quarter once its 13F for that quarter is indexed, so a quarter whose 13Fs are still arriving shows few or none), filing latency, and leadership-change backtest aggregates.", "operationId": "get-company-signals", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "insiderBuys": { "type": "array", "items": { "type": "object", "properties": { "ownerName": { "type": "string" }, "officerTitle": { "type": [ "string", "null" ] }, "isDirector": { "type": "boolean" }, "transactionDate": { "type": "string", "format": "date" }, "shares": { "type": "integer" }, "pricePerShare": { "type": "number" }, "valueUsd": { "type": "number" }, "is10b51": { "type": "boolean" }, "clusterBuyers": { "type": "integer" } } } }, "dissent": { "type": "array", "items": { "type": "object", "properties": { "nominee": { "type": "string" }, "electionDate": { "type": "string", "format": "date" }, "supportPct": { "type": "number" }, "supportDeltaPct": { "type": [ "number", "null" ] } } } }, "redFlags": { "type": "array", "items": { "type": "object", "properties": { "accessionNumber": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "itemCode": { "type": "string" }, "itemName": { "type": "string" }, "severity": { "type": "string" } } } }, "interlocks": { "type": "array", "items": { "type": "object", "properties": { "ownerName": { "type": "string" }, "otherCompanyName": { "type": "string" }, "otherCompanyCik": { "type": "string" }, "directorHere": { "type": "boolean" }, "directorThere": { "type": "boolean" }, "titleHere": { "type": [ "string", "null" ] }, "titleThere": { "type": [ "string", "null" ] } } } }, "rotation": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "counts": { "type": "object" }, "topMoves": { "type": "array", "items": {} } } }, "latency": { "type": "object", "properties": { "avgDays": { "type": [ "number", "null" ] }, "count": { "type": "integer" }, "byAccession": { "type": "object", "additionalProperties": { "type": "integer" } } } }, "backtest": { "type": "array", "items": { "type": "object", "properties": { "action": { "type": "string" }, "roleBucket": { "type": [ "string", "null" ] }, "n": { "type": "integer" }, "avg1d": { "type": "number" }, "avg5d": { "type": "number" }, "avg21d": { "type": "number" }, "avg63d": { "type": "number" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "insiderBuys": [ { "ownerName": "Kress Colette", "officerTitle": "EVP & Chief Financial Officer", "isDirector": false, "transactionDate": "2020-12-03", "shares": 100, "pricePerShare": 537.28, "valueUsd": 53728, "is10b51": false, "clusterBuyers": 0 }, { "ownerName": "Neal Stephen C", "officerTitle": null, "isDirector": true, "transactionDate": "2020-09-25", "shares": 498, "pricePerShare": 500.95, "valueUsd": 249473.1, "is10b51": false, "clusterBuyers": 0 } ], "dissent": [ { "nominee": "Aarti Shah", "electionDate": "2026-06-30", "supportPct": 93.5, "supportDeltaPct": 0.97 }, { "nominee": "Ellen Ochoa", "electionDate": "2025-07-01", "supportPct": 99.2, "supportDeltaPct": null } ], "redFlags": [ { "accessionNumber": "0001045810-22-000005", "filingDate": "2022-02-08", "itemCode": "1.02", "itemName": "Termination of a Material Definitive Agreement", "severity": "medium" }, { "accessionNumber": "0001045810-17-000164", "filingDate": "2017-11-09", "itemCode": "1.02", "itemName": "Termination of a Material Definitive Agreement", "severity": "medium" } ], "interlocks": [ { "ownerName": "BURGESS ROBERT K", "otherCompanyName": "ADOBE INC.", "otherCompanyCik": "0000796343", "directorHere": true, "directorThere": true, "titleHere": null, "titleThere": null }, { "ownerName": "GAWEL SCOTT", "otherCompanyName": "INTEL CORP", "otherCompanyCik": "0000050863", "directorHere": false, "directorThere": false, "titleHere": "Principal Accounting Officer", "titleThere": "CVP, Chief Accounting Officer" } ], "rotation": { "period": "2026-09-30", "counts": {}, "topMoves": [] }, "latency": { "avgDays": 2.1, "count": 248, "byAccession": { "0001012870-02-003669": 0, "0000950168-02-001118": 4, "0001012870-01-500581": 11, "0001045810-13-000104": 0, "0001193125-06-230621": 3, "0001045810-14-000062": 4 } }, "backtest": [ { "action": "appointed", "roleBucket": null, "n": 19, "avg1d": -0.01, "avg5d": 1.43, "avg21d": 1.83, "avg63d": 1.49 }, { "action": "appointed", "roleBucket": "cfo", "n": 3, "avg1d": -3.16, "avg5d": 2.64, "avg21d": 6.82, "avg63d": 4.04 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/scorecard": { "get": { "summary": "Company scorecard", "description": "Guidance-vs-actual scorecard.", "operationId": "get-company-scorecard", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "scorecard": { "type": "object", "properties": { "ticker": { "type": "string" }, "cik": { "type": "string" }, "summary": { "type": "object", "properties": { "n": { "type": "integer" }, "hits": { "type": "integer" }, "hitRate": { "type": [ "number", "null" ] }, "sufficient": { "type": "boolean" }, "avgSignedError": { "type": [ "number", "null" ] }, "executives": { "type": "integer" } } }, "executives": { "type": "array", "items": { "type": "object", "properties": { "speakerName": { "type": "string" }, "personCik": { "type": "string" }, "n": { "type": "integer" }, "hits": { "type": "integer" }, "hitRate": { "type": "number" }, "sufficient": { "type": "boolean" }, "beats": { "type": "integer" }, "shortfalls": { "type": "integer" }, "avgAbsError": { "type": "number" }, "avgSignedError": { "type": "number" }, "avgHorizonDays": { "type": "number" }, "metrics": { "type": "array", "items": { "type": "string" } }, "timeline": { "type": "array", "items": { "type": "object", "properties": { "targetPeriodEnd": { "type": "string", "format": "date" }, "stdKey": { "type": "string" }, "guidedLow": { "type": "number" }, "guidedHigh": { "type": "number" }, "guidedUnit": { "type": "string" }, "realizedValue": { "type": "number" }, "midpointErrorRel": { "type": "number" }, "withinRange": { "type": "boolean" }, "periodicity": { "type": "string" }, "observationId": { "type": "integer" }, "firstObservedAt": { "type": "string", "format": "date" }, "reaffirmCount": { "type": "integer" }, "horizonDays": { "type": "integer" } } } }, "funnel": { "type": "object", "properties": { "tracked": { "type": "integer" }, "reconciled": { "type": "integer" }, "verified": { "type": "integer" }, "held": { "type": "integer" } } } } } }, "predictions": { "type": "array", "items": { "type": "object", "properties": { "observation_id": { "type": "string" }, "ticker": { "type": "string" }, "cik": { "type": "string" }, "std_key": { "type": "string" }, "kind": { "type": "string" }, "periodicity": { "type": "string" }, "change_basis": { "type": "string" }, "target_period_end": { "type": "string", "format": "date" }, "first_observed_at": { "type": "string", "format": "date" }, "horizon_days": { "type": "integer" }, "guided_low": { "type": "number" }, "guided_high": { "type": "number" }, "guided_unit": { "type": "string" }, "realized_value": { "type": "number" }, "within_range": { "type": "boolean" }, "midpoint_error_rel": { "type": "number" }, "reaffirm_count": { "type": "integer" }, "revision_seq": { "type": "integer" }, "speaker_name": { "type": "string" }, "evidence_quote": { "type": "string" }, "concept": { "type": "string" }, "external_id": { "type": "string" } } } }, "events": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string" }, "eventDate": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "integer" }, "resolved": { "type": "integer" }, "kept": { "type": "integer" }, "fidelityRate": { "type": "number" }, "abnMkt1d": { "type": "number" }, "abnMkt21d": { "type": "number" }, "abnMkt63d": { "type": "number" } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "scorecard": { "ticker": "NVDA", "cik": "0001045810", "summary": { "n": 78, "hits": 40, "hitRate": 0.5128205128205128, "sufficient": true, "avgSignedError": 0.008489653846153846, "executives": 1 }, "executives": [ { "speakerName": "Colette Kress", "personCik": "0001588670", "n": 78, "hits": 40, "hitRate": 0.5128205128205128, "sufficient": true, "beats": 54, "shortfalls": 21, "avgAbsError": 0.039257602564102566, "avgSignedError": 0.008489653846153846, "avgHorizonDays": 71.73076923076923, "metrics": [ "capex", "gross_margin" ], "timeline": [ { "targetPeriodEnd": "2020-04-30", "stdKey": "revenue", "guidedLow": 2940000000, "guidedHigh": 3060000000, "guidedUnit": "usd_billions", "realizedValue": 3080000000, "midpointErrorRel": 0.026667, "withinRange": false, "periodicity": "quarterly", "observationId": 642671, "firstObservedAt": "2020-02-13", "reaffirmCount": 0, "horizonDays": 77 }, { "targetPeriodEnd": "2020-04-30", "stdKey": "gross_margin", "guidedLow": 64.5, "guidedHigh": 65.5, "guidedUnit": "percent", "realizedValue": 65.0649, "midpointErrorRel": 0.000998, "withinRange": true, "periodicity": "quarterly", "observationId": 642672, "firstObservedAt": "2020-02-13", "reaffirmCount": 0, "horizonDays": 77 } ], "funnel": { "tracked": 629, "reconciled": 92, "verified": 78, "held": 7 } } ], "predictions": [ { "observation_id": "3637", "ticker": "NVDA", "cik": "0001045810", "std_key": "gross_margin", "kind": "margin_pct", "periodicity": "quarterly", "change_basis": "level", "target_period_end": "2026-04-30", "first_observed_at": "2026-02-25", "horizon_days": 64, "guided_low": 74.4, "guided_high": 75.4, "guided_unit": "percent", "realized_value": 74.9335, "within_range": true, "midpoint_error_rel": 0.000447, "reaffirm_count": 0, "revision_seq": 0, "speaker_name": "Colette Kress", "evidence_quote": "GAAP and non-GAAP gross margins are expected to be 74.9% and 75%, respectively, plus or minus 50 basis points.", "concept": "GAAP gross margin guidance", "external_id": "20595" }, { "observation_id": "644845", "ticker": "NVDA", "cik": "0001045810", "std_key": "opex", "kind": "level_usd", "periodicity": "quarterly", "change_basis": "level", "target_period_end": "2021-10-31", "first_observed_at": "2021-08-18", "horizon_days": 74, "guided_low": 1960000000, "guided_high": 1960000000, "guided_unit": "usd_billions", "realized_value": 1960000000, "within_range": true, "midpoint_error_rel": 0, "reaffirm_count": 0, "revision_seq": 0, "speaker_name": "Colette Kress", "evidence_quote": "GAAP and non-GAAP operating expenses are expected to be approximately $1.96 billion and $1.37 billion, respectively.", "concept": "GAAP operating expenses outlook", "external_id": "134578" } ], "events": [ { "documentId": "1", "eventDate": "2026-05-20", "fiscalYear": 2027, "fiscalQuarter": 1, "resolved": 78, "kept": 40, "fidelityRate": 0.5128205128205128, "abnMkt1d": -0.019704, "abnMkt21d": -0.073141, "abnMkt63d": -0.061077 }, { "documentId": "735", "eventDate": "2026-02-25", "fiscalYear": 2026, "fiscalQuarter": 4, "resolved": 73, "kept": 36, "fidelityRate": 0.4931506849315068, "abnMkt1d": -0.049007, "abnMkt21d": -0.057519, "abnMkt63d": 0.001556 } ] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/earnings/overview": { "get": { "summary": "Earnings overview", "description": "Quarterly revenue and EPS (newest 16 quarters by default; see quarters), the market's measured reaction to each call, and highlights from the latest call.", "operationId": "get-earnings-overview", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "quarters", "in": "query", "description": "Quarters of history: 1–200, or `all`. Default 16.", "schema": { "type": "string", "pattern": "^(all|[1-9][0-9]?|1[0-9]{2}|200)$", "minimum": 1, "maximum": 200, "default": 16 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string" }, "cik": { "type": "string" }, "companyName": { "type": "string" }, "accountingBasis": { "type": "string" }, "latestReleaseNote": { "type": [ "string", "null" ] }, "highlightsNote": { "type": [ "string", "null" ] }, "periods": { "type": "array", "items": { "type": "object", "properties": { "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "integer" }, "label": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "revenue": { "type": "integer" }, "epsDiluted": { "type": "number" }, "revenueDerived": { "type": "boolean" }, "epsDerived": { "type": "boolean" }, "reported": { "type": "boolean" }, "epsEstimate": { "type": "null" }, "revenueEstimate": { "type": "null" } } } }, "latestRelease": { "type": [ "object", "null" ], "properties": { "accessionNumber": { "type": "string" }, "acceptedAt": { "type": "string", "format": "date-time" }, "filingDate": { "type": "string", "format": "date" }, "periodEnd": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "integer" }, "label": { "type": "string" }, "revenue": { "type": "integer" }, "grossProfit": { "type": "integer" }, "operatingIncome": { "type": "integer" }, "netIncome": { "type": "integer" }, "epsDiluted": { "type": "null" }, "confirmedByFiling": { "type": "boolean" } } }, "estimates": { "type": "object", "properties": { "available": { "type": "boolean" }, "source": { "type": "null" }, "asOf": { "type": "null" } } }, "reactions": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "integer" }, "eventDate": { "type": "string", "format": "date" }, "fiscalLabel": { "type": "null" }, "timingClass": { "type": "string" }, "ret1d": { "type": "number" }, "abnMarket1d": { "type": "number" }, "abnSector1d": { "type": "number" }, "abnMarket5d": { "type": "number" }, "abnMarket21d": { "type": "number" }, "sectorSymbol": { "type": "string" } } } }, "latestCall": { "type": [ "object", "null" ], "properties": { "documentId": { "type": "integer" }, "eventDate": { "type": "string", "format": "date" }, "fiscalLabel": { "type": "string" }, "transcriptExternalId": { "type": "string" } } }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "observationType": { "type": "string" }, "concept": { "type": "string" }, "statement": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "isForwardLooking": { "type": "boolean" }, "evidence": { "type": "object", "properties": { "observationId": { "type": "integer" }, "quote": { "type": "string" }, "statement": { "type": "string" }, "speakerName": { "type": "string" }, "speakerRole": { "type": "string" }, "ticker": { "type": "string" }, "companyName": { "type": "string" }, "observedAt": { "type": "string", "format": "date" }, "observationType": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "verificationStatus": { "type": "string" }, "documentId": { "type": "integer" }, "transcriptExternalId": { "type": "string" }, "transcriptDate": { "type": "string", "format": "date" }, "fiscalLabel": { "type": "string" } } } } } }, "coverageNote": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "ticker": "NVDA", "cik": "0001045810", "companyName": "NVIDIA CORP", "accountingBasis": "US GAAP", "latestReleaseNote": null, "highlightsNote": null, "periods": [ { "fiscalYear": 2023, "fiscalQuarter": 3, "label": "Q3 FY2023", "periodEnd": "2022-10-30", "revenue": 5931000000, "epsDiluted": 0.27, "revenueDerived": false, "epsDerived": false, "reported": true, "epsEstimate": null, "revenueEstimate": null }, { "fiscalYear": 2023, "fiscalQuarter": 4, "label": "Q4 FY2023", "periodEnd": "2023-01-29", "revenue": 6051000000, "epsDiluted": 0.052227, "revenueDerived": true, "epsDerived": true, "reported": true, "epsEstimate": null, "revenueEstimate": null } ], "latestRelease": { "accessionNumber": "0001045810-26-000073", "acceptedAt": "2026-08-26T20:21:19.000Z", "filingDate": "2026-08-26", "periodEnd": "2026-07-26", "fiscalYear": 2027, "fiscalQuarter": 2, "label": "Q2 FY2027", "revenue": 96221000000, "grossProfit": 72142000000, "operatingIncome": 63734000000, "netIncome": 59688000000, "epsDiluted": null, "confirmedByFiling": true }, "estimates": { "available": false, "source": null, "asOf": null }, "reactions": [ { "documentId": 1, "eventDate": "2026-05-20", "fiscalLabel": null, "timingClass": "postclose", "ret1d": -1.7721, "abnMarket1d": -1.9704, "abnSector1d": -2.5963, "abnMarket5d": -5.9268, "abnMarket21d": -7.3141, "sectorSymbol": "XLK" }, { "documentId": 735, "eventDate": "2026-02-25", "fiscalLabel": null, "timingClass": "postclose", "ret1d": -5.4561, "abnMarket1d": -4.9007000000000005, "abnSector1d": -4.0576, "abnMarket5d": -5.2451, "abnMarket21d": -5.7519, "sectorSymbol": "XLK" } ], "latestCall": { "documentId": 35778, "eventDate": "2026-08-26", "fiscalLabel": "Q2 FY2027", "transcriptExternalId": "257198" }, "highlights": [ { "observationId": 744507, "observationType": "guidance", "concept": "technology economics", "statement": "NVIDIA's CEO is 100% confident that NVIDIA's technology will continue to be extraordinarily economic across the AI processing lifecycle.", "direction": null, "isForwardLooking": true, "evidence": { "observationId": 744507, "quote": "I have 100% confidence that our technology will continue to be extraordinary for them and that the economics of using our technology, whether it's from data processing to training to post training to …", "statement": "NVIDIA's CEO is 100% confident that NVIDIA's technology will continue to be extraordinarily economic across the AI processing lifecycle.", "speakerName": "Jen-Hsun Huang", "speakerRole": "executive", "ticker": "NVDA", "companyName": "NVIDIA Corporation", "observedAt": "2026-08-26", "observationType": "guidance", "direction": null, "verificationStatus": "supported", "documentId": 35778, "transcriptExternalId": "257198", "transcriptDate": "2026-08-26", "fiscalLabel": "Q2 FY2027" } }, { "observationId": 742857, "observationType": "guidance", "concept": "market segment size outlook", "statement": "The computing market involving sovereign AI, original AIs, neo clouds, AI start-ups, and enterprises is likely to be larger over time than the current cloud computing market.", "direction": "increasing", "isForwardLooking": true, "evidence": { "observationId": 742857, "quote": "That part of the world's computing is likely to be larger over time than even what we're currently experiencing in the cloud.", "statement": "The computing market involving sovereign AI, original AIs, neo clouds, AI start-ups, and enterprises is likely to be larger over time than the current cloud computing market.", "speakerName": "Jen-Hsun Huang", "speakerRole": "executive", "ticker": "NVDA", "companyName": "NVIDIA Corporation", "observedAt": "2026-08-26", "observationType": "guidance", "direction": "increasing", "verificationStatus": "supported", "documentId": 35778, "transcriptExternalId": "257198", "transcriptDate": "2026-08-26", "fiscalLabel": "Q2 FY2027" } } ], "coverageNote": "Reported figures are US GAAP as filed, per discrete quarter. No analyst estimates are on record for this company yet, so nothing here is described as a beat, a miss or a surprise — only what was repor…" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/earnings/promises": { "get": { "summary": "Guidance commitments", "description": "Every forward-looking statement from the latest earnings call(s), quote first and without a verdict, plus the confirmed commitments resolved at the latest results.", "operationId": "get-guidance-commitments", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string" }, "cik": { "type": "string" }, "callDate": { "type": [ "string", "null" ], "format": "date" }, "fiscalYear": { "type": [ "integer", "null" ] }, "fiscalQuarter": { "type": [ "integer", "null" ] }, "calls": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "integer" }, "externalId": { "type": "string" }, "label": { "type": "string" }, "segmentCount": { "type": "integer" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "integer" } } } }, "buckets": { "type": "object", "properties": { "dueNext": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "quote": { "type": "string" }, "speaker": { "type": "string" }, "section": { "type": "null" }, "conceptLabel": { "type": "string" }, "value": { "type": "number" }, "valueLow": { "type": "null" }, "valueHigh": { "type": "null" }, "unit": { "type": "string" }, "isNumeric": { "type": "boolean" }, "callDate": { "type": "string", "format": "date" }, "externalId": { "type": "string" }, "callLabel": { "type": "null" }, "periodRaw": { "type": "string" }, "bucket": { "type": "string" }, "checksAgainst": { "type": "string" } } } }, "carveOut": { "type": "array", "items": {} }, "conditional": { "type": "array", "items": {} }, "longDated": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "quote": { "type": "string" }, "speaker": { "type": "string" }, "section": { "type": "null" }, "conceptLabel": { "type": "string" }, "value": { "type": "number" }, "valueLow": { "type": "null" }, "valueHigh": { "type": "null" }, "unit": { "type": "string" }, "isNumeric": { "type": "boolean" }, "callDate": { "type": "string", "format": "date" }, "externalId": { "type": "string" }, "callLabel": { "type": "null" }, "periodRaw": { "type": "string" }, "bucket": { "type": "string" }, "checksAgainst": { "type": "string" } } } }, "qualitative": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "quote": { "type": "string" }, "speaker": { "type": "string" }, "section": { "type": "null" }, "conceptLabel": { "type": "string" }, "value": { "type": "null" }, "valueLow": { "type": "null" }, "valueHigh": { "type": "null" }, "unit": { "type": [ "string", "null" ] }, "isNumeric": { "type": "boolean" }, "callDate": { "type": "string", "format": "date" }, "externalId": { "type": "string" }, "callLabel": { "type": "null" }, "periodRaw": { "type": "string" }, "bucket": { "type": "string" }, "checksAgainst": { "type": "string" } } } } } }, "resolvedLastPrint": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "stdKey": { "type": "string" }, "targetPeriodEnd": { "type": "string", "format": "date" }, "guidedLow": { "type": "number" }, "guidedHigh": { "type": "number" }, "guidedUnit": { "type": "string" }, "realizedValue": { "type": "number" }, "withinRange": { "type": "boolean" }, "midpointErrorRel": { "type": "number" }, "speakerName": { "type": "string" }, "quote": { "type": "string" }, "externalId": { "type": "string" } } } }, "summary": { "type": "object", "properties": { "verifiedCount": { "type": "integer" }, "issuerCount": { "type": "integer" }, "lastAuditNote": { "type": "string" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "ticker": "NVDA", "cik": "0001045810", "callDate": "2026-08-26", "fiscalYear": 2027, "fiscalQuarter": 2, "calls": [ { "documentId": 35778, "externalId": "257198", "label": "call", "segmentCount": 31, "fiscalYear": 2027, "fiscalQuarter": 2 } ], "buckets": { "dueNext": [ { "observationId": 742708, "quote": "We expect to grow revenue by approximately 70% in fiscal 2028.", "speaker": "Colette Kress", "section": null, "conceptLabel": "revenue growth guidance", "value": 70, "valueLow": null, "valueHigh": null, "unit": "percent", "isNumeric": true, "callDate": "2026-08-26", "externalId": "257198", "callLabel": null, "periodRaw": "fiscal 2028", "bucket": "dueNext", "checksAgainst": "next release / 10-Q" }, { "observationId": 742717, "quote": "and $1.3 trillion in 2027", "speaker": "Colette Kress", "section": null, "conceptLabel": "hyperscaler CapEx", "value": 1.3, "valueLow": null, "valueHigh": null, "unit": "usd_trillions", "isNumeric": true, "callDate": "2026-08-26", "externalId": "257198", "callLabel": null, "periodRaw": "2027", "bucket": "dueNext", "checksAgainst": "next release / 10-Q" } ], "carveOut": [], "conditional": [], "longDated": [ { "observationId": 742749, "quote": "We continue to see demand for approximately $20 billion in total server CPUs.", "speaker": "Colette Kress", "section": null, "conceptLabel": "server CPU demand", "value": 20, "valueLow": null, "valueHigh": null, "unit": "usd_billions", "isNumeric": true, "callDate": "2026-08-26", "externalId": "257198", "callLabel": null, "periodRaw": "continue to see", "bucket": "longDated", "checksAgainst": "future filings" }, { "observationId": 742794, "quote": "The initial deployment expected to support 4.25 gigawatts of AI factory capacity", "speaker": "Colette Kress", "section": null, "conceptLabel": "AI factory capacity", "value": 4.25, "valueLow": null, "valueHigh": null, "unit": "gigawatts", "isNumeric": true, "callDate": "2026-08-26", "externalId": "257198", "callLabel": null, "periodRaw": "initial deployment expected", "bucket": "longDated", "checksAgainst": "future filings" } ], "qualitative": [ { "observationId": 742746, "quote": "We expect Vera to be deployed by every major hyperscaler, NeoCloud, AI lab, and system OEM", "speaker": "Colette Kress", "section": null, "conceptLabel": "Vera CPU deployment", "value": null, "valueLow": null, "valueHigh": null, "unit": null, "isNumeric": false, "callDate": "2026-08-26", "externalId": "257198", "callLabel": null, "periodRaw": "expect Vera to be deployed", "bucket": "qualitative", "checksAgainst": "future filings" }, { "observationId": 742850, "quote": "For full year fiscal year '27, we continue to expect GAAP and non-GAAP taxes to be between 16% and 18%", "speaker": "Colette Kress", "section": null, "conceptLabel": "tax rate outlook", "value": null, "valueLow": null, "valueHigh": null, "unit": "percent", "isNumeric": false, "callDate": "2026-08-26", "externalId": "257198", "callLabel": null, "periodRaw": "For full year fiscal year '27", "bucket": "qualitative", "checksAgainst": "FY27 10-K" } ] }, "resolvedLastPrint": [ { "observationId": 3637, "stdKey": "gross_margin", "targetPeriodEnd": "2026-04-30", "guidedLow": 74.4, "guidedHigh": 75.4, "guidedUnit": "percent", "realizedValue": 74.9335, "withinRange": true, "midpointErrorRel": 0.000447, "speakerName": "Colette Kress", "quote": "GAAP and non-GAAP gross margins are expected to be 74.9% and 75%, respectively, plus or minus 50 basis points.", "externalId": "20595" }, { "observationId": 2508, "stdKey": "opex", "targetPeriodEnd": "2026-04-30", "guidedLow": 7700000000, "guidedHigh": 7700000000, "guidedUnit": "usd_billions", "realizedValue": 7621000000, "withinRange": true, "midpointErrorRel": -0.01026, "speakerName": "Colette Kress", "quote": "GAAP and non-GAAP operating expenses are expected to be approximately $7.7 billion and $7.5 billion, respectively", "externalId": "20595" } ], "summary": { "verifiedCount": 512, "issuerCount": 10, "lastAuditNote": "audit #5 · 2026-08-01 · 63/63 individually verified" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/earnings/scorecard": { "get": { "summary": "Guidance scorecard", "description": "Per-call scorecard of commitments kept vs missed.", "operationId": "get-guidance-scorecard", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string" }, "ticker": { "type": "string" }, "predictions": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "stdKey": { "type": "string" }, "periodicity": { "type": "string" }, "targetPeriodEnd": { "type": "string", "format": "date" }, "guidedLow": { "type": "number" }, "guidedHigh": { "type": "number" }, "guidedUnit": { "type": "string" }, "realizedValue": { "type": "number" }, "realizedPeriodEnd": { "type": "string", "format": "date" }, "withinRange": { "type": "boolean" }, "midpointErrorRel": { "type": "number" }, "speakerName": { "type": "string" }, "speakerRole": { "type": "string" }, "changeBasis": { "type": "string" }, "reaffirmCount": { "type": "integer" }, "revisionSeq": { "type": "integer" }, "firstObservedAt": { "type": "string", "format": "date" }, "horizonDays": { "type": "integer" }, "evidence": { "type": "object", "properties": { "observationId": { "type": "integer" }, "quote": { "type": "string" }, "statement": { "type": "string" }, "speakerName": { "type": "string" }, "speakerRole": { "type": "string" }, "ticker": { "type": "string" }, "companyName": { "type": "string" }, "observedAt": { "type": "string", "format": "date" }, "observationType": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "verificationStatus": { "type": "string" }, "documentId": { "type": "integer" }, "transcriptExternalId": { "type": "string" }, "transcriptDate": { "type": "string", "format": "date" }, "fiscalLabel": { "type": "string" } } } } } }, "aggregate": { "type": "object", "properties": { "n": { "type": "integer" }, "hits": { "type": "integer" }, "hitRate": { "type": [ "number", "null" ] }, "sufficient": { "type": "boolean" }, "avgAbsError": { "type": [ "number", "null" ] }, "above": { "type": "integer" }, "below": { "type": "integer" }, "speakers": { "type": "integer" }, "metrics": { "type": "integer" } } }, "tracked": { "type": "integer" }, "funnel": { "type": "object", "properties": { "tracked": { "type": "integer" }, "reconciled": { "type": "integer" }, "verified": { "type": "integer" }, "held": { "type": "integer" } } }, "speakerFunnels": { "type": "object", "properties": { "Colette Kress": { "type": "object", "properties": { "tracked": { "type": "integer" }, "reconciled": { "type": "integer" }, "verified": { "type": "integer" }, "held": { "type": "integer" } } }, "Jen-Hsun Huang": { "type": "object", "properties": { "tracked": { "type": "integer" }, "reconciled": { "type": "integer" }, "verified": { "type": "integer" }, "held": { "type": "integer" } } }, "Jensen Huang;Co-Founder, CEO, President & Director": { "type": "object", "properties": { "tracked": { "type": "integer" }, "reconciled": { "type": "integer" }, "verified": { "type": "integer" }, "held": { "type": "integer" } } }, "Simona Stefan Jankowski": { "type": "object", "properties": { "tracked": { "type": "integer" }, "reconciled": { "type": "integer" }, "verified": { "type": "integer" }, "held": { "type": "integer" } } } } }, "speakerCiks": { "type": "object", "properties": { "Colette Kress": { "type": "string" }, "Jen-Hsun Huang": { "type": "string" }, "Jensen Huang": { "type": "string" } } }, "corpus": { "type": "object", "properties": { "predictions": { "type": "integer" }, "issuers": { "type": "integer" }, "metrics": { "type": "integer" } } }, "caveats": { "type": "array", "items": { "type": "string" } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "source": "v137", "ticker": "NVDA", "predictions": [ { "observationId": 3637, "stdKey": "gross_margin", "periodicity": "quarterly", "targetPeriodEnd": "2026-04-30", "guidedLow": 74.4, "guidedHigh": 75.4, "guidedUnit": "percent", "realizedValue": 74.9335, "realizedPeriodEnd": "2026-04-26", "withinRange": true, "midpointErrorRel": 0.000447, "speakerName": "Colette Kress", "speakerRole": "executive", "changeBasis": "level", "reaffirmCount": 0, "revisionSeq": 0, "firstObservedAt": "2026-02-25", "horizonDays": 64, "evidence": { "observationId": 3637, "quote": "GAAP and non-GAAP gross margins are expected to be 74.9% and 75%, respectively, plus or minus 50 basis points.", "statement": "NVIDIA expects Q1 FY2027 GAAP gross margin to be 74.9%, plus or minus 50 basis points.", "speakerName": "Colette Kress", "speakerRole": "executive", "ticker": "NVDA", "companyName": "NVIDIA Corporation", "observedAt": "2026-02-25", "observationType": "metric", "direction": null, "verificationStatus": "supported", "documentId": 735, "transcriptExternalId": "20595", "transcriptDate": "2026-02-25", "fiscalLabel": "Q4 FY2026" } }, { "observationId": 2508, "stdKey": "opex", "periodicity": "quarterly", "targetPeriodEnd": "2026-04-30", "guidedLow": 7700000000, "guidedHigh": 7700000000, "guidedUnit": "usd_billions", "realizedValue": 7621000000, "realizedPeriodEnd": "2026-04-26", "withinRange": true, "midpointErrorRel": -0.01026, "speakerName": "Colette Kress", "speakerRole": "executive", "changeBasis": "level", "reaffirmCount": 0, "revisionSeq": 0, "firstObservedAt": "2026-02-25", "horizonDays": 64, "evidence": { "observationId": 2508, "quote": "GAAP and non-GAAP operating expenses are expected to be approximately $7.7 billion and $7.5 billion, respectively", "statement": "NVIDIA expects Q1 FY2027 GAAP operating expenses to be approximately $7.7 billion.", "speakerName": "Colette Kress", "speakerRole": "executive", "ticker": "NVDA", "companyName": "NVIDIA Corporation", "observedAt": "2026-02-25", "observationType": "metric", "direction": "increasing", "verificationStatus": "supported", "documentId": 735, "transcriptExternalId": "20595", "transcriptDate": "2026-02-25", "fiscalLabel": "Q4 FY2026" } } ], "aggregate": { "n": 78, "hits": 40, "hitRate": 0.5128205128205128, "sufficient": true, "avgAbsError": 0.03925760256410256, "above": 54, "below": 21, "speakers": 1, "metrics": 6 }, "tracked": 975, "funnel": { "tracked": 975, "reconciled": 92, "verified": 78, "held": 7 }, "speakerFunnels": { "Colette Kress": { "tracked": 629, "reconciled": 92, "verified": 78, "held": 7 }, "Jen-Hsun Huang": { "tracked": 201, "reconciled": 0, "verified": 0, "held": 0 }, "Jensen Huang;Co-Founder, CEO, President & Director": { "tracked": 144, "reconciled": 0, "verified": 0, "held": 0 }, "Simona Stefan Jankowski": { "tracked": 1, "reconciled": 0, "verified": 0, "held": 0 } }, "speakerCiks": { "Colette Kress": "0001588670", "Jen-Hsun Huang": "0001197649", "Jensen Huang": "0001197649" }, "corpus": { "predictions": 512, "issuers": 10, "metrics": 22 }, "caveats": [ "A verdict compares the reported figure to the range management themselves gave. It is not a comparison against analyst consensus — this database holds no estimates, so beat and miss are not claims thi…", "Realized figures are GAAP as filed. Guidance stated on an adjusted or non-GAAP basis is deliberately held rather than compared against a GAAP actual it does not correspond to." ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/transcripts": { "get": { "summary": "Transcript index", "description": "Earnings-call transcript index.", "operationId": "get-transcript-index", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "transcripts": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date" }, "fiscalQuarter": { "type": [ "integer", "null" ] }, "fiscalYear": { "type": [ "integer", "null" ] }, "quarterLabel": { "type": "string" }, "company": { "type": "string" }, "ticker": { "type": "string" }, "eventDatetime": { "type": "string" }, "durationSeconds": { "type": [ "integer", "null" ] }, "hasAudio": { "type": "boolean" }, "hasVideo": { "type": "boolean" }, "eventType": { "type": "string" }, "title": { "type": "string" }, "kindLabel": { "type": [ "string", "null" ] }, "eventLabel": { "type": [ "string", "null" ] }, "startTimeLabel": { "type": [ "string", "null" ] } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "transcripts": [ { "id": "258388", "date": "2026-09-10", "fiscalQuarter": null, "fiscalYear": null, "quarterLabel": "Sep 10, 2026", "company": "NVIDIA Corporation", "ticker": "NVDA", "eventDatetime": "2026-09-10T15:50:00.000Z", "durationSeconds": 2258, "hasAudio": false, "hasVideo": false, "eventType": "conference_presentation", "title": "NVIDIA Corporation presents at Goldman Sachs Communacopia + Technology Conference 2026", "kindLabel": "Conference", "eventLabel": "Goldman Sachs Communacopia + Technology Conference 2026", "startTimeLabel": "11:50 AM ET" }, { "id": "IRUS-NVDA-20190311-EC", "date": "2019-03-11", "fiscalQuarter": 4, "fiscalYear": 2019, "quarterLabel": "Q4 2019", "company": "NVIDIA CORP", "ticker": "NVDA", "eventDatetime": "2019-03-11T00:00:00", "durationSeconds": null, "hasAudio": false, "hasVideo": false, "eventType": "earnings", "title": "NVIDIA CORP - FY 2019 Earnings Call", "kindLabel": null, "eventLabel": null, "startTimeLabel": null } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/transcripts/{transcriptId}": { "get": { "summary": "Transcript text", "description": "One transcript, as plain text with speaker turns.", "operationId": "get-transcript-text", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "transcriptId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": true, "description": "The transcript's date (YYYY-MM-DD) exactly as returned by the transcript index.", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "string" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/transcripts/{transcriptId}/annotations": { "get": { "summary": "Transcript annotations", "description": "Every observation extracted from this transcript, with exact character spans into the transcript text, verification status, narrative assignments and claim-graph edge links. The company in the path is not checked; 404 when the transcript has no extractions.", "operationId": "get-transcript-annotations", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "transcriptId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "integer" }, "ticker": { "type": "string" }, "companyName": { "type": "string" }, "eventDate": { "type": "string", "format": "date" }, "fiscalLabel": { "type": "string" }, "counts": { "type": "object", "properties": { "event": { "type": "integer" }, "state": { "type": "integer" }, "metric": { "type": "integer" }, "causal_claim": { "type": "integer" }, "guidance": { "type": "integer" } } }, "supportedCount": { "type": "integer" }, "totalCount": { "type": "integer" }, "annotations": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "observationType": { "type": "string" }, "concept": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "isForwardLooking": { "type": "boolean" }, "verificationStatus": { "type": "string" }, "charStart": { "type": "integer" }, "charEnd": { "type": "integer" }, "quote": { "type": "string" }, "statement": { "type": "string" }, "speakerName": { "type": "string" }, "causeStatement": { "type": [ "string", "null" ] }, "effectStatement": { "type": [ "string", "null" ] }, "narrativeIds": { "type": "array", "items": {} }, "narrativeNames": { "type": "array", "items": {} }, "edgeId": { "type": [ "string", "null" ] } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "documentId": 1, "ticker": "NVDA", "companyName": "NVIDIA Corporation", "eventDate": "2026-05-20", "fiscalLabel": "Q1 FY2027", "counts": { "event": 23, "state": 168, "metric": 80, "causal_claim": 19, "guidance": 25 }, "supportedCount": 308, "totalCount": 315, "annotations": [ { "observationId": 2727, "observationType": "event", "concept": "earnings call webcast", "direction": null, "isForwardLooking": false, "verificationStatus": "supported", "charStart": 860, "charEnd": 930, "quote": "Our call is being webcast live on NVIDIA's Investor Relations website.", "statement": "NVIDIA's Q1 FY2027 earnings call is being webcast live on the company's Investor Relations website.", "speakerName": "Toshiya Hari", "causeStatement": null, "effectStatement": null, "narrativeIds": [], "narrativeNames": [], "edgeId": null }, { "observationId": 2864, "observationType": "causal_claim", "concept": "sequential revenue growth driver", "direction": "increasing", "isForwardLooking": true, "verificationStatus": "supported", "charStart": 14705, "charEnd": 14771, "quote": "We expect sequential growth to be driven primarily by Data Center.", "statement": "NVIDIA expects Q2 FY2027 sequential revenue growth to be driven primarily by Data Center.", "speakerName": "Colette Kress", "causeStatement": "Data Center performance is the primary driver.", "effectStatement": "NVIDIA expects sequential revenue growth in Q2 FY2027.", "narrativeIds": [], "narrativeNames": [], "edgeId": "e-ai-dccapex" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/transcripts/search": { "get": { "summary": "Transcript search", "description": "Full-text search over every spoken word in the transcript corpus (websearch syntax: quoted phrases, OR, -exclusion), or with `mentioned` the passages where other companies name that company. Each passage carries the speaker and role, the speaking company, the call and date, a highlighted snippet, and charStart/charEnd — the exact span in the transcript text.", "operationId": "get-transcript-search", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "topicColumns", "in": "query", "description": "JSON array of 1–12 ordered columns: id, label, terms, exclude, match (any/all). Each phrase is literal text; exclusions apply across all alternatives. Definitions must fit a 6,000-character URL-encoded budget.", "schema": { "type": "string" } }, { "name": "column", "in": "query", "description": "Apply a column from topicColumns (or the default set) to source passages.", "schema": { "type": "string" } }, { "name": "q2", "in": "query", "description": "Second websearch expression; combined with q in the same speaker passage.", "schema": { "type": "string" } }, { "name": "termMatch", "in": "query", "description": "Combine q and q2 using all (AND) or any (OR).", "schema": { "type": "string", "enum": [ "all", "any" ], "default": "all" } }, { "name": "topic", "in": "query", "description": "Inspectable lexical research topic.", "schema": { "type": "string", "enum": [ "demand", "pricing", "margins", "investment", "ai", "credit", "funding", "regulation", "returns", "outlook" ] } }, { "name": "browse", "in": "query", "description": "1 = browse source turns without a keyword predicate.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Issuer region from the country catalog.", "schema": { "type": "string" } }, { "name": "subregion", "in": "query", "description": "Issuer subregion from the country catalog.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "Exact city in the company's currently stored business address; missing addresses remain unknown.", "schema": { "type": "string" } }, { "name": "locationMode", "in": "query", "description": "Inside or outside the intersection of selected country/region/subregion/city.", "schema": { "type": "string", "enum": [ "inside", "outside" ], "default": "inside" } }, { "name": "includeUnknownLocation", "in": "query", "description": "1 = include unknown geography in outside searches; excluded by default.", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "description": "Explicit lexical theme; AND with q in the same passage.", "schema": { "type": "string", "enum": [ "purchase-delays", "pricing-pressure", "pricing-power", "ai-investment", "inventory", "capacity", "tariffs", "guidance" ] } }, { "name": "speaker", "in": "query", "description": "Speaker name contains; max 120 characters.", "schema": { "type": "string" } }, { "name": "includeContext", "in": "query", "description": "1 = include bounded surrounding turns or indexed Q&A exchange; truncation flagged.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Websearch query; combine with mentioned or theme to narrow the same passage.", "schema": { "type": "string" } }, { "name": "mentioned", "in": "query", "description": "Company talked about — ticker, CIK or platform key (mentions mode).", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Only calls held by this company.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Source issuer country from transcript metadata: uppercase ISO alpha-2 code, or unknown for missing geography.", "schema": { "type": "string" } }, { "name": "companies", "in": "query", "description": "Comma-separated company basket, at most 20 identifiers; intersects company if supplied.", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Speaker role.", "schema": { "type": "string", "enum": [ "executive", "analyst", "operator" ] } }, { "name": "section", "in": "query", "description": "Part of the call.", "schema": { "type": "string", "enum": [ "prepared", "qa" ] } }, { "name": "from", "in": "query", "description": "Calls on or after, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Calls on or before, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "sort", "in": "query", "description": "newest (default) or relevance; relevance applies only with q, q2, theme, topic or column, otherwise newest is used.", "schema": { "type": "string", "enum": [ "newest", "relevance" ], "default": "newest" } }, { "name": "limit", "in": "query", "description": "1–50, default 20.", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } }, { "name": "cursor", "in": "query", "description": "nextCursor from the previous page.", "schema": { "type": "string" } }, { "name": "includeSelf", "in": "query", "description": "1 = include the mentioned company's own calls.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string" }, "hits": { "type": "array", "items": { "type": "object", "properties": { "segmentId": { "type": "integer" }, "transcriptId": { "type": "string" }, "date": { "type": "string", "format": "date" }, "company": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" } } }, "eventLabel": { "type": "string" }, "isEarningsCall": { "type": "boolean" }, "speaker": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" } } }, "section": { "type": "string" }, "snippet": { "type": "string" }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } } } }, "charStart": { "type": "integer" }, "charEnd": { "type": "integer" } } } }, "total": { "type": "integer" }, "totalCapped": { "type": "boolean" }, "nextCursor": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "mode": "keyword", "hits": [ { "segmentId": 2406609, "transcriptId": "262199", "date": "2026-10-30", "company": { "cik": "0001551152", "ticker": "ABBV", "name": "AbbVie Inc." }, "eventLabel": "Q3 2026 earnings call", "isEarningsCall": true, "speaker": { "name": "Roopal Thakkar", "role": "executive" }, "section": "prepared", "snippet": "…SKYRIZI plus our novel anti-alpha4beta7 antibody ABBV 382 in Crohn's disease. The combination resulted in a near doubling of endoscopic remission at week 24 compared to either monotherapy. \nAdditiona…", "highlights": [ { "start": 225, "end": 229 } ], "charStart": 13807, "charEnd": 13811 }, { "segmentId": 2406569, "transcriptId": "262104", "date": "2026-10-29", "company": { "cik": "DSMD000022", "ticker": "MEZA", "name": "MEEZA QSTP-LLC (Public)" }, "eventLabel": "Q3 2026 earnings call", "isEarningsCall": true, "speaker": { "name": "James Corby", "role": "executive" }, "section": "qa", "snippet": "Yes, so the fit-out projects are approximately 10% margin versus the typical Data Center margin of closer to 40%.", "highlights": [ { "start": 77, "end": 81 }, { "start": 82, "end": 88 } ], "charStart": 14163, "charEnd": 14167 } ], "total": 10000, "totalCapped": true, "nextCursor": "2026-10-29_2406569" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/transcripts/search/summary": { "get": { "summary": "Transcript search summary", "description": "The same search, summarized: matches per calendar quarter, the companies doing the talking, and companyQuarters counts of matching calls and passages for the leading companies. countries carries issuer country/region counts across all matches. Sampled summaries omit companyQuarters and countries detail.", "operationId": "get-transcript-search-summary", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "topicColumns", "in": "query", "description": "JSON array of 1–12 ordered columns: id, label, terms, exclude, match (any/all). Each phrase is literal text; exclusions apply across all alternatives. Definitions must fit a 6,000-character URL-encoded budget.", "schema": { "type": "string" } }, { "name": "column", "in": "query", "description": "Apply a column from topicColumns (or the default set) to source passages.", "schema": { "type": "string" } }, { "name": "q2", "in": "query", "description": "Second websearch expression; combined with q in the same speaker passage.", "schema": { "type": "string" } }, { "name": "termMatch", "in": "query", "description": "Combine q and q2 using all (AND) or any (OR).", "schema": { "type": "string", "enum": [ "all", "any" ], "default": "all" } }, { "name": "topic", "in": "query", "description": "Inspectable lexical research topic.", "schema": { "type": "string", "enum": [ "demand", "pricing", "margins", "investment", "ai", "credit", "funding", "regulation", "returns", "outlook" ] } }, { "name": "browse", "in": "query", "description": "1 = browse source turns without a keyword predicate.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Issuer region from the country catalog.", "schema": { "type": "string" } }, { "name": "subregion", "in": "query", "description": "Issuer subregion from the country catalog.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "Exact city in the company's currently stored business address; missing addresses remain unknown.", "schema": { "type": "string" } }, { "name": "locationMode", "in": "query", "description": "Inside or outside the intersection of selected country/region/subregion/city.", "schema": { "type": "string", "enum": [ "inside", "outside" ], "default": "inside" } }, { "name": "includeUnknownLocation", "in": "query", "description": "1 = include unknown geography in outside searches; excluded by default.", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "description": "Explicit lexical theme; AND with q in the same passage.", "schema": { "type": "string", "enum": [ "purchase-delays", "pricing-pressure", "pricing-power", "ai-investment", "inventory", "capacity", "tariffs", "guidance" ] } }, { "name": "speaker", "in": "query", "description": "Speaker name contains; max 120 characters.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Websearch query; combine with mentioned or theme to narrow the same passage.", "schema": { "type": "string" } }, { "name": "mentioned", "in": "query", "description": "Company talked about (mentions mode).", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Only calls held by this company.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Source issuer country from transcript metadata: uppercase ISO alpha-2 code, or unknown for missing geography.", "schema": { "type": "string" } }, { "name": "companies", "in": "query", "description": "Comma-separated company basket, at most 20 identifiers; intersects company if supplied.", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Speaker role.", "schema": { "type": "string", "enum": [ "executive", "analyst", "operator" ] } }, { "name": "section", "in": "query", "description": "Part of the call.", "schema": { "type": "string", "enum": [ "prepared", "qa" ] } }, { "name": "from", "in": "query", "description": "Calls on or after, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Calls on or before, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "includeSelf", "in": "query", "description": "1 = include the mentioned company's own calls.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string" }, "totalMatches": { "type": "integer" }, "totalDocuments": { "type": "integer" }, "totalCompanies": { "type": "integer" }, "firstDate": { "type": "string", "format": "date" }, "lastDate": { "type": "string", "format": "date" }, "quarters": { "type": "array", "items": { "type": "object", "properties": { "quarter": { "type": "string" }, "start": { "type": "string", "format": "date" }, "matches": { "type": "integer" }, "documents": { "type": "integer" } } } }, "speakers": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" }, "matches": { "type": "integer" }, "documents": { "type": "integer" }, "lastDate": { "type": "string", "format": "date" } } } }, "sampled": { "type": "boolean" }, "companyQuarters": { "type": "array", "items": {} }, "countries": { "type": "array", "items": {} } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "mode": "keyword", "totalMatches": 20000, "totalDocuments": 6073, "totalCompanies": 1195, "firstDate": "2023-04-25", "lastDate": "2026-10-30", "quarters": [ { "quarter": "2023 Q2", "start": "2023-04-01", "matches": 555, "documents": 241 }, { "quarter": "2023 Q3", "start": "2023-07-01", "matches": 696, "documents": 294 } ], "speakers": [ { "cik": "0000002488", "ticker": "AMD", "name": "Advanced Micro Devices, Inc.", "matches": 370, "documents": 31, "lastDate": "2026-09-11" }, { "cik": "XNSE000077", "ticker": "TECHNOE", "name": "Techno Electric & Engineering Company Limited", "matches": 315, "documents": 14, "lastDate": "2026-08-12" } ], "sampled": true, "companyQuarters": [], "countries": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/transcripts/search/topics": { "get": { "summary": "Transcript topic analysis", "description": "Lexical company/topic matrix, calendar topic evolution, analyst Q&A turn counts and comparison with an immediately preceding equal-day window. Defaults to the latest twelve months when from is omitted; without a company scope (company, companies or mentioned) a window is at most 92 days and defaults to the 92 days ending `to`, and a wider one is a 400. Topic caps are explicit; geographic and text filters match source turns.", "operationId": "get-transcript-topic-analysis", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "topicColumns", "in": "query", "description": "JSON array of 1–12 ordered columns: id, label, terms, exclude, match (any/all). Each phrase is literal text; exclusions apply across all alternatives. Definitions must fit a 6,000-character URL-encoded budget.", "schema": { "type": "string" } }, { "name": "column", "in": "query", "description": "Apply a column from topicColumns (or the default set) to source passages.", "schema": { "type": "string" } }, { "name": "q2", "in": "query", "description": "Second websearch expression; combined with q in the same speaker passage.", "schema": { "type": "string" } }, { "name": "termMatch", "in": "query", "description": "Combine q and q2 using all (AND) or any (OR).", "schema": { "type": "string", "enum": [ "all", "any" ], "default": "all" } }, { "name": "topic", "in": "query", "description": "Inspectable lexical research topic.", "schema": { "type": "string", "enum": [ "demand", "pricing", "margins", "investment", "ai", "credit", "funding", "regulation", "returns", "outlook" ] } }, { "name": "browse", "in": "query", "description": "1 = browse source turns without a keyword predicate.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Issuer region from the country catalog.", "schema": { "type": "string" } }, { "name": "subregion", "in": "query", "description": "Issuer subregion from the country catalog.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "Exact city in the company's currently stored business address; missing addresses remain unknown.", "schema": { "type": "string" } }, { "name": "locationMode", "in": "query", "description": "Inside or outside the intersection of selected country/region/subregion/city.", "schema": { "type": "string", "enum": [ "inside", "outside" ], "default": "inside" } }, { "name": "includeUnknownLocation", "in": "query", "description": "1 = include unknown geography in outside searches; excluded by default.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Primary websearch expression.", "schema": { "type": "string" } }, { "name": "mentioned", "in": "query", "description": "Company being named.", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "description": "Explicit lexical theme: purchase-delays, pricing-pressure, pricing-power, ai-investment, inventory, capacity, tariffs, guidance.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Issuer ISO alpha-2 country or unknown.", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Speaking company.", "schema": { "type": "string" } }, { "name": "companies", "in": "query", "description": "Company basket, up to 20 identifiers.", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Speaker role.", "schema": { "type": "string" } }, { "name": "section", "in": "query", "description": "prepared or qa.", "schema": { "type": "string" } }, { "name": "speaker", "in": "query", "description": "Speaker name contains.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Current comparison window start, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Current comparison window end, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "includeSelf", "in": "query", "description": "1 includes subject's own calls.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" }, "currentCalls": { "type": "integer" }, "previousCalls": { "type": "integer" } } } }, "cells": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "topic": { "type": "string" }, "period": { "type": "string" }, "passages": { "type": "integer" }, "calls": { "type": "integer" }, "analystTurns": { "type": "integer" }, "exchanges": { "type": "integer" }, "example": { "type": "object", "properties": { "segmentId": { "type": "integer" }, "transcriptId": { "type": "string" }, "date": { "type": "string", "format": "date" }, "company": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" } } }, "eventLabel": { "type": "string" }, "isEarningsCall": { "type": "boolean" }, "speaker": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" } } }, "section": { "type": "string" }, "snippet": { "type": "string" }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } } } }, "charStart": { "type": "integer" }, "charEnd": { "type": "integer" } } } } } }, "quarters": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "start": { "type": "string", "format": "date" }, "calls": { "type": "integer" }, "analystTurns": { "type": "integer" } } } }, "totals": { "type": "array", "items": { "type": "object", "properties": { "topic": { "type": "string" }, "period": { "type": "string" }, "passages": { "type": "integer" }, "calls": { "type": "integer" }, "companies": { "type": "integer" }, "analystTurns": { "type": "integer" }, "exchanges": { "type": "integer" } } } }, "coverage": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string" }, "calls": { "type": "integer" }, "companies": { "type": "integer" } } } }, "cappedTopics": { "type": "array", "items": {} }, "topicColumns": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "terms": { "type": "array", "items": { "type": "string" } }, "exclude": { "type": "array", "items": {} }, "match": { "type": "string" } } } }, "periods": { "type": "object", "properties": { "current": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" } } }, "previous": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "string", "format": "date" } } } } }, "sampled": { "type": "boolean" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "companies": [ { "cik": "0000732717", "ticker": "T", "name": "AT&T INC.", "currentCalls": 5, "previousCalls": 3 }, { "cik": "0000002488", "ticker": "AMD", "name": "ADVANCED MICRO DEVICES INC", "currentCalls": 4, "previousCalls": 3 } ], "cells": [ { "cik": "0000002488", "topic": "ai", "period": "current", "passages": 27, "calls": 4, "analystTurns": 5, "exchanges": 5, "example": { "segmentId": 412, "transcriptId": "258530", "date": "2026-09-11", "company": { "cik": "0000002488", "ticker": "AMD", "name": "Advanced Micro Devices, Inc." }, "eventLabel": "Presents at Goldman Sachs Communacopia + Technology Conference 2026", "isEarningsCall": false, "speaker": { "name": "Daniel McNamara", "role": "executive" }, "section": "qa", "snippet": "Yes. Actually, just 1 last point. I want to just emphasize that, right? So you've got domain specific and then you've got sort of what I would call general IT automation. -- and 1 is for efficiency. B…", "highlights": [ { "start": 159, "end": 169 } ], "charStart": 4635, "charEnd": 4645 } }, { "cik": "0000002488", "topic": "ai", "period": "previous", "passages": 20, "calls": 3, "analystTurns": 1, "exchanges": 1 } ], "quarters": [ { "topic": "ai", "start": "2026-07-01", "calls": 199, "analystTurns": 39 }, { "topic": "credit", "start": "2026-07-01", "calls": 24, "analystTurns": 0 } ], "totals": [ { "topic": "ai", "period": "current", "passages": 439, "calls": 224, "companies": 188, "analystTurns": 44, "exchanges": 44 }, { "topic": "ai", "period": "previous", "passages": 920, "calls": 462, "companies": 382, "analystTurns": 102, "exchanges": 102 } ], "coverage": [ { "period": "current", "calls": 349, "companies": 308 }, { "period": "previous", "calls": 672, "companies": 554 } ], "cappedTopics": [], "topicColumns": [ { "id": "demand", "label": "Demand & growth", "terms": [ "demand", "growth" ], "exclude": [], "match": "any" }, { "id": "pricing", "label": "Pricing & competition", "terms": [ "pricing", "prices" ], "exclude": [], "match": "any" } ], "periods": { "current": { "from": "2026-08-02", "to": "2026-11-01" }, "previous": { "from": "2026-05-02", "to": "2026-08-01" } }, "sampled": false } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/transcripts/search/facets": { "get": { "summary": "Transcript geography options", "description": "Without parameters: every country as { code, name } (no region or subregion fields). With country=XX: the business-address cities of companies holding a transcript there, with company counts.", "operationId": "get-transcript-geography-options", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "country", "in": "query", "description": "Two-letter country code: adds that country's cities with their company counts.", "schema": { "type": "string", "pattern": "^[A-Za-z]{2}$" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "countries": [ { "code": "AF", "name": "Afghanistan" }, { "code": "AX", "name": "Åland Islands" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/mentioned-by": { "get": { "summary": "Mentioned by", "description": "Where this company is talked about on OTHER companies' earnings calls and events — newest first, speaker named, exact span in the source transcript. Its own calls are excluded unless includeSelf=1.", "operationId": "get-mentioned-by", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "topicColumns", "in": "query", "description": "JSON array of 1–12 ordered columns: id, label, terms, exclude, match (any/all). Each phrase is literal text; exclusions apply across all alternatives. Definitions must fit a 6,000-character URL-encoded budget.", "schema": { "type": "string" } }, { "name": "column", "in": "query", "description": "Apply a column from topicColumns (or the default set) to source passages.", "schema": { "type": "string" } }, { "name": "q2", "in": "query", "description": "Second websearch expression; combined with q in the same speaker passage.", "schema": { "type": "string" } }, { "name": "termMatch", "in": "query", "description": "Combine q and q2 using all (AND) or any (OR).", "schema": { "type": "string", "enum": [ "all", "any" ], "default": "all" } }, { "name": "topic", "in": "query", "description": "Inspectable lexical research topic.", "schema": { "type": "string", "enum": [ "demand", "pricing", "margins", "investment", "ai", "credit", "funding", "regulation", "returns", "outlook" ] } }, { "name": "browse", "in": "query", "description": "1 = browse source turns without a keyword predicate.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Issuer region from the country catalog.", "schema": { "type": "string" } }, { "name": "subregion", "in": "query", "description": "Issuer subregion from the country catalog.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "Exact city in the company's currently stored business address; missing addresses remain unknown.", "schema": { "type": "string" } }, { "name": "locationMode", "in": "query", "description": "Inside or outside the intersection of selected country/region/subregion/city.", "schema": { "type": "string", "enum": [ "inside", "outside" ], "default": "inside" } }, { "name": "includeUnknownLocation", "in": "query", "description": "1 = include unknown geography in outside searches; excluded by default.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Optional keyword query within a company mention.", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "description": "Explicit lexical theme; AND with q in the same passage.", "schema": { "type": "string", "enum": [ "purchase-delays", "pricing-pressure", "pricing-power", "ai-investment", "inventory", "capacity", "tariffs", "guidance" ] } }, { "name": "speaker", "in": "query", "description": "Speaker name contains; max 120 characters.", "schema": { "type": "string" } }, { "name": "includeContext", "in": "query", "description": "1 = include bounded surrounding turns or indexed Q&A exchange; truncation flagged.", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Only calls held by this company.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Source issuer country from transcript metadata: uppercase ISO alpha-2 code, or unknown for missing geography.", "schema": { "type": "string" } }, { "name": "companies", "in": "query", "description": "Comma-separated company basket, at most 20 identifiers; intersects company if supplied.", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Speaker role.", "schema": { "type": "string", "enum": [ "executive", "analyst", "operator" ] } }, { "name": "section", "in": "query", "description": "Part of the call.", "schema": { "type": "string", "enum": [ "prepared", "qa" ] } }, { "name": "from", "in": "query", "description": "Calls on or after, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Calls on or before, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "sort", "in": "query", "description": "newest (default) or relevance; relevance applies only with q, q2, theme, topic or column, otherwise newest is used.", "schema": { "type": "string", "enum": [ "newest", "relevance" ], "default": "newest" } }, { "name": "limit", "in": "query", "description": "1–50, default 20.", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 20 } }, { "name": "cursor", "in": "query", "description": "nextCursor from the previous page.", "schema": { "type": "string" } }, { "name": "includeSelf", "in": "query", "description": "1 = include the company's own calls.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string" }, "hits": { "type": "array", "items": { "type": "object", "properties": { "segmentId": { "type": "integer" }, "transcriptId": { "type": "string" }, "date": { "type": "string", "format": "date" }, "company": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" } } }, "eventLabel": { "type": "string" }, "isEarningsCall": { "type": "boolean" }, "speaker": { "type": "object", "properties": { "name": { "type": "string" }, "role": { "type": "string" } } }, "section": { "type": "string" }, "snippet": { "type": "string" }, "highlights": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } } } }, "charStart": { "type": "integer" }, "charEnd": { "type": "integer" }, "isSelfMention": { "type": "boolean" }, "confidence": { "type": "number" } } } }, "total": { "type": "integer" }, "totalCapped": { "type": "boolean" }, "nextCursor": { "type": "string" }, "subject": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "mode": "mentions", "hits": [ { "segmentId": 2405642, "transcriptId": "261523", "date": "2026-10-28", "company": { "cik": "0001652044", "ticker": "GOOGL", "name": "Alphabet Inc." }, "eventLabel": "Q3 2026 earnings call", "isEarningsCall": true, "speaker": { "name": "Thomas Kurian", "role": "executive" }, "section": "prepared", "snippet": "…infrastructure, including financial institutions like Banorte and Jack Henry and telecommunication providers such as AT&T. All of this is powered by our leading AI infrastructure, spanning our TPU sy…", "highlights": [ { "start": 230, "end": 236 } ], "charStart": 19032, "charEnd": 19038, "isSelfMention": false, "confidence": 0.95 }, { "segmentId": 2405491, "transcriptId": "261538", "date": "2026-10-28", "company": { "cik": "0000789019", "ticker": "MSFT", "name": "Microsoft Corporation" }, "eventLabel": "Q1 2027 earnings call", "isEarningsCall": true, "speaker": { "name": "Satya Nadella", "role": "executive" }, "section": "prepared", "snippet": "…the data center design, silicon systems, software and models. For example, we increased the throughput for Copilot workloads by over 50% quarter-over-quarter. We continue to scale our fleet with the …", "highlights": [ { "start": 224, "end": 230 }, { "start": 292, "end": 298 } ], "charStart": 13898, "charEnd": 13904, "isSelfMention": false, "confidence": 0.95 } ], "total": 1903, "totalCapped": false, "nextCursor": "2026-10-28_2405491", "subject": { "cik": "0001045810", "ticker": "NVDA", "name": "NVIDIA CORP" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/mentioned-by/summary": { "get": { "summary": "Mentioned by summary", "description": "Mentions of this company on other companies' calls per calendar quarter, plus the companies doing the talking.", "operationId": "get-mentioned-by-summary", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "topicColumns", "in": "query", "description": "JSON array of 1–12 ordered columns: id, label, terms, exclude, match (any/all). Each phrase is literal text; exclusions apply across all alternatives. Definitions must fit a 6,000-character URL-encoded budget.", "schema": { "type": "string" } }, { "name": "column", "in": "query", "description": "Apply a column from topicColumns (or the default set) to source passages.", "schema": { "type": "string" } }, { "name": "q2", "in": "query", "description": "Second websearch expression; combined with q in the same speaker passage.", "schema": { "type": "string" } }, { "name": "termMatch", "in": "query", "description": "Combine q and q2 using all (AND) or any (OR).", "schema": { "type": "string", "enum": [ "all", "any" ], "default": "all" } }, { "name": "topic", "in": "query", "description": "Inspectable lexical research topic.", "schema": { "type": "string", "enum": [ "demand", "pricing", "margins", "investment", "ai", "credit", "funding", "regulation", "returns", "outlook" ] } }, { "name": "browse", "in": "query", "description": "1 = browse source turns without a keyword predicate.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Issuer region from the country catalog.", "schema": { "type": "string" } }, { "name": "subregion", "in": "query", "description": "Issuer subregion from the country catalog.", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "Exact city in the company's currently stored business address; missing addresses remain unknown.", "schema": { "type": "string" } }, { "name": "locationMode", "in": "query", "description": "Inside or outside the intersection of selected country/region/subregion/city.", "schema": { "type": "string", "enum": [ "inside", "outside" ], "default": "inside" } }, { "name": "includeUnknownLocation", "in": "query", "description": "1 = include unknown geography in outside searches; excluded by default.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Optional keyword query within a company mention.", "schema": { "type": "string" } }, { "name": "theme", "in": "query", "description": "Explicit lexical theme; AND with q in the same passage.", "schema": { "type": "string", "enum": [ "purchase-delays", "pricing-pressure", "pricing-power", "ai-investment", "inventory", "capacity", "tariffs", "guidance" ] } }, { "name": "speaker", "in": "query", "description": "Speaker name contains; max 120 characters.", "schema": { "type": "string" } }, { "name": "company", "in": "query", "description": "Only calls held by this company.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Source issuer country from transcript metadata: uppercase ISO alpha-2 code, or unknown for missing geography.", "schema": { "type": "string" } }, { "name": "companies", "in": "query", "description": "Comma-separated company basket, at most 20 identifiers; intersects company if supplied.", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Speaker role.", "schema": { "type": "string", "enum": [ "executive", "analyst", "operator" ] } }, { "name": "section", "in": "query", "description": "Part of the call.", "schema": { "type": "string", "enum": [ "prepared", "qa" ] } }, { "name": "from", "in": "query", "description": "Calls on or after, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Calls on or before, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "includeSelf", "in": "query", "description": "1 = include the company's own calls.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string" }, "totalMatches": { "type": "integer" }, "totalDocuments": { "type": "integer" }, "totalCompanies": { "type": "integer" }, "firstDate": { "type": "string", "format": "date" }, "lastDate": { "type": "string", "format": "date" }, "quarters": { "type": "array", "items": { "type": "object", "properties": { "quarter": { "type": "string" }, "start": { "type": "string", "format": "date" }, "matches": { "type": "integer" }, "documents": { "type": "integer" } } } }, "speakers": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" }, "matches": { "type": "integer" }, "documents": { "type": "integer" }, "lastDate": { "type": "string", "format": "date" } } } }, "sampled": { "type": "boolean" }, "companyQuarters": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "start": { "type": "string", "format": "date" }, "matches": { "type": "integer" }, "documents": { "type": "integer" } } } }, "countries": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "matches": { "type": "integer" }, "documents": { "type": "integer" }, "companies": { "type": "integer" }, "name": { "type": "string" }, "region": { "type": "string" }, "subregion": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "mode": "mentions", "totalMatches": 1903, "totalDocuments": 1058, "totalCompanies": 275, "firstDate": "2020-01-27", "lastDate": "2026-10-28", "quarters": [ { "quarter": "2020 Q1", "start": "2020-01-01", "matches": 5, "documents": 4 }, { "quarter": "2020 Q2", "start": "2020-04-01", "matches": 9, "documents": 5 } ], "speakers": [ { "cik": "0001375365", "ticker": "SMCI", "name": "Super Micro Computer, Inc.", "matches": 77, "documents": 27, "lastDate": "2026-08-11" }, { "cik": "0000858877", "ticker": "CSCO", "name": "Cisco Systems, Inc.", "matches": 61, "documents": 22, "lastDate": "2026-09-08" } ], "sampled": false, "companyQuarters": [ { "cik": "0000002488", "start": "2020-01-01", "matches": 1, "documents": 1 }, { "cik": "0000002488", "start": "2020-07-01", "matches": 1, "documents": 1 } ], "countries": [ { "code": "US", "matches": 1508, "documents": 806, "companies": 179, "name": "United States", "region": "Americas", "subregion": "North America" }, { "code": "IN", "matches": 80, "documents": 61, "companies": 28, "name": "India", "region": "Asia", "subregion": "Southern Asia" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/observations": { "get": { "summary": "Observations", "description": "Span-verified 8-K event observations, newest event first (event date, else filing date). Calls are not a source. Paged: `limit` (1–500, default 50, for every caller) and `offset`; the body carries `total`, `limit`, `offset`, `hasMore` and `nextOffset`. Rows are read from the newest 500, so from/to and offset page only within those 500.", "operationId": "get-observations", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "family", "in": "query", "description": "Event family (same list as /events/wire); an unknown one is a 400.", "schema": { "type": "string" } }, { "name": "includeReview", "in": "query", "description": "Include rows still under review (1).", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First filing date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last filing date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Rows per page, 1–500, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip (the previous `nextOffset`), default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "array", "items": { "type": "string" } }, "observations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "eventFamily": { "type": "string" }, "eventType": { "type": "string" }, "subject": { "type": [ "string", "null" ] }, "action": { "type": "string" }, "eventDate": { "type": [ "string", "null" ], "format": "date" }, "eventDateKind": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "summary": { "type": [ "string", "null" ] }, "headline": { "type": "string" }, "supportingQuote": { "type": "string" }, "metadata": { "type": [ "object", "null" ], "properties": { "deal_value": { "type": "object", "properties": { "parsed": { "type": "object", "properties": { "amount": { "type": "integer" }, "currency": { "type": "string" } } }, "fact_index": { "type": "integer" }, "value_text": { "type": "string" } } }, "counterparty": { "type": "object", "properties": { "parsed": { "type": "null" }, "fact_index": { "type": "integer" }, "value_text": { "type": "string" } } }, "expected_close_text": { "type": "object", "properties": { "parsed": { "type": "null" }, "fact_index": { "type": "integer" }, "value_text": { "type": "string" } } }, "eps": { "type": "object", "properties": { "parsed": { "type": "null" }, "fact_index": { "type": "integer" }, "value_text": { "type": "string" } } }, "revenue": { "type": "object", "properties": { "parsed": { "type": "null" }, "fact_index": { "type": "integer" }, "value_text": { "type": "string" } } } } }, "facts": { "type": [ "array", "null" ], "items": { "type": "object", "properties": { "label": { "type": "string" }, "quote_end": { "type": "integer" }, "value_text": { "type": "string" }, "quote_start": { "type": "integer" }, "supporting_quote": { "type": "string" } } } }, "accessionNumber": { "type": "string" }, "itemCode": { "type": "string" }, "itemName": { "type": "string" }, "trust": { "type": "string" } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "nextOffset": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": [ "0001045810" ], "observations": [ { "id": 162316, "eventFamily": "mna", "eventType": "acquisition_agreement", "subject": "Hugging Face, Inc.", "action": "acquire", "eventDate": "2026-09-02", "eventDateKind": "agreement", "filingDate": "2026-09-03", "summary": "NVIDIA Corporation entered into a definitive agreement to acquire Hugging Face, Inc.", "headline": "NVIDIA agrees to acquire Hugging Face for $11.9B", "supportingQuote": "On September 2, 2026, NVIDIA Corporation (“NVIDIA”) entered into a definitive agreement to acquire Hugging Face, Inc. (“Hugging Face”).", "metadata": { "deal_value": { "parsed": { "amount": 11900000000, "currency": "USD" }, "fact_index": 1, "value_text": "$11.9 billion" }, "counterparty": { "parsed": null, "fact_index": 0, "value_text": "Hugging Face, Inc." }, "expected_close_text": { "parsed": null, "fact_index": 2, "value_text": "first half of 2027" } }, "facts": [ { "label": "counterparty", "quote_end": 207, "value_text": "Hugging Face, Inc.", "quote_start": 72, "supporting_quote": "On September 2, 2026, NVIDIA Corporation (“NVIDIA”) entered into a definitive agreement to acquire Hugging Face, Inc. (“Hugging Face”)." }, { "label": "deal_value", "quote_end": 481, "value_text": "$11.9 billion", "quote_start": 341, "supporting_quote": "The transaction includes an approximately $11.9 billion purchase price payable to Hugging Face stockholders, subject to certain adjustments," } ], "accessionNumber": "0001045810-26-000078", "itemCode": "8.01", "itemName": "Other Events", "trust": "verified" }, { "id": 129496, "eventFamily": "earnings", "eventType": "earnings_release", "subject": null, "action": "announced_earnings", "eventDate": "2026-08-26", "eventDateKind": "announcement", "filingDate": "2026-08-26", "summary": "Earnings release announced", "headline": "NVIDIA reports results for quarter ended July 26, 2026", "supportingQuote": "On August 26, 2026, NVIDIA Corporation, or the Company, issued a press release announcing its results for the quarter ended July 26, 2026. The press release is attached as Exhibit 99.1 and is incorpor…", "metadata": null, "facts": null, "accessionNumber": "0001045810-26-000073", "itemCode": "2.02", "itemName": "Results of Operations and Financial Condition", "trust": "verified" } ], "total": 249, "offset": 0, "nextOffset": 2, "limit": 2, "hasMore": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/presentations": { "get": { "summary": "IR presentations", "description": "Investor-presentation decks, newest first: 8-K exhibits stored as slide images (format slides) and exchange or IR-site results decks (format pdf, opened through the filings document route). Undated decks are placed on their fiscal period end; undated ones without a period come last.", "operationId": "get-ir-presentations", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First filing date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last filing date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Page size, 1–200.", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "dedupe", "in": "query", "description": "1 (the default) collapses the same deck published more than once (an 8-K exhibit and the IR-site copy) into one row and says how many were collapsed in `duplicatesCollapsed`; 0 lists every copy.", "schema": { "type": "string", "enum": [ "1", "0" ], "default": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "presentations": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "accessionNumber": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "filingType": { "type": "string" }, "itemCodes": { "type": "array", "items": {} }, "exhibitType": { "type": "string" }, "title": { "type": "string" }, "sourceTitle": { "type": "string" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "integer" }, "pageCount": { "type": "integer" }, "totalBytes": { "type": "integer" }, "cik": { "type": "string" }, "format": { "type": "string" }, "docRef": { "type": "string" }, "alsoHeldAs": { "type": "array", "items": {} }, "date": { "type": "string", "format": "date" }, "dateBasis": { "type": "string" } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "nextOffset": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" }, "duplicatesCollapsed": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "presentations": [ { "id": -548687, "accessionNumber": "DFM-DIB-20261020-DECK", "filingDate": "2026-10-20", "filingType": "PRES", "itemCodes": [], "exhibitType": "PDF", "title": "Q3 2026 Presentation", "sourceTitle": "Q3 2026 Presentation", "fiscalYear": 2026, "fiscalQuarter": 3, "pageCount": 34, "totalBytes": 1816747, "cik": "XDFM000004", "format": "pdf", "docRef": "DFM-DIB-20261020-DECK", "alsoHeldAs": [], "date": "2026-10-20", "dateBasis": "filed" }, { "id": -291002, "accessionNumber": "DFM-DIB-20260729-DECK", "filingDate": "2026-07-29", "filingType": "PRES", "itemCodes": [], "exhibitType": "PDF", "title": "H1 2026 Presentation", "sourceTitle": "H1 2026 Presentation", "fiscalYear": 2026, "fiscalQuarter": 2, "pageCount": 34, "totalBytes": 1831278, "cik": "XDFM000004", "format": "pdf", "docRef": "DFM-DIB-20260729-DECK", "alsoHeldAs": [], "date": "2026-07-29", "dateBasis": "filed" } ], "total": 52, "offset": 0, "nextOffset": 2, "limit": 2, "hasMore": true, "duplicatesCollapsed": 0 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/presentation-guidance": { "get": { "summary": "Presentation guidance", "description": "Guidance the company printed in its investor presentations, every disclosure kept (the same target said in several decks is several rows), each with its deck (`doc_ref`) and page. Newest deck first by default; paged (`total`, `limit`, `offset`, `hasMore`, `nextOffset`); `keys` lists every guidance key the company has with its label and row count.", "operationId": "get-presentation-guidance", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Guidance keys, comma-separated.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Guidance kinds, comma-separated.", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First published date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last published date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Rows per page, 1–500, default 100.", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 100 } }, { "name": "offset", "in": "query", "description": "Rows to skip: the previous reply's `nextOffset`.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "`newest` puts the latest deck first (the default; undated last), `target` orders by the period targeted (latest first), `key` groups by metric (the Guidance table's order).", "schema": { "type": "string", "enum": [ "newest", "target", "key" ], "default": "newest" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "guidance": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "guidance_key": { "type": "string" }, "label": { "type": "string" }, "guidance_kind": { "type": "string" }, "axis": { "type": "null" }, "member_label": { "type": "null" }, "value": { "type": "number" }, "value_qualifier": { "type": "null" }, "unit_kind": { "type": "string" }, "unit_expression": { "type": "string" }, "currency": { "type": "null" }, "disclosed_period_end": { "type": "string", "format": "date" }, "disclosed_label": { "type": "string" }, "target_period_label": { "type": "string" }, "target_period_end": { "type": "string", "format": "date" }, "doc_ref": { "type": "string" }, "page": { "type": "integer" }, "printed_expression": { "type": "string" }, "raw_label": { "type": "string" }, "note": { "type": "string" }, "published_date": { "type": "string", "format": "date" }, "headline": { "type": "string" } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "nextOffset": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" }, "sort": { "type": "string" }, "keys": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "XDFM000004", "guidance": [ { "id": 4876, "guidance_key": "cost_to_income", "label": "Cost to income ratio", "guidance_kind": "target", "axis": null, "member_label": null, "value": 0.28, "value_qualifier": null, "unit_kind": "percent", "unit_expression": "%", "currency": null, "disclosed_period_end": "2026-09-30", "disclosed_label": "9M-26", "target_period_label": "FY-26", "target_period_end": "2026-12-31", "doc_ref": "DFM-DIB-20261020-DECK", "page": 26, "printed_expression": "28.0%", "raw_label": "Cost-to-Income Ratio - FY 2026 Guidance", "note": "Full-year 2026 guidance as shown in the 9M-26 deck (same as in the H1-26 deck).", "published_date": "2026-10-20", "headline": "Q3 2026 Presentation" }, { "id": 4873, "guidance_key": "digital_payment_merchants", "label": "Merchants onboarded to DIB digital payments", "guidance_kind": "target", "axis": null, "member_label": null, "value": 2800, "value_qualifier": null, "unit_kind": "count", "unit_expression": "count", "currency": null, "disclosed_period_end": "2026-09-30", "disclosed_label": "9M-26", "target_period_label": "FY-26", "target_period_end": "2026-12-31", "doc_ref": "DFM-DIB-20261020-DECK", "page": 23, "printed_expression": "2,800", "raw_label": "on-track to achieve the year-end target of 2,800 merchants", "note": "Year-end 2026 target.", "published_date": "2026-10-20", "headline": "Q3 2026 Presentation" } ], "total": 458, "offset": 0, "nextOffset": 2, "limit": 2, "hasMore": true, "sort": "newest", "keys": [ { "key": "cash_coverage_ratio", "label": "Cash coverage ratio", "count": 34 }, { "key": "cost_to_income", "label": "Cost to income ratio", "count": 57 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/market-events": { "get": { "summary": "Market events", "description": "Dated events to overlay on the company's charts: global, regional, country, exchange and company events, and Ramadan for Muslim-majority markets.", "operationId": "get-market-events", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "max_tier", "in": "query", "description": "Least important tier to include, 1–3, default 3; any other value is read as 3.", "schema": { "type": "integer", "minimum": 1, "maximum": 3, "default": 3 } }, { "name": "economy", "in": "query", "description": "ISO alpha-2 economy for economic events (recessions); default the home country, else US.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Categories, comma-separated, e.g. war_conflict,financial_crisis.", "schema": { "type": "string" } }, { "name": "exclude_category", "in": "query", "description": "Categories to drop, e.g. calendar (Ramadan).", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First day (events overlapping the window), YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last day, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Page size, 1–500.", "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "order", "in": "query", "description": "Date order: `asc` oldest first (the default), `desc` newest first.", "schema": { "type": "string", "enum": [ "asc", "desc" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "economy": { "type": "string" }, "economies": { "type": "array", "items": { "type": "string" } }, "events": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "parent": { "type": "null" }, "title": { "type": "string" }, "label": { "type": "string" }, "summary": { "type": [ "string", "null" ] }, "category": { "type": "string" }, "tier": { "type": "integer" }, "start": { "type": "string", "format": "date" }, "end": { "type": [ "string", "null" ], "format": "date" }, "precision": { "type": "string" }, "sentiment": { "type": "string" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" } } } }, "matched_kinds": { "type": "array", "items": { "type": "string" } }, "matched_kind": { "type": "string" }, "matched_code": { "type": "string" } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "nextOffset": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" }, "order": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "economy": "US", "economies": [ "AE", "CA" ], "events": [ { "key": "recession-us-194503", "parent": null, "title": "US recession, Feb 1945 peak to Oct 1945 trough (NBER)", "label": "US recession 1945", "summary": "8 months of contraction as dated by the NBER Business Cycle Dating Committee (peak Feb 1945, trough Oct 1945).", "category": "business_cycle", "tier": 1, "start": "1945-03-01", "end": "1945-10-31", "precision": "month", "sentiment": "negative", "sources": [ { "url": "https://www.nber.org/research/data/us-business-cycle-expansions-and-contractions" }, { "url": "https://fred.stlouisfed.org/series/USREC" } ], "matched_kinds": [ "country" ], "matched_kind": "country", "matched_code": "US" }, { "key": "recession-us-194812", "parent": null, "title": "US recession, Nov 1948 peak to Oct 1949 trough (NBER)", "label": "US recession 1948–49", "summary": "11 months of contraction as dated by the NBER Business Cycle Dating Committee (peak Nov 1948, trough Oct 1949).", "category": "business_cycle", "tier": 1, "start": "1948-12-01", "end": "1949-10-31", "precision": "month", "sentiment": "negative", "sources": [ { "url": "https://www.nber.org/research/data/us-business-cycle-expansions-and-contractions" }, { "url": "https://fred.stlouisfed.org/series/USREC" } ], "matched_kinds": [ "country" ], "matched_kind": "country", "matched_code": "US" } ], "total": 192, "offset": 0, "nextOffset": 2, "limit": 2, "hasMore": true, "order": "asc" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/presentations/{presentationId}/pages/{page}": { "get": { "summary": "Presentation page image", "description": "One rendered page image of an IR deck.", "operationId": "get-presentation-page-image", "tags": [ "Transcripts & Calls" ], "x-tier": "public", "security": [], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "presentationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "page", "in": "path", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/compute": { "get": { "summary": "Compute exposure", "description": "Compute / GPU exposure for hyperscalers and neoclouds. {id} must be a ticker (letters, dots, dashes; a CIK is a 400); 404 when the company is not in the compute set.", "operationId": "get-compute-exposure", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "compute": { "type": "object", "properties": { "ticker": { "type": "string" }, "silicon": { "type": "array", "items": { "type": "object", "properties": { "listed_as": { "type": "array", "items": { "type": "string" } }, "symbol": { "type": "string" }, "name": { "type": "string" }, "short_name": { "type": "string" }, "asset_class": { "type": "string" }, "category": { "type": "string" }, "tier": { "type": "string" }, "parent_symbol": { "type": "null" }, "host_code": { "type": "null" }, "instance_family": { "type": "null" }, "vendor": { "type": "string" }, "unit": { "type": "string" }, "attributes": { "type": "object", "properties": { "basis": { "type": "string" }, "source": { "type": "string" }, "vram_gb": { "type": "integer" }, "form_factor": { "type": "string" }, "architecture": { "type": "string" }, "interconnect": { "type": "string" } } }, "provider": { "type": "string" }, "premium_vs_reference": { "type": "null" }, "spec": { "type": "object", "properties": { "chip": { "type": "string" }, "tdp_w": { "type": "integer" }, "die_mm2": { "type": "integer" }, "vram_gb": { "type": "integer" }, "fp8_tflops": { "type": [ "integer", "null" ] }, "process_nm": { "type": "integer" }, "form_factor": { "type": "string" }, "fp16_tflops": { "type": [ "number", "null" ] }, "launch_date": { "type": "string", "format": "date" }, "memory_type": { "type": "string" }, "spec_source": { "type": "string" }, "architecture": { "type": "string" }, "manufacturer": { "type": "string" }, "mem_bus_bits": { "type": "integer" }, "bandwidth_gbs": { "type": "integer" }, "transistors_m": { "type": "integer" }, "spec_source_url": { "type": "string" }, "launch_price_usd": { "type": [ "integer", "null" ] }, "launch_price_note": { "type": "string" } } }, "hosts": { "type": "array", "items": { "type": "object", "properties": { "host_code": { "type": "string" }, "host_name": { "type": "string" }, "company_ticker": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "company_website": { "type": [ "string", "null" ] }, "instance_family": { "type": "string" }, "gpus_per_instance": { "type": [ "integer", "null" ] }, "vram_variant_gb": { "type": "integer" }, "notes": { "type": "string" }, "url": { "type": "string" } } } }, "last_price": { "type": "number" }, "last_price_date": { "type": "string", "format": "date" }, "return_1d": { "type": "null" }, "return_ytd": { "type": "null" }, "return_1y": { "type": "null" }, "volatility_30d": { "type": "number" }, "price_rows": { "type": "integer" }, "days_stale": { "type": "integer" }, "stale_after_days": { "type": "integer" }, "frequency": { "type": "string" }, "prev_price": { "type": "number" }, "prev_price_date": { "type": "string", "format": "date" }, "return_prev": { "type": "number" }, "return_1m": { "type": "number" }, "high_52w": { "type": "number" }, "low_52w": { "type": "number" }, "gflops_per_watt": { "type": [ "number", "null" ] }, "usd_per_pflop_hour": { "type": [ "number", "null" ] }, "launch_usd_per_tflops": { "type": [ "number", "null" ] }, "closes": { "type": "array", "items": { "type": "number" } }, "display_order": { "type": "integer" } } } }, "accelerators": { "type": "array", "items": {} }, "rental_book": { "type": "array", "items": {} }, "peer_boards": { "type": "array", "items": { "type": "object", "properties": { "gpu": { "type": "string" }, "reference_price": { "type": "number" }, "own_price": { "type": "null" }, "max_price": { "type": "number" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string" }, "host_label": { "type": "string" }, "company_ticker": { "type": [ "string", "null" ] }, "host_code": { "type": "string" }, "company_website": { "type": [ "string", "null" ] }, "tier": { "type": "string" }, "last_price": { "type": "number" }, "premium_vs_reference": { "type": "number" }, "vs_own": { "type": "null" }, "is_own": { "type": "boolean" }, "closes": { "type": "array", "items": { "type": "number" } } } } } } } }, "h100_usd_per_pflop_hour": { "type": "number" }, "flagship_symbol": { "type": "string" }, "flagship_history": { "type": "array", "items": { "type": "object", "properties": { "d": { "type": "string", "format": "date" }, "v": { "type": "number" } } } }, "quarters": { "type": "array", "items": { "type": "object", "properties": { "period_end": { "type": "string", "format": "date" }, "value": { "type": "integer" } } } }, "quarters_kind": { "type": "string" }, "quarters_label": { "type": "string" }, "own_mentions": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "observed_at": { "type": "string", "format": "date" }, "speaker_name": { "type": "string" }, "speaker_role": { "type": "string" }, "sentiment": { "type": "string" }, "is_forward_looking": { "type": "boolean" }, "quote": { "type": "string" }, "fiscal_title": { "type": "string" }, "matched_symbol": { "type": "string" } } } }, "customer_mentions": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "observed_at": { "type": "string", "format": "date" }, "speaker_name": { "type": "string" }, "speaker_role": { "type": "string" }, "sentiment": { "type": "string" }, "is_forward_looking": { "type": "boolean" }, "quote": { "type": "string" }, "fiscal_title": { "type": "string" }, "matched_symbol": { "type": "string" } } } }, "mention_trend": { "type": "array", "items": { "type": "object", "properties": { "quarter": { "type": "string" }, "own": { "type": "integer" }, "customers": { "type": "integer" } } } }, "fleet_pnl": { "type": "null" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "compute": { "ticker": "NVDA", "silicon": [ { "listed_as": [ "NYMEX GPU1" ], "symbol": "H100", "name": "NVIDIA H100 SXM", "short_name": "H100 SXM", "asset_class": "compute", "category": "gpu", "tier": "reference", "parent_symbol": null, "host_code": null, "instance_family": null, "vendor": "NVIDIA", "unit": "USD per GPU-hour", "attributes": { "basis": "on-demand, transaction-weighted", "source": "Ornn OCPI", "vram_gb": 80, "form_factor": "SXM5", "architecture": "Hopper", "interconnect": "NVLink" }, "provider": "ORNN", "premium_vs_reference": null, "spec": { "chip": "GH100", "tdp_w": 700, "die_mm2": 814, "vram_gb": 80, "fp8_tflops": 1979, "process_nm": 5, "form_factor": "SXM5", "fp16_tflops": 989.4, "launch_date": "2022-09-20", "memory_type": "HBM3", "spec_source": "Epoch AI, Machine Learning Hardware (CC-BY 4.0)", "architecture": "Hopper", "manufacturer": "NVIDIA", "mem_bus_bits": 5120, "bandwidth_gbs": 3350, "transistors_m": 80000, "spec_source_url": "https://www.nvidia.com/en-us/data-center/h100/", "launch_price_usd": 33600, "launch_price_note": "Epoch: no official MSRP; $269k DGX H100 ÷ 8 (SemiAnalysis, May 2023)." }, "hosts": [ { "host_code": "AWS", "host_name": "Amazon Web Services", "company_ticker": "AMZN", "company_name": "AMAZON COM INC", "company_website": "https://www.amazon.com", "instance_family": "p5.48xlarge", "gpus_per_instance": 8, "vram_variant_gb": 80, "notes": "EC2 P5, 8× H100 SXM, 3.2 Tbps EFA", "url": "https://aws.amazon.com/ec2/instance-types/p5/" }, { "host_code": "RUNPOD", "host_name": "RunPod", "company_ticker": null, "company_name": null, "company_website": null, "instance_family": "secure H100 SXM", "gpus_per_instance": null, "vram_variant_gb": 80, "notes": "Secure cloud, per-GPU rental", "url": "https://www.runpod.io/pricing" } ], "last_price": 3.03, "last_price_date": "2026-10-30", "return_1d": null, "return_ytd": null, "return_1y": null, "volatility_30d": 1.2592278334375073, "price_rows": 163, "days_stale": 2, "stale_after_days": 3, "frequency": "D", "prev_price": 2.92, "prev_price_date": "2026-10-29", "return_prev": 0.03767123287671237, "return_1m": 0.11808118081180807, "high_52w": 3.57, "low_52w": 2.29, "gflops_per_watt": 1413.4285714285713, "usd_per_pflop_hour": 3.062462098241358, "launch_usd_per_tflops": 33.95997574287447, "closes": [ 3.2, 3.06 ], "display_order": 10 }, { "listed_as": [], "symbol": "RTXPRO6000", "name": "NVIDIA RTX PRO 6000 (WS)", "short_name": "RTX PRO 6000", "asset_class": "compute", "category": "gpu", "tier": "reference", "parent_symbol": null, "host_code": null, "instance_family": null, "vendor": "NVIDIA", "unit": "USD per GPU-hour", "attributes": { "basis": "on-demand list, median across venues", "source": "median of venue list prices", "vram_gb": 96, "form_factor": "PCIe", "architecture": "Blackwell", "interconnect": "PCIe" }, "provider": "DERIVED", "premium_vs_reference": null, "spec": { "chip": "GB202", "tdp_w": 600, "die_mm2": 750, "vram_gb": 96, "fp8_tflops": null, "process_nm": 4, "form_factor": "PCIe", "fp16_tflops": null, "launch_date": "2025-04-23", "memory_type": "GDDR7", "spec_source": "Epoch AI, Machine Learning Hardware (CC-BY 4.0)", "architecture": "Blackwell", "manufacturer": "NVIDIA", "mem_bus_bits": 512, "bandwidth_gbs": 1792, "transistors_m": 92200, "spec_source_url": "https://www.nvidia.com/en-us/products/workstations/professional-desktop-gpus/rtx-pro-6000/", "launch_price_usd": null, "launch_price_note": "No official MSRP; no dense-tensor FP16 figure we can defend — left empty." }, "hosts": [ { "host_code": "NEBIUS", "host_name": "Nebius", "company_ticker": "NBIS", "company_name": "Nebius Group N.V.", "company_website": "https://nebius.com", "instance_family": "RTX PRO 6000", "gpus_per_instance": null, "vram_variant_gb": 96, "notes": "On-demand instances", "url": "https://nebius.com/prices" }, { "host_code": "RUNPOD", "host_name": "RunPod", "company_ticker": null, "company_name": null, "company_website": null, "instance_family": "secure RTX PRO 6000 WS", "gpus_per_instance": null, "vram_variant_gb": 96, "notes": "Secure cloud, per-GPU rental", "url": "https://www.runpod.io/pricing" } ], "last_price": 1.995, "last_price_date": "2026-09-19", "return_1d": null, "return_ytd": null, "return_1y": null, "volatility_30d": 0.2726445840176513, "price_rows": 31, "days_stale": 43, "stale_after_days": 3, "frequency": "D", "prev_price": 1.995, "prev_price_date": "2026-09-18", "return_prev": 0, "return_1m": 0.08130081300813008, "high_52w": 1.995, "low_52w": 1.845, "gflops_per_watt": null, "usd_per_pflop_hour": null, "launch_usd_per_tflops": null, "closes": [ 1.845, 1.845 ], "display_order": 75 } ], "accelerators": [], "rental_book": [], "peer_boards": [ { "gpu": "H100", "reference_price": 3.03, "own_price": null, "max_price": 12.29, "rows": [ { "symbol": "H100-VAST", "host_label": "Vast.ai", "company_ticker": null, "host_code": "VAST", "company_website": null, "tier": "marketplace", "last_price": 2.4, "premium_vs_reference": -0.20792079207920788, "vs_own": null, "is_own": false, "closes": [ 2.4, 2.93 ] }, { "symbol": "H100-OCI", "host_label": "Oracle Cloud", "company_ticker": "ORCL", "host_code": "OCI", "company_website": "https://www.oracle.com", "tier": "hyperscaler", "last_price": 10, "premium_vs_reference": 2.3003300330033007, "vs_own": null, "is_own": false, "closes": [ 10, 10 ] } ] }, { "gpu": "GB200", "reference_price": 13.25, "own_price": null, "max_price": 16, "rows": [ { "symbol": "GB200-CRWV", "host_label": "CoreWeave", "company_ticker": "CRWV", "host_code": "COREWEAVE", "company_website": "https://www.coreweave.com", "tier": "neocloud", "last_price": 10.5, "premium_vs_reference": -0.2075471698113207, "vs_own": null, "is_own": false, "closes": [ 10.5, 10.5 ] }, { "symbol": "GB200-OCI", "host_label": "Oracle Cloud", "company_ticker": "ORCL", "host_code": "OCI", "company_website": "https://www.oracle.com", "tier": "hyperscaler", "last_price": 16, "premium_vs_reference": 0.2075471698113207, "vs_own": null, "is_own": false, "closes": [ 16, 16 ] } ] } ], "h100_usd_per_pflop_hour": 3.062462098241358, "flagship_symbol": "H100", "flagship_history": [ { "d": "2026-05-20", "v": 3.2 }, { "d": "2026-05-21", "v": 3.06 } ], "quarters": [ { "period_end": "2021-08-01", "value": 2600000000 }, { "period_end": "2021-10-31", "value": 3011000000 } ], "quarters_kind": "segment_revenue", "quarters_label": "Compute And Networking Segment revenue", "own_mentions": [ { "ticker": "NVDA", "observed_at": "2026-05-20", "speaker_name": "Colette Kress", "speaker_role": "executive", "sentiment": "positive", "is_forward_looking": false, "quote": "The price of renting an H100 has risen 20% year-to-date", "fiscal_title": "NVIDIA Corporation - Q1 2027 Earnings Call", "matched_symbol": "H100" }, { "ticker": "NVDA", "observed_at": "2026-05-20", "speaker_name": "Colette Kress", "speaker_role": "executive", "sentiment": "positive", "is_forward_looking": false, "quote": "while A100 cloud pricing is up nearly 15%.", "fiscal_title": "NVIDIA Corporation - Q1 2027 Earnings Call", "matched_symbol": "A100" } ], "customer_mentions": [ { "ticker": "GOOGL", "observed_at": "2026-04-29", "speaker_name": "Sundar Pichai", "speaker_role": "executive", "sentiment": "positive", "is_forward_looking": true, "quote": "NVIDIA GPUs are a core part of our AI accelerator portfolio and will be among the first to offer NVIDIA Vera Rubin NVL72 in addition to the Blackwell and Hopper-based instances already available.", "fiscal_title": "Alphabet Inc. - Q1 2026 Earnings Call", "matched_symbol": "GB200" }, { "ticker": "ORCL", "observed_at": "2025-12-10", "speaker_name": "Clay Magouyrk", "speaker_role": "executive", "sentiment": "positive", "is_forward_looking": false, "quote": "Our SuperCluster in Abilene, Texas is on track with more than 96,000 NVIDIA Grace Blackwell GB200 delivered.", "fiscal_title": "Oracle Corporation - Q2 2026 Earnings Call", "matched_symbol": "GB200" } ], "mention_trend": [ { "quarter": "2024 Q3", "own": 3, "customers": 4 }, { "quarter": "2024 Q4", "own": 7, "customers": 9 } ], "fleet_pnl": null } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/filings": { "get": { "summary": "Latest filings", "description": "Newest documents across every source: completed SEC EDGAR filings and the exchange, regulator and IR documents we store (DFM, ADX, Tadawul, QSE, DART, EDINET, …), newest first.", "operationId": "get-latest-filings", "tags": [ "SEC Filings" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "limit", "in": "query", "description": "1–100, default 100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 100 } }, { "name": "offset", "in": "query", "description": "Default 0; the response carries hasMore and nextOffset.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "family", "in": "query", "description": "Only filings of one family: annual (10-K, 20-F, exchange annual reports), interim (10-Q, exchange interims), current (8-K, 6-K, exchange disclosures), press, insider (Forms 3/4/5), holdings (13F, 13D/G), meetings (proxies, AGMs) or calls (exchange calls and decks).", "schema": { "type": "string", "enum": [ "annual", "interim", "current", "press", "insider", "holdings", "meetings", "calls" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "filings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "accessionNumber": { "type": "string" }, "filingType": { "type": "string" }, "filingDate": { "type": "string", "format": "date" }, "fileSizeBytes": { "type": "integer" }, "cik": { "type": "string" }, "title": { "type": "string" }, "documentKind": { "type": "string" }, "source": { "type": "string" }, "companyName": { "type": "string" }, "ticker": { "type": "string" } } } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "filings": [ { "id": -773257, "accessionNumber": "SAU-2283-20261101-PR", "filingType": "PR", "filingDate": "2026-11-01", "fileSizeBytes": 3730, "cik": "XSAU000015", "title": "First Milling Co. announces hosting an earnings call to discuss the financial results for third quarter and the nine-month period of 2026", "documentKind": "pdf", "source": "TADAWUL", "companyName": "First Milling Co.", "ticker": "2283" }, { "id": -773224, "accessionNumber": "ADX-GIH-20261101-AGM", "filingType": "AGM", "filingDate": "2026-11-01", "fileSizeBytes": 275046, "cik": "XKUW000074", "title": "Gulf Investment House Company General Assembly Meeting Result held on 01/11/2026 at 12:00", "documentKind": "pdf", "source": "ADX", "companyName": "Gulf Investment House", "ticker": "GIH" } ], "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/filings/{accession}": { "get": { "summary": "Filing by accession", "description": "The primary document of a completed SEC filing, as sanitized HTML (text/html), by SEC accession number (0000000000-00-000000, dashes optional). Exchange documents (doc_ref ids from /filings) are not served here.", "operationId": "get-filing-by-accession", "tags": [ "SEC Filings" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "accession", "in": "path", "required": true, "description": "SEC accession number, e.g. 0001045810-25-000023.", "schema": { "type": "string" } }, { "name": "issuer", "in": "query", "description": "For a 13F filing only: keep the information-table rows whose issuer name contains this text (≤200 characters).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "text/html": { "schema": { "type": "string", "description": "The document as sanitized HTML." } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/events/latest": { "get": { "summary": "Latest events", "description": "Newest span-verified 8-K event headlines across published companies, newest filing first.", "operationId": "get-latest-events", "tags": [ "8-K Events" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "family", "in": "query", "description": "One event family (same list as /events/wire); an unknown one is a 400.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "1–100, default 30.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "headlines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "headline": { "type": "string" }, "eventFamily": { "type": "string" }, "eventDate": { "type": "null" }, "filingDate": { "type": "string", "format": "date" }, "cik": { "type": "string" }, "ticker": { "type": "string" }, "companyName": { "type": "string" }, "accessionNumber": { "type": "string" }, "itemCode": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "headlines": [ { "id": 197619, "headline": "Athene Holding Ltd. publishes presentation on AI-related infrastructure financing", "eventFamily": "other", "eventDate": null, "filingDate": "2026-10-30", "cik": "0001858681", "ticker": "APO", "companyName": "Apollo Global Management, Inc.", "accessionNumber": "0001858681-26-000059", "itemCode": "7.01" }, { "id": 197615, "headline": "2020 Equity Incentive Plan amended and restated", "eventFamily": "governance_vote", "eventDate": null, "filingDate": "2026-10-30", "cik": "0001577526", "ticker": "AI", "companyName": "C3.ai, Inc.", "accessionNumber": "0001577526-26-000179", "itemCode": "5.07" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/events/wire": { "get": { "summary": "Event wire", "description": "Searchable headline wire of 8-K items and exchange disclosures across published companies: newest filing first (`sort=oldest` reverses), paged. The body carries `headlines`, `total`, `limit`, `offset`, `hasMore`, `nextOffset` (null on the last page), `sort` and `asOf` (when the feed it was cut from was read; it is cached for two minutes). Every value is checked: a bad one is a 400 naming it.", "operationId": "get-event-wire", "tags": [ "8-K Events" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "q", "in": "query", "description": "One phrase, case-insensitive, matched as a substring of the headline, the ticker or the company name; not the filing text and no search syntax. At most 200 characters.", "schema": { "type": "string" } }, { "name": "family", "in": "query", "description": "Event families, comma-separated or repeated: dividend, stock_split, guidance, earnings, mna, debt_financing, equity_financing, buyback, restatement_non_reliance, cyber_incident, restructuring, impairment, leadership, governance_vote, agreement, legal_regulatory, listing_compliance, other. An unknown one is a 400.", "schema": { "type": "array", "items": { "type": "string", "enum": [ "dividend", "stock_split", "guidance", "earnings", "mna", "debt_financing", "equity_financing", "buyback", "restatement_non_reliance", "cyber_incident", "restructuring", "impairment", "leadership", "governance_vote", "agreement", "legal_regulatory", "listing_compliance", "other" ] } } }, { "name": "from", "in": "query", "description": "First filing date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last filing date, YYYY-MM-DD; not before `from`.", "schema": { "type": "string", "format": "date" } }, { "name": "sort", "in": "query", "description": "Filing-date order.", "schema": { "type": "string", "enum": [ "newest", "oldest" ], "default": "newest" } }, { "name": "limit", "in": "query", "description": "Page size, 1–100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip: the previous `nextOffset`.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "counts", "in": "query", "description": "1 adds `familyCounts`: matches per family for the same `q` and dates, ignoring `family`.", "schema": { "type": "string", "enum": [ "0", "1", "true", "false" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "headlines": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "headline": { "type": "string" }, "eventFamily": { "type": "string" }, "eventDate": { "type": "null" }, "filingDate": { "type": "string", "format": "date" }, "cik": { "type": "string" }, "ticker": { "type": "string" }, "companyName": { "type": "string" }, "accessionNumber": { "type": "string" }, "itemCode": { "type": "string" } } } }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" }, "sort": { "type": "string" }, "asOf": { "type": "string", "format": "date-time" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "headlines": [ { "id": 197619, "headline": "Athene Holding Ltd. publishes presentation on AI-related infrastructure financing", "eventFamily": "other", "eventDate": null, "filingDate": "2026-10-30", "cik": "0001858681", "ticker": "APO", "companyName": "Apollo Global Management, Inc.", "accessionNumber": "0001858681-26-000059", "itemCode": "7.01" }, { "id": 197615, "headline": "2020 Equity Incentive Plan amended and restated", "eventFamily": "governance_vote", "eventDate": null, "filingDate": "2026-10-30", "cik": "0001577526", "ticker": "AI", "companyName": "C3.ai, Inc.", "accessionNumber": "0001577526-26-000179", "itemCode": "5.07" } ], "total": 53543, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2, "sort": "newest", "asOf": "2026-11-01T12:50:35.223Z" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/news/feed": { "get": { "summary": "News feed", "description": "The intraday news tape: SEC filings as they are accepted, issuer press releases, exchange and regulator notices, central-bank releases and licensed wires, stamped with the source time and the moment Astreus first saw them. Cursor-paged on id: poll forward with after=latestId (+changedSince=serverTime to pick up rewritten headlines), page back with before=nextCursor. Every row carries its source attribution and display policy; snippet/body are withheld where the license does not allow them. An unknown topic or source code, a malformed cursor or a limit above 200 is a 400 naming the parameter; an unknown `cik` is a 404.", "operationId": "get-news-feed", "tags": [ "News" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "after", "in": "query", "description": "Poll: return items with id greater than this (newest first). Pass the previous response's latestId.", "schema": { "type": "integer", "format": "int64" } }, { "name": "before", "in": "query", "description": "Load older: items published before item on the tape (by publication time, then id). Pass the previous response's nextCursor.", "schema": { "type": "integer", "format": "int64" } }, { "name": "changedSince", "in": "query", "description": "ISO 8601; with `after`, also re-send items whose updatedAt is later (headline rewrites, re-tagging). Pass the previous response's serverTime.", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "description": "Items per page, 1–200, default 100; above 200 is a 400 (page with before=nextCursor).", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 } }, { "name": "tickers", "in": "query", "description": "Comma-separated tickers; items tagged with any of them.", "schema": { "type": "string" } }, { "name": "cik", "in": "query", "description": "Numeric CIK or platform key; items whose primary company or a tagged company entity is this issuer.", "schema": { "type": "string" } }, { "name": "topics", "in": "query", "description": "Comma-separated topic codes (see /news/topics); any of them.", "schema": { "type": "string" } }, { "name": "sources", "in": "query", "description": "Comma-separated source codes (see /news/sources); any of them.", "schema": { "type": "string" } }, { "name": "excludeSources", "in": "query", "description": "Comma-separated source codes to hide (the UI's Markets view hides agency releases, social posts and GDELT links).", "schema": { "type": "string" } }, { "name": "excludeForms", "in": "query", "description": "Comma-separated filing form types to hide (e.g. 4,144,SC 13G); rows without a form are kept.", "schema": { "type": "string" } }, { "name": "flash", "in": "query", "description": "1 to return flash (high-priority) items only; 0 (default) for all.", "schema": { "type": "string", "enum": [ "0", "1", "true", "false" ] } }, { "name": "minImportance", "in": "query", "description": "Minimum importance score 0–100.", "schema": { "type": "integer", "minimum": 0, "maximum": 100 } }, { "name": "q", "in": "query", "description": "Full-text query over headline and snippet (websearch syntax: quoted phrases, OR, -exclusion).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewsFeedResponse" }, "example": { "items": [ { "id": 24577978, "sourceCode": "BSKY", "sourceName": "Bluesky — official accounts", "sourceKind": "social", "displayPolicy": "headline_snippet", "attribution": "Source: Bluesky", "headline": "@theguardian.com: Premier League today: How to watch, TV channels & live stream", "headlineKind": "source", "snippet": null, "url": "https://bsky.app/profile/theguardian.com/post/3mzatsgjh7i2g", "publishedAt": "2026-11-01T12:48:04.923Z", "observedAt": "2026-11-01T12:48:06.340Z", "updatedAt": "2026-11-01T12:48:06.533Z", "importance": 30, "isFlash": false, "tickers": [], "primaryCik": null, "formType": null, "itemCodes": null, "topics": [ "LEADERSHIP", "SOCIAL_OFFICIAL" ], "clusterId": 140326, "language": "en", "publisher": null }, { "id": 24577566, "sourceCode": "BSKY", "sourceName": "Bluesky — official accounts", "sourceKind": "social", "displayPolicy": "headline_snippet", "attribution": "Source: Bluesky", "headline": "@cnbc.com: Crocs stock jumped 25% after earnings. Here's why that might be just the beginning", "headlineKind": "source", "snippet": null, "url": "https://bsky.app/profile/cnbc.com/post/3mzatozcjzr27", "publishedAt": "2026-11-01T12:46:10.000Z", "observedAt": "2026-11-01T12:46:10.938Z", "updatedAt": "2026-11-01T12:46:11.394Z", "importance": 45, "isFlash": false, "tickers": [], "primaryCik": null, "formType": null, "itemCodes": null, "topics": [ "EARNINGS", "SOCIAL_OFFICIAL" ], "clusterId": 140324, "language": "en", "publisher": null } ], "latestId": 24577978, "nextCursor": 24577566, "serverTime": "2026-11-01T12:50:10.882Z" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/news/items/{id}": { "get": { "summary": "News story", "description": "One story: the item, its entity tags (companies, people, indicators…), the rest of its storyline (same cluster, newest first, up to 10), metadata, and the full text for full_text-licensed sources only (null otherwise).", "operationId": "get-news-story", "tags": [ "News" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "News item id.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "item" ], "properties": { "item": { "$ref": "#/components/schemas/NewsStory" } } }, "example": { "item": { "id": 24577978, "sourceCode": "BSKY", "sourceName": "Bluesky — official accounts", "sourceKind": "social", "displayPolicy": "headline_snippet", "attribution": "Source: Bluesky", "headline": "@theguardian.com: Premier League today: How to watch, TV channels & live stream", "headlineKind": "source", "snippet": null, "url": "https://bsky.app/profile/theguardian.com/post/3mzatsgjh7i2g", "publishedAt": "2026-11-01T12:48:04.923Z", "observedAt": "2026-11-01T12:48:06.340Z", "updatedAt": "2026-11-01T12:48:06.533Z", "importance": 30, "isFlash": false, "tickers": [], "primaryCik": null, "formType": null, "itemCodes": null, "topics": [ "LEADERSHIP", "SOCIAL_OFFICIAL" ], "clusterId": 140326, "language": "en", "publisher": null, "body": null, "entities": [], "related": [], "metadata": { "did": "did:plc:vovinwhtulbsx4mwfw26r5ni", "handle": "theguardian.com", "has_embed": true } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/news/search": { "get": { "summary": "Search news", "description": "Full-text search over headline and snippet of the served tape, newest first. Accepts the feed's narrowing filters. Paged: `nextCursor` (null when exhausted) is the `before` of the next page. An unknown topic or source code or a limit above 100 is a 400; an unknown `cik` is a 404.", "operationId": "get-search-news", "tags": [ "News" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "q", "in": "query", "description": "Required. Search text (websearch syntax), at most 200 characters (longer is cut).", "schema": { "type": "string" }, "required": true }, { "name": "limit", "in": "query", "description": "Items per page, 1–100, default 50; above 100 is a 400.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, { "name": "tickers", "in": "query", "description": "Comma-separated tickers; items tagged with any of them.", "schema": { "type": "string" } }, { "name": "cik", "in": "query", "description": "Numeric CIK or platform key; items whose primary company or a tagged company entity is this issuer.", "schema": { "type": "string" } }, { "name": "topics", "in": "query", "description": "Comma-separated topic codes (see /news/topics); any of them.", "schema": { "type": "string" } }, { "name": "sources", "in": "query", "description": "Comma-separated source codes (see /news/sources); any of them.", "schema": { "type": "string" } }, { "name": "excludeSources", "in": "query", "description": "Comma-separated source codes to hide (the UI's Markets view hides agency releases, social posts and GDELT links).", "schema": { "type": "string" } }, { "name": "excludeForms", "in": "query", "description": "Comma-separated filing form types to hide (e.g. 4,144,SC 13G); rows without a form are kept.", "schema": { "type": "string" } }, { "name": "flash", "in": "query", "description": "1 to return flash (high-priority) items only; 0 (default) for all.", "schema": { "type": "string", "enum": [ "0", "1", "true", "false" ] } }, { "name": "minImportance", "in": "query", "description": "Minimum importance score 0–100.", "schema": { "type": "integer", "minimum": 0, "maximum": 100 } }, { "name": "before", "in": "query", "description": "Load older: items published before item on the tape (by publication time, then id). Pass the previous response's nextCursor.", "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "nextCursor" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NewsItem" }, "description": "Newest first." }, "nextCursor": { "type": [ "integer", "null" ], "format": "int64", "description": "Pass as before= for the next page; null when exhausted." } } }, "example": { "items": [ { "id": 24572400, "sourceCode": "MINT", "sourceName": "Mint — Markets", "sourceKind": "publisher_rss", "displayPolicy": "headline_link", "attribution": "Mint", "headline": "Tax twist for OMC stocks: Indian Oil, BPCL, HPCL shares in 2 Nov focus after this decision by Govt on petrol, diesel", "headlineKind": "source", "snippet": null, "url": "https://livemint.com/market/stock-market-news/tax-twist-for-omc-stocks-indian-oil-bpcl-hpcl-shares-in-2-nov-focus-after-this-decision-by-govt-on-petrol-diesel-11793531837968.html", "publishedAt": "2026-11-01T12:11:32.000Z", "observedAt": "2026-11-01T12:18:01.968Z", "updatedAt": "2026-11-01T12:18:02.618Z", "importance": 22, "isFlash": false, "tickers": [], "primaryCik": null, "formType": null, "itemCodes": null, "topics": [ "ASIA", "ENERGY" ], "clusterId": 140284, "language": "en", "publisher": null }, { "id": 24555806, "sourceCode": "BSKY", "sourceName": "Bluesky — official accounts", "sourceKind": "social", "displayPolicy": "headline_snippet", "attribution": "Source: Bluesky", "headline": "@theguardian.com: Rare short-necked oil beetle rediscovered in Wales after nearly 60 years", "headlineKind": "source", "snippet": null, "url": "https://bsky.app/profile/theguardian.com/post/3mzandafu2y22", "publishedAt": "2026-11-01T10:52:13.000Z", "observedAt": "2026-11-01T10:52:14.053Z", "updatedAt": "2026-11-01T10:52:16.013Z", "importance": 31, "isFlash": false, "tickers": [], "primaryCik": null, "formType": null, "itemCodes": null, "topics": [ "ENERGY", "SOCIAL_OFFICIAL" ], "clusterId": 139724, "language": "en", "publisher": null } ], "nextCursor": 24555806 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/news/topics": { "get": { "summary": "News topics", "description": "Topic taxonomy (corporate event families, macro, policy, market, sector, region) with a rolling 24-hour item count per topic.", "operationId": "get-news-topics", "tags": [ "News" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "topics" ], "properties": { "topics": { "type": "array", "items": { "$ref": "#/components/schemas/NewsTopic" } } } }, "example": { "topics": [ { "code": "EARNINGS", "label": "Earnings & results", "group": "corporate", "isFlashDefault": true, "count24h": 33 }, { "code": "GUIDANCE", "label": "Guidance & outlook", "group": "corporate", "isFlashDefault": true, "count24h": 2 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/news/sources": { "get": { "summary": "News sources", "description": "Enabled news sources with license class, display policy and the attribution line to render, plus a rolling 24-hour item count.", "operationId": "get-news-sources", "tags": [ "News" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "sources" ], "properties": { "sources": { "type": "array", "items": { "$ref": "#/components/schemas/NewsSourceSummary" } } } }, "example": { "sources": [ { "code": "ABC", "name": "ABC News (Australia) — Business", "kind": "publisher_rss", "licenseClass": "link_only", "displayPolicy": "headline_link", "attribution": "ABC News (Australia)", "homepageUrl": "https://www.abc.net.au/news/business", "count24h": 10 }, { "code": "IRS", "name": "Company investor-relations sites", "kind": "ir_rss", "licenseClass": "issuer_owned", "displayPolicy": "headline_snippet", "attribution": "Source: company investor relations", "homepageUrl": null, "count24h": 2 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/news/top": { "get": { "summary": "Top news", "description": "Most important items in the window, one per storyline (each cluster collapsed to its strongest item), ranked by importance then recency.", "operationId": "get-top-news", "tags": [ "News" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "window", "in": "query", "description": "Lookback window.", "schema": { "type": "string", "enum": [ "6h", "24h", "7d" ], "default": "24h" } }, { "name": "limit", "in": "query", "description": "1–100, default 30.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 30 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/NewsItem" } } } }, "example": { "items": [ { "id": 24577624, "sourceCode": "TDWL", "sourceName": "Saudi Exchange (Tadawul) — issuer announcements", "sourceKind": "exchange", "displayPolicy": "headline_snippet", "attribution": "Source: Saudi Exchange (issuer announcement)", "headline": "First Milling Co. announces hosting an earnings call to discuss the financial results for third quarter and the nine-month period of 2026", "headlineKind": "source", "snippet": "First Milling Co. — Press release · Saudi Exchange.", "url": "https://www.saudiexchange.sa/wps/portal/saudiexchange/newsandreports/issuer-news/issuer-announcements/issuer-announcements-details/?anId=98873&anCat=1&cs=2283&locale=en", "publishedAt": "2026-11-01T09:00:00.000Z", "observedAt": "2026-11-01T12:46:31.068Z", "updatedAt": "2026-11-01T12:46:31.663Z", "importance": 77, "isFlash": true, "tickers": [ "1111", "2283" ], "primaryCik": "XSAU000015", "formType": null, "itemCodes": null, "topics": [ "EARNINGS", "GULF" ], "clusterId": 140325, "language": "en", "publisher": null }, { "id": 24505163, "sourceCode": "TDWL", "sourceName": "Saudi Exchange (Tadawul) — issuer announcements", "sourceKind": "exchange", "displayPolicy": "headline_snippet", "attribution": "Source: Saudi Exchange (issuer announcement)", "headline": "Nayifat Finance Co. announces its Interim Financial results for the Period Ending on 2026-09-30 ( Nine Months )", "headlineKind": "source", "snippet": "Nayifat Finance Co. — Press release, Q3 2026 · Saudi Exchange.", "url": "https://www.saudiexchange.sa/wps/portal/saudiexchange/newsandreports/issuer-news/issuer-announcements/issuer-announcements-details/?anId=98872&anCat=1&cs=4081&locale=en", "publishedAt": "2026-11-01T06:50:46.848Z", "observedAt": "2026-11-01T06:52:33.687Z", "updatedAt": "2026-11-01T06:52:36.462Z", "importance": 77, "isFlash": true, "tickers": [ "1111", "4081" ], "primaryCik": "XSAU000173", "formType": null, "itemCodes": null, "topics": [ "EARNINGS", "GULF" ], "clusterId": 138997, "language": "en", "publisher": null } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/news/stream": { "get": { "summary": "News stream (SSE)", "description": "Server-Sent Events push of the tape with the feed's filters. Emits `event: items` with a NewsFeedResponse body whenever new or rewritten rows appear (polled every 2 s), a `: ping` comment every 15 s, and closes after ~280 s — reconnect with after=. Without `after` the first event is the current page. `limit` caps each event's rows. A bad filter value is a 400 naming it, before the stream opens.", "operationId": "get-news-stream-sse", "tags": [ "News" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "after", "in": "query", "description": "Resume cursor: only items with id greater than this.", "schema": { "type": "integer", "format": "int64" } }, { "name": "changedSince", "in": "query", "description": "ISO 8601; with `after`, also re-send items whose updatedAt is later (headline rewrites, re-tagging). Pass the previous response's serverTime.", "schema": { "type": "string", "format": "date-time" } }, { "name": "tickers", "in": "query", "description": "Comma-separated tickers; items tagged with any of them.", "schema": { "type": "string" } }, { "name": "cik", "in": "query", "description": "Numeric CIK or platform key; items whose primary company or a tagged company entity is this issuer.", "schema": { "type": "string" } }, { "name": "topics", "in": "query", "description": "Comma-separated topic codes (see /news/topics); any of them.", "schema": { "type": "string" } }, { "name": "sources", "in": "query", "description": "Comma-separated source codes (see /news/sources); any of them.", "schema": { "type": "string" } }, { "name": "excludeSources", "in": "query", "description": "Comma-separated source codes to hide (the UI's Markets view hides agency releases, social posts and GDELT links).", "schema": { "type": "string" } }, { "name": "excludeForms", "in": "query", "description": "Comma-separated filing form types to hide (e.g. 4,144,SC 13G); rows without a form are kept.", "schema": { "type": "string" } }, { "name": "flash", "in": "query", "description": "1 to return flash (high-priority) items only; 0 (default) for all.", "schema": { "type": "string", "enum": [ "0", "1", "true", "false" ] } }, { "name": "minImportance", "in": "query", "description": "Minimum importance score 0–100.", "schema": { "type": "integer", "minimum": 0, "maximum": 100 } }, { "name": "q", "in": "query", "description": "Full-text query over headline and snippet (websearch syntax: quoted phrases, OR, -exclusion).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Rows per event, 1–50, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 50 } } ], "responses": { "200": { "description": "OK", "content": { "text/event-stream": { "schema": { "type": "string", "description": "Server-Sent Events: `event: items` frames carrying a NewsFeedResponse JSON body, `: ping` keep-alive comments." } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/news": { "get": { "summary": "Company news", "description": "The company's tape: items whose primary company or a tagged company entity is this issuer or any predecessor in its corporate lineage. Same cursor semantics as /news/feed; `cik` echoes the resolved identifier.", "operationId": "get-company-news", "tags": [ "News" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional) or platform key (e.g. XDFM000002).", "schema": { "type": "string" } }, { "name": "after", "in": "query", "description": "Poll: return items with id greater than this (newest first). Pass the previous response's latestId.", "schema": { "type": "integer", "format": "int64" } }, { "name": "before", "in": "query", "description": "Load older: items published before item on the tape (by publication time, then id). Pass the previous response's nextCursor.", "schema": { "type": "integer", "format": "int64" } }, { "name": "changedSince", "in": "query", "description": "ISO 8601; with `after`, also re-send items whose updatedAt is later (headline rewrites, re-tagging). Pass the previous response's serverTime.", "schema": { "type": "string", "format": "date-time" } }, { "name": "limit", "in": "query", "description": "1–200, default 100.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 100 } }, { "name": "tickers", "in": "query", "description": "Comma-separated tickers; items tagged with any of them.", "schema": { "type": "string" } }, { "name": "topics", "in": "query", "description": "Comma-separated topic codes (see /news/topics); any of them.", "schema": { "type": "string" } }, { "name": "sources", "in": "query", "description": "Comma-separated source codes (see /news/sources); any of them.", "schema": { "type": "string" } }, { "name": "excludeSources", "in": "query", "description": "Comma-separated source codes to hide (the UI's Markets view hides agency releases, social posts and GDELT links).", "schema": { "type": "string" } }, { "name": "excludeForms", "in": "query", "description": "Comma-separated filing form types to hide (e.g. 4,144,SC 13G); rows without a form are kept.", "schema": { "type": "string" } }, { "name": "flash", "in": "query", "description": "1 to return flash (high-priority) items only; 0 (default) for all.", "schema": { "type": "string", "enum": [ "0", "1", "true", "false" ] } }, { "name": "minImportance", "in": "query", "description": "Minimum importance score 0–100.", "schema": { "type": "integer", "minimum": 0, "maximum": 100 } }, { "name": "q", "in": "query", "description": "Full-text query over headline and snippet (websearch syntax: quoted phrases, OR, -exclusion).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/NewsFeedResponse" }, { "type": "object", "required": [ "cik" ], "properties": { "cik": { "type": "string", "description": "Resolved 10-character CIK or platform key." } } } ] }, "example": { "cik": "0001045810", "items": [ { "id": 24499631, "sourceCode": "TDWL", "sourceName": "Saudi Exchange (Tadawul) — issuer announcements", "sourceKind": "exchange", "displayPolicy": "headline_snippet", "attribution": "Source: Saudi Exchange (issuer announcement)", "headline": "Etihad GO Telecom Co. (GO) announces the award of a project to Total Technical Triangle Company - 3T, valued at SAR 185.9 million, for the supply and installation of infrastructure for a data center d…", "headlineKind": "source", "snippet": "Etihad GO Telecom Co. — Disclosure · Saudi Exchange.", "url": "https://www.saudiexchange.sa/wps/portal/saudiexchange/newsandreports/issuer-news/issuer-announcements/issuer-announcements-details/?anId=98866&anCat=1&cs=7040&locale=en", "publishedAt": "2026-11-01T06:30:37.848Z", "observedAt": "2026-11-01T06:32:35.138Z", "updatedAt": "2026-11-01T06:32:35.851Z", "importance": 57, "isFlash": false, "tickers": [ "1111", "7040" ], "primaryCik": "XSAU000229", "formType": null, "itemCodes": null, "topics": [ "GULF", "SEMIS" ], "clusterId": 139035, "language": "en", "publisher": null }, { "id": 24467695, "sourceCode": "BSKY", "sourceName": "Bluesky — official accounts", "sourceKind": "social", "displayPolicy": "headline_snippet", "attribution": "Source: Bluesky", "headline": "@wsj.com: When Irfan Al-Hussaini, a data scientist at Nvidia died in July at age 32, the medical examiner ruled his death a suicide. His family has challenged the ruling and is calling for an investig…", "headlineKind": "source", "snippet": "When Irfan Al-Hussaini, a data scientist at Nvidia died in July at age 32, the medical examiner ruled his death a suicide. His family has challenged the ruling and is calling for an investigation.", "url": "https://bsky.app/profile/wsj.com/post/3mz7wknfakj2j", "publishedAt": "2026-11-01T04:04:45.223Z", "observedAt": "2026-11-01T04:04:45.903Z", "updatedAt": "2026-11-01T04:04:48.739Z", "importance": 47, "isFlash": false, "tickers": [ "NVDA" ], "primaryCik": "0001045810", "formType": null, "itemCodes": null, "topics": [ "LEGAL", "SEMIS" ], "clusterId": 138978, "language": "en", "publisher": null } ], "latestId": 24499631, "nextCursor": 24467695, "serverTime": "2026-11-01T12:50:15.277Z" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries": { "get": { "summary": "List countries", "description": "Countries with macro coverage and their headline figures, one page at a time: { countries, sort, order, total, limit, offset, hasMore, nextOffset, page }. Growth is two figures: `real_gdp_growth` (% year on year of real GDP, null where no real series is held) and `nominal_gdp_growth` (% change in nominal GDP on the same period a year earlier: not real growth); `gdp_growth` is a deprecated copy of `nominal_gdp_growth`. `periods` gives each figure's period. Each row's cube-backed values carry `sources` = { gdp, population, inflation, debt, real_gdp_growth }, each { name, fullName, url, note } — the publisher of the series the value was read from; a value without a recorded source is absent from it. A null figure is not held, never zero.", "operationId": "get-list-countries", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "q", "in": "query", "description": "Words in the name or ISO code.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Region or sub-region, e.g. Asia, Western Asia.", "schema": { "type": "string" } }, { "name": "sort", "in": "query", "description": "Rank by this figure, largest first (`name`: A–Z). Default real_gdp_growth. `gdp_growth` is deprecated: it is nominal_gdp_growth.", "schema": { "type": "string", "enum": [ "real_gdp_growth", "nominal_gdp_growth", "gdp_usd_bn", "population", "inflation", "debt_to_gdp", "name", "gdp_growth" ], "default": "real_gdp_growth" } }, { "name": "order", "in": "query", "description": "Default desc (asc for name), nulls last either way.", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "name": "limit", "in": "query", "description": "Page size, 1–250, default 50 once any filter or paging parameter is given; without any, every country is served. A limit above 250 is a 400.", "schema": { "type": "integer", "minimum": 1, "maximum": 250, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0: the previous page's `nextOffset`.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "alpha_3": { "type": "string" }, "currency_code": { "type": "string" }, "region": { "type": "string" }, "sub_region": { "type": "string" }, "population": { "type": "integer" }, "market_value_usd": { "type": "integer" }, "gdp_usd_bn": { "type": "number" }, "gdp_local_bn": { "type": "number" }, "gdp_local_currency": { "type": "string" }, "gdp_growth": { "type": "number" }, "real_gdp_growth": { "type": "number" }, "real_gdp_growth_basis": { "type": "string" }, "periods": { "type": "object", "properties": { "population": { "type": "string", "format": "date" }, "gdp": { "type": "string", "format": "date" }, "real_gdp_growth": { "type": "string", "format": "date" }, "nominal_gdp_growth": { "type": "string", "format": "date" }, "inflation": { "type": "string", "format": "date" }, "debt_to_gdp": { "type": "null" } } }, "inflation": { "type": "number" }, "debt_to_gdp": { "type": "null" }, "risk_score": { "type": "null" }, "risk_band": { "type": "null" }, "sp_rating": { "type": "null" }, "sources": { "type": "object", "properties": { "gdp": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "url": { "type": "string" }, "note": { "type": "string" } } }, "population": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "url": { "type": "string" }, "note": { "type": "string" } } }, "inflation": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "url": { "type": "string" }, "note": { "type": "string" } } }, "real_gdp_growth": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "url": { "type": "string" }, "note": { "type": "string" } } } } }, "nominal_gdp_growth": { "type": "number" } } } }, "sort": { "type": "string" }, "order": { "type": "string" }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" }, "page": { "type": "object", "properties": { "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "countries": [ { "code": "SA", "name": "Saudi Arabia", "alpha_3": "SAU", "currency_code": "SAR", "region": "Asia", "sub_region": "Western Asia", "population": 36973555, "market_value_usd": 2484030748197, "gdp_usd_bn": 1276.94293333333, "gdp_local_bn": 4775.83, "gdp_local_currency": "SAR", "gdp_growth": 1.8181477975463423, "real_gdp_growth": 4.502466, "real_gdp_growth_basis": "published_yoy", "periods": { "population": "2025-01-01", "gdp": "2025-01-01", "real_gdp_growth": "2025-01-01", "nominal_gdp_growth": "2025-01-01", "inflation": "2025-12-01", "debt_to_gdp": null }, "inflation": 2.0634211701652543, "debt_to_gdp": null, "risk_score": null, "risk_band": null, "sp_rating": null, "sources": { "gdp": { "name": "FRED", "fullName": "FRED · World Bank", "url": "https://fred.stlouisfed.org/series/MKTGDPSAA646NWDB", "note": "Retrieved from FRED (Federal Reserve Bank of St. Louis); original source: World Bank — World Development Indicators" }, "population": { "name": "FRED", "fullName": "FRED · World Bank", "url": "https://fred.stlouisfed.org/series/POPTOTSAA647NWDB", "note": "Retrieved from FRED (Federal Reserve Bank of St. Louis); original source: World Bank — World Development Indicators" }, "inflation": { "name": "GCC-Stat", "fullName": "GCC Statistical Center (GCC-Stat) · Marsa data portal", "url": "https://dp.marsa.gccstat.org/dataexplorer/?ds=DF_ES_CPI", "note": "GCC-Stat consumer prices (monthly, 2018=100) — dataflow DF_ES_CPI" }, "real_gdp_growth": { "name": "World Bank", "fullName": "World Bank · World Development Indicators", "url": "https://data.worldbank.org/indicator/NY.GDP.MKTP.KD.ZG?locations=SA", "note": "WDI indicator NY.GDP.MKTP.KD.ZG" } }, "nominal_gdp_growth": 1.8181477975463423 }, { "code": "BH", "name": "Bahrain", "alpha_3": "BHR", "currency_code": "BHD", "region": "Asia", "sub_region": "Western Asia", "population": 1600366, "market_value_usd": 15852000723, "gdp_usd_bn": 48.9657255319149, "gdp_local_bn": 18.4111128, "gdp_local_currency": "BHD", "gdp_growth": 3.7173598423613217, "real_gdp_growth": 3.481376, "real_gdp_growth_basis": "published_yoy", "periods": { "population": "2025-01-01", "gdp": "2025-01-01", "real_gdp_growth": "2025-01-01", "nominal_gdp_growth": "2025-01-01", "inflation": "2025-12-01", "debt_to_gdp": null }, "inflation": 0.4891410682840931, "debt_to_gdp": null, "risk_score": null, "risk_band": null, "sp_rating": null, "sources": { "gdp": { "name": "FRED", "fullName": "FRED · World Bank", "url": "https://fred.stlouisfed.org/series/MKTGDPBHA646NWDB", "note": "Retrieved from FRED (Federal Reserve Bank of St. Louis); original source: World Bank — World Development Indicators" }, "population": { "name": "FRED", "fullName": "FRED · World Bank", "url": "https://fred.stlouisfed.org/series/POPTOTBHA647NWDB", "note": "Retrieved from FRED (Federal Reserve Bank of St. Louis); original source: World Bank — World Development Indicators" }, "inflation": { "name": "GCC-Stat", "fullName": "GCC Statistical Center (GCC-Stat) · Marsa data portal", "url": "https://dp.marsa.gccstat.org/dataexplorer/?ds=DF_ES_CPI", "note": "GCC-Stat consumer prices (monthly, 2018=100) — dataflow DF_ES_CPI" }, "real_gdp_growth": { "name": "World Bank", "fullName": "World Bank · World Development Indicators", "url": "https://data.worldbank.org/indicator/NY.GDP.MKTP.KD.ZG?locations=BH", "note": "WDI indicator NY.GDP.MKTP.KD.ZG" } }, "nominal_gdp_growth": 3.7173598423613217 } ], "sort": "real_gdp_growth", "order": "desc", "total": 213, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2, "page": { "total": 213, "offset": 0, "limit": 2, "nextOffset": 2 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/gdp-sparklines": { "get": { "summary": "GDP sparklines", "description": "Annual nominal GDP for a set of countries, for mini bar charts: { sparklines: { : { gdp: [number] (billions of US dollars, oldest first), years: [year of each point], growth: [NOMINAL % change on the year before; null when that year is missing], currency } }, unit: \"Billions of US dollars\", growthBasis: \"nominal\", missing: [codes with no annual GDP held] }. Up to six years; forecasts excluded.", "operationId": "get-gdp-sparklines", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "codes", "in": "query", "required": true, "description": "ISO 3166-1 alpha-2 codes, comma-separated, up to 500, e.g. US,GB,JP.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "sparklines": { "type": "object", "properties": { "AE": { "type": "object", "properties": { "gdp": { "type": "array", "items": { "type": "number" } }, "years": { "type": "array", "items": { "type": "integer" } }, "growth": { "type": "array", "items": { "type": "number" } }, "currency": { "type": "string" } } }, "US": { "type": "object", "properties": { "gdp": { "type": "array", "items": { "type": "number" } }, "years": { "type": "array", "items": { "type": "integer" } }, "growth": { "type": "array", "items": { "type": "number" } }, "currency": { "type": "string" } } } } }, "unit": { "type": "string" }, "growthBasis": { "type": "string" }, "missing": { "type": "array", "items": {} } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "sparklines": { "AE": { "gdp": [ 357.162, 422.441 ], "years": [ 2020, 2021 ], "growth": [ -17.69, 18.28 ], "currency": "USD" }, "US": { "gdp": [ 24823.19, 26774.117 ], "years": [ 2021, 2022 ], "growth": [ 12.39, 7.86 ], "currency": "USD" } }, "unit": "Billions of US dollars", "growthBasis": "nominal", "missing": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}": { "get": { "summary": "Country dashboard", "description": "Country macro dashboard. By default (`view=profile`, 5–50 KB) the profile — headline figures with their periods, curves, leaders, facts — with `seriesCount`, `branches` (the country page's tabs and sub-tabs the country fills) and `views` (where the rest is read). `view=full` adds every curated indicator as a card in `macroSeries[]` (900–1,700 cards, about 1–1.8 MB): label, units, `latest` (null when the series holds no print yet), `yoyChange` (year on year: the latest print against the same period a year earlier; a % change for levels and indexes, a change in points for rates and percents — `yoyChangeUnit` says which; null when no print a year back is held), `yearAgo` (that print), `priorChange` (latest minus the print before it, in the series' own unit) and a short sparkline (the newest 12 current-vintage observations). One card per key. The full, uncapped current-vintage history of any series is GET /api/v1/countries/{iso}/series?key=. Each card carries `source` = { name, fullName, url, note } — its publisher and where it was retrieved.", "operationId": "get-country-dashboard", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "`profile` (default): the payload without `macroSeries` (plus `seriesCount`, `branches`: the country page's tabs and sub-tabs, each with the MCP tool and argument that reads it, and `views`). `full`: the whole dashboard with every series card. `catalog`: the series as rows without histories — { series: [{ key, title, unit, category, frequency, latest, latestPeriod, stale, staleAfterDays, source }], total, offset, limit, nextOffset, categories }; `stale` is true when `latestPeriod` is older than the series' cadence allows (more than `staleAfterDays` days after the period's first day), null when the cadence is unknown. `economy`: one Economy sub-tab (`section`) as the page draws it — headline cards, its questions (modules) with their cards, charts and table, then the sub-tab's other series paged by `limit` / `offset` ({ total, limit, offset, hasMore, nextOffset }; `next_offset` is a deprecated copy of nextOffset); each card carries latest, prior and year-ago prints and change_1y; without `section`, the sub-tabs the country fills. `central_bank`: `section` overview | statistics | financials, built from series. `government`: the Government sections and the parts each is made of — per part `path` (the route that reads it) and `query` (its parameters, e.g. section=votes), plus `view` / `args` (the same part as get_government arguments). The profile leaves out the dashboard's always-empty placeholder fields (indices, fx, news, …); `full` keeps them.", "schema": { "type": "string", "enum": [ "profile", "full", "catalog", "economy", "central_bank", "government" ], "default": "profile" } }, { "name": "section", "in": "query", "description": "economy: growth_activity, labour_market, inflation_prices, consumption_households, housing_real_estate, credit_funding, trade_external, fx, energy, tourism_transport, industry_technology, fiscal. central_bank: overview, statistics, financials. catalog: an Economy sub-tab slug, to list the series that pane draws.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "catalog: words that must all appear in the title, key or publisher.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "catalog: one indicator category (output, prices, labor, rates, money, …).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "catalog: rows, 1–500 (default 100). economy / central_bank: other series per page, 0–200 (default 40).", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "catalog, economy, central_bank: rows to skip.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "country": { "type": "object", "properties": { "iso2": { "type": "string" }, "iso3": { "type": "string" }, "name": { "type": "string" }, "officialName": { "type": "string" }, "region": { "type": "string" }, "subregion": { "type": "string" }, "capital": { "type": "string" }, "governmentType": { "type": "string" }, "headOfState": { "type": "string" }, "headOfGovernment": { "type": "string" }, "description": { "type": "string" }, "profileFacts": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } } } }, "headline": { "type": "object", "properties": { "population": { "type": "integer" }, "gdpUsdBn": { "type": "number" }, "gdpGrowth": { "type": "number" }, "inflation": { "type": "number" }, "unemployment": { "type": "number" }, "policyRate": { "type": "number" }, "debtToGdp": { "type": "number" }, "currencyCode": { "type": "string" }, "currentAccountPctGdp": { "type": "null" } } }, "headlinePeriods": { "type": "object", "properties": { "gdpGrowth": { "type": "string", "format": "date" }, "inflation": { "type": "string", "format": "date" }, "population": { "type": "string", "format": "date" }, "gdpUsdBn": { "type": "string", "format": "date" }, "unemployment": { "type": "string", "format": "date" }, "policyRate": { "type": "string", "format": "date" }, "debtToGdp": { "type": "string", "format": "date" } } }, "headlineNotes": { "type": "object", "properties": { "gdpGrowth": { "type": "string" }, "inflation": { "type": "string" } } }, "ratings": { "type": "array", "items": { "type": "object", "properties": { "agency": { "type": "string" }, "rating": { "type": "string" }, "outlook": { "type": "string" }, "lastAction": { "type": "string", "format": "date" } } } }, "yieldCurve": { "type": "array", "items": { "type": "object", "properties": { "tenorMonths": { "type": "integer" }, "tenorLabel": { "type": "string" }, "yield": { "type": "number" } } } }, "yieldCurveYearAgo": { "type": "array", "items": { "type": "object", "properties": { "tenorMonths": { "type": "integer" }, "tenorLabel": { "type": "string" }, "yield": { "type": "number" } } } }, "leaders": { "type": "array", "items": { "type": "object", "properties": { "role": { "type": "string" }, "name": { "type": "string" }, "since": { "type": "string", "format": "date" } } } }, "seriesCount": { "type": "integer" }, "branches": { "type": "object", "properties": { "economy": { "type": "object", "properties": { "tool": { "type": "string" }, "argument": { "type": "string" }, "sections": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "title": { "type": "string" }, "series": { "type": "integer" }, "modules": { "type": "array", "items": { "type": "string" } } } } } } }, "central_bank": { "type": "object", "properties": { "tool": { "type": "string" }, "argument": { "type": "string" }, "name": { "type": "string" }, "sections": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "title": { "type": "string" } } } } } }, "government": { "type": "object", "properties": { "tool": { "type": "string" }, "argument": { "type": "string" }, "sections": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "title": { "type": "string" }, "calls": { "type": "array", "items": { "type": "object", "properties": { "path": { "type": "string" }, "query": { "type": "object", "properties": { "section": { "type": "string" } } }, "view": { "type": "string" } } } } } } }, "detail": { "type": "string" } } }, "military": { "type": "object", "properties": { "tool": { "type": "string" }, "argument": { "type": "string" }, "sections": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "title": { "type": "string" } } } } } }, "foreign_relations": { "type": "object", "properties": { "tool": { "type": "string" }, "argument": { "type": "string" }, "sections": { "type": "array", "items": { "type": "object", "properties": { "section": { "type": "string" }, "title": { "type": "string" } } } } } } } } } }, "views": { "type": "object", "properties": { "catalog": { "type": "string" }, "economy": { "type": "string" }, "central_bank": { "type": "string" }, "series": { "type": "string" }, "full": { "type": "string" } } }, "iso2": { "type": "string" }, "name": { "type": "string" }, "series": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "unit": { "type": "string" }, "category": { "type": "string" }, "frequency": { "type": "string" }, "latest": { "type": "integer" }, "latestPeriod": { "type": "string", "format": "date" }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" } } }, "stale": { "type": "boolean" }, "staleAfterDays": { "type": "integer" } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" }, "categories": { "type": "object", "properties": { "output": { "type": "integer" }, "labor": { "type": "integer" }, "credit": { "type": "integer" }, "money": { "type": "integer" }, "external": { "type": "integer" }, "rates": { "type": "integer" }, "prices": { "type": "integer" }, "energy": { "type": "integer" }, "fiscal": { "type": "integer" }, "commodity": { "type": "integer" }, "population": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "country": { "iso2": "US", "iso3": "USA", "name": "United States", "officialName": "United States of America", "region": "Americas", "subregion": "North America", "capital": "Washington, D.C.", "governmentType": "Federal presidential republic", "headOfState": "Donald J. Trump", "headOfGovernment": "Donald J. Trump", "description": "The United States of America is a federal republic in North America. It is made up of fifty states, a federal district — Washington, D.C., the capital — and inhabited territories in the Caribbean and …", "profileFacts": [ { "label": "Largest city", "value": "New York" }, { "label": "Area", "value": "9.83 million km²" } ], "headline": { "population": 342909000, "gdpUsdBn": 33010.036, "gdpGrowth": 2.065739237553774, "inflation": 3.7172508442689933, "unemployment": 4.2, "policyRate": 3.75, "debtToGdp": 121.18773, "currencyCode": "USD", "currentAccountPctGdp": null }, "headlinePeriods": { "gdpGrowth": "2026-07-01", "inflation": "2026-09-01", "population": "2026-07-01", "gdpUsdBn": "2026-07-01", "unemployment": "2026-09-01", "policyRate": "2026-09-01", "debtToGdp": "2026-04-01" }, "headlineNotes": { "gdpGrowth": "Real GDP growth, % year on year (real GDP against the same period a year earlier)", "inflation": "CPI inflation, % year on year" }, "ratings": [ { "agency": "S&P", "rating": "AA+", "outlook": "Stable", "lastAction": "2011-08-05" }, { "agency": "Moody's", "rating": "Aa1", "outlook": "Stable", "lastAction": "2023-11-10" } ], "yieldCurve": [ { "tenorMonths": 1, "tenorLabel": "1M", "yield": 4.06 }, { "tenorMonths": 3, "tenorLabel": "3M", "yield": 4.18 } ], "yieldCurveYearAgo": [ { "tenorMonths": 1, "tenorLabel": "1M", "yield": 4.06 }, { "tenorMonths": 3, "tenorLabel": "3M", "yield": 3.89 } ], "leaders": [ { "role": "Vice President", "name": "JD Vance", "since": "2025-01-20" }, { "role": "Fed Chair", "name": "Kevin M. Warsh", "since": "2026-05-22" } ], "seriesCount": 955, "branches": { "economy": { "tool": "get_economy", "argument": "section", "sections": [ { "section": "growth_activity", "title": "Growth & Activity", "series": 124, "modules": [ "Output and income", "What is driving GDP" ] }, { "section": "labour_market", "title": "Labour Market", "series": 96, "modules": [ "The jobs report", "Early warning signs" ] } ] }, "central_bank": { "tool": "get_central_bank", "argument": "section", "name": "Federal Reserve", "sections": [ { "section": "overview", "title": "Overview" }, { "section": "fomc", "title": "FOMC" } ] }, "government": { "tool": "get_government", "argument": "section", "sections": [ { "section": "administration", "title": "Administration", "calls": [ { "path": "/api/v1/countries/US/officials", "query": {}, "view": "officials" }, { "path": "/api/v1/countries/US/government/executive", "query": { "section": "presidential" }, "view": "presidential_documents" } ] }, { "section": "congress", "title": "Congress", "calls": [ { "path": "/api/v1/countries/US/government/congress", "query": { "section": "members" }, "view": "members" }, { "path": "/api/v1/countries/US/government/congress", "query": { "section": "committees" }, "view": "committees" } ] } ], "detail": "Each call is get_government(view, args): one part of the sub-tab in full, paged with offset." }, "military": { "tool": "get_military", "argument": "section", "sections": [ { "section": "armed_forces", "title": "Armed Forces" }, { "section": "conflicts", "title": "Conflicts" } ] }, "foreign_relations": { "tool": "get_foreign_relations", "argument": "section", "sections": [ { "section": "partners", "title": "Partners" }, { "section": "organisations", "title": "Organisations" } ] } } }, "views": { "catalog": "/api/v1/countries/US?view=catalog — every series without its history, filtered (q, category, section) and paged", "economy": "/api/v1/countries/US?view=economy — the Economy sub-tabs; with section, one sub-tab's cards", "central_bank": "/api/v1/countries/US?view=central_bank§ion=overview|statistics|financials", "series": "/api/v1/countries/US/series?key=KEY — one series' history", "full": "/api/v1/countries/US?view=full — the whole dashboard with every series card (about 1 MB)" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/regions": { "get": { "summary": "Regional macro series", "description": "Macro series held for each first-level region of the country (the UAE's emirates). By default (`view=index`) each region's code, name, `seriesCount` and newest `latestPeriod`, with `views`. `view=full` serves the series as cards grouped by region (the same card as /countries/{iso}?view=full: latest, yoyChange, yoyChangeUnit, yearAgo, priorChange, a short sparkline and `source` { name, fullName, url, note }; about 400 KB for the UAE), or one region's with `region`. A card's full history is GET /api/v1/countries/{region}/series?key= with the region's ISO 3166-2 code (e.g. AE-DU). An unknown `region` is a 404. `parent` (a first-level region, e.g. DE-BY) reads the second level under it instead (Germany's Kreise, DE-KRS-09162, by Regionalschlüssel; Spain's or Italy's provinces, coded like ISO 3166-2, e.g. ES-SE): the same views, with `region` naming one of its sub-regions and the index carrying `parent`; a first-level region with none (Berlin) lists no regions.", "operationId": "get-regional-macro-series", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "`index` (default): the regions with series counts. `full`: every region's series as cards (`region` narrows to one). `catalog` with `region`: one region's series as rows without histories (same shape as /countries/{iso}?view=catalog).", "schema": { "type": "string", "enum": [ "index", "full", "catalog" ], "default": "index" } }, { "name": "region", "in": "query", "description": "full, catalog (required): the region's ISO 3166-2 code, e.g. AE-DU (with `parent`: a sub-region's code, e.g. DE-KRS-09162 or ES-SE).", "schema": { "type": "string" } }, { "name": "parent", "in": "query", "description": "A first-level region's ISO 3166-2 code (e.g. DE-BY): read the second-level regions under it.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "catalog: words that must all appear.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "catalog: one indicator category.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "catalog: rows, 1–500 (default 100).", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "catalog: rows to skip.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "region": { "type": "string" }, "name": { "type": "string" }, "series": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "unit": { "type": "string" }, "category": { "type": "string" }, "frequency": { "type": "string" }, "latest": { "type": "integer" }, "latestPeriod": { "type": "string", "format": "date" }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" } } }, "stale": { "type": "boolean" }, "staleAfterDays": { "type": "integer" } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" }, "categories": { "type": "object", "properties": { "output": { "type": "integer" }, "transport": { "type": "integer" }, "money": { "type": "integer" }, "housing": { "type": "integer" }, "prices": { "type": "integer" }, "energy": { "type": "integer" }, "population": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "region": "AE-DU", "name": "Dubai", "series": [ { "key": "AIR_CARGO_DISCHARGED_DWC", "title": "Air cargo discharged — Al Maktoum International (DWC) only", "unit": "Metric Tons", "category": "output", "frequency": "Monthly", "latest": 47128, "latestPeriod": "2026-08-01", "source": { "name": "Dubai Statistics", "fullName": "Dubai Data and Statistics Establishment · Data Dubai" }, "stale": false, "staleAfterDays": 125 }, { "key": "AIR_CARGO_DISCHARGED_DXB", "title": "Air cargo discharged — Dubai International (DXB) only", "unit": "Metric Tons", "category": "output", "frequency": "Monthly", "latest": 83686, "latestPeriod": "2026-08-01", "source": { "name": "Dubai Statistics", "fullName": "Dubai Data and Statistics Establishment · Data Dubai" }, "stale": false, "staleAfterDays": 125 } ], "total": 325, "offset": 0, "limit": 2, "nextOffset": 2, "categories": { "output": 110, "transport": 58, "money": 41, "housing": 64, "prices": 21, "energy": 25, "population": 6 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/series": { "get": { "summary": "Macro series", "description": "History of one macro series (the current vintage: the latest published value for each period), uncapped unless `from` / `to` / `limit` bound it; the header names its title, `units` (as its values are scaled) and seasonal adjustment. Use this for any series the country dashboard shows as a card. Every value carries its provenance: `source` = { name (short publisher name), fullName, url (where it was retrieved), note (how it reached the platform) }, null when not recorded. A key the country or region does not hold is a 404 (`not_found`).", "operationId": "get-macro-series", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 country code (US), ISO 3166-2 first-level region code (AE-DU) or second-level region code (DE-KRS-09162, ES-SE).", "schema": { "type": "string" } }, { "name": "key", "in": "query", "required": true, "description": "Series key, A-Z0-9_ (e.g. UNEMPLOYMENT_RATE). Keys come from GET /api/v1/countries/{iso}?view=catalog (or /regions?view=catalog®ion= for a region, with &parent= for a second-level one).", "schema": { "type": "string", "pattern": "^[A-Z0-9_]{1,64}$" } }, { "name": "from", "in": "query", "description": "First period, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Last period, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Latest N observations inside [from, to], 1–100000; `window` then reports total, returned and `olderTo` (the `to` that reads the points before).", "schema": { "type": "integer", "minimum": 1, "maximum": 100000 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "history": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "value": { "type": "number" } } } }, "frequency": { "type": "string" }, "description": { "type": "string" }, "sourceName": { "type": "string" }, "sourceLink": { "type": "string" }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "url": { "type": "string" }, "note": { "type": "string" } } }, "title": { "type": "string" }, "units": { "type": "string" }, "seasonalAdjustment": { "type": "string" }, "window": { "type": "object", "properties": { "from": { "type": "null" }, "to": { "type": "null" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "returned": { "type": "integer" }, "olderTo": { "type": "string", "format": "date" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "history": [ { "period": "2026-08-01", "value": 4.1 }, { "period": "2026-09-01", "value": 4.2 } ], "frequency": "Monthly", "description": "The unemployment rate represents the number of unemployed as a percentage of the labor force. Labor force data are restricted to people 16 years of age and older, who currently reside in 1 of the 50 s…", "sourceName": "U.S. Bureau of Labor Statistics", "sourceLink": "https://www.bls.gov/", "source": { "name": "FRED", "fullName": "FRED · U.S. Bureau of Labor Statistics", "url": "https://fred.stlouisfed.org/series/UNRATE", "note": "Retrieved from FRED (Federal Reserve Bank of St. Louis); original source: U.S. Bureau of Labor Statistics — Employment Situation" }, "title": "Unemployment Rate", "units": "Percent", "seasonalAdjustment": "Seasonally Adjusted", "window": { "from": null, "to": null, "limit": 2, "total": 944, "returned": 2, "olderTo": "2026-07-01" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/macro/series/{seriesId}": { "get": { "summary": "Macro series by id", "description": "One macro series by its numeric id: its current-vintage history (all of it unless from / to / limit bound it), title, units, frequency, description, last period and `source` ({ name, fullName, url, note }). Use it for series an indicator key cannot address, such as a government entity's own series (`series[]` on GET /countries/{iso}/government/entities/{code}).", "operationId": "get-macro-series-by-id", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "seriesId", "in": "path", "required": true, "description": "macro_series id (digits).", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "First period, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "to", "in": "query", "description": "Last period, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Latest N observations inside [from, to]. 1–100000.", "schema": { "type": "integer", "minimum": 1, "maximum": 100000 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "seriesId": { "type": "integer" }, "title": { "type": "string" }, "units": { "type": "string" }, "lastPeriod": { "type": "string", "format": "date" }, "history": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "value": { "type": "integer" } } } }, "frequency": { "type": "string" }, "description": { "type": "string" }, "sourceName": { "type": "string" }, "sourceLink": { "type": "string" }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" }, "url": { "type": "string" }, "note": { "type": "string" } } }, "window": { "type": "object", "properties": { "from": { "type": "null" }, "to": { "type": "null" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "returned": { "type": "integer" }, "olderTo": { "type": "string", "format": "date" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "seriesId": 21869, "title": "Dubai marine transport passengers, all stations (abra, ferry, water bus, water taxi; monthly)", "units": "Passengers", "lastPeriod": "2026-07-01", "history": [ { "period": "2026-06-01", "value": 848229 }, { "period": "2026-07-01", "value": 894751 } ], "frequency": "Monthly", "description": "Roads and Transport Authority open data on data.dubai (dataset 466217, marine transport passengers by station, monthly). A month printed in several loads counts once when the loads repeat one figure a…", "sourceName": "Roads and Transport Authority (RTA), Dubai", "sourceLink": "https://www.rta.ae", "source": { "name": "RTA", "fullName": "Roads and Transport Authority, Dubai · Data Dubai", "url": "https://data.dubai/en/l/466217", "note": "Dubai marine transport passengers and fleet (RTA open data, monthly)" }, "window": { "from": null, "to": null, "limit": 2, "total": 46, "returned": 2, "olderTo": "2026-05-01" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/executive-orders": { "get": { "summary": "Executive orders", "description": "Every executive order in the online Federal Register (1994 onward), grouped by the administration that signed it; searchable and paged, newest number first: { administrations, total, offset, limit, hasMore, nextOffset, orders, coverage: { held, firstNumber, lastNumber, missing (gaps between firstNumber and lastNumber only), newestDate, complete, note }, load }. `coverage.complete` is true only when the held range has no gaps AND the Federal Register lane is fresh (`load.stale` false): a stale lane may be missing orders signed after `newestDate`. An unknown `era` is a 400 naming the country's eras.", "operationId": "get-executive-orders", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "era", "in": "query", "description": "Administration era code, e.g. US_ADMIN_TRUMP_47 (`administrations[].eraCode`).", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Title/abstract contains, or an EO number.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "limit", "in": "query", "description": "1–200, default 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 25 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "available": { "type": "boolean" }, "load": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } }, "administrations": { "type": "array", "items": { "type": "object", "properties": { "eraCode": { "type": "string" }, "label": { "type": "string" }, "shortLabel": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" }, "count": { "type": "integer" }, "firstNumber": { "type": [ "integer", "null" ] }, "lastNumber": { "type": [ "integer", "null" ] } } } }, "eraCode": { "type": "null" }, "query": { "type": "null" }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "orders": { "type": "array", "items": { "type": "object", "properties": { "documentNumber": { "type": "string" }, "docType": { "type": "string" }, "presidentialDocType": { "type": "string" }, "executiveOrderNumber": { "type": "integer" }, "title": { "type": "string" }, "abstract": { "type": "null" }, "publicationDate": { "type": "string", "format": "date" }, "signingDate": { "type": "string", "format": "date" }, "effectiveOn": { "type": "null" }, "commentsCloseOn": { "type": "null" }, "citation": { "type": "string" }, "isSignificant": { "type": "null" }, "president": { "type": "string" }, "agencies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } }, "docketIds": { "type": "array", "items": {} }, "topics": { "type": "array", "items": {} }, "htmlUrl": { "type": "string" }, "pdfUrl": { "type": "string" } } } }, "coverage": { "type": "object", "properties": { "held": { "type": "integer" }, "firstNumber": { "type": [ "integer", "null" ] }, "lastNumber": { "type": [ "integer", "null" ] }, "missing": { "type": "integer" }, "newestDate": { "type": [ "string", "null" ], "format": "date" }, "complete": { "type": "boolean" }, "note": { "type": [ "string", "null" ] } } }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": [ "integer", "null" ] } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "available": true, "load": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T05:09:16.480Z", "stale": true, "staleLanes": [ "federal_register/executive_orders" ], "failedLanes": [], "runs": [ { "sourceCode": "federal_register", "lane": "executive_orders", "mode": "backfill", "status": "succeeded", "rowsWritten": 7, "finishedAt": "2026-09-19T05:09:16.480Z" } ] }, "administrations": [ { "eraCode": "US_ADMIN_TRUMP_47", "label": "Trump administration", "shortLabel": "Trump 47", "from": "2025-01-20", "to": null, "isCurrent": true, "count": 281, "firstNumber": 14147, "lastNumber": 14427 }, { "eraCode": "US_ADMIN_BUSH_41", "label": "Bush administration (41st)", "shortLabel": "Bush 41", "from": "1989-01-20", "to": "1993-01-20", "isCurrent": false, "count": 0, "firstNumber": null, "lastNumber": null } ], "eraCode": null, "query": null, "total": 1538, "offset": 0, "limit": 2, "orders": [ { "documentNumber": "2026-18739", "docType": "Presidential Document", "presidentialDocType": "executive_order", "executiveOrderNumber": 14427, "title": "Adjusting Certain Delegations Under the Defense Production Act", "abstract": null, "publicationDate": "2026-09-11", "signingDate": "2026-09-08", "effectiveOn": null, "commentsCloseOn": null, "citation": "91 FR 58007", "isSignificant": null, "president": "Donald Trump", "agencies": [ { "id": 538, "name": "Executive Office of the President", "slug": "executive-office-of-the-president" } ], "docketIds": [], "topics": [], "htmlUrl": "https://www.federalregister.gov/documents/2026/09/11/2026-18739/adjusting-certain-delegations-under-the-defense-production-act", "pdfUrl": "https://www.govinfo.gov/content/pkg/FR-2026-09-11/pdf/2026-18739.pdf" }, { "documentNumber": "2026-18738", "docType": "Presidential Document", "presidentialDocType": "executive_order", "executiveOrderNumber": 14426, "title": "Accelerating Access to Veterans' Benefits and Employment Opportunities", "abstract": null, "publicationDate": "2026-09-11", "signingDate": "2026-09-08", "effectiveOn": null, "commentsCloseOn": null, "citation": "91 FR 58003", "isSignificant": null, "president": "Donald Trump", "agencies": [ { "id": 538, "name": "Executive Office of the President", "slug": "executive-office-of-the-president" } ], "docketIds": [], "topics": [], "htmlUrl": "https://www.federalregister.gov/documents/2026/09/11/2026-18738/accelerating-access-to-veterans-benefits-and-employment-opportunities", "pdfUrl": "https://www.govinfo.gov/content/pkg/FR-2026-09-11/pdf/2026-18738.pdf" } ], "coverage": { "held": 1538, "firstNumber": 12890, "lastNumber": 14427, "missing": 0, "newestDate": "2026-09-08", "complete": false, "note": "No gaps between 12890 and 14427. The Federal Register lane last loaded on 2026-09-19, so orders signed after 2026-09-08 may be missing." }, "hasMore": true, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/executive-orders/monthly": { "get": { "summary": "Executive order monthly counts", "description": "Monthly counts of executive orders, other Federal Register presidential documents, and GovInfo compilation packages.", "operationId": "get-executive-order-monthly-counts", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "available": { "type": "boolean" }, "load": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } }, "loads": { "type": "object", "properties": { "executiveOrders": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } }, "otherPresidential": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } }, "compilation": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } } } }, "executiveOrders": { "type": "object", "properties": { "months": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "count": { "type": "integer" } } } }, "total": { "type": "integer" } } }, "otherPresidential": { "type": "object", "properties": { "months": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "count": { "type": "integer" } } } }, "total": { "type": "integer" } } }, "compilation": { "type": "object", "properties": { "months": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "count": { "type": "integer" } } } }, "total": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "available": true, "load": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T05:09:16.480Z", "stale": true, "staleLanes": [ "federal_register/executive_orders", "federal_register/fr_documents" ], "failedLanes": [], "runs": [ { "sourceCode": "federal_register", "lane": "executive_orders", "mode": "backfill", "status": "succeeded", "rowsWritten": 7, "finishedAt": "2026-09-19T05:09:16.480Z" }, { "sourceCode": "federal_register", "lane": "fr_documents", "mode": "backfill", "status": "succeeded", "rowsWritten": 525, "finishedAt": "2026-09-19T03:14:07.944Z" } ] }, "loads": { "executiveOrders": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T05:09:16.480Z", "stale": true, "staleLanes": [ "federal_register/executive_orders" ], "failedLanes": [], "runs": [ { "sourceCode": "federal_register", "lane": "executive_orders", "mode": "backfill", "status": "succeeded", "rowsWritten": 7, "finishedAt": "2026-09-19T05:09:16.480Z" } ] }, "otherPresidential": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T03:14:07.944Z", "stale": true, "staleLanes": [ "federal_register/fr_documents" ], "failedLanes": [], "runs": [ { "sourceCode": "federal_register", "lane": "fr_documents", "mode": "backfill", "status": "succeeded", "rowsWritten": 525, "finishedAt": "2026-09-19T03:14:07.944Z" } ] }, "compilation": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T03:14:54.511Z", "stale": true, "staleLanes": [ "govinfo/govinfo_packages" ], "failedLanes": [], "runs": [ { "sourceCode": "govinfo", "lane": "govinfo_packages", "mode": "backfill", "status": "succeeded", "rowsWritten": 0, "finishedAt": "2026-09-19T03:14:54.511Z" } ] } }, "executiveOrders": { "months": [ { "period": "1993-12-01", "count": 1 }, { "period": "1994-01-01", "count": 5 } ], "total": 1538 }, "otherPresidential": { "months": [ { "period": "1993-12-01", "count": 1 }, { "period": "1994-01-01", "count": 14 } ], "total": 7003 }, "compilation": { "months": [ { "period": "1993-01-01", "count": 3 }, { "period": "1993-02-01", "count": 4 } ], "total": 18469 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/bills/monthly": { "get": { "summary": "Legislation monthly counts", "description": "Monthly counts of measures first reaching each legislative stage: introduced, passed one chamber, cleared Congress, became law, vetoed.", "operationId": "get-legislation-monthly-counts", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "congress", "in": "query", "description": "Congress number (1–200), or all. Default: the newest held.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "available": { "type": "boolean" }, "load": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } }, "congress": { "type": [ "integer", "null" ] }, "congresses": { "type": "array", "items": { "type": "integer" } }, "stages": { "type": "object", "properties": { "introduced": { "type": "object", "properties": { "months": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "count": { "type": "integer" } } } }, "total": { "type": "integer" } } }, "passed_one": { "type": "object", "properties": { "months": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "count": { "type": "integer" } } } }, "total": { "type": "integer" } } }, "cleared": { "type": "object", "properties": { "months": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "count": { "type": "integer" } } } }, "total": { "type": "integer" } } }, "law": { "type": "object", "properties": { "months": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "count": { "type": "integer" } } } }, "total": { "type": "integer" } } }, "vetoed": { "type": "object", "properties": { "months": { "type": "array", "items": { "type": "object", "properties": { "period": { "type": "string", "format": "date" }, "count": { "type": "integer" } } } }, "total": { "type": "integer" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "available": true, "load": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T01:51:46.741Z", "stale": true, "staleLanes": [ "govinfo/bills" ], "failedLanes": [], "runs": [ { "sourceCode": "govinfo", "lane": "bills", "mode": "backfill", "status": "succeeded", "rowsWritten": 2803741, "finishedAt": "2026-09-19T01:51:46.741Z" } ] }, "congress": 119, "congresses": [ 119, 118 ], "stages": { "introduced": { "months": [ { "period": "2025-01-01", "count": 1422 }, { "period": "2025-02-01", "count": 1517 } ], "total": 18956 }, "passed_one": { "months": [ { "period": "2025-01-01", "count": 75 }, { "period": "2025-02-01", "count": 61 } ], "total": 1576 }, "cleared": { "months": [ { "period": "2025-01-01", "count": 4 }, { "period": "2025-02-01", "count": 2 } ], "total": 152 }, "law": { "months": [ { "period": "2025-01-01", "count": 1 }, { "period": "2025-03-01", "count": 3 } ], "total": 112 }, "vetoed": { "months": [ { "period": "2025-12-01", "count": 2 } ], "total": 2 } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/entities": { "get": { "summary": "Government entities", "description": "Government entity registry (non-US countries, e.g. AE): the federal → emirate → entity tree with each entity's head and its counts of listed-company links and publications, plus per-region and overall counts. available=false while the registry holds nothing for the country. Each entity carries `logo` = { url, kind, width, height, sourcePage, sourceUrl, license } when its emblem is held. Paged in registry order: the first 50 entities by default, with `page` = { total, offset, limit, nextOffset }; `full=true` serves every entity (about 250 KB for AE). A level, kind or region the registry does not hold is a 400 naming the ones it does.", "operationId": "get-government-entities", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "level", "in": "query", "description": "Entity level, e.g. federal, emirate, free_zone, local.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "ISO 3166-2 region, e.g. AE-DU.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Entity kind, e.g. authority, ministry, regulator.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Words that must all appear in the entity's text fields (name, code, kind, level, head, …).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size, 1–200, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "full", "in": "query", "description": "true = the whole registry, unpaged. Does not combine with filters or paging.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "available": { "type": "boolean" }, "entities": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "parentCode": { "type": [ "string", "null" ] }, "level": { "type": "string" }, "admin1": { "type": [ "string", "null" ] }, "kind": { "type": "string" }, "name": { "type": "string" }, "nameAr": { "type": [ "string", "null" ] }, "shortName": { "type": "string" }, "website": { "type": "string" }, "logo": { "type": "object", "properties": { "url": { "type": "string" }, "kind": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "sourcePage": { "type": "string" }, "sourceUrl": { "type": "string" }, "license": { "type": "string" }, "onDark": { "type": "boolean" } } }, "sortOrder": { "type": "integer" }, "head": { "type": "null" }, "companyCount": { "type": "integer" }, "publicationCount": { "type": "integer" } } } }, "regions": { "type": "array", "items": { "type": "object", "properties": { "admin1": { "type": "string" }, "name": { "type": "string" }, "entityCount": { "type": "integer" }, "governmentCode": { "type": "string" } } } }, "counts": { "type": "object", "properties": { "entities": { "type": "integer" }, "companyLinks": { "type": "integer" }, "publications": { "type": "integer" }, "machineReadable": { "type": "integer" }, "ingested": { "type": "integer" }, "legislatureSeats": { "type": "integer" } } }, "page": { "type": "object", "properties": { "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "AE", "available": true, "entities": [ { "code": "AE", "parentCode": null, "level": "federal", "admin1": null, "kind": "government", "name": "Government of the United Arab Emirates", "nameAr": "حكومة دولة الإمارات العربية المتحدة", "shortName": "UAE Government", "website": "https://u.ae", "logo": { "url": "/api/v1/countries/AE/government/entities/AE/logo", "kind": "svg", "width": 396, "height": 512, "sourcePage": "https://commons.wikimedia.org/wiki/File:Emblem_of_the_United_Arab_Emirates.svg", "sourceUrl": "https://commons.wikimedia.org/wiki/Special:FilePath/Emblem_of_the_United_Arab_Emirates.svg", "license": "Government of the United Arab Emirates — Public domain via Wikimedia Commons (https://commons.wikimedia.org/wiki/File:Emblem_of_the_United_Arab_Emirates.svg)", "onDark": true }, "sortOrder": 0, "head": null, "companyCount": 0, "publicationCount": 0 }, { "code": "AE.AZ.ALC", "parentCode": "AE.AZ.DCT", "level": "emirate", "admin1": "AE-AZ", "kind": "other", "name": "Abu Dhabi Arabic Language Centre", "nameAr": null, "shortName": "ALC", "website": "https://alc.ae", "logo": { "url": "/api/v1/countries/AE/government/entities/AE.AZ.ALC/logo", "kind": "png", "width": 512, "height": 240, "sourcePage": "https://alc.ae/", "sourceUrl": "https://alc.ae/media/htonj1al/alc-logo-header.png", "license": "© the entity — all rights reserved (no copyright line printed on the page) — official logo as published on https://alc.ae (terms: https://alc.ae/terms-conditions/)", "onDark": false }, "sortOrder": 10, "head": null, "companyCount": 0, "publicationCount": 0 } ], "regions": [ { "admin1": "AE-AZ", "name": "Abu Dhabi", "entityCount": 74, "governmentCode": "AE.AZ.GOV" }, { "admin1": "AE-DU", "name": "Dubai", "entityCount": 94, "governmentCode": "AE.DU.GOV" } ], "counts": { "entities": 313, "companyLinks": 516, "publications": 232, "machineReadable": 115, "ingested": 112, "legislatureSeats": 1 }, "page": { "total": 313, "offset": 0, "limit": 2, "nextOffset": 2 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/entities/{code}": { "get": { "summary": "Government entity", "description": "One government entity: description, website, head, lineage and children; the listed companies it owns, regulates or grants a concession to (stake, evidence URL); and `notIngested[]`: the datasets it publishes that the platform does not hold yet (gov_entity_publication_coverage, not_ingested; datasets only, never press releases or landing pages) — { publicationId, kind, kindLabel, title, url, format, frequency, datasetRef, status, lastChecked, seriesCount, reason }; empty when every dataset is held. Each entity carries `logo` = { url, kind, width, height, sourcePage, sourceUrl, license } when its emblem is held. `legalDocuments[]`: the laws, decrees and regulations tied to the entity — { docId, role (issuer | establishes | administers | regulates | amends_mandate | mentions), docType, docTypeLabel, number, year, titleEn, titleAr, titleEnDisplay (official English title, else a machine translation), titleEnIsMachine, titleEnMachine, issueDate, effectiveDate, status, issuerEntityCode, issuerName, sourcePageUrl, pdfUrlEn, pdfUrlAr, summaryEn, companies: [{ cik, name, ticker, routeKey }] — the published companies the instrument affects (GET /companies/{id}/laws) }, establishing instruments first, then newest; empty when none are on record. `series[]`: the series the entity publishes as the macro cube holds them — { seriesId, indicatorCode, title, frequency, geoCode, units, publicationId, publicationTitle, groupLabel, sortOrder, lastPeriod, lastValue, snapshot }; each one's history is GET /api/v1/macro/series/{seriesId}, and a whole group's latest values, y/y and sparklines in one batch at GET …/entities/{code}/series?group=.", "operationId": "get-government-entity", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "description": "gov_entity code, e.g. AE.DU.RTA.", "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "`compact` (default): legal documents paged under `legalDocumentsPage` ({ total, offset, limit, nextOffset }), series replaced by `seriesCount`. `full`: every legal document and series (the RTA's is about 1.1 MB).", "schema": { "type": "string", "enum": [ "compact", "full" ], "default": "compact" } }, { "name": "limit", "in": "query", "description": "compact: legal documents per page, 1–200, default 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 25 } }, { "name": "offset", "in": "query", "description": "compact: legal documents to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "q", "in": "query", "description": "compact: words that must all appear in a legal document's text fields (title, number, issuer, type, summary, …). limit, offset or q with view=full is a 400.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "parentCode": { "type": "string" }, "level": { "type": "string" }, "admin1": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "nameAr": { "type": "string" }, "shortName": { "type": "string" }, "website": { "type": "string" }, "logo": { "type": "object", "properties": { "url": { "type": "string" }, "kind": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "sourcePage": { "type": "string" }, "sourceUrl": { "type": "string" }, "license": { "type": "string" }, "onDark": { "type": "boolean" } } }, "sortOrder": { "type": "integer" }, "head": { "type": "object", "properties": { "name": { "type": "string" }, "title": { "type": "string" }, "since": { "type": "string", "format": "date" }, "personKey": { "type": "string" }, "photoUrl": { "type": "string" } } }, "companyCount": { "type": "integer" }, "publicationCount": { "type": "integer" }, "description": { "type": "string" }, "established": { "type": "string", "format": "date" }, "wikidataQid": { "type": "null" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "title": { "type": "string" }, "accessed": { "type": "string", "format": "date" } } } }, "ancestors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" } } } }, "children": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "parentCode": { "type": "string" }, "level": { "type": "string" }, "admin1": { "type": "string" }, "kind": { "type": "string" }, "name": { "type": "string" }, "nameAr": { "type": "null" }, "shortName": { "type": "string" }, "website": { "type": "null" }, "logo": { "type": "object", "properties": { "url": { "type": "string" }, "kind": { "type": "string" }, "width": { "type": "integer" }, "height": { "type": "integer" }, "sourcePage": { "type": "string" }, "sourceUrl": { "type": "string" }, "license": { "type": "string" }, "onDark": { "type": "boolean" } } }, "sortOrder": { "type": "integer" }, "head": { "type": "null" }, "companyCount": { "type": "integer" }, "publicationCount": { "type": "integer" } } } }, "companies": { "type": "array", "items": { "type": "object", "properties": { "relation": { "type": "string" }, "relationLabel": { "type": "string" }, "stakePct": { "type": "null" }, "asOf": { "type": "string", "format": "date" }, "validFrom": { "type": [ "string", "null" ], "format": "date" }, "validTo": { "type": "null" }, "description": { "type": "string" }, "evidenceUrl": { "type": "string" }, "evidenceQuote": { "type": "string" }, "source": { "type": "string" }, "company": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" }, "exchange": { "type": "string" }, "routeKey": { "type": "string" } } } } } }, "notIngested": { "type": "array", "items": { "type": "object", "properties": { "publicationId": { "type": "string" }, "kind": { "type": "string" }, "kindLabel": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "format": { "type": "string" }, "frequency": { "type": "string" }, "datasetRef": { "type": "string" }, "status": { "type": "string" }, "lastChecked": { "type": "string", "format": "date" }, "seriesCount": { "type": "integer" }, "reason": { "type": "string" } } } }, "commercialRelationships": { "type": "array", "items": {} }, "legalDocuments": { "type": "array", "items": { "type": "object", "properties": { "docId": { "type": "string" }, "role": { "type": "string" }, "docType": { "type": "string" }, "docTypeLabel": { "type": "string" }, "number": { "type": "string" }, "year": { "type": "integer" }, "titleEn": { "type": [ "string", "null" ] }, "titleAr": { "type": "string" }, "titleEnDisplay": { "type": "string" }, "titleEnIsMachine": { "type": "boolean" }, "titleEnMachine": { "type": [ "string", "null" ] }, "issueDate": { "type": "string", "format": "date" }, "effectiveDate": { "type": [ "string", "null" ], "format": "date" }, "status": { "type": "string" }, "issuerEntityCode": { "type": "string" }, "issuerName": { "type": "string" }, "sourcePageUrl": { "type": "string" }, "pdfUrlEn": { "type": [ "string", "null" ] }, "pdfUrlAr": { "type": "string" }, "summaryEn": { "type": "null" }, "companies": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "name": { "type": "string" }, "ticker": { "type": "string" }, "routeKey": { "type": "string" } } } } } } }, "legalDocumentsPage": { "type": "object", "properties": { "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } } }, "seriesCount": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "code": "AE.DU.RTA", "parentCode": "AE.DU.GOV", "level": "emirate", "admin1": "AE-DU", "kind": "authority", "name": "Roads and Transport Authority", "nameAr": "هيئة الطرق والمواصلات", "shortName": "RTA", "website": "https://www.rta.ae", "logo": { "url": "/api/v1/countries/AE/government/entities/AE.DU.RTA/logo", "kind": "png", "width": 481, "height": 105, "sourcePage": "https://tec.gov.ae/en/web/tec/dubai-government-entities", "sourceUrl": "https://tec.gov.ae/documents/1561773/1587832/RTA_Logo.png/aac4b56d-dd0f-51c0-feaa-b411b6f1472c", "license": "Copyright © 2026 The Executive Council of Dubai - All rights reserved — official logo as published on https://tec.gov.ae/en/web/tec/dubai-government-entities (terms: https://legal.dubai.gov.ae/en/Page…", "onDark": false }, "sortOrder": 200, "head": { "name": "Mattar Mohammed Al Tayer", "title": "Director General and Chairman of the Board of Executive Directors of RTA, since its establishment in 2005", "since": "2005-01-01", "personKey": "AEGVP00044", "photoUrl": "/api/v1/people/AEGVP00044/photo" }, "companyCount": 8, "publicationCount": 36, "description": "Established by Law No. (17) of 2005 to plan and run Dubai's roads and transport (metro, tram, bus, marine transport, taxis, licensing, parking, tolls); agencies under it are the Public Transport, Rail…", "established": "2005-01-01", "wikidataQid": null, "sources": [ { "url": "https://www.rta.ae/wps/portal/rta/ae/home/about-rta", "title": "About RTA", "accessed": "2026-10-09" }, { "url": "https://www.rta.ae/wps/portal/rta/ae/home/open-data/agencies-legislation", "title": "RTA Agencies Legislation (Law No. 17 of 2005; EC Resolutions 8/2006, 8/2008)", "accessed": "2026-10-09" } ], "ancestors": [ { "code": "AE", "name": "Government of the United Arab Emirates" }, { "code": "AE.DU.GOV", "name": "Government of Dubai" } ], "children": [ { "code": "AE.DU.RTA_PTA", "parentCode": "AE.DU.RTA", "level": "emirate", "admin1": "AE-DU", "kind": "authority", "name": "Public Transport Agency (RTA)", "nameAr": null, "shortName": "RTA Public Transport Agency", "website": null, "logo": { "url": "/api/v1/countries/AE/government/entities/AE.DU.RTA_PTA/logo", "kind": "png", "width": 481, "height": 105, "sourcePage": "https://tec.gov.ae/en/web/tec/dubai-government-entities", "sourceUrl": "https://tec.gov.ae/documents/1561773/1587832/RTA_Logo.png/aac4b56d-dd0f-51c0-feaa-b411b6f1472c", "license": "Emblem of Roads and Transport Authority (RTA agency; uses the RTA logo, no own mark) — Copyright © 2026 The Executive Council of Dubai - All rights reserved — official logo as published on https://tec…", "onDark": false }, "sortOrder": 10, "head": null, "companyCount": 0, "publicationCount": 0 }, { "code": "AE.DU.RTA_RAIL", "parentCode": "AE.DU.RTA", "level": "emirate", "admin1": "AE-DU", "kind": "authority", "name": "Rail Agency (RTA)", "nameAr": null, "shortName": "RTA Rail Agency", "website": null, "logo": { "url": "/api/v1/countries/AE/government/entities/AE.DU.RTA_RAIL/logo", "kind": "png", "width": 481, "height": 105, "sourcePage": "https://tec.gov.ae/en/web/tec/dubai-government-entities", "sourceUrl": "https://tec.gov.ae/documents/1561773/1587832/RTA_Logo.png/aac4b56d-dd0f-51c0-feaa-b411b6f1472c", "license": "Emblem of Roads and Transport Authority (RTA agency; uses the RTA logo, no own mark) — Copyright © 2026 The Executive Council of Dubai - All rights reserved — official logo as published on https://tec…", "onDark": false }, "sortOrder": 20, "head": null, "companyCount": 0, "publicationCount": 0 } ], "companies": [ { "relation": "concession_grantor", "relationLabel": "Concession grantor", "stakePct": null, "asOf": "2025-12-31", "validFrom": null, "validTo": null, "description": "Dubai Taxi runs street-hail and e-hail taxis under a franchise model with RTA, paying taxi-plate, franchise and royalty fees (AED 486m in FY2025)", "evidenceUrl": "https://cdn.prod.website-files.com/656e39bd8b07a811ace24224/69ccd2da8d9a597d0fb2053a_DTC_Integrated_Report%20_E_2025.pdf#page=11", "evidenceQuote": "Street hailing and e-hailing taxi service operating through a franchise-based model with RTA", "source": "annual_report", "company": { "cik": "XDFM000008", "name": "Dubai Taxi Company PJSC", "ticker": "DTC", "exchange": "DFM", "routeKey": "XDFM000008" } }, { "relation": "concession_grantor", "relationLabel": "Concession grantor", "stakePct": null, "asOf": "2025-12-31", "validFrom": "2022-07-01", "validTo": null, "description": "RTA granted Salik a 49-year concession for Dubai tolling operations effective 1 July 2022 (AED 4bn upfront fee; 22.5% variable concession fee since April 2024)", "evidenceUrl": "https://feeds.dfm.ae/documents/2026/Mar/4/e8d9bb68-e21c-453c-b6c6-4b2da4f34412/EN%20Salik%20FS%20Dec%2025%20S.pdf#page=32", "evidenceQuote": "Salik Company P.J.S.C. entered into a concession agreement with RTA effective 1 July 2022 to undertake the Dubai tolling operations", "source": "annual_report", "company": { "cik": "XDFM000029", "name": "Salik Company PJSC", "ticker": "SALIK", "exchange": "DFM", "routeKey": "XDFM000029" } } ], "notIngested": [ { "publicationId": "259", "kind": "open_data", "kindLabel": "Open data", "title": "Bus Ridership Transactions", "url": "https://data.dubai/en/l/459803", "format": "csv/json", "frequency": "daily", "datasetRef": "data.dubai 459803", "status": "live", "lastChecked": "2026-10-10", "seriesCount": 0, "reason": "Tap-level card transactions (~44 GB); daily series are built but the download runs on the server, not yet run." }, { "publicationId": "258", "kind": "open_data", "kindLabel": "Open data", "title": "Dubai Metro Ridership", "url": "https://data.dubai/en/l/466403", "format": "csv/json", "frequency": "daily", "datasetRef": "data.dubai 466403", "status": "live", "lastChecked": "2026-10-10", "seriesCount": 0, "reason": "Tap-level card transactions (~25 GB); daily series are built but the download runs on the server, not yet run." } ], "commercialRelationships": [], "legalDocuments": [ { "docId": "1051", "role": "establishes", "docType": "law", "docTypeLabel": "Law", "number": "17", "year": 2005, "titleEn": "Law No. (17) of 2005 Establishing the Roads and Transport Authority", "titleAr": "قانون رقم (17) لسنة 2005 بإنشاء هيئة الطرق والمواصلات", "titleEnDisplay": "Law No. (17) of 2005 Establishing the Roads and Transport Authority", "titleEnIsMachine": false, "titleEnMachine": null, "issueDate": "2005-11-01", "effectiveDate": null, "status": "amended", "issuerEntityCode": "AE.DU.GOV", "issuerName": "Government of Dubai", "sourcePageUrl": "https://dlp.dubai.gov.ae/en/Pages/HTMLViewer.aspx?file=TGF3IDE3IG9mIDIwMDU=&year=2005", "pdfUrlEn": "https://dlp.dubai.gov.ae/Legislation%20Reference/2005/Law%2017%20of%202005.pdf", "pdfUrlAr": "https://dlp.dubai.gov.ae/Legislation%20Ar%20Reference/2005/%D9%82%D8%A7%D9%86%D9%88%D9%86%20%D8%B1%D9%82%D9%85%20(17)%20%D9%84%D8%B3%D9%86%D8%A9%202005.pdf", "summaryEn": null, "companies": [ { "cik": "XDFM000008", "name": "Dubai Taxi Company PJSC", "ticker": "DTC", "routeKey": "XDFM000008" }, { "cik": "XDFM000028", "name": "Parkin Company PJSC", "ticker": "PARKIN", "routeKey": "XDFM000028" } ] }, { "docId": "543", "role": "issuer", "docType": "administrative_resolution", "docTypeLabel": "Administrative Resolution", "number": "721", "year": 2026, "titleEn": null, "titleAr": "قرار إداري رقم (721) لسنة 2026 بإلغاء صفة الضبطية القضائية عن بعض موظفي مؤسسة المرور والطرق في هيئة الطرق والمواصلات", "titleEnDisplay": "Administrative Resolution No. (721) of 2026 Revoking the Capacity of Law Enforcement Officers from Certain Employees of the Traffic and Roads Agency at the Roads and Transport Authority", "titleEnIsMachine": true, "titleEnMachine": "Administrative Resolution No. (721) of 2026 Revoking the Capacity of Law Enforcement Officers from Certain Employees of the Traffic and Roads Agency at the Roads and Transport Authority", "issueDate": "2026-09-15", "effectiveDate": "2026-09-15", "status": "in_force", "issuerEntityCode": "AE.DU.RTA", "issuerName": "Roads and Transport Authority", "sourcePageUrl": "https://dlp.dubai.gov.ae/ar/Pages/HTMLViewer.aspx?file=2YLYsdin2LEg2KXYr9in2LHZiiDYsdmC2YUgKDcyMSkg2YTYs9mG2KkgMjAyNiDYqNil2YTYutin2KEg2KfZhNi22KjYt9mK2Kkg2KfZhNmC2LbYp9im2YrYqSDYudmGINmF2YjYuNmB2Yog2…", "pdfUrlEn": null, "pdfUrlAr": "https://dlp.dubai.gov.ae/Legislation%20Ar%20Reference/2026/%D9%82%D8%B1%D8%A7%D8%B1%20%D8%A5%D8%AF%D8%A7%D8%B1%D9%8A%20%D8%B1%D9%82%D9%85%20(721)%20%D9%84%D8%B3%D9%86%D8%A9%202026%20%D8%A8%D8%A5%D9%84…", "summaryEn": null, "companies": [] } ], "legalDocumentsPage": { "total": 546, "offset": 0, "limit": 2, "nextOffset": 2 }, "seriesCount": 739 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/entities/{code}/series": { "get": { "summary": "Government entity series", "description": "The series a government entity publishes, one row each in a single batch: { entityCode, group, series: [{ seriesId, latest, latestPeriod, yearAgo, yearAgoPeriod, spark: [number] (the last values, up to 36, oldest first), source: { name, fullName, url, note } }] }, in the entity's own order. `group` narrows to one group — the series' groupLabel, else its publicationTitle, as on the entity's `series[]` (where each also carries lastValue and `snapshot` = true for a one-observation series). Current vintage, tombstones excluded. Full histories: GET /api/v1/macro/series/{seriesId}.", "operationId": "get-government-entity-series", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "description": "gov_entity code, e.g. AE.DU.RTA.", "schema": { "type": "string" } }, { "name": "group", "in": "query", "required": false, "description": "Group label, e.g. Bus.", "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "`catalog`: rows without sparklines, with title, unit and frequency — { series: [{ seriesId, title, unit, frequency, latest, latestPeriod, source }], total, offset, limit, nextOffset }.", "schema": { "type": "string", "enum": [ "full", "catalog" ], "default": "full" } }, { "name": "q", "in": "query", "description": "Words that must all appear (catalog; and full when paged).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "catalog: rows, 1–500 (default 100). full: rows, 1–200; default 50 without `group`, the whole group with it. A paged reply adds total, offset, limit, hasMore and nextOffset.", "schema": { "type": "integer", "minimum": 1, "maximum": 500 } }, { "name": "offset", "in": "query", "description": "Rows to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "category", "in": "query", "description": "With view=catalog: only series in this category.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "entityCode": { "type": "string" }, "group": { "type": "null" }, "series": { "type": "array", "items": { "type": "object", "properties": { "seriesId": { "type": "integer" }, "title": { "type": "string" }, "unit": { "type": "string" }, "frequency": { "type": "string" }, "latest": { "type": "integer" }, "latestPeriod": { "type": "string", "format": "date" }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "fullName": { "type": "string" } } } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" }, "categories": { "type": "object", "properties": { "other": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "entityCode": "AE.DU.RTA", "group": null, "series": [ { "seriesId": 21869, "title": "Dubai marine transport passengers, all stations (abra, ferry, water bus, water taxi; monthly)", "unit": "Passengers", "frequency": "Monthly", "latest": 894751, "latestPeriod": "2026-07-01", "source": { "name": "RTA", "fullName": "Roads and Transport Authority, Dubai · Data Dubai" } }, { "seriesId": 20340, "title": "Dubai Metro ridership, all stations (monthly)", "unit": "Passengers", "frequency": "Monthly", "latest": 20965355, "latestPeriod": "2026-08-01", "source": { "name": "Dubai Statistics", "fullName": "Dubai Data and Statistics Establishment · Data Dubai" } } ], "total": 739, "offset": 0, "limit": 2, "nextOffset": 2, "categories": { "other": 739 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/entities/{code}/logo": { "get": { "summary": "Government entity logo", "description": "A government entity's emblem (SVG or PNG), as published by the entity — each entity's `logo` on the registry carries its source page and licence. 404 when none is held.", "operationId": "get-government-entity-logo", "tags": [ "Macro" ], "x-tier": "public", "security": [], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "code", "in": "path", "required": true, "description": "Entity code (e.g. AE.DU.RTA).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/government/{view}": { "get": { "summary": "Government data", "description": "US government data from the platform's gov_* lanes: congress (members, committee rosters, meetings with witnesses, hearings, House roll-call votes), legislation (bills with sponsors, cosponsors, actions, subjects), executive (presidential documents, GovInfo packages), regulation (Federal Register rules and Regulations.gov dockets), spending (USAspending awards, recipients, agency totals) or feed (the newest 40 dated events; events are dated no later than today except scheduled committee meetings, up to 120 days ahead, which carry `scheduled: true`). Without `section` the reply is bounded: every section's first 20 rows, a `pages` block per section ({ total, offset, limit, nextOffset }) and a `note`; `full=true` serves every row (congress is about 1.3 MB). Paged rows are compact: a committee carries `seatCount` and its subcommittees' codes and names, a roll-call vote no member positions (GET …/government/votes/{congress}/{chamber}/{session}/{roll} has them), a recipient group `recipientEntities` (a count). `load` says how complete and how fresh the rows are: `isSample` (a pilot load), `inProgress`, `lastLoadedAt`, `stale` (some lane has not loaded within its publisher's cadence, 3 days for daily publishers), `staleLanes` and `failedLanes` (as source/lane). Non-US countries return available=false.", "operationId": "get-government-data", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "view", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "congress", "legislation", "executive", "regulation", "spending", "feed" ] } }, { "name": "chamber", "in": "query", "description": "congress only: house, senate, joint or all (default all). Passing it with any other view is a 400.", "schema": { "type": "string", "enum": [ "house", "senate", "joint", "all" ], "default": "all" } }, { "name": "section", "in": "query", "description": "Row arrays of the view to page, comma-separated (congress: members, committees, meetings, hearings, votes; legislation: bills; executive: presidential, packages; regulation: rules, dockets; spending: awards, recipients, byAgency; feed: events); the others are left out. Paging without section is a 400.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Rows per section, 1–200, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip per section.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "q", "in": "query", "description": "Words that filter each section's rows.", "schema": { "type": "string" } }, { "name": "full", "in": "query", "description": "true = every row of every section, uncompacted (the terminal's panels). Does not combine with section, limit, offset or q.", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "available": { "type": "boolean" }, "load": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } }, "loads": { "type": "object", "properties": { "presidential": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } }, "packages": { "type": "object", "properties": { "isSample": { "type": "boolean" }, "inProgress": { "type": "boolean" }, "unrecorded": { "type": "boolean" }, "lastLoadedAt": { "type": "string", "format": "date-time" }, "stale": { "type": "boolean" }, "staleLanes": { "type": "array", "items": { "type": "string" } }, "failedLanes": { "type": "array", "items": {} }, "runs": { "type": "array", "items": { "type": "object", "properties": { "sourceCode": { "type": "string" }, "lane": { "type": "string" }, "mode": { "type": "string" }, "status": { "type": "string" }, "rowsWritten": { "type": "integer" }, "finishedAt": { "type": "string", "format": "date-time" } } } } } } } }, "presidential": { "type": "array", "items": { "type": "object", "properties": { "documentNumber": { "type": "string" }, "docType": { "type": "string" }, "presidentialDocType": { "type": "string" }, "executiveOrderNumber": { "type": "null" }, "title": { "type": "string" }, "abstract": { "type": "null" }, "publicationDate": { "type": "string", "format": "date" }, "signingDate": { "type": "string", "format": "date" }, "effectiveOn": { "type": "null" }, "commentsCloseOn": { "type": "null" }, "citation": { "type": "string" }, "isSignificant": { "type": "null" }, "president": { "type": "string" }, "agencies": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "slug": { "type": "string" } } } }, "docketIds": { "type": "array", "items": {} }, "topics": { "type": "array", "items": {} }, "htmlUrl": { "type": "string" }, "pdfUrl": { "type": "string" } } } }, "pages": { "type": "object", "properties": { "presidential": { "type": "object", "properties": { "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "available": true, "load": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T03:14:54.511Z", "stale": true, "staleLanes": [ "federal_register/fr_documents", "govinfo/govinfo_packages" ], "failedLanes": [], "runs": [ { "sourceCode": "federal_register", "lane": "fr_documents", "mode": "backfill", "status": "succeeded", "rowsWritten": 525, "finishedAt": "2026-09-19T03:14:07.944Z" }, { "sourceCode": "govinfo", "lane": "govinfo_packages", "mode": "backfill", "status": "succeeded", "rowsWritten": 0, "finishedAt": "2026-09-19T03:14:54.511Z" } ] }, "loads": { "presidential": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T03:14:07.944Z", "stale": true, "staleLanes": [ "federal_register/fr_documents" ], "failedLanes": [], "runs": [ { "sourceCode": "federal_register", "lane": "fr_documents", "mode": "backfill", "status": "succeeded", "rowsWritten": 525, "finishedAt": "2026-09-19T03:14:07.944Z" } ] }, "packages": { "isSample": false, "inProgress": false, "unrecorded": false, "lastLoadedAt": "2026-09-19T03:14:54.511Z", "stale": true, "staleLanes": [ "govinfo/govinfo_packages" ], "failedLanes": [], "runs": [ { "sourceCode": "govinfo", "lane": "govinfo_packages", "mode": "backfill", "status": "succeeded", "rowsWritten": 0, "finishedAt": "2026-09-19T03:14:54.511Z" } ] } }, "presidential": [ { "documentNumber": "2026-19251", "docType": "Presidential Document", "presidentialDocType": "determination", "executiveOrderNumber": null, "title": "Presidential Determination on Major Drug Transit or Major Illicit Drug Producing Countries for Fiscal Year 2027", "abstract": null, "publicationDate": "2026-09-18", "signingDate": "2026-09-11", "effectiveOn": null, "commentsCloseOn": null, "citation": "91 FR 59687", "isSignificant": null, "president": "Donald Trump", "agencies": [ { "id": 538, "name": "Executive Office of the President", "slug": "executive-office-of-the-president" } ], "docketIds": [], "topics": [], "htmlUrl": "https://www.federalregister.gov/documents/2026/09/18/2026-19251/presidential-determination-on-major-drug-transit-or-major-illicit-drug-producing-countries-for", "pdfUrl": "https://www.govinfo.gov/content/pkg/FR-2026-09-18/pdf/2026-19251.pdf" }, { "documentNumber": "2026-19053", "docType": "Presidential Document", "presidentialDocType": "notice", "executiveOrderNumber": null, "title": "Continuation of the National Emergency With Respect to Persons Who Commit, Threaten To Commit, or Support Terrorism", "abstract": null, "publicationDate": "2026-09-16", "signingDate": "2026-09-11", "effectiveOn": null, "commentsCloseOn": null, "citation": "91 FR 58805", "isSignificant": null, "president": "Donald Trump", "agencies": [ { "id": 538, "name": "Executive Office of the President", "slug": "executive-office-of-the-president" } ], "docketIds": [], "topics": [], "htmlUrl": "https://www.federalregister.gov/documents/2026/09/16/2026-19053/continuation-of-the-national-emergency-with-respect-to-persons-who-commit-threaten-to-commit-or", "pdfUrl": "https://www.govinfo.gov/content/pkg/FR-2026-09-16/pdf/2026-19053.pdf" } ], "pages": { "presidential": { "total": 50, "offset": 0, "limit": 2, "nextOffset": 2 } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/judiciary/{view}": { "get": { "summary": "Judiciary data", "description": "US judiciary: the Supreme Court's docket, opinions and orders (scotus), the courts below it (courts), judges, opinions and advocates. Non-US countries return available=false.", "operationId": "get-judiciary-data", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "view", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "scotus", "courts", "judges", "opinions", "advocates" ] } }, { "name": "section", "in": "query", "description": "Row arrays of the view to page, comma-separated; the others are left out. scotus: inProgress, decided, precedent, recentOrders, terms. courts: tiers, byState, federalAppellate, federalDistricts, stateSupreme, prosecutors. judges: tiers, byPresident, recent, supremeCourt. opinions: byCourt, byNatureSuit, recent. advocates: topByCases, topFirms. limit, offset or q without section is a 400.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Rows per section, 1–200, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip per section.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "q", "in": "query", "description": "Words that filter each section's rows.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "available": { "type": "boolean" }, "iso2": { "type": "string" }, "currentTerm": { "type": "integer" }, "counts": { "type": "object", "properties": { "cases": { "type": "integer" }, "decided": { "type": "integer" }, "inProgress": { "type": "integer" }, "opinions": { "type": "integer" }, "orders": { "type": "integer" }, "codedDecisions": { "type": "integer" }, "justiceVotes": { "type": "integer" }, "earliestTerm": { "type": "integer" } } }, "decided": { "type": "array", "items": { "type": "object", "properties": { "docketNumber": { "type": "string" }, "term": { "type": "integer" }, "caseClass": { "type": "string" }, "caseName": { "type": "string" }, "petitionerTitle": { "type": "string" }, "respondentTitle": { "type": "string" }, "stage": { "type": "string" }, "stageLabel": { "type": "string" }, "docketedDate": { "type": "string", "format": "date" }, "certGrantedDate": { "type": "null" }, "arguedDate": { "type": "null" }, "decidedDate": { "type": "string", "format": "date" }, "lowerCourt": { "type": "string" }, "questionPresentedUrl": { "type": "null" }, "amicusCount": { "type": "integer" }, "eventCount": { "type": "integer" }, "isCapitalCase": { "type": "boolean" }, "opinionPdfUrl": { "type": "string" }, "usReportsCite": { "type": "null" }, "authorCode": { "type": "string" }, "syllabus": { "type": [ "string", "null" ] }, "transcriptUrl": { "type": "null" }, "audioUrl": { "type": "null" }, "scdb": { "type": "null" } } } }, "pages": { "type": "object", "properties": { "decided": { "type": "object", "properties": { "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "available": true, "iso2": "US", "currentTerm": 2026, "counts": { "cases": 8827, "decided": 246, "inProgress": 849, "opinions": 1179, "orders": 2577, "codedDecisions": 29270, "justiceVotes": 256444, "earliestTerm": 1791 }, "decided": [ { "docketNumber": "26A305", "term": 2026, "caseClass": "application", "caseName": "United States Postal Service, et al. v. California, et al.", "petitionerTitle": "United States Postal Service, et al., Applicants", "respondentTitle": "California, et al.", "stage": "application_resolved", "stageLabel": "Application resolved", "docketedDate": "2026-09-06", "certGrantedDate": null, "arguedDate": null, "decidedDate": "2026-09-14", "lowerCourt": "United States Court of Appeals for the First Circuit", "questionPresentedUrl": null, "amicusCount": 20, "eventCount": 30, "isCapitalCase": false, "opinionPdfUrl": "https://www.supremecourt.gov/opinions/25pdf/26a305_4g15.pdf", "usReportsCite": null, "authorCode": "BK", "syllabus": null, "transcriptUrl": null, "audioUrl": null, "scdb": null }, { "docketNumber": "26A274", "term": 2026, "caseClass": "application", "caseName": "National Republican Congressional Committee, et al. v. Sherrod Brown, et al.", "petitionerTitle": "National Republican Congressional Committee, et al. Applicants", "respondentTitle": "Sherrod Brown, et al.", "stage": "application_resolved", "stageLabel": "Application resolved", "docketedDate": "2026-08-31", "certGrantedDate": null, "arguedDate": null, "decidedDate": "2026-09-04", "lowerCourt": "United States Court of Appeals for the Fourth Circuit", "questionPresentedUrl": null, "amicusCount": 2, "eventCount": 9, "isCapitalCase": false, "opinionPdfUrl": "https://www.supremecourt.gov/opinions/25pdf/26a274_l537.pdf", "usReportsCite": null, "authorCode": "PC", "syllabus": "Because the Fourth Circuit likely lacked jurisdiction to review the Federal Communications Commission’s lowest-unit-charge requirements while the candidates’ application for review remained pending be…", "transcriptUrl": null, "audioUrl": null, "scdb": null } ], "pages": { "decided": { "total": 60, "offset": 0, "limit": 2, "nextOffset": 2 } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/officials/changes": { "get": { "summary": "Office changes", "description": "Arrivals and departures in public office, by era (administration, or central-bank chair), with the seats awaiting confirmation.", "operationId": "get-office-changes", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "scope", "in": "query", "description": "Which bodies. Default government.", "schema": { "type": "string", "enum": [ "government", "central_bank" ] } }, { "name": "since", "in": "query", "description": "Changes effective on or after, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "until", "in": "query", "description": "Changes effective on or before, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "era", "in": "query", "description": "One era code.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Arrivals or departures.", "schema": { "type": "string", "enum": [ "arrival", "departure" ] } }, { "name": "q", "in": "query", "description": "Words in the name, title or office.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size, 1–200, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "bodyCodes": { "type": "array", "items": { "type": "string" } }, "eras": { "type": "array", "items": { "type": "object", "properties": { "eraCode": { "type": "string" }, "kind": { "type": "string" }, "label": { "type": "string" }, "shortLabel": { "type": "string" }, "leaderName": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" }, "arrivals": { "type": "integer" }, "departures": { "type": "integer" }, "sourceUrl": { "type": "string" } } } }, "changes": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "basis": { "type": "string" }, "at": { "type": "string", "format": "date" }, "atPrecision": { "type": "string" }, "officeCode": { "type": "string" }, "title": { "type": "string" }, "orgName": { "type": "string" }, "personName": { "type": "string" }, "personKey": { "type": "string" }, "photoUrl": { "type": "string" }, "acting": { "type": "boolean" }, "nominatedOn": { "type": [ "string", "null" ], "format": "date" }, "confirmedOn": { "type": [ "string", "null" ], "format": "date" }, "citation": { "type": [ "string", "null" ] }, "predecessorName": { "type": [ "string", "null" ] }, "predecessorReason": { "type": "null" }, "successorName": { "type": [ "string", "null" ] }, "departureReason": { "type": "null" }, "sourceUrl": { "type": "string" }, "eraCode": { "type": "string" } } } }, "pending": { "type": "array", "items": {} }, "page": { "type": "object", "properties": { "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "bodyCodes": [ "US_EXECUTIVE" ], "eras": [ { "eraCode": "US_ADMIN_TRUMP_47", "kind": "administration", "label": "Trump administration", "shortLabel": "Trump 47", "leaderName": "Donald J. Trump", "from": "2025-01-20", "to": null, "isCurrent": true, "arrivals": 29, "departures": 25, "sourceUrl": "https://www.whitehouse.gov/administration/" }, { "eraCode": "US_ADMIN_BIDEN_46", "kind": "administration", "label": "Biden administration", "shortLabel": "Biden", "leaderName": "Joseph R. Biden Jr.", "from": "2021-01-20", "to": "2025-01-20", "isCurrent": false, "arrivals": 22, "departures": 22, "sourceUrl": "https://bidenwhitehouse.archives.gov/administration/" } ], "changes": [ { "kind": "arrival", "basis": "roster", "at": "2026-08-10", "atPrecision": "day", "officeCode": "US_ATTORNEY_GENERAL", "title": "Attorney General", "orgName": "Department of Justice", "personName": "Todd Blanche", "personKey": "USGVP00004", "photoUrl": "/api/v1/people/USGVP00004/photo", "acting": false, "nominatedOn": "2026-06-08", "confirmedOn": "2026-08-08", "citation": "PN1078", "predecessorName": "Pamela Bondi", "predecessorReason": null, "successorName": null, "departureReason": null, "sourceUrl": "https://www.whitehouse.gov/administration/cabinet/", "eraCode": "US_ADMIN_TRUMP_47" }, { "kind": "departure", "basis": "roster", "at": "2026-08-08", "atPrecision": "day", "officeCode": "US_ATTORNEY_GENERAL", "title": "Attorney General", "orgName": "Department of Justice", "personName": "Pamela Bondi", "personKey": "USGVP02787", "photoUrl": "/api/v1/people/USGVP02787/photo", "acting": false, "nominatedOn": null, "confirmedOn": null, "citation": null, "predecessorName": null, "predecessorReason": null, "successorName": "Todd Blanche", "departureReason": null, "sourceUrl": "https://www.congress.gov/nomination/119th-congress/11/2", "eraCode": "US_ADMIN_TRUMP_47" } ], "pending": [], "page": { "total": 567, "offset": 0, "limit": 2, "nextOffset": 2 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/officials/schedule": { "get": { "summary": "Presidential schedule", "description": "The sitting US president's week (Sunday–Saturday, America/New_York), from BNO News' compilation of the White House press-pool schedule: a third-party source, not an official White House release. Other countries return available=false.", "operationId": "get-presidential-schedule", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "from", "in": "query", "description": "Any day in the week, YYYY-MM-DD; defaults to today in America/New_York.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "available": { "type": "boolean" }, "ok": { "type": "boolean" }, "weekStart": { "type": "string", "format": "date" }, "weekEnd": { "type": "string", "format": "date" }, "timezone": { "type": "string" }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" } } }, "events": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "date": { "type": "string", "format": "date" }, "time": { "type": [ "string", "null" ] }, "timezone": { "type": "string" }, "title": { "type": "string" }, "rawTitle": { "type": "string" }, "location": { "type": "string" }, "press": { "type": "string" }, "kind": { "type": "string" }, "sourceUrl": { "type": "string" } } } }, "fetchedAt": { "type": [ "string", "null" ], "format": "date-time" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "available": true, "ok": true, "weekStart": "2026-11-01", "weekEnd": "2026-11-07", "timezone": "America/New_York", "source": { "name": "BNO News — White House pool schedule", "url": "https://bnonews.com/whpool/schedule" }, "events": [ { "id": "2026-11-01-08:00-executive-time-0", "date": "2026-11-01", "time": "08:00", "timezone": "ET", "title": "Executive Time", "rawTitle": "THE PRESIDENT participates in Executive Time", "location": "Palm Beach, Florida", "press": "closed", "kind": "executive_time", "sourceUrl": "https://bnonews.com/whpool/9WDDgFz8" }, { "id": "2026-11-01-tba-departs-palm-beach-florida-en-route-dubu-1", "date": "2026-11-01", "time": null, "timezone": "ET", "title": "Departs Palm Beach, Florida en route Dubuque, Iowa", "rawTitle": "THE PRESIDENT departs Palm Beach, Florida en route Dubuque, Iowa", "location": "Palm Beach, Florida", "press": "travel_pool", "kind": "travel", "sourceUrl": "https://bnonews.com/whpool/9WDDgFz8" } ], "fetchedAt": "2026-11-01T12:50:48.401Z" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/officials": { "get": { "summary": "Country officials", "description": "Public officeholders from the people registry: executive cabinet, central-bank board, regional bank presidents. Defaults to the sitting era. An unknown `body` or `era` is a 400 naming the country's. With `limit` / `offset` the holders are paged in roster order: { eraCode, bodies (every body with its holder count), rosters (this page's holders), eras, total, offset, limit, hasMore, nextOffset }.", "operationId": "get-country-officials", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "era", "in": "query", "description": "Step to a past administration or chair era; the roster is read at that era's last day.", "schema": { "type": "string" } }, { "name": "body", "in": "query", "description": "Office body codes, comma-separated, up to 20 (e.g. AE_CBUAE_BOARD): only those rosters and eras.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Holders per page, 1–200, default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "description": "Holders to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "eraCode": { "type": "null" }, "bodies": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string" }, "asOf": { "type": [ "string", "null" ], "format": "date" }, "holders": { "type": "integer" } } } }, "rosters": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string" }, "asOf": { "type": [ "string", "null" ], "format": "date" }, "holders": { "type": "array", "items": { "type": "object", "properties": { "officeCode": { "type": "string" }, "title": { "type": "string" }, "shortLabel": { "type": "string" }, "department": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "since": { "type": "string", "format": "date" }, "sincePrecision": { "type": "string" }, "acting": { "type": "boolean" }, "personKey": { "type": "string" }, "photoUrl": { "type": "string" }, "basis": { "type": "string" }, "until": { "type": "null" }, "appointedBy": { "type": "null" } } } } } } }, "eras": { "type": "object", "properties": { "US_EXECUTIVE": { "type": "array", "items": { "type": "object", "properties": { "eraCode": { "type": "string" }, "label": { "type": "string" }, "leaderName": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" } } } }, "US_FED_BANKS": { "type": "array", "items": { "type": "object", "properties": { "eraCode": { "type": "string" }, "label": { "type": "string" }, "leaderName": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" } } } }, "US_FED_BOARD": { "type": "array", "items": { "type": "object", "properties": { "eraCode": { "type": "string" }, "label": { "type": "string" }, "leaderName": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" } } } }, "US_SCOTUS": { "type": "array", "items": { "type": "object", "properties": { "eraCode": { "type": "string" }, "label": { "type": "string" }, "leaderName": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" } } } }, "AE_CBUAE_BOARD": { "type": "array", "items": { "type": "object", "properties": { "eraCode": { "type": "string" }, "label": { "type": "string" }, "leaderName": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" } } } }, "AE_FEDERAL_EXECUTIVE": { "type": "array", "items": { "type": "object", "properties": { "eraCode": { "type": "string" }, "label": { "type": "string" }, "leaderName": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" } } } }, "AE_FEDERAL_SUPREME_COUNCIL": { "type": "array", "items": { "type": "object", "properties": { "eraCode": { "type": "string" }, "label": { "type": "string" }, "leaderName": { "type": "string" }, "from": { "type": "string", "format": "date" }, "to": { "type": [ "string", "null" ], "format": "date" }, "isCurrent": { "type": "boolean" } } } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "eraCode": null, "bodies": [ { "body": "US_EXECUTIVE", "asOf": "2026-11-01", "holders": 25 }, { "body": "US_MILITARY", "asOf": null, "holders": 26 } ], "rosters": [ { "body": "US_EXECUTIVE", "asOf": "2026-11-01", "holders": [ { "officeCode": "US_PRESIDENT", "title": "President", "shortLabel": "President", "department": "White House", "name": "Donald J. Trump", "since": "2025-01-20", "sincePrecision": "day", "acting": false, "personKey": "USGVP00001", "photoUrl": "/api/v1/people/USGVP00001/photo", "basis": "roster", "until": null, "appointedBy": null }, { "officeCode": "US_VICE_PRESIDENT", "title": "Vice President", "shortLabel": "Vice President", "department": "White House", "name": "JD Vance", "since": "2025-01-20", "sincePrecision": "day", "acting": false, "personKey": "USGVP00002", "photoUrl": "/api/v1/people/USGVP00002/photo", "basis": "roster", "until": null, "appointedBy": null } ] } ], "eras": { "US_EXECUTIVE": [ { "eraCode": "US_ADMIN_TRUMP_47", "label": "Trump administration", "leaderName": "Donald J. Trump", "from": "2025-01-20", "to": null, "isCurrent": true }, { "eraCode": "US_ADMIN_BIDEN_46", "label": "Biden administration", "leaderName": "Joseph R. Biden Jr.", "from": "2021-01-20", "to": "2025-01-20", "isCurrent": false } ], "US_FED_BANKS": [ { "eraCode": "US_FED_CHAIR_WARSH", "label": "Warsh Fed", "leaderName": "Kevin M. Warsh", "from": "2026-05-22", "to": null, "isCurrent": true }, { "eraCode": "US_FED_CHAIR_POWELL", "label": "Powell Fed", "leaderName": "Jerome H. Powell", "from": "2018-02-05", "to": "2026-05-22", "isCurrent": false } ], "US_FED_BOARD": [ { "eraCode": "US_FED_CHAIR_WARSH", "label": "Warsh Fed", "leaderName": "Kevin M. Warsh", "from": "2026-05-22", "to": null, "isCurrent": true }, { "eraCode": "US_FED_CHAIR_POWELL", "label": "Powell Fed", "leaderName": "Jerome H. Powell", "from": "2018-02-05", "to": "2026-05-22", "isCurrent": false } ], "US_SCOTUS": [ { "eraCode": "US_SCOTUS_COURT_ROBERTS", "label": "Roberts Court", "leaderName": "John G. Roberts, Jr.", "from": "2005-09-29", "to": null, "isCurrent": true }, { "eraCode": "US_SCOTUS_COURT_REHNQUIST", "label": "Rehnquist Court", "leaderName": "William H. Rehnquist", "from": "1986-09-26", "to": "2005-09-03", "isCurrent": false } ] }, "total": 79, "offset": 0, "limit": 2, "hasMore": true, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/fed-financials": { "get": { "summary": "Federal Reserve financials", "description": "The Federal Reserve Banks' balance sheet and income statement (United States only).", "operationId": "get-federal-reserve-financials", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "entity", "in": "query", "description": "`combined` (default) or one Reserve Bank.", "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Column cadence.", "schema": { "type": "string", "enum": [ "annual", "quarterly" ], "default": "annual" } }, { "name": "statement", "in": "query", "description": "One statement.", "schema": { "type": "string", "enum": [ "balance_sheet", "income_statement", "income_summary" ] } }, { "name": "from", "in": "query", "description": "First period end, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last period end, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "last", "in": "query", "description": "Newest N columns in the window, 1–200.", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "entity": { "type": "string" }, "entityLabel": { "type": "string" }, "entities": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "firstPeriod": { "type": "string", "format": "date" }, "lastPeriod": { "type": "string", "format": "date" }, "hasQuarterly": { "type": "boolean" } } } }, "periodType": { "type": "string" }, "unit": { "type": "string" }, "statements": { "type": "object", "properties": { "income_statement": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "endDate": { "type": "string", "format": "date" }, "durationMonths": { "type": "integer" }, "derived": { "type": "boolean" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "kind": { "type": "string" } } } } } } }, "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "fullLabel": { "type": "string" }, "depth": { "type": "integer" }, "header": { "type": "boolean" }, "total": { "type": "boolean" }, "values": { "type": "object", "properties": { "FY2024": { "type": "integer" }, "FY2025": { "type": "integer" } } } } } } } }, "balance_sheet": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "endDate": { "type": "string", "format": "date" }, "durationMonths": { "type": "integer" }, "derived": { "type": "boolean" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "kind": { "type": "string" } } } } } } }, "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "fullLabel": { "type": "string" }, "depth": { "type": "integer" }, "header": { "type": "boolean" }, "total": { "type": "boolean" }, "values": { "type": "object", "properties": { "FY2024": { "type": "integer" }, "FY2025": { "type": "integer" } } } } } } } }, "income_summary": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "endDate": { "type": "string", "format": "date" }, "durationMonths": { "type": "integer" }, "derived": { "type": "boolean" }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "kind": { "type": "string" } } } } } } }, "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "fullLabel": { "type": "string" }, "depth": { "type": "integer" }, "header": { "type": "boolean" }, "total": { "type": "boolean" }, "values": { "type": "object", "properties": { "FY2023": { "type": "number" }, "FY2024": { "type": "number" } } } } } } } } } }, "noteRefs": { "type": "object", "properties": { "balance_sheet": { "type": "object", "properties": { "accrued_benefit_costs": { "type": "string" }, "bank_premises_and_equipment_net": { "type": "string" }, "capital_paid_in": { "type": "string" }, "consolidated_variable_interest_entities_assets_held_net": { "type": "string" }, "consolidated_variable_interest_entities_formed_to_administer_credit_and_liquidity_facilities_non_controlling_interest": { "type": "string" }, "consolidated_variable_interest_entities_other_liabilities": { "type": "string" }, "deferred_asset_remittances_to_the_treasury": { "type": "string" }, "deposits.depository_institutions": { "type": "string" }, "deposit_treasury_funding_of_lending_facility_credit_protection": { "type": "string" }, "federal_reserve_notes_outstanding_net": { "type": "string" }, "foreign_currency_denominated_investments_net": { "type": "string" }, "loans": { "type": "string" }, "loans.other_loans": { "type": "string" }, "loans_to_depository_institutions": { "type": "string" }, "prepaid_pension_benefit_costs": { "type": "string" }, "surplus": { "type": "string" }, "system_open_market_account.accrued_interest_receivable": { "type": "string" }, "system_open_market_account.central_bank_liquidity_swaps": { "type": "string" }, "system_open_market_account.federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_net": { "type": "string" }, "system_open_market_account.government_sponsored_enterprise_debt_securities_net": { "type": "string" }, "system_open_market_account.other_assets": { "type": "string" }, "system_open_market_account.other_liabilities": { "type": "string" }, "system_open_market_account.securities_purchased_under_agreements_to_resell": { "type": "string" }, "system_open_market_account.securities_sold_under_agreements_to_repurchase": { "type": "string" }, "system_open_market_account.treasury_securities_net": { "type": "string" }, "treasury_general_account": { "type": "string" } } }, "income_statement": { "type": "object", "properties": { "board_of_governors_operating_expenses_and_currency_costs": { "type": "string" }, "bureau_of_consumer_financial_protection": { "type": "string" }, "central_bank_liquidity_swaps": { "type": "string" }, "change_in_actuarial_gains_related_to_benefit_plans": { "type": "string" }, "change_in_prior_service_costs_related_to_benefit_plans": { "type": "string" }, "consolidated_variable_interest_entities_gains_net": { "type": "string" }, "consolidated_variable_interest_entities_income_net": { "type": "string" }, "consolidated_variable_interest_entities_non_controlling_interest_income_net": { "type": "string" }, "depository_institutions_and_others": { "type": "string" }, "earnings_remittances_to_the_treasury_net": { "type": "string" }, "equipment": { "type": "string" }, "federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_gains_net": { "type": "string" }, "federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_net": { "type": "string" }, "foreign_currency_denominated_investments_net": { "type": "string" }, "foreign_currency_translation_gains_net": { "type": "string" }, "government_sponsored_enterprise_debt_securities_net": { "type": "string" }, "income_from_investments_held_by_consolidated_variable_interest_entities_net": { "type": "string" }, "income_from_services": { "type": "string" }, "interest_expense.system_open_market_account.other": { "type": "string" }, "interest_on_federal_reserve_notes": { "type": "string" }, "investments_held_by_consolidated_variable_interest_entities": { "type": "string" }, "investments_held_by_consolidated_variable_interest_entities_gains_net": { "type": "string" }, "loans": { "type": "string" }, "loans_to_depository_institutions": { "type": "string" }, "net_periodic_pension_expense": { "type": "string" }, "occupancy": { "type": "string" }, "operating_expenses.other": { "type": "string" }, "other_components_of_net_benefit_costs": { "type": "string" }, "other_income.system_open_market_account.other": { "type": "string" }, "other_income.system_open_market_account.other#2": { "type": "string" }, "other_loans": { "type": "string" }, "payments_to_u_s_treasury_as_required_by_statute": { "type": "string" }, "reimbursable_services_to_government_agencies": { "type": "string" }, "required_by_the_federal_reserve_act_as_amended_by_the_fast_act": { "type": "string" }, "salaries_and_benefits": { "type": "string" }, "securities_purchased_under_agreements_to_resell": { "type": "string" }, "securities_sold_under_agreements_to_repurchase": { "type": "string" }, "system_pension_service_cost": { "type": "string" }, "treasury_securities_gains_net": { "type": "string" }, "treasury_securities_net": { "type": "string" } } } } }, "quality": { "type": "object", "properties": { "documentsListed": { "type": "integer" }, "documentsStored": { "type": "integer" }, "documentsServed": { "type": "integer" }, "errata": { "type": "array", "items": { "type": "object", "properties": { "statement": { "type": "string" }, "period": { "type": "string", "format": "date" }, "subject": { "type": "string" }, "detail": { "type": "string" }, "printed": { "type": "integer" }, "corrected": { "type": "integer" }, "sourceUrl": { "type": "string" } } } }, "withheld": { "type": "array", "items": { "type": "object", "properties": { "statement": { "type": "string" }, "period": { "type": "string", "format": "date" }, "subject": { "type": "string" }, "detail": { "type": "string" }, "printed": { "type": "null" }, "corrected": { "type": "null" }, "sourceUrl": { "type": "string" } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "entity": "combined", "entityLabel": "Federal Reserve Banks (combined)", "entities": [ { "key": "combined", "label": "Federal Reserve Banks (combined)", "firstPeriod": "1915-12-31", "lastPeriod": "2026-06-30", "hasQuarterly": true }, { "key": "boston", "label": "Federal Reserve Bank of Boston", "firstPeriod": "1995-12-31", "lastPeriod": "2025-12-31", "hasQuarterly": false } ], "periodType": "annual", "unit": "USD millions", "statements": { "income_statement": { "columns": [ { "key": "FY2024", "endDate": "2024-12-31", "durationMonths": 12, "derived": false, "sources": [ { "url": "https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf", "kind": "annual_audited" } ] }, { "key": "FY2025", "endDate": "2025-12-31", "durationMonths": 12, "derived": false, "sources": [ { "url": "https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf", "kind": "annual_audited" } ] } ], "rows": [ { "key": "hdr:0:0", "label": "Interest income", "fullLabel": "Interest income", "depth": 0, "header": true, "total": false, "values": {} }, { "key": "loans_to_depository_institutions", "label": "Loans to depository institutions", "fullLabel": "Loans to depository institutions", "depth": 2, "header": false, "total": false, "values": { "FY2024": 204, "FY2025": 203 } } ] }, "balance_sheet": { "columns": [ { "key": "FY2024", "endDate": "2024-12-31", "durationMonths": 0, "derived": false, "sources": [ { "url": "https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf", "kind": "annual_audited" }, { "url": "https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2024.pdf", "kind": "annual_audited" } ] }, { "key": "FY2025", "endDate": "2025-12-31", "durationMonths": 0, "derived": false, "sources": [ { "url": "https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf", "kind": "annual_audited" } ] } ], "rows": [ { "key": "gold_certificates", "label": "Gold certificates", "fullLabel": "Gold certificates", "depth": 0, "header": false, "total": false, "values": { "FY2024": 11037, "FY2025": 11037 } }, { "key": "special_drawing_rights_certificates", "label": "Special drawing rights certificates", "fullLabel": "Special drawing rights certificates", "depth": 0, "header": false, "total": false, "values": { "FY2024": 15200, "FY2025": 15200 } } ] }, "income_summary": { "columns": [ { "key": "FY2023", "endDate": "2023-12-31", "durationMonths": 12, "derived": false, "sources": [ { "url": "https://www.federalreserve.gov/publications/2024-ar-statistical-tables.htm", "kind": "annual_report_stats" } ] }, { "key": "FY2024", "endDate": "2024-12-31", "durationMonths": 12, "derived": false, "sources": [ { "url": "https://www.federalreserve.gov/publications/2024-ar-statistical-tables.htm", "kind": "annual_report_stats" } ] } ], "rows": [ { "key": "current_income", "label": "Current income", "fullLabel": "Current income", "depth": 0, "header": false, "total": false, "values": { "FY2023": 175136.109, "FY2024": 159323.708 } }, { "key": "assessments_by_the_board_of_governors_board_expenditures", "label": "Assessments by the Board of Governors: Board expenditures", "fullLabel": "Assessments by the Board of Governors: Board expenditures", "depth": 0, "header": false, "total": false, "values": { "FY2023": 1144, "FY2024": 1438 } } ] } }, "noteRefs": { "balance_sheet": { "accrued_benefit_costs": "Notes 9, 10", "bank_premises_and_equipment_net": "Note 7", "capital_paid_in": "Note 7", "consolidated_variable_interest_entities_assets_held_net": "Note 3", "consolidated_variable_interest_entities_formed_to_administer_credit_and_liquidity_facilities_non_controlling_interest": "Note 3", "consolidated_variable_interest_entities_other_liabilities": "Note 3", "deferred_asset_remittances_to_the_treasury": "Note 12", "deposits.depository_institutions": "Note 5", "deposit_treasury_funding_of_lending_facility_credit_protection": "Note 4", "federal_reserve_notes_outstanding_net": "Note 4", "foreign_currency_denominated_investments_net": "Note 2", "loans": "Note 4", "loans.other_loans": "Note 1", "loans_to_depository_institutions": "Note 1", "prepaid_pension_benefit_costs": "Note 9", "surplus": "Note 7", "system_open_market_account.accrued_interest_receivable": "Note 2", "system_open_market_account.central_bank_liquidity_swaps": "Note 2", "system_open_market_account.federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_net": "Note 2", "system_open_market_account.government_sponsored_enterprise_debt_securities_net": "Note 2", "system_open_market_account.other_assets": "Note 5", "system_open_market_account.other_liabilities": "Note 2", "system_open_market_account.securities_purchased_under_agreements_to_resell": "Note 2", "system_open_market_account.securities_sold_under_agreements_to_repurchase": "Note 2", "system_open_market_account.treasury_securities_net": "Note 2", "treasury_general_account": "Note 6" }, "income_statement": { "board_of_governors_operating_expenses_and_currency_costs": "Note 8(E)", "bureau_of_consumer_financial_protection": "Note 8(E)", "central_bank_liquidity_swaps": "Note 8(B)", "change_in_actuarial_gains_related_to_benefit_plans": "Notes 9, 10, 11", "change_in_prior_service_costs_related_to_benefit_plans": "Notes 9, 10, 11", "consolidated_variable_interest_entities_gains_net": "Note 3", "consolidated_variable_interest_entities_income_net": "Note 8(C)", "consolidated_variable_interest_entities_non_controlling_interest_income_net": "Note 8(C)", "depository_institutions_and_others": "Note 8(D)", "earnings_remittances_to_the_treasury_net": "Note 12", "equipment": "Note 8(E)", "federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_gains_net": "Note 8(B)", "federal_agency_and_government_sponsored_enterprise_mortgage_backed_securities_net": "Note 8(B)", "foreign_currency_denominated_investments_net": "Note 8(B)", "foreign_currency_translation_gains_net": "Note 8(B)", "government_sponsored_enterprise_debt_securities_net": "Note 8(B)", "income_from_investments_held_by_consolidated_variable_interest_entities_net": "Note 3", "income_from_services": "Note 5", "interest_expense.system_open_market_account.other": "Note 5", "interest_on_federal_reserve_notes": "Note 13", "investments_held_by_consolidated_variable_interest_entities": "Note 3", "investments_held_by_consolidated_variable_interest_entities_gains_net": "Note 3", "loans": "Note 4", "loans_to_depository_institutions": "Note 8(A)", "net_periodic_pension_expense": "Note 9", "occupancy": "Note 8(E)", "operating_expenses.other": "Note 8(E)", "other_components_of_net_benefit_costs": "Notes 9, 10", "other_income.system_open_market_account.other": "Note 8(B)", "other_income.system_open_market_account.other#2": "Note 5", "other_loans": "Note 8(A)", "payments_to_u_s_treasury_as_required_by_statute": "Note 3", "reimbursable_services_to_government_agencies": "Note 5", "required_by_the_federal_reserve_act_as_amended_by_the_fast_act": "Note 3o", "salaries_and_benefits": "Note 8(E)", "securities_purchased_under_agreements_to_resell": "Note 8(B)", "securities_sold_under_agreements_to_repurchase": "Note 8(B)", "system_pension_service_cost": "Note 8(E)", "treasury_securities_gains_net": "Note 8(B)", "treasury_securities_net": "Note 8(B)" } }, "quality": { "documentsListed": 157, "documentsStored": 157, "documentsServed": 76, "errata": [ { "statement": "balance_sheet", "period": "2016-06-30", "subject": "Total liabilities @ 2016-06-30", "detail": "June 30, 2016 total liabilities printed as 4,482,386 (digits transposed, same in the HTML edition). The twelve liability lines sum to 4,428,386, and total liabilities and capital 4,468,497 − total cap…", "printed": 4482386, "corrected": 4428386, "sourceUrl": "https://www.federalreserve.gov/aboutthefed/files/quarterly-report-20160630.pdf" } ], "withheld": [ { "statement": "income_statement", "period": "2024-12-31", "subject": "Total distribution of comprehensive income @ 2024-12-31 12m", "detail": "no run of the items above foots it", "printed": null, "corrected": null, "sourceUrl": "https://www.federalreserve.gov/publications/2024-ar-statistical-tables.htm" }, { "statement": "income_statement", "period": "2023-12-31", "subject": "Total distribution of comprehensive income @ 2023-12-31 12m", "detail": "no run of the items above foots it", "printed": null, "corrected": null, "sourceUrl": "https://www.federalreserve.gov/publications/2023-ar-statistical-tables.htm" } ] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/fed-financials/notes": { "get": { "summary": "Federal Reserve financial notes", "description": "The notes to one Federal Reserve financial-statement document as tables, figures shown only for tables that pass their checks (United States only). By default an index: { entity, view: \"index\", documents, document, tables: [{ id, noteNumber, noteTitle, tableTitle, caption, unitScale, page, status, holdReason, rowCount }] } without figures; `table=` serves that table with its figures; `view=full` every table with its figures (about 400 KB). Each document's `held` (also `withheldTables`) counts the tables a check withheld; 0 means none was withheld.", "operationId": "get-federal-reserve-financial-notes", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "entity", "in": "query", "description": "`combined` (default) or one Reserve Bank.", "schema": { "type": "string" } }, { "name": "doc_id", "in": "query", "description": "One document.", "schema": { "type": "integer" } }, { "name": "period_end", "in": "query", "description": "The document for this period end, YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "period", "in": "query", "description": "Cadence.", "schema": { "type": "string", "enum": [ "annual", "quarterly" ], "default": "annual" } }, { "name": "table", "in": "query", "description": "Only this note table, with its figures (404 when the document has none).", "schema": { "type": "integer" } }, { "name": "view", "in": "query", "description": "`index` (default): tables without figures. `full`: every table with its figures.", "schema": { "type": "string", "enum": [ "index", "full" ], "default": "index" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "entity": { "type": "string" }, "view": { "type": "string" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "docId": { "type": "integer" }, "docKind": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": [ "integer", "null" ] }, "sourceUrl": { "type": "string" }, "format": { "type": "string" }, "tables": { "type": "integer" }, "held": { "type": "integer" }, "withheldTables": { "type": "integer" } } } }, "document": { "type": "object", "properties": { "docId": { "type": "integer" }, "docKind": { "type": "string" }, "periodEnd": { "type": "string", "format": "date" }, "fiscalYear": { "type": "integer" }, "fiscalQuarter": { "type": "null" }, "sourceUrl": { "type": "string" }, "format": { "type": "string" }, "tables": { "type": "integer" }, "held": { "type": "integer" }, "withheldTables": { "type": "integer" } } }, "tables": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "noteNumber": { "type": "integer" }, "noteTitle": { "type": "string" }, "tableTitle": { "type": "null" }, "caption": { "type": "string" }, "unitScale": { "type": [ "string", "null" ] }, "page": { "type": "integer" }, "status": { "type": "string" }, "holdReason": { "type": "null" }, "rowCount": { "type": "integer" } } } }, "note": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "entity": "combined", "view": "index", "documents": [ { "docId": 292, "docKind": "quarterly_unaudited", "periodEnd": "2026-06-30", "fiscalYear": 2026, "fiscalQuarter": 2, "sourceUrl": "https://www.federalreserve.gov/aboutthefed/files/quarterly-report-20260828.pdf", "format": "pdf", "tables": 21, "held": 2, "withheldTables": 2 }, { "docId": 290, "docKind": "annual_audited", "periodEnd": "2025-12-31", "fiscalYear": 2025, "fiscalQuarter": null, "sourceUrl": "https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf", "format": "pdf", "tables": 43, "held": 0, "withheldTables": 0 } ], "document": { "docId": 290, "docKind": "annual_audited", "periodEnd": "2025-12-31", "fiscalYear": 2025, "fiscalQuarter": null, "sourceUrl": "https://www.federalreserve.gov/aboutthefed/files/combinedfinstmt2025.pdf", "format": "pdf", "tables": 43, "held": 0, "withheldTables": 0 }, "tables": [ { "id": 21822, "noteNumber": 4, "noteTitle": "LOANS", "tableTitle": null, "caption": "The remaining maturity distribution and the total amount of loans outstanding at December 31, 2025 and 2024 were as follows (in millions):", "unitScale": "millions", "page": 28, "status": "ok", "holdReason": null, "rowCount": 13 }, { "id": 21844, "noteNumber": 6, "noteTitle": "CONSOLIDATED VARIABLE INTEREST ENTITIES", "tableTitle": null, "caption": "The following table shows rating distribution using internally derived risk ratings on a scale comparable to a Moody’s rating scale as of December 31, 2025 and 2024:", "unitScale": null, "page": 46, "status": "ok", "holdReason": null, "rowCount": 6 } ], "note": "One entry per note table. Read a table's figures with table=, or every table at once with view=full." } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/military/conflicts": { "get": { "summary": "Armed conflicts", "description": "The armed conflicts published from the registry (UCDP/PRIO 1946–2024 plus sourced seeds): span, type, region, intensity, battle deaths and the states on either side. Published so far: the 2026 Iran war, the 2026 Houthi–Saudi war, the 2025–2026 Afghanistan–Pakistan war and the Russia–Ukraine war; the rest of the registry is under review. Any filter switches to a page.", "operationId": "get-armed-conflicts", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "country", "in": "query", "description": "ISO alpha-2 state that took part, either side.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "One of africa, americas, asia, europe, global, middle_east, oceania.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Conflict types, comma-separated, from interstate, intrastate, internationalized_intrastate, extrasystemic, operation, crisis.", "schema": { "type": "string" } }, { "name": "active_in", "in": "query", "description": "A year (1800–2100) the conflict was active in.", "schema": { "type": "integer" } }, { "name": "from", "in": "query", "description": "First day (conflicts overlapping the window), YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last day, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "ongoing", "in": "query", "description": "1 or true: only ongoing conflicts. 0 or false: only ended ones. Any other value is a 400.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Words that must all appear in the conflict's name or location.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size, 1–500.", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "conflicts": { "type": "object", "properties": { "conflicts": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "location": { "type": "string" }, "region": { "type": "string" }, "start": { "type": "string", "format": "date" }, "end": { "type": "null" }, "intensity": { "type": [ "string", "null" ] }, "battleDeaths": { "type": "null" }, "battleDeathsSpan": { "type": "null" }, "states": { "type": "array", "items": { "type": "string" } }, "partyCount": { "type": "integer" }, "sourceCode": { "type": "string" }, "draft": { "type": "boolean" }, "partOf": { "type": [ "string", "null" ] } } } }, "ucdpThrough": { "type": "integer" }, "notices": { "type": "array", "items": {} }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "conflicts": { "conflicts": [ { "key": "seed:ethiopia-eritrea-2026", "name": "Ethiopia–Eritrea armed confrontation (2026)", "kind": "interstate", "location": "Eastern Tigray (Adigrat, Zalambessa, Idaga Hamus, Rama); northern Afar", "region": "africa", "start": "2026-10-01", "end": null, "intensity": null, "battleDeaths": null, "battleDeathsSpan": null, "states": [ "ER", "ET" ], "partyCount": 3, "sourceCode": "seed", "draft": true, "partOf": null }, { "key": "seed:yemen-red-sea-coast-2026", "name": "Battle for Yemen's Red Sea coast and the Bab al-Mandab (2026)", "kind": "internationalized_intrastate", "location": "Taiz and Hodeidah governorates: Mokha, Dhubab, Perim (Mayyun) Island, Bab al-Mandab, Yemen; Saudi airports", "region": "middle_east", "start": "2026-09-01", "end": null, "intensity": "minor", "battleDeaths": null, "battleDeathsSpan": null, "states": [ "SA", "YE" ], "partyCount": 3, "sourceCode": "seed", "draft": true, "partOf": "ucdp:230" } ], "ucdpThrough": 2024, "notices": [], "total": 478, "offset": 0, "limit": 2, "nextOffset": 2 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/military/countries/{iso2}": { "get": { "summary": "Country armed forces", "description": "A country's armed forces, for a country with a Military page (the US, the UAE, Saudi Arabia, …; any other is a 404): the head of state and ministers who command them (`principals`, each under its military title), the military leadership seats with their holders, rank, start date and source page (`leaders`), defence spending by year (`spending`: SIPRI military expenditure in US dollars, as a share of GDP and of government spending, IISS armed forces personnel, all via World Bank WDI, plus the country's own budget line where it publishes one, converted to dollars), and counts of the published conflicts it took part in (`conflicts`). A year a source does not hold is absent, never zero.", "operationId": "get-country-armed-forces", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso2", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. SA).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/military/countries/{iso2}/conflicts": { "get": { "summary": "Country conflicts", "description": "The published armed conflicts a country took part in, from its side: its role (primary party, or supporting with its own troops), its years, whom it faced, the conflict's type, intensity and battle deaths. Only published conflicts serve (as on /military/conflicts). Any filter switches to a page; `counts` stay those of every listed conflict.", "operationId": "get-country-conflicts", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso2", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. SA).", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "One of africa, americas, asia, europe, global, middle_east, oceania.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Conflict types, comma-separated, from interstate, intrastate, internationalized_intrastate, extrasystemic, operation, crisis.", "schema": { "type": "string" } }, { "name": "active_in", "in": "query", "description": "A year (1800–2100) the conflict was active in.", "schema": { "type": "integer" } }, { "name": "from", "in": "query", "description": "First day (conflicts overlapping the window), YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last day, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "ongoing", "in": "query", "description": "1 or true: only ongoing conflicts. 0 or false: only ended ones. Any other value is a 400.", "schema": { "type": "string" } }, { "name": "q", "in": "query", "description": "Words that must all appear in the conflict's name or location.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size, 1–500.", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/foreign-relations/organisations": { "get": { "summary": "International organisations", "description": "Every international organisation in the registry (UN bodies, development banks, standard setters, alliances, blocs, forums) with how many countries sit in it today. Any filter switches to a page.", "operationId": "get-international-organisations", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "q", "in": "query", "description": "Words in the code, name or short name.", "schema": { "type": "string" } }, { "name": "kind", "in": "query", "description": "Organisation kind, e.g. development_bank.", "schema": { "type": "string" } }, { "name": "domain", "in": "query", "description": "Domain, e.g. finance.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size, 1–500.", "schema": { "type": "integer", "minimum": 1, "maximum": 500, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "organisations": { "type": "object", "properties": { "organisations": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "kind": { "type": "string" }, "domains": { "type": "array", "items": { "type": "string" } }, "parent": { "type": [ "string", "null" ] }, "founded": { "type": "null" }, "dissolved": { "type": "null" }, "hqCountry": { "type": "string" }, "draft": { "type": "boolean" }, "membersNow": { "type": "integer" }, "seatsNow": { "type": "integer" } } } }, "notices": { "type": "array", "items": {} }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "organisations": { "organisations": [ { "code": "AFRICA_CDC", "name": "Africa Centres for Disease Control and Prevention", "shortName": "Africa CDC", "kind": "intergovernmental", "domains": [ "health" ], "parent": "AU", "founded": null, "dissolved": null, "hqCountry": "ET", "draft": false, "membersNow": 0, "seatsNow": 0 }, { "code": "AFC", "name": "Africa Finance Corporation", "shortName": "AFC", "kind": "development_bank", "domains": [ "finance", "infrastructure" ], "parent": null, "founded": null, "dissolved": null, "hqCountry": "NG", "draft": false, "membersNow": 46, "seatsNow": 46 } ], "notices": [], "total": 492, "offset": 0, "limit": 2, "nextOffset": 2 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/foreign-relations/organisations/{code}/countries/{iso2}": { "get": { "summary": "Organisation and country", "description": "One organisation's relationship with one country (e.g. IMF–Pakistan): seats, measured series, financing instruments with their reviews, dated acts and, for the UN, treaties deposited.", "operationId": "get-organisation-and-country", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "code", "in": "path", "required": true, "description": "Organisation code, e.g. IMF.", "schema": { "type": "string" } }, { "name": "iso2", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code.", "schema": { "type": "string" } }, { "name": "instrument_class", "in": "query", "description": "Financing instrument classes, comma-separated, e.g. loan,credit.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Financing instruments per page, 1–200, default 20, newest approval first; adds `financingPage`.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 20 } }, { "name": "offset", "in": "query", "description": "Financing instruments to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "relation": { "type": "object", "properties": { "org": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "kind": { "type": "string" }, "dissolved": { "type": "null" }, "draft": { "type": "boolean" } } }, "country": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "region": { "type": "string" }, "currency": { "type": "string" } } }, "family": { "type": "array", "items": { "type": "string" } }, "seats": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "org": { "type": "string" }, "orgName": { "type": "string" }, "orgShortName": { "type": "string" }, "orgKind": { "type": "string" }, "domains": { "type": "array", "items": { "type": "string" } }, "parent": { "type": "null" }, "country": { "type": "string" }, "status": { "type": "string" }, "validFrom": { "type": "null" }, "validTo": { "type": "string", "format": "date" }, "attributes": { "type": "object", "properties": { "joined_as": { "type": "string" } } }, "sources": { "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string" }, "tier": { "type": "string" }, "quote": { "type": "string" }, "title": { "type": "string" }, "accessed": { "type": "string", "format": "date" } } } }, "draft": { "type": "boolean" } } } }, "series": { "type": "array", "items": {} }, "financing": { "type": "array", "items": {} }, "events": { "type": "array", "items": {} }, "treaties": { "type": "null" }, "notices": { "type": "array", "items": {} }, "financingPage": { "type": "object", "properties": { "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "nextOffset": { "type": "null" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "relation": { "org": { "code": "OPEC", "name": "Organization of the Petroleum Exporting Countries", "shortName": "OPEC", "kind": "producer_group", "dissolved": null, "draft": false }, "country": { "code": "AE", "name": "United Arab Emirates", "region": "Asia", "currency": "AED" }, "family": [ "OPEC" ], "seats": [ { "id": 84, "org": "OPEC", "orgName": "Organization of the Petroleum Exporting Countries", "orgShortName": "OPEC", "orgKind": "producer_group", "domains": [ "energy" ], "parent": null, "country": "AE", "status": "member", "validFrom": null, "validTo": "2026-05-01", "attributes": { "joined_as": "Emirate of Abu Dhabi" }, "sources": [ { "url": "https://www.eia.gov/todayinenergy/detail.php?id=67804", "tier": "government_text", "quote": "joined OPEC as the emirate of Abu Dhabi in 1967", "title": "EIA Today in Energy - UAE exit from OPEC (23 June 2026)", "accessed": "2026-10-27" }, { "url": "https://www.eia.gov/todayinenergy/detail.php?id=67804", "tier": "government_text", "quote": "On April 28, 2026, the United Arab Emirates (UAE) announced that it was leaving OPEC, effective on May 1.", "title": "EIA Today in Energy - UAE exit from OPEC", "accessed": "2026-10-27" } ], "draft": false } ], "series": [], "financing": [], "events": [], "treaties": null, "notices": [], "financingPage": { "total": 0, "offset": 0, "limit": 2, "nextOffset": null } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/policy-text": { "get": { "summary": "Policy text overview", "description": "Central-bank text corpus summary: coverage, the newest release of each type and the concepts discussed (US Federal Reserve; UAE Central Bank). available=false for a country with no corpus.", "operationId": "get-policy-text-overview", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "iso2": { "type": "string" }, "institution": { "type": "string" }, "available": { "type": "boolean" }, "coverage": { "type": "array", "items": { "type": "object", "properties": { "docType": { "type": "string" }, "documents": { "type": "integer" }, "analyzedDocuments": { "type": "integer" }, "observations": { "type": "integer" }, "firstEventDate": { "type": "string", "format": "date" }, "lastEventDate": { "type": "string", "format": "date" } } } }, "latest": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "integer" }, "externalId": { "type": "string" }, "docType": { "type": "string" }, "title": { "type": "string" }, "eventDate": { "type": "string", "format": "date" }, "meetingDate": { "type": [ "string", "null" ], "format": "date" }, "speaker": { "type": [ "string", "null" ] }, "district": { "type": "null" }, "sourceUrl": { "type": "string" }, "venue": { "type": [ "string", "null" ] }, "subtype": { "type": [ "string", "null" ] }, "unscheduled": { "type": [ "boolean", "null" ] }, "observationCount": { "type": "integer" }, "byteSize": { "type": "integer" } } } }, "analysisWindow": { "type": [ "object", "null" ], "properties": { "start": { "type": "string", "format": "date" }, "end": { "type": "string", "format": "date" } } }, "pulse": { "type": "array", "items": { "type": "object", "properties": { "concept": { "type": "string" }, "mentions": { "type": "integer" }, "netDirection": { "type": "number" }, "forwardShare": { "type": "number" }, "docTypes": { "type": "array", "items": { "type": "string" } }, "sampleObservationId": { "type": "integer" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "iso2": "US", "institution": "Federal Reserve", "available": true, "coverage": [ { "docType": "fomc_statement", "documents": 263, "analyzedDocuments": 23, "observations": 291, "firstEventDate": "1994-02-04", "lastEventDate": "2026-10-28" }, { "docType": "fomc_minutes", "documents": 270, "analyzedDocuments": 21, "observations": 6218, "firstEventDate": "1993-03-26", "lastEventDate": "2026-10-07" } ], "latest": [ { "documentId": 84316, "externalId": "stmt-20261028a", "docType": "fomc_statement", "title": "Federal Reserve issues FOMC statement", "eventDate": "2026-10-28", "meetingDate": "2026-10-28", "speaker": null, "district": null, "sourceUrl": "https://www.federalreserve.gov/newsevents/pressreleases/monetary20261028a.htm", "venue": null, "subtype": null, "unscheduled": false, "observationCount": 0, "byteSize": 1527 }, { "documentId": 81310, "externalId": "speech-bowman20261014a", "docType": "fed_speech", "title": "Supervisory Modernization After Silicon Valley Bank", "eventDate": "2026-10-14", "meetingDate": null, "speaker": "Vice Chair for Supervision Michelle W. Bowman", "district": null, "sourceUrl": "https://www.federalreserve.gov/newsevents/speech/bowman20261014a.htm", "venue": "At the Bangkok Economic Festival, Reinventing Bretton Woods Committee, Bangkok, Thailand", "subtype": null, "unscheduled": null, "observationCount": 0, "byteSize": 13587 } ], "analysisWindow": { "start": "2024-01-03", "end": "2026-07-15" }, "pulse": [ { "concept": "employment", "mentions": 112, "netDirection": 0.47058823529411764, "forwardShare": 0, "docTypes": [ "beige_book" ], "sampleObservationId": 489021 }, { "concept": "monetary policy stance", "mentions": 23, "netDirection": 0, "forwardShare": 0.30434782608695654, "docTypes": [ "fed_speech", "fomc_minutes" ], "sampleObservationId": 493604 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/policy-text/documents": { "get": { "summary": "Policy documents", "description": "Policy document index.", "operationId": "get-policy-documents", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "group", "in": "query", "description": "Document group: overview, decisions, statements, press-conferences, minutes, speeches, beige-book (Fed); base-rate-decisions, press-releases, public-statements, financial-stability, annual-reports, periodic-reports, research (CBUAE). Others are a 400.", "schema": { "type": "string" } }, { "name": "docType", "in": "query", "description": "Document type: fomc_statement, fomc_minutes, fomc_press_conference, fed_speech, beige_book, cbuae_base_rate_decision, cbuae_press_release, cbuae_public_statement, cbuae_financial_stability_report, cbuae_annual_report, cbuae_periodic_report, cbuae_research_paper. Others are a 400.", "schema": { "type": "string" } }, { "name": "year", "in": "query", "description": "Calendar year, 1900–2100; any other value is a 400.", "schema": { "type": "integer", "minimum": 1900, "maximum": 2100 } }, { "name": "speaker", "in": "query", "description": "Speaker name, exactly as stored (the page's picker).", "schema": { "type": "string" } }, { "name": "speakerWords", "in": "query", "description": "Words of the speaker's name, any order (e.g. Powell).", "schema": { "type": "string" } }, { "name": "district", "in": "query", "description": "Beige Book district.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Words in the title or speaker line only.", "schema": { "type": "string" } }, { "name": "text", "in": "query", "description": "Words in the documents' own text. Reads the newest documents passing the other filters, within a per-request budget, and answers { items (each with matchedIn, occurrences, snippets), scan: { candidates, offset, scanned, nextOffset, newest, oldest, unreadable, stoppedAtLimit } }; pass scan.nextOffset as offset to search older documents.", "schema": { "type": "string" } }, { "name": "analyzedOnly", "in": "query", "description": "1 = only documents with extracted observations.", "schema": { "type": "string", "enum": [ "1" ] } }, { "name": "limit", "in": "query", "description": "Default 50, max 200; with text, default 20, max 50. Above the max is a 400.", "schema": { "type": "integer", "minimum": 1, "maximum": 200 } }, { "name": "offset", "in": "query", "description": "Default 0. The list answers limit, offset, hasMore and nextOffset; a text scan answers scan.nextOffset.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "subtype", "in": "query", "description": "Only documents of this subtype, as listed on each document (`subtype`).", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "integer" }, "externalId": { "type": "string" }, "docType": { "type": "string" }, "title": { "type": "string" }, "eventDate": { "type": "string", "format": "date" }, "meetingDate": { "type": [ "string", "null" ], "format": "date" }, "speaker": { "type": [ "string", "null" ] }, "district": { "type": "null" }, "sourceUrl": { "type": "string" }, "venue": { "type": [ "string", "null" ] }, "subtype": { "type": [ "string", "null" ] }, "unscheduled": { "type": [ "boolean", "null" ] }, "observationCount": { "type": "integer" }, "byteSize": { "type": "integer" } } } }, "total": { "type": "integer" }, "facets": { "type": "object", "properties": { "years": { "type": "array", "items": { "type": "integer" } }, "speakers": { "type": "array", "items": { "type": "string" } }, "districts": { "type": "array", "items": { "type": "string" } }, "subtypes": { "type": "array", "items": { "type": "string" } } } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "items": [ { "documentId": 84316, "externalId": "stmt-20261028a", "docType": "fomc_statement", "title": "Federal Reserve issues FOMC statement", "eventDate": "2026-10-28", "meetingDate": "2026-10-28", "speaker": null, "district": null, "sourceUrl": "https://www.federalreserve.gov/newsevents/pressreleases/monetary20261028a.htm", "venue": null, "subtype": null, "unscheduled": false, "observationCount": 0, "byteSize": 1527 }, { "documentId": 81310, "externalId": "speech-bowman20261014a", "docType": "fed_speech", "title": "Supervisory Modernization After Silicon Valley Bank", "eventDate": "2026-10-14", "meetingDate": null, "speaker": "Vice Chair for Supervision Michelle W. Bowman", "district": null, "sourceUrl": "https://www.federalreserve.gov/newsevents/speech/bowman20261014a.htm", "venue": "At the Bangkok Economic Festival, Reinventing Bretton Woods Committee, Bangkok, Thailand", "subtype": null, "unscheduled": null, "observationCount": 0, "byteSize": 13587 } ], "total": 4663, "facets": { "years": [ 2026, 2025 ], "speakers": [ "Chair Janet L. Yellen", "Chair Jerome H. Powell" ], "districts": [ "National Summary", "Boston" ], "subtypes": [ "bs", "lrg" ] }, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/policy-text/documents/{documentId}": { "get": { "summary": "Policy document", "description": "One policy document: its full text (document.txt) and every servable observation on it, each with character offsets into that text.", "operationId": "get-policy-document", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "document": { "type": "object", "properties": { "documentId": { "type": "integer" }, "externalId": { "type": "string" }, "docType": { "type": "string" }, "title": { "type": "string" }, "eventDate": { "type": "string", "format": "date" }, "meetingDate": { "type": "string", "format": "date" }, "speaker": { "type": "null" }, "district": { "type": "null" }, "sourceUrl": { "type": "string" }, "venue": { "type": "null" }, "subtype": { "type": "null" }, "unscheduled": { "type": "boolean" }, "observationCount": { "type": "integer" }, "byteSize": { "type": "integer" } } }, "text": { "type": "string" }, "observations": { "type": "array", "items": {} } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "document": { "documentId": 84316, "externalId": "stmt-20261028a", "docType": "fomc_statement", "title": "Federal Reserve issues FOMC statement", "eventDate": "2026-10-28", "meetingDate": "2026-10-28", "speaker": null, "district": null, "sourceUrl": "https://www.federalreserve.gov/newsevents/pressreleases/monetary20261028a.htm", "venue": null, "subtype": null, "unscheduled": false, "observationCount": 0, "byteSize": 1527 }, "text": "================================================================================\nFEDERAL RESERVE | fomc_statement | 2026-10-28\nFederal Reserve issues FOMC statement\nsource: federalreserve | id: stmt-2…", "observations": [] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/policy-text/districts": { "get": { "summary": "Beige Book districts", "description": "Beige Book district breakdown, newest release first.", "operationId": "get-beige-book-districts", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Releases, 1–24, default 8.", "schema": { "type": "integer", "minimum": 1, "maximum": 24, "default": 8 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "releases": { "type": "array", "items": { "type": "object", "properties": { "eventDate": { "type": "string", "format": "date" }, "label": { "type": "string" }, "districts": { "type": "array", "items": { "type": "object", "properties": { "district": { "type": "string" }, "documentId": { "type": "integer" }, "observations": { "type": "integer" }, "netDirection": { "type": "number" }, "netSentiment": { "type": "number" } } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "releases": [ { "eventDate": "2026-07-15", "label": "Jul 2026", "districts": [ { "district": "National Summary", "documentId": 17636, "observations": 134, "netDirection": 0.6730769230769231, "netSentiment": 0.4166666666666667 }, { "district": "Minneapolis", "documentId": 17645, "observations": 95, "netDirection": 0.3888888888888889, "netSentiment": 0 } ] } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/policy-text/guidance": { "get": { "summary": "Policy guidance", "description": "Forward-guidance observations from policy text, newest first.", "operationId": "get-policy-guidance", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Readings, 1–50, default 8.", "schema": { "type": "integer", "minimum": 1, "maximum": 50, "default": 8 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "observationType": { "type": "string" }, "concept": { "type": "string" }, "statement": { "type": "string" }, "evidenceQuote": { "type": "string" }, "charStart": { "type": "integer" }, "charEnd": { "type": "integer" }, "direction": { "type": "null" }, "magnitude": { "type": "null" }, "sentiment": { "type": "string" }, "isForwardLooking": { "type": "boolean" }, "periodStart": { "type": [ "string", "null" ], "format": "date" }, "periodEnd": { "type": [ "string", "null" ], "format": "date" }, "speakerName": { "type": "null" }, "speakerRole": { "type": "string" }, "sectionLabel": { "type": "null" }, "document": { "type": "object", "properties": { "documentId": { "type": "integer" }, "externalId": { "type": "string" }, "docType": { "type": "string" }, "title": { "type": "string" }, "eventDate": { "type": "string", "format": "date" }, "meetingDate": { "type": "string", "format": "date" }, "speaker": { "type": "null" }, "district": { "type": "null" }, "sourceUrl": { "type": "string" }, "venue": { "type": "null" }, "subtype": { "type": "null" }, "unscheduled": { "type": "boolean" }, "observationCount": { "type": "integer" }, "byteSize": { "type": "integer" } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "items": [ { "observationId": 447287, "observationType": "causal_claim", "concept": "term premium drivers", "statement": "The manager of the System Open Market Account commented that the shift in Treasury ownership composition could have implications for the term premium component of yields.", "evidenceQuote": "which could have implications for the term premium component of yields", "charStart": 3049, "charEnd": 3119, "direction": null, "magnitude": null, "sentiment": "uncertain", "isForwardLooking": true, "periodStart": null, "periodEnd": null, "speakerName": null, "speakerRole": "official", "sectionLabel": null, "document": { "documentId": 7635, "externalId": "min-20260617", "docType": "fomc_minutes", "title": "Minutes of the Federal Open Market Committee", "eventDate": "2026-07-08", "meetingDate": "2026-06-17", "speaker": null, "district": null, "sourceUrl": "https://www.federalreserve.gov/monetarypolicy/fomcminutes20260617.htm", "venue": null, "subtype": null, "unscheduled": false, "observationCount": 0, "byteSize": 36700 } }, { "observationId": 447339, "observationType": "causal_claim", "concept": "projection assumptions", "statement": "Almost all FOMC participants' June 2026 projections were based on their individual assessments of appropriate monetary policy, including their projections of the federal funds rate.", "evidenceQuote": "The projections were based on participants' individual assessments of appropriate monetary policy, including their projections of the federal funds rate.", "charStart": 15634, "charEnd": 15787, "direction": null, "magnitude": null, "sentiment": "neutral", "isForwardLooking": true, "periodStart": "2026-05-06", "periodEnd": "2026-06-17", "speakerName": null, "speakerRole": "official", "sectionLabel": null, "document": { "documentId": 7635, "externalId": "min-20260617", "docType": "fomc_minutes", "title": "Minutes of the Federal Open Market Committee", "eventDate": "2026-07-08", "meetingDate": "2026-06-17", "speaker": null, "district": null, "sourceUrl": "https://www.federalreserve.gov/monetarypolicy/fomcminutes20260617.htm", "venue": null, "subtype": null, "unscheduled": false, "observationCount": 0, "byteSize": 36700 } } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/indices": { "get": { "summary": "List benchmarks", "description": "Benchmark indices and sector ETFs. With `vs`, prices and returns are converted into that currency at the exchange rate on each figure's own dates (`currency` then reads `vs`; `listing_currency` keeps the exchange's); 30-day volatility stays in the listing currency.", "operationId": "get-list-benchmarks", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "vs", "in": "query", "description": "Fiat ISO code to price in, e.g. USD or EUR (any currency on the FX board). Omit for each listing's own currency.", "schema": { "type": "string", "pattern": "^[A-Za-z]{3}$" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "indices": { "type": "array", "items": { "type": "object", "properties": { "symbol": { "type": "string" }, "name": { "type": "string" }, "short_name": { "type": [ "string", "null" ] }, "category": { "type": "string" }, "benchmark_role": { "type": "string" }, "sector_key": { "type": "null" }, "index_family": { "type": [ "string", "null" ] }, "issuer": { "type": "string" }, "expense_ratio": { "type": [ "number", "null" ] }, "inception_date": { "type": [ "string", "null" ], "format": "date" }, "currency": { "type": "string" }, "listing_currency": { "type": "string" }, "return_basis": { "type": "string" }, "last_price": { "type": "number" }, "last_price_date": { "type": "string", "format": "date" }, "return_1d": { "type": [ "number", "null" ] }, "return_1w": { "type": [ "number", "null" ] }, "return_1m": { "type": [ "number", "null" ] }, "return_ytd": { "type": [ "number", "null" ] }, "return_1y": { "type": [ "number", "null" ] }, "return_5y": { "type": [ "number", "null" ] }, "low_52w": { "type": "number" }, "high_52w": { "type": "number" }, "volatility_30d": { "type": [ "number", "null" ] }, "price_rows": { "type": "integer" }, "days_stale": { "type": "integer" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "indices": [ { "symbol": "SPY", "name": "SPDR S&P 500 ETF Trust", "short_name": "S&P 500", "category": "broad_market", "benchmark_role": "market", "sector_key": null, "index_family": "S&P 500", "issuer": "State Street", "expense_ratio": 0.0945, "inception_date": "1993-01-22", "currency": "USD", "listing_currency": "USD", "return_basis": "total_return", "last_price": 755.719971, "last_price_date": "2026-10-30", "return_1d": -0.017729040066985058, "return_1w": -0.005592326226268707, "return_1m": -0.009060794821467821, "return_ytd": 0.11687981112416601, "return_1y": 0.12362377065638386, "return_5y": 0.759379957248546, "low_52w": 629.280029, "high_52w": 781.619995, "volatility_30d": 0.11143032453359386, "price_rows": 8497, "days_stale": 2 }, { "symbol": "GCCDIV", "name": "Lunate Solactive GCC Shariah Dividend ETF", "short_name": null, "category": "factor", "benchmark_role": "none", "sector_key": null, "index_family": null, "issuer": "Lunate", "expense_ratio": null, "inception_date": null, "currency": "AED", "listing_currency": "AED", "return_basis": "price", "last_price": 3.5, "last_price_date": "2026-10-30", "return_1d": null, "return_1w": null, "return_1m": null, "return_ytd": null, "return_1y": null, "return_5y": null, "low_52w": 3.48, "high_52w": 3.86, "volatility_30d": null, "price_rows": 62, "days_stale": 2 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/indices/sparklines": { "get": { "summary": "Benchmark sparklines", "description": "Batch benchmark sparklines, keyed by uppercase registry symbol. Each array contains the same listing-currency closes as the 2Y prices route, including its up-to-200-bar moving-average lookback prefix. Unknown, inactive and unpriced symbols are omitted.", "operationId": "get-benchmark-sparklines", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "symbols", "in": "query", "description": "Up to 64 index symbols total, comma-separated or repeated, e.g. SPY,QQQ. Empty or absent symbols return an empty map. Each registry symbol is 1–16 letters, digits, dots, underscores or dashes and starts with a letter or digit.", "schema": { "type": "array", "maxItems": 64, "items": { "type": "string", "pattern": "^[A-Za-z0-9][A-Za-z0-9._-]{0,15}$" } }, "style": "form", "explode": false } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "sparklines" ], "properties": { "sparklines": { "type": "object", "additionalProperties": { "type": "array", "items": { "type": "number" } } } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/indices/{symbol}": { "get": { "summary": "Benchmark detail", "description": "One benchmark.", "operationId": "get-benchmark-detail", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "description": "Index / ETF symbol, e.g. SPY.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "index": { "type": "object", "properties": { "symbol": { "type": "string" }, "name": { "type": "string" }, "short_name": { "type": "string" }, "category": { "type": "string" }, "benchmark_role": { "type": "string" }, "sector_key": { "type": "null" }, "index_family": { "type": "string" }, "issuer": { "type": "string" }, "expense_ratio": { "type": "number" }, "inception_date": { "type": "string", "format": "date" }, "currency": { "type": "string" }, "listing_currency": { "type": "string" }, "return_basis": { "type": "string" }, "last_price": { "type": "number" }, "last_price_date": { "type": "string", "format": "date" }, "return_1d": { "type": "number" }, "return_1w": { "type": "number" }, "return_1m": { "type": "number" }, "return_ytd": { "type": "number" }, "return_1y": { "type": "number" }, "return_5y": { "type": "number" }, "low_52w": { "type": "number" }, "high_52w": { "type": "number" }, "volatility_30d": { "type": "number" }, "price_rows": { "type": "integer" }, "days_stale": { "type": "integer" }, "bars": { "type": "array", "items": { "type": "object", "properties": { "t": { "type": "integer" }, "o": { "type": "number" }, "h": { "type": "number" }, "l": { "type": "number" }, "c": { "type": "number" }, "v": { "type": "integer" } } } }, "members": { "type": "array", "items": { "type": "object", "properties": { "company_id": { "type": "string" }, "cik": { "type": "string" }, "symbol": { "type": "string" }, "name": { "type": "string" }, "sector": { "type": "string" }, "listing_currency": { "type": "string" }, "website": { "type": "string" }, "brandMark": { "type": "string" }, "brandMarkChecked": { "type": "boolean" }, "logoUrl": { "type": [ "string", "null" ] }, "last_price": { "type": "number" }, "return_1d": { "type": "number" }, "return_1m": { "type": "number" }, "return_ytd": { "type": "number" }, "market_cap": { "type": "integer" } } } }, "members_source": { "type": "string" }, "members_as_of": { "type": "string", "format": "date" }, "members_roster_count": { "type": "integer" }, "members_are_proxy": { "type": "boolean" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "index": { "symbol": "SPY", "name": "SPDR S&P 500 ETF Trust", "short_name": "S&P 500", "category": "broad_market", "benchmark_role": "market", "sector_key": null, "index_family": "S&P 500", "issuer": "State Street", "expense_ratio": 0.0945, "inception_date": "1993-01-22", "currency": "USD", "listing_currency": "USD", "return_basis": "total_return", "last_price": 755.719971, "last_price_date": "2026-10-30", "return_1d": -0.017729040066985058, "return_1w": -0.005592326226268707, "return_1m": -0.009060794821467821, "return_ytd": 0.11687981112416601, "return_1y": 0.12362377065638386, "return_5y": 0.759379957248546, "low_52w": 629.280029, "high_52w": 781.619995, "volatility_30d": 0.11143032453359386, "price_rows": 8497, "days_stale": 2, "bars": [ { "t": 1478044800000, "o": 210.649994, "h": 211.100006, "l": 209.229996, "c": 209.740005, "v": 103330800 }, { "t": 1479686400000, "o": 219.169998, "h": 220.179993, "l": 219, "c": 220.149994, "v": 72402600 } ], "members": [ { "company_id": "0ad3537d-49af-43c9-9065-9593fcb9e62f", "cik": "0000320193", "symbol": "AAPL", "name": "Apple Inc.", "sector": "Technology", "listing_currency": "USD", "website": "https://www.apple.com", "brandMark": "https://cdn.brandfetch.io/apple.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brandMarkChecked": true, "logoUrl": "/api/v1/companies/AAPL/logo", "last_price": 348.910004, "return_1d": 0.014774793334125347, "return_1m": 0.05922893246925809, "return_ytd": 0.2869114658144942, "market_cap": 5034686918690 }, { "company_id": "2d4cb1c6-028f-460f-a403-0b61fc8f5935", "cik": "0001868275", "symbol": "CEG", "name": "Constellation Energy Corp", "sector": "Utilities", "listing_currency": "USD", "website": "https://www.constellationenergy.com", "brandMark": "https://cdn.brandfetch.io/constellationenergy.com/icon?c=1idQJ_8ukVnXwK_PLYs&fallback=404", "brandMarkChecked": true, "logoUrl": null, "last_price": 264.579987, "return_1d": 0.02518599010933764, "return_1m": 0, "return_ytd": -0.24773097818963352, "market_cap": 93144900000 } ], "members_source": "constituents", "members_as_of": "2026-07-25", "members_roster_count": 500, "members_are_proxy": false } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/indices/{symbol}/prices": { "get": { "summary": "Benchmark prices", "description": "Daily bars for a benchmark.", "operationId": "get-benchmark-prices", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "description": "Index / ETF symbol.", "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "Lookback window.", "schema": { "type": "string", "enum": [ "1M", "3M", "6M", "YTD", "1Y", "2Y", "5Y", "ALL" ], "default": "1Y", "x-case-insensitive": true } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string" }, "bars": { "type": "array", "items": { "type": "object", "properties": { "t": { "type": "integer" }, "o": { "type": "number" }, "h": { "type": "number" }, "l": { "type": "number" }, "c": { "type": "number" }, "v": { "type": "integer" }, "adj": { "type": "number" } } } }, "displayFrom": { "type": "integer" }, "currency": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "symbol": "SPY", "bars": [ { "t": 1765497600000, "o": 688.169983, "h": 688.880005, "l": 679.169983, "c": 681.76001, "v": 113160300, "adj": 674.483248 }, { "t": 1768348800000, "o": 691, "h": 691.719971, "l": 686.039978, "c": 690.359985, "v": 94676700, "adj": 685.009591 } ], "displayFrom": 1790812800000, "currency": "USD" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/commodities": { "get": { "summary": "List commodities & compute", "description": "Commodity and compute instruments (including GPU rental prices). World Bank Pink Sheet rows carry an `attribution` (CC BY 4.0) to display.", "operationId": "get-list-commodities-compute", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "asset_class", "in": "query", "description": "Which asset class to list; one class per call, because the columns differ (a compute row carries a GPU spec sheet, a physical row carries a benchmark and unit).", "schema": { "type": "string", "enum": [ "compute", "energy", "metals", "agriculture", "other" ], "default": "compute" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "commodities": { "type": "array", "items": { "type": "object", "properties": { "listed_as": { "type": "array", "items": { "type": "string" } }, "symbol": { "type": "string" }, "name": { "type": "string" }, "short_name": { "type": "string" }, "asset_class": { "type": "string" }, "category": { "type": "string" }, "tier": { "type": "string" }, "parent_symbol": { "type": [ "string", "null" ] }, "host_code": { "type": [ "string", "null" ] }, "instance_family": { "type": [ "string", "null" ] }, "vendor": { "type": [ "string", "null" ] }, "unit": { "type": "string" }, "attributes": { "type": "object", "properties": { "basis": { "type": "string" }, "board": { "type": "string" }, "source": { "type": "string" }, "section": { "type": "string" }, "benchmark": { "type": "string" }, "daily_series_licensed": { "type": "string" }, "country": { "type": "string" }, "vram_gb": { "type": "integer" }, "form_factor": { "type": "string" }, "architecture": { "type": "string" }, "interconnect": { "type": "string" }, "gpu": { "type": "string" } } }, "provider": { "type": "string" }, "premium_vs_reference": { "type": [ "number", "null" ] }, "spec": { "type": [ "object", "null" ], "properties": { "chip": { "type": "string" }, "tdp_w": { "type": "integer" }, "die_mm2": { "type": [ "integer", "null" ] }, "vram_gb": { "type": "integer" }, "fp8_tflops": { "type": "integer" }, "process_nm": { "type": "integer" }, "form_factor": { "type": "string" }, "fp16_tflops": { "type": "number" }, "launch_date": { "type": "string", "format": "date" }, "memory_type": { "type": "string" }, "spec_source": { "type": "string" }, "architecture": { "type": "string" }, "manufacturer": { "type": "string" }, "mem_bus_bits": { "type": [ "integer", "null" ] }, "bandwidth_gbs": { "type": "integer" }, "transistors_m": { "type": "integer" }, "spec_source_url": { "type": "string" }, "launch_price_usd": { "type": [ "integer", "null" ] }, "launch_price_note": { "type": "string" } } }, "hosts": { "type": "array", "items": { "type": "object", "properties": { "host_code": { "type": "string" }, "host_name": { "type": "string" }, "company_ticker": { "type": [ "string", "null" ] }, "company_name": { "type": [ "string", "null" ] }, "company_website": { "type": [ "string", "null" ] }, "instance_family": { "type": "string" }, "gpus_per_instance": { "type": [ "integer", "null" ] }, "vram_variant_gb": { "type": "integer" }, "notes": { "type": "string" }, "url": { "type": "string" } } } }, "last_price": { "type": "number" }, "last_price_date": { "type": "string", "format": "date" }, "return_1d": { "type": "null" }, "return_ytd": { "type": [ "number", "null" ] }, "return_1y": { "type": [ "number", "null" ] }, "volatility_30d": { "type": [ "number", "null" ] }, "price_rows": { "type": "integer" }, "days_stale": { "type": "integer" }, "stale_after_days": { "type": "integer" }, "frequency": { "type": "string" }, "prev_price": { "type": "number" }, "prev_price_date": { "type": "string", "format": "date" }, "return_prev": { "type": "number" }, "return_1m": { "type": "number" }, "high_52w": { "type": "number" }, "low_52w": { "type": "number" }, "gflops_per_watt": { "type": [ "number", "null" ] }, "usd_per_pflop_hour": { "type": [ "number", "null" ] }, "launch_usd_per_tflops": { "type": [ "number", "null" ] }, "closes": { "type": "array", "items": { "type": "number" } }, "display_order": { "type": "integer" }, "attribution": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "commodities": [ { "listed_as": [], "symbol": "GOLD", "name": "Gold", "short_name": "Gold", "asset_class": "metals", "category": "precious", "tier": "reference", "parent_symbol": null, "host_code": null, "instance_family": null, "vendor": null, "unit": "USD per troy ounce", "attributes": { "basis": "monthly average", "board": "precious", "source": "World Bank", "section": "benchmarks", "benchmark": "World Bank monthly average of daily spot rates", "daily_series_licensed": "LBMA:GOLD_PM" }, "provider": "WORLDBANK", "premium_vs_reference": null, "spec": null, "hosts": [], "last_price": 4319, "last_price_date": "2026-09-01", "return_1d": null, "return_ytd": 0.0023207240659086636, "return_1y": 0.05676535356006851, "volatility_30d": null, "price_rows": 801, "days_stale": 61, "stale_after_days": 70, "frequency": "M", "prev_price": 4411, "prev_price_date": "2026-08-01", "return_prev": -0.020856948537746556, "return_1m": -0.020856948537746556, "high_52w": 5020, "low_52w": 4058, "gflops_per_watt": null, "usd_per_pflop_hour": null, "launch_usd_per_tflops": null, "closes": [ 2651, 2648 ], "display_order": 3010, "attribution": "Source: World Bank Commodity Price Data (The Pink Sheet), CC BY 4.0" }, { "listed_as": [], "symbol": "IRONORE", "name": "Iron ore", "short_name": "Iron ore", "asset_class": "metals", "category": "ferrous", "tier": "reference", "parent_symbol": null, "host_code": null, "instance_family": null, "vendor": null, "unit": "USD per dry metric ton", "attributes": { "basis": "monthly average", "board": "industrial", "source": "World Bank", "country": "CN", "section": "ferrous", "benchmark": "Fines 62% Fe, CFR China" }, "provider": "WORLDBANK", "premium_vs_reference": null, "spec": null, "hosts": [], "last_price": 97.7, "last_price_date": "2026-09-01", "return_1d": null, "return_ytd": -0.06596558317399615, "return_1y": -0.04682926829268286, "volatility_30d": null, "price_rows": 801, "days_stale": 61, "stale_after_days": 70, "frequency": "M", "prev_price": 96.3, "prev_price_date": "2026-08-01", "return_prev": 0.014537902388369828, "return_1m": 0.014537902388369828, "high_52w": 108.6, "low_52w": 96.3, "gflops_per_watt": null, "usd_per_pflop_hour": null, "launch_usd_per_tflops": null, "closes": [ 100.5, 97 ], "display_order": 3210, "attribution": "Source: World Bank Commodity Price Data (The Pink Sheet), CC BY 4.0" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/commodities/fundamentals": { "get": { "summary": "Commodity fundamentals", "description": "Non-price commodity series for an asset class — US petroleum inventories and crude production (EIA WPSR) — with the change on the previous report, on a year earlier, and vs the five-year average.", "operationId": "get-commodity-fundamentals", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "asset_class", "in": "query", "description": "Asset class. Default energy.", "schema": { "type": "string", "enum": [ "energy", "metals", "agriculture", "other" ], "default": "energy" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "fundamentals": { "type": "array", "items": { "type": "object", "properties": { "series_id": { "type": "string" }, "indicator_code": { "type": "string" }, "name": { "type": "string" }, "title": { "type": "string" }, "group": { "type": "string" }, "provider": { "type": "string" }, "external_series_id": { "type": "string" }, "release": { "type": "string" }, "units": { "type": "string" }, "units_short": { "type": "string" }, "frequency": { "type": "string" }, "value_kind": { "type": "string" }, "closes": { "type": "array", "items": { "type": "integer" } }, "last": { "type": "integer" }, "last_date": { "type": "string", "format": "date" }, "change_prev": { "type": "integer" }, "prev_date": { "type": "string", "format": "date" }, "change_1y": { "type": "integer" }, "avg_5y": { "type": [ "integer", "null" ] }, "vs_5y": { "type": [ "number", "null" ] } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "fundamentals": [ { "series_id": "6110", "indicator_code": "PETROLEUM_STOCKS_CRUDE_EXSPR", "name": "Crude oil stocks excluding SPR", "title": "U.S. Ending Stocks of Crude Oil Excluding SPR", "group": "US petroleum inventories", "provider": "EIA", "external_series_id": "PET.WCESTUS1.W", "release": "Weekly Petroleum Status Report", "units": "Thousand Barrels", "units_short": "MBbl", "frequency": "W", "value_kind": "stock", "closes": [ 427658, 429747 ], "last": 410625, "last_date": "2026-10-23", "change_prev": -1892, "prev_date": "2026-10-16", "change_1y": -5341, "avg_5y": 426860, "vs_5y": -0.0380335472988802 }, { "series_id": "6834", "indicator_code": "PETROLEUM_PRODUCTION_CRUDE_MONTHLY", "name": "US crude oil field production (monthly)", "title": "U.S. Field Production of Crude Oil (monthly)", "group": "US crude production", "provider": "EIA", "external_series_id": "PET.MCRFPUS2.M", "release": "Petroleum bulk dataset (PET)", "units": "Thousand Barrels per Day", "units_short": "MBbl/d", "frequency": "M", "value_kind": "flow", "closes": [ 13491, 13530 ], "last": 13965, "last_date": "2026-08-01", "change_prev": 19, "prev_date": "2026-07-01", "change_1y": 130, "avg_5y": null, "vs_5y": null } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/commodities/market-map": { "get": { "summary": "Commodity market map", "description": "The commodity market map: the sector tree (energy, precious and industrial metals, grains, softs, livestock, fertilizers, compute) with each node's price drivers and quoting convention, and under it every benchmark, grade and product a professional terminal shows — with its exchange contract, price-reporting agency, the benchmark a grade is quoted against, and `coverage`: what the platform carries for it (futures > daily > weekly > monthly > pending > not_carried). Energy is mapped first.", "operationId": "get-commodity-market-map", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "asset_class", "in": "query", "description": "Limit to one asset class; omit for the whole tree.", "schema": { "type": "string", "enum": [ "compute", "energy", "metals", "agriculture", "other" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "sectors": { "type": "array", "items": { "type": "object", "properties": { "sector_code": { "type": "string" }, "parent_code": { "type": "null" }, "asset_class": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "price_drivers": { "type": "string" }, "quoting_convention": { "type": "string" }, "children": { "type": "array", "items": { "type": "object", "properties": { "sector_code": { "type": "string" }, "parent_code": { "type": "string" }, "asset_class": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "price_drivers": { "type": "string" }, "quoting_convention": { "type": "string" }, "children": { "type": "array", "items": {} }, "benchmarks": { "type": "array", "items": { "type": "object", "properties": { "benchmark_code": { "type": "string" }, "sector_code": { "type": "string" }, "name": { "type": "string" }, "role": { "type": "string" }, "reference_code": { "type": [ "string", "null" ] }, "location": { "type": "string" }, "quality": { "type": "string" }, "unit": { "type": "string" }, "futures_venue": { "type": [ "string", "null" ] }, "futures_code": { "type": [ "string", "null" ] }, "assessed_by": { "type": [ "string", "null" ] }, "headline_basis": { "type": "string" }, "licence": { "type": "string" }, "free_source": { "type": [ "string", "null" ] }, "is_headline": { "type": "boolean" }, "notes": { "type": [ "string", "null" ] }, "symbols": { "type": "array", "items": { "type": "string" } }, "coverage": { "type": "string" } } } } } } }, "benchmarks": { "type": "array", "items": {} } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "sectors": [ { "sector_code": "energy", "parent_code": null, "asset_class": "energy", "name": "Energy", "description": "Fuels and the markets built on them: crude oil and what it is refined into, natural gas, coal, electricity, carbon allowances and nuclear fuel.", "price_drivers": "Global growth, OPEC+ supply policy, inventories, refinery runs, weather, geopolitics.", "quoting_convention": "Exchange futures are the reference: the front-month settlement is the headline, the forward curve beside it. Physical grades are quoted as a differential to a benchmark.", "children": [ { "sector_code": "energy.crude", "parent_code": "energy", "asset_class": "energy", "name": "Crude oil", "description": "Unrefined oil. Quality varies by density (API gravity: light vs heavy) and sulfur (sweet vs sour); light sweet crude yields more gasoline and diesel and sells at a premium.", "price_drivers": "OPEC+ quotas, US shale output, inventories (Cushing for WTI), refinery demand, shipping disruptions.", "quoting_convention": "A few benchmarks (WTI, Brent, Dubai/Oman) trade as futures; hundreds of grades are priced as benchmark ± differential, and Gulf producers set monthly official selling prices (OSPs).", "children": [], "benchmarks": [ { "benchmark_code": "WTI", "sector_code": "energy.crude", "name": "West Texas Intermediate", "role": "benchmark", "reference_code": null, "location": "Cushing, Oklahoma", "quality": "Light sweet", "unit": "USD per barrel", "futures_venue": "NYMEX", "futures_code": "CL", "assessed_by": null, "headline_basis": "front_month_futures", "licence": "licensed", "free_source": "EIA daily Cushing spot (public domain). Futures: none free since EIA stopped republishing NYMEX settlements on 2024-04-05.", "is_headline": true, "notes": "Physically delivered at Cushing; the April 2020 negative settlement (−$37.63) was a front-month expiry with storage there nearly full.", "symbols": [ "WTI" ], "coverage": "daily" }, { "benchmark_code": "LLS", "sector_code": "energy.crude", "name": "Light Louisiana Sweet", "role": "grade", "reference_code": "WTI", "location": "St. James, Louisiana", "quality": "Light sweet", "unit": "USD per barrel", "futures_venue": null, "futures_code": null, "assessed_by": "Argus", "headline_basis": "differential", "licence": "licensed", "free_source": null, "is_headline": false, "notes": null, "symbols": [], "coverage": "not_carried" } ] }, { "sector_code": "energy.ngl", "parent_code": "energy", "asset_class": "energy", "name": "Natural gas liquids", "description": "Ethane, propane and butane separated from gas streams; petrochemical feedstock and heating fuel.", "price_drivers": "Petrochemical demand, export capacity, winter heating.", "quoting_convention": "Mont Belvieu, Texas is the US hub (cents or dollars per gallon); Saudi Aramco's monthly contract price sets Middle East propane.", "children": [], "benchmarks": [ { "benchmark_code": "PROPANE_MB", "sector_code": "energy.ngl", "name": "Propane, Mont Belvieu", "role": "product", "reference_code": null, "location": "Mont Belvieu, Texas", "quality": "Non-TET propane", "unit": "USD per gallon", "futures_venue": null, "futures_code": null, "assessed_by": "OPIS / Argus", "headline_basis": "assessment", "licence": "licensed", "free_source": "EIA daily spot (public domain).", "is_headline": false, "notes": null, "symbols": [ "PROPANE" ], "coverage": "daily" }, { "benchmark_code": "SAUDI_CP", "sector_code": "energy.ngl", "name": "Saudi Aramco propane contract price", "role": "osp", "reference_code": null, "location": "Ras Tanura, Saudi Arabia", "quality": "Propane", "unit": "USD per tonne", "futures_venue": null, "futures_code": null, "assessed_by": "Saudi Aramco", "headline_basis": "osp", "licence": "unverified", "free_source": null, "is_headline": false, "notes": "Set monthly; the reference for Middle East LPG into Asia.", "symbols": [], "coverage": "not_carried" } ] } ], "benchmarks": [] } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/commodities/futures": { "get": { "summary": "Commodity futures curves", "description": "Continuation futures curves: NYMEX WTI (CL), RBOB (RB), NY Harbor ULSD (HO) and Henry Hub (NG) settlements by position (1 = nearest-expiring), from a CME end-of-day feed. Returns no curves until that feed is licensed and loaded. Contract 1 is the nearest-expiring contract through its last trading day. Each position carries its latest and previous settle and the same position a week and a month earlier.", "operationId": "get-commodity-futures-curves", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "asset_class", "in": "query", "description": "Limit to one asset class; omit for all.", "schema": { "type": "string", "enum": [ "compute", "energy", "metals", "agriculture", "other" ] } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "curves": { "type": "array", "items": {} }, "note": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "curves": [], "note": "No futures curves are served: the CME end-of-day feed they come from is not licensed and loaded yet." } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/commodities/spreads": { "get": { "summary": "Commodity spreads & ratios", "description": "Spreads & ratios for an asset class — crack spreads (3-2-1, gasoline, diesel, jet), Brent–WTI, Brent–Dubai, WCS–WTI, TTF–Henry Hub, gold/silver, copper/gold, soybean/corn, the soybean crush and more — computed from their legs' published prices, only on dates where every leg printed (monthly spreads average each leg by month). Each carries its definition, legs, latest value, previous value, 52-week range and history: by default each history's last year, with a `window` block (`olderTo` reads further back); `view=full` serves five years.", "operationId": "get-commodity-spreads-ratios", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "asset_class", "in": "query", "description": "Asset class.", "schema": { "type": "string", "enum": [ "energy", "metals", "agriculture" ], "default": "energy" } }, { "name": "key", "in": "query", "description": "One spread, e.g. BRENT_WTI: uppercase letters, digits and _ (else 400); unknown key 404.", "schema": { "type": "string" } }, { "name": "view", "in": "query", "description": "`summary`: latest figures, no history. Cannot be combined with from, to, limit or frequency (400). `full`: every spread with its five-year history (no window). Omit for each history's last year.", "schema": { "type": "string", "enum": [ "summary", "full" ] } }, { "name": "from", "in": "query", "description": "First day of each history, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last day of each history, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Latest N points of each history, 1–100000; `window.olderTo` reads further back.", "schema": { "type": "integer", "minimum": 1, "maximum": 100000 } }, { "name": "frequency", "in": "query", "description": "Bar frequency: daily (the default), weekly or monthly (the last close of each week or month).", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "default": "daily" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "spreads": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "unit": { "type": "string" }, "align": { "type": "string" }, "board": { "type": "string" }, "description": { "type": "string" }, "legs": { "type": "array", "items": { "type": "string" } }, "last": { "type": "number" }, "last_date": { "type": "string", "format": "date" }, "prev": { "type": "number" }, "prev_date": { "type": "string", "format": "date" }, "high_52w": { "type": "number" }, "low_52w": { "type": "number" }, "history": { "type": "array", "items": { "type": "object", "properties": { "d": { "type": "string", "format": "date" }, "v": { "type": "number" } } } }, "window": { "type": "object", "properties": { "from": { "type": "null" }, "to": { "type": "null" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "returned": { "type": "integer" }, "olderTo": { "type": "string", "format": "date" } } }, "attribution": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "spreads": [ { "key": "BRENT_WTI", "name": "Brent–WTI", "kind": "difference", "unit": "$/bbl", "align": "daily", "board": "oil", "description": "Brent minus WTI spot. The price of moving US crude to the world market: it widens when US pipelines or export docks are constrained.", "legs": [ "BRENT", "WTI" ], "last": 19.72999999999999, "last_date": "2026-10-27", "prev": 22.870000000000005, "prev_date": "2026-10-26", "high_52w": 37.61999999999999, "low_52w": -2.450000000000003, "history": [ { "d": "2026-10-26", "v": 22.870000000000005 }, { "d": "2026-10-27", "v": 19.72999999999999 } ], "window": { "from": null, "to": null, "limit": 2, "total": 1259, "returned": 2, "olderTo": "2026-10-23" } }, { "key": "BRENT_DUBAI", "name": "Brent–Dubai", "kind": "difference", "unit": "$/bbl", "align": "monthly", "board": "oil", "description": "Light sweet against medium sour crude (monthly). Positive and wide when sour barrels are plentiful — typically when OPEC+ raises output.", "legs": [ "BRENT", "DUBAI" ], "last": 20.85909090909091, "last_date": "2026-09-01", "prev": 11.37599999999999, "prev_date": "2026-08-01", "high_52w": 24.58749999999999, "low_52w": -0.003000000000007219, "history": [ { "d": "2026-08-01", "v": 11.37599999999999 }, { "d": "2026-09-01", "v": 20.85909090909091 } ], "attribution": "Source: World Bank Commodity Price Data (The Pink Sheet), CC BY 4.0", "window": { "from": null, "to": null, "limit": 2, "total": 60, "returned": 2, "olderTo": "2026-07-01" } } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/commodities/positioning": { "get": { "summary": "Commodity positioning (CFTC COT)", "description": "CFTC Commitments of Traders (disaggregated, futures only) for the asset class's futures markets: managed-money and producer net positions, week-on-week change, share of open interest, position in the three-year range, and the weekly managed-money history. Positions at Tuesday's close, published Friday 15:30 ET.", "operationId": "get-commodity-positioning-cftc-cot", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "asset_class", "in": "query", "description": "Asset class; all (default) = every class with a futures market on file.", "schema": { "type": "string", "enum": [ "all", "compute", "energy", "metals", "agriculture", "other" ], "default": "all" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "positioning": { "type": "array", "items": { "type": "object", "properties": { "cftc_code": { "type": "string" }, "market_name": { "type": "string" }, "exchange": { "type": "string" }, "benchmark_code": { "type": "string" }, "sector_code": { "type": "string" }, "contract_unit": { "type": "string" }, "report_date": { "type": "string", "format": "date" }, "open_interest": { "type": "integer" }, "mm_long": { "type": "integer" }, "mm_short": { "type": "integer" }, "mm_net": { "type": "integer" }, "mm_net_change": { "type": "integer" }, "mm_net_pct_oi": { "type": "number" }, "mm_net_range_pos": { "type": "number" }, "prod_net": { "type": "integer" }, "swap_net": { "type": "integer" }, "history": { "type": "array", "items": { "type": "object", "properties": { "d": { "type": "string", "format": "date" }, "v": { "type": "integer" } } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "positioning": [ { "cftc_code": "067651", "market_name": "WTI crude oil", "exchange": "NYMEX", "benchmark_code": "WTI", "sector_code": "energy.crude", "contract_unit": "1,000 barrels", "report_date": "2026-10-27", "open_interest": 1886280, "mm_long": 157433, "mm_short": 126305, "mm_net": 31128, "mm_net_change": -5059, "mm_net_pct_oi": 0.016502322030663527, "mm_net_range_pos": 0, "prod_net": 366392, "swap_net": -469360, "history": [ { "d": "2026-08-18", "v": 87479 }, { "d": "2026-08-25", "v": 84020 } ] }, { "cftc_code": "111659", "market_name": "RBOB gasoline", "exchange": "NYMEX", "benchmark_code": "RBOB", "sector_code": "energy.refined", "contract_unit": "42,000 gallons", "report_date": "2026-10-27", "open_interest": 334170, "mm_long": 98749, "mm_short": 7307, "mm_net": 91442, "mm_net_change": -2270, "mm_net_pct_oi": 0.2736391656941078, "mm_net_range_pos": 0.7286271876442691, "prod_net": -83012, "swap_net": -683, "history": [ { "d": "2026-08-18", "v": 74081 }, { "d": "2026-08-25", "v": 79652 } ] } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/commodities/{symbol}": { "get": { "summary": "Instrument detail", "description": "One instrument with spec and venues. An unknown symbol is a 404.", "operationId": "get-instrument-detail", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "description": "Instrument symbol.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "commodity": { "type": "object", "properties": { "derivatives": { "type": "array", "items": {} }, "listed_as": { "type": "array", "items": {} }, "symbol": { "type": "string" }, "name": { "type": "string" }, "short_name": { "type": "string" }, "asset_class": { "type": "string" }, "category": { "type": "string" }, "tier": { "type": "string" }, "parent_symbol": { "type": "null" }, "host_code": { "type": "null" }, "instance_family": { "type": "null" }, "vendor": { "type": "null" }, "unit": { "type": "string" }, "attributes": { "type": "object", "properties": { "basis": { "type": "string" }, "board": { "type": "string" }, "source": { "type": "string" }, "section": { "type": "string" }, "benchmark": { "type": "string" }, "daily_series_licensed": { "type": "string" } } }, "provider": { "type": "string" }, "premium_vs_reference": { "type": "null" }, "series_id": { "type": "string" }, "external_series_id": { "type": "string" }, "series_title": { "type": "string" }, "spec": { "type": "null" }, "hosts": { "type": "array", "items": {} }, "host_rows": { "type": "array", "items": {} }, "venues": { "type": "array", "items": {} }, "indices": { "type": "array", "items": {} }, "reference": { "type": "null" }, "last_price": { "type": "integer" }, "last_price_date": { "type": "string", "format": "date" }, "return_1d": { "type": "null" }, "return_ytd": { "type": "number" }, "return_1y": { "type": "number" }, "volatility_30d": { "type": "null" }, "price_rows": { "type": "integer" }, "days_stale": { "type": "integer" }, "stale_after_days": { "type": "integer" }, "frequency": { "type": "string" }, "prev_price": { "type": "integer" }, "prev_price_date": { "type": "string", "format": "date" }, "return_prev": { "type": "number" }, "return_1m": { "type": "number" }, "high_52w": { "type": "integer" }, "low_52w": { "type": "integer" }, "gflops_per_watt": { "type": "null" }, "usd_per_pflop_hour": { "type": "null" }, "launch_usd_per_tflops": { "type": "null" }, "closes": { "type": "array", "items": { "type": "integer" } }, "history": { "type": "array", "items": { "type": "object", "properties": { "d": { "type": "string", "format": "date" }, "v": { "type": "integer" } } } }, "display_order": { "type": "integer" }, "attribution": { "type": "string" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "commodity": { "derivatives": [], "listed_as": [], "symbol": "GOLD", "name": "Gold", "short_name": "Gold", "asset_class": "metals", "category": "precious", "tier": "reference", "parent_symbol": null, "host_code": null, "instance_family": null, "vendor": null, "unit": "USD per troy ounce", "attributes": { "basis": "monthly average", "board": "precious", "source": "World Bank", "section": "benchmarks", "benchmark": "World Bank monthly average of daily spot rates", "daily_series_licensed": "LBMA:GOLD_PM" }, "provider": "WORLDBANK", "premium_vs_reference": null, "series_id": "13218", "external_series_id": "CMO_GOLD", "series_title": "Gold (Pink Sheet)", "spec": null, "hosts": [], "host_rows": [], "venues": [], "indices": [], "reference": null, "last_price": 4319, "last_price_date": "2026-09-01", "return_1d": null, "return_ytd": 0.0023207240659086636, "return_1y": 0.05676535356006851, "volatility_30d": null, "price_rows": 801, "days_stale": 61, "stale_after_days": 70, "frequency": "M", "prev_price": 4411, "prev_price_date": "2026-08-01", "return_prev": -0.020856948537746556, "return_1m": -0.020856948537746556, "high_52w": 5020, "low_52w": 4058, "gflops_per_watt": null, "usd_per_pflop_hour": null, "launch_usd_per_tflops": null, "closes": [ 2651, 2648 ], "history": [ { "d": "2024-11-01", "v": 2651 }, { "d": "2024-12-01", "v": 2648 } ], "display_order": 3010, "attribution": "Source: World Bank Commodity Price Data (The Pink Sheet), CC BY 4.0" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/commodities/{symbol}/prices": { "get": { "summary": "Instrument prices", "description": "Daily bars for an instrument (close-only: open, high and low repeat the close; volume is 0). Bars run from the first trading day of `range` to the latest; `lookback` adds earlier bars for moving averages. `coverageFrom` is the first day held; `note` says when the history starts after the range's first day or no bar falls inside it. Bar times `t` are epoch ms at UTC midnight. An unknown symbol is a 404.", "operationId": "get-instrument-prices", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "description": "Instrument symbol.", "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "Window of bars served: from the range's first day (1M = 31 days back, YTD = 1 January) to the latest bar; ALL is the whole history. `rangeFrom` echoes the first day; `displayFrom` is the epoch ms of the first bar inside the range.", "schema": { "type": "string", "enum": [ "1M", "3M", "6M", "YTD", "1Y", "2Y", "5Y", "ALL" ], "default": "1Y", "x-case-insensitive": true } }, { "name": "lookback", "in": "query", "description": "Bars to add before the range's first day, e.g. 200 to draw a 200-day moving average from the first bar. Default 0: only bars inside the range. `lookbackBars` says how many were added.", "schema": { "type": "integer", "minimum": 0, "maximum": 1000, "default": 0 } }, { "name": "from", "in": "query", "description": "First day (default the range's first day), YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last day, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Latest N bars in the window, 1–100000. With from, to, limit or frequency only the window's bars are served, plus `window` and `instrument` blocks; `lookback` does not apply.", "schema": { "type": "integer", "minimum": 1, "maximum": 100000 } }, { "name": "frequency", "in": "query", "description": "Bar frequency: daily (the default), weekly or monthly (the last close of each week or month).", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "default": "daily" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string" }, "bars": { "type": "array", "items": {} }, "displayFrom": { "type": "null" }, "window": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "null" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "returned": { "type": "integer" }, "olderTo": { "type": "string", "format": "date" } } }, "instrument": { "type": "object", "properties": { "symbol": { "type": "string" }, "name": { "type": "string" }, "unit": { "type": "string" }, "asset_class": { "type": "string" }, "provider": { "type": "string" }, "frequency": { "type": "string" }, "series_title": { "type": "string" }, "external_series_id": { "type": "string" } } }, "attribution": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "symbol": "GOLD", "bars": [], "displayFrom": null, "window": { "from": "2026-10-01", "to": null, "limit": 2, "total": 0, "returned": 0, "olderTo": "2026-09-01" }, "instrument": { "symbol": "GOLD", "name": "Gold", "unit": "USD per troy ounce", "asset_class": "metals", "provider": "WORLDBANK", "frequency": "M", "series_title": "Gold (Pink Sheet)", "external_series_id": "CMO_GOLD" }, "attribution": "Source: World Bank Commodity Price Data (The Pink Sheet), CC BY 4.0" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/commodities/{symbol}/mentions": { "get": { "summary": "Instrument mentions", "description": "Earnings-call mentions of the instrument, newest first, at most 10. Mentions are tracked for GPU instruments only; for any other instrument `mentions` is empty and `tracked` is false. An unknown symbol is a 404.", "operationId": "get-instrument-mentions", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "symbol", "in": "path", "required": true, "description": "Instrument symbol.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "mentions": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "company_name": { "type": "string" }, "fiscal_title": { "type": "string" }, "observed_at": { "type": "string", "format": "date" }, "speaker_name": { "type": "string" }, "speaker_role": { "type": "string" }, "sentiment": { "type": "string" }, "is_forward_looking": { "type": "boolean" }, "quote": { "type": "string" } } } }, "tracked": { "type": "boolean" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "mentions": [ { "ticker": "NVDA", "company_name": "NVIDIA Corporation", "fiscal_title": "NVIDIA Corporation - Q1 2027 Earnings Call", "observed_at": "2026-05-20", "speaker_name": "Colette Kress", "speaker_role": "executive", "sentiment": "positive", "is_forward_looking": false, "quote": "The price of renting an H100 has risen 20% year-to-date" }, { "ticker": "NVDA", "company_name": "NVIDIA Corporation", "fiscal_title": "NVIDIA Corporation - Q2 2026 Earnings Call", "observed_at": "2025-08-27", "speaker_name": "Colette Kress", "speaker_role": "executive", "sentiment": "positive", "is_forward_looking": false, "quote": "CoreWeave prepares to bring their GB300 instance to market as they are already seeing 10x more inference performance on reasoning models compared to H100." } ], "tracked": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/fx": { "get": { "summary": "FX reference rates", "description": "FX reference-rate board: every fiat currency against USD (units per 1 USD) at the latest complete weekday, the session before and 1W–10Y back, with two years of weekly closes (Frankfurter central-bank blend).", "operationId": "get-fx-reference-rates", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "base", "in": "query", "description": "ISO 4217 code: the board re-based on this currency (units per 1 base, the base's return against each); unknown currency 404.", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "With base: one region.", "schema": { "type": "string", "enum": [ "majors", "europe", "middle_east", "asia_pacific", "americas", "africa", "other" ] } }, { "name": "codes", "in": "query", "description": "With base: ISO 4217 codes, comma-separated, up to 60.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "board": { "type": "object", "properties": { "asOf": { "type": "string", "format": "date" }, "pointDates": { "type": "object", "properties": { "last": { "type": "string", "format": "date" }, "d1": { "type": "string", "format": "date" }, "w1": { "type": "string", "format": "date" }, "m1": { "type": "string", "format": "date" }, "m3": { "type": "string", "format": "date" }, "m6": { "type": "string", "format": "date" }, "y1": { "type": "string", "format": "date" }, "y2": { "type": "string", "format": "date" }, "y5": { "type": "string", "format": "date" }, "y10": { "type": "string", "format": "date" } } }, "base": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "lastDate": { "type": "string", "format": "date" } } }, "rows": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "name": { "type": "string" }, "region": { "type": "string" }, "last": { "type": "number" }, "returns": { "type": "object", "properties": { "d1": { "type": "number" }, "w1": { "type": "number" }, "m1": { "type": "number" }, "m3": { "type": "number" }, "m6": { "type": "number" }, "y1": { "type": "number" }, "y2": { "type": "number" }, "y5": { "type": "number" }, "y10": { "type": "number" } } }, "spark": { "type": "array", "items": { "type": "number" } }, "lastDate": { "type": "string", "format": "date" }, "stale": { "type": "boolean" } } } } } }, "source": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "note": { "type": "string" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "board": { "asOf": "2026-10-30", "pointDates": { "last": "2026-10-30", "d1": "2026-10-29", "w1": "2026-10-23", "m1": "2026-09-30", "m3": "2026-07-30", "m6": "2026-04-30", "y1": "2025-10-30", "y2": "2024-10-30", "y5": "2021-10-29", "y10": "2016-10-28" }, "base": { "code": "USD", "name": "United States Dollar", "lastDate": "2026-10-30" }, "rows": [ { "code": "EUR", "name": "Euro", "region": "majors", "last": 0.8951, "returns": { "d1": -0.0007925787834474063, "w1": 0.00424090113539477, "m1": 0.016096807882667985, "m3": 0.02479849789338706, "m6": 0.04686385273031357, "y1": 0.03937574751216344, "y2": -0.030416603479278104, "y5": 0.04097130961657003, "y10": -0.021973099070158764 }, "spark": [ 0.91964, 0.92713 ], "lastDate": "2026-10-30", "stale": false }, { "code": "AED", "name": "United Arab Emirates Dirham", "region": "middle_east", "last": 3.6725, "returns": { "d1": 0, "w1": 0, "m1": 0, "m3": 0, "m6": 0, "y1": 0, "y2": 0, "y5": 0, "y10": 0 }, "spark": [ 3.6725, 3.6725 ], "lastDate": "2026-10-30", "stale": false } ] }, "source": { "name": "Frankfurter", "url": "https://frankfurter.dev", "note": "Blended reference rates from central banks and official publishers." } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/fx/pairs/{pair}/prices": { "get": { "summary": "FX pair prices", "description": "Daily closes of one currency pair (units of the quote per 1 base; close-only, volume 0). Bars run from the first trading day of `range` to the latest; `lookback` adds earlier bars for moving averages. `coverageFrom` is the first day held; `note` says when the history starts after the range's first day or no bar falls inside it. Bar times `t` are epoch ms at UTC midnight. A pair with no rates held is a 404.", "operationId": "get-fx-pair-prices", "tags": [ "Market Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "pair", "in": "path", "required": true, "description": "Two ISO 4217 codes, e.g. USDCAD.", "schema": { "type": "string" } }, { "name": "range", "in": "query", "description": "Window of bars served: from the range's first day (1M = 31 days back, YTD = 1 January) to the latest bar; ALL is the whole history. `rangeFrom` echoes the first day; `displayFrom` is the epoch ms of the first bar inside the range.", "schema": { "type": "string", "enum": [ "1M", "3M", "6M", "YTD", "1Y", "2Y", "5Y", "ALL" ], "default": "1Y", "x-case-insensitive": true } }, { "name": "lookback", "in": "query", "description": "Bars to add before the range's first day, e.g. 200 to draw a 200-day moving average from the first bar. Default 0: only bars inside the range. `lookbackBars` says how many were added.", "schema": { "type": "integer", "minimum": 0, "maximum": 1000, "default": 0 } }, { "name": "from", "in": "query", "description": "First day (default the range's first day), YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last day, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Latest N bars in the window, 1–100000. With from, to, limit or frequency exactly the window's bars are served, plus a `window` block; `lookback` does not apply.", "schema": { "type": "integer", "minimum": 1, "maximum": 100000 } }, { "name": "frequency", "in": "query", "description": "Bar frequency: daily (the default), weekly or monthly (the last close of each week or month).", "schema": { "type": "string", "enum": [ "daily", "weekly", "monthly" ], "default": "daily" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "symbol": { "type": "string" }, "bars": { "type": "array", "items": { "type": "object", "properties": { "t": { "type": "integer" }, "o": { "type": "number" }, "h": { "type": "number" }, "l": { "type": "number" }, "c": { "type": "number" }, "v": { "type": "integer" }, "adj": { "type": "number" } } } }, "displayFrom": { "type": "integer" }, "currency": { "type": "string" }, "coverageFrom": { "type": "string", "format": "date" }, "window": { "type": "object", "properties": { "from": { "type": "string", "format": "date" }, "to": { "type": "null" }, "limit": { "type": "integer" }, "total": { "type": "integer" }, "returned": { "type": "integer" }, "olderTo": { "type": "string", "format": "date" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "symbol": "EURUSD", "bars": [ { "t": 1793232000000, "o": 1.1163081457005393, "h": 1.1163081457005393, "l": 1.1163081457005393, "c": 1.1163081457005393, "v": 0, "adj": 1.1163081457005393 }, { "t": 1793318400000, "o": 1.1171936096525528, "h": 1.1171936096525528, "l": 1.1171936096525528, "c": 1.1171936096525528, "v": 0, "adj": 1.1171936096525528 } ], "displayFrom": 1793232000000, "currency": "USD", "coverageFrom": "1999-01-01", "window": { "from": "2026-10-01", "to": null, "limit": 2, "total": 22, "returned": 2, "olderTo": "2026-10-28" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/people": { "get": { "summary": "People registry", "description": "People registry: corporate insiders (Section 16), government officeholders and central bankers. Paged: the body carries `rows`, `total`, `limit`, `offset`, `hasMore` and `nextOffset` (null on the last page), and for the corporate segment `asOf` (when the registry rollup was read; it is cached for ten minutes). Every value is checked: a bad one is a 400 naming it.", "operationId": "get-people-registry", "tags": [ "Ownership & Insiders" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "search", "in": "query", "description": "Name or ticker contains (case-insensitive); at most 200 characters.", "schema": { "type": "string" } }, { "name": "segment", "in": "query", "description": "Population.", "schema": { "type": "string", "enum": [ "corporate", "government", "central_bank" ], "default": "corporate" } }, { "name": "ticker", "in": "query", "description": "People with a seat at this company (exact ticker).", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Subset of corporate filers: people (humans only), officers, directors, institutions. Ignored for segment=government|central_bank.", "schema": { "type": "string", "enum": [ "people", "officers", "directors", "institutions" ], "default": "people" } }, { "name": "currentOnly", "in": "query", "description": "1 = only people with a seat filing in the last two years (officials: in office now).", "schema": { "type": "string", "enum": [ "0", "1", "true", "false" ], "default": "0" } }, { "name": "sort", "in": "query", "description": "Order; every order ends on the CIK, so offset paging is stable. Corporate segment only (officials are listed in their institution's chart order).", "schema": { "type": "string", "enum": [ "featured", "recent", "name", "companies", "accuracy" ], "default": "featured" } }, { "name": "limit", "in": "query", "description": "Page size, 1–200.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 50 } }, { "name": "offset", "in": "query", "description": "Rows to skip: the previous `nextOffset`.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "universe", "in": "query", "description": "0 leaves out the `universe` block (registry-wide counts; null when left out).", "schema": { "type": "string", "enum": [ "1", "0", "true", "false" ], "default": "1" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "items": { "type": "object", "properties": { "personCik": { "type": "string" }, "name": { "type": "string" }, "personType": { "type": "string" }, "secName": { "type": "string" }, "photoUrl": { "type": "string" }, "primaryTicker": { "type": "string" }, "primaryCompanyName": { "type": "string" }, "primaryTitle": { "type": "string" }, "isOfficer": { "type": "boolean" }, "isDirector": { "type": "boolean" }, "isTenPercentOwner": { "type": "boolean" }, "companyCount": { "type": "integer" }, "tickers": { "type": "array", "items": { "type": "string" } }, "firstFilingDate": { "type": "string", "format": "date" }, "lastFilingDate": { "type": "string", "format": "date" }, "isCurrent": { "type": "boolean" }, "sharesHeld": { "type": "number" }, "positions": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "shares": { "type": "number" } } } }, "predictions": { "type": "integer" }, "verified": { "type": "integer" }, "hits": { "type": "integer" }, "hitRate": { "type": [ "number", "null" ] }, "sufficient": { "type": "boolean" }, "avgAbsError": { "type": [ "number", "null" ] }, "calls": { "type": "integer" }, "observations": { "type": "integer" } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" }, "asOf": { "type": "string", "format": "date-time" }, "universe": { "type": "object", "properties": { "people": { "type": "integer" }, "officers": { "type": "integer" }, "directors": { "type": "integer" }, "institutions": { "type": "integer" }, "withScorecard": { "type": "integer" }, "speakers": { "type": "integer" }, "government": { "type": "integer" }, "centralBank": { "type": "integer" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "rows": [ { "personCik": "0001588670", "name": "Colette Kress", "personType": "executive", "secName": "Kress Colette", "photoUrl": "/api/v1/people/0001588670/photo", "primaryTicker": "NVDA", "primaryCompanyName": "NVIDIA CORP", "primaryTitle": "EVP & Chief Financial Officer", "isOfficer": true, "isDirector": false, "isTenPercentOwner": false, "companyCount": 1, "tickers": [ "NVDA" ], "firstFilingDate": "2013-10-09", "lastFilingDate": "2026-09-18", "isCurrent": true, "sharesHeld": 4775733, "positions": [ { "ticker": "NVDA", "shares": 4775733 } ], "predictions": 78, "verified": 78, "hits": 40, "hitRate": 0.5128205128205128, "sufficient": true, "avgAbsError": 0.039257602564102566, "calls": 27, "observations": 4226 }, { "personCik": "0001844763", "name": "Andre Schulten", "personType": "executive", "secName": "Schulten Andre", "photoUrl": "/api/v1/people/0001844763/photo", "primaryTicker": "PG", "primaryCompanyName": "PROCTER & GAMBLE Co", "primaryTitle": "Chief Financial Officer", "isOfficer": true, "isDirector": true, "isTenPercentOwner": false, "companyCount": 2, "tickers": [ "PG", "ETN" ], "firstFilingDate": "2021-03-02", "lastFilingDate": "2026-10-06", "isCurrent": true, "sharesHeld": 73222.4287, "positions": [ { "ticker": "PG", "shares": 73222.4287 } ], "predictions": 0, "verified": 0, "hits": 0, "hitRate": null, "sufficient": false, "avgAbsError": null, "calls": 22, "observations": 5157 } ], "total": 24240, "offset": 0, "limit": 2, "hasMore": true, "nextOffset": 2, "asOf": "2026-11-01T12:46:09.448Z", "universe": { "people": 24240, "officers": 15997, "directors": 11043, "institutions": 2969, "withScorecard": 20, "speakers": 414, "government": 3213, "centralBank": 265 } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/people/{cik}": { "get": { "summary": "Person profile", "description": "One person: roles, tenure, holdings.", "operationId": "get-person-profile", "tags": [ "Ownership & Insiders" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "cik", "in": "path", "required": true, "description": "Reporting-owner CIK.", "schema": { "type": "string" } }, { "name": "sections", "in": "query", "description": "Comma-separated: roles, insider, scorecard, statements, speech, shareholder_votes, leadership, office. Without it the whole person.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "With sections: page size of the long lists (predictions, statementCalls, votes, leadershipEvents), 1–100, default 20. Without sections, limit/offset are a 400.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "offset", "in": "query", "description": "With sections: rows to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "person": { "type": "object", "properties": { "publicOffice": { "type": "null" }, "personId": { "type": "string" }, "personType": { "type": "string" }, "personCik": { "type": "string" }, "secName": { "type": "string" }, "displayName": { "type": "string" }, "photoUrl": { "type": "null" }, "aliases": { "type": "array", "items": { "type": "string" } }, "votes": { "type": "array", "items": {} }, "speech": { "type": "array", "items": {} }, "roles": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "companyName": { "type": "string" }, "companyId": { "type": "string" }, "officerTitle": { "type": "null" }, "isDirector": { "type": "boolean" }, "isOfficer": { "type": "boolean" }, "firstFilingDate": { "type": "string", "format": "date" }, "lastFilingDate": { "type": "string", "format": "date" }, "isCurrent": { "type": "boolean" } } } }, "accuracy": { "type": "null" }, "predictions": { "type": "array", "items": {} }, "timeline": { "type": "array", "items": {} }, "funnel": { "type": "object", "properties": { "tracked": { "type": "integer" }, "reconciled": { "type": "integer" }, "verified": { "type": "integer" }, "held": { "type": "integer" } } }, "perSeat": { "type": "array", "items": {} }, "statementCalls": { "type": "array", "items": {} }, "insiderSummary": { "type": "object", "properties": { "last12mCount": { "type": "integer" }, "planCount": { "type": "integer" }, "discretionaryCount": { "type": "integer" } } }, "verifiedSummary": { "type": "object", "properties": { "verifiedCount": { "type": "integer" }, "issuerCount": { "type": "integer" }, "lastAuditNote": { "type": "string" } } }, "positions": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "companyName": { "type": "string" }, "totalShares": { "type": "integer" }, "asOfDate": { "type": "string", "format": "date" } } } }, "transactions": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "transactionDate": { "type": "string", "format": "date" }, "transactionCode": { "type": "string" }, "acquiredDisposed": { "type": "string" }, "shares": { "type": "integer" }, "pricePerShare": { "type": "number" }, "value": { "type": "number" }, "isDerivative": { "type": "boolean" }, "is10b51": { "type": "boolean" }, "securityTitle": { "type": "string" } } } }, "transactionCount": { "type": "integer" }, "leadershipEvents": { "type": "array", "items": {} } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "person": { "publicOffice": null, "personId": "6762", "personType": "organization", "personCik": "0001045810", "secName": "NVIDIA CORP", "displayName": "Corp Nvidia", "photoUrl": null, "aliases": [ "NVIDIA CORP" ], "votes": [], "speech": [], "roles": [ { "ticker": "CRWV", "companyName": "CoreWeave, Inc.", "companyId": "b57689f3-3561-405f-881a-b8027ae75940", "officerTitle": null, "isDirector": false, "isOfficer": false, "firstFilingDate": "2026-01-26", "lastFilingDate": "2026-01-26", "isCurrent": true } ], "accuracy": null, "predictions": [], "timeline": [], "funnel": { "tracked": 0, "reconciled": 0, "verified": 0, "held": 0 }, "perSeat": [], "statementCalls": [], "insiderSummary": { "last12mCount": 0, "planCount": 0, "discretionaryCount": 0 }, "verifiedSummary": { "verifiedCount": 512, "issuerCount": 10, "lastAuditNote": "audit #5 · 2026-08-01 · 63/63 individually verified" }, "positions": [ { "ticker": "CRWV", "companyName": "CoreWeave, Inc.", "totalShares": 47213353, "asOfDate": "2026-01-23" } ], "transactions": [ { "ticker": "SERV", "transactionDate": "2024-04-22", "transactionCode": "J", "acquiredDisposed": "A", "shares": 1050129, "pricePerShare": 2.42, "value": 2541312.1799999997, "isDerivative": false, "is10b51": false, "securityTitle": "Common Stock" }, { "ticker": "SERV", "transactionDate": "2023-07-31", "transactionCode": "P", "acquiredDisposed": "A", "shares": 62500, "pricePerShare": 4, "value": 250000, "isDerivative": false, "is10b51": false, "securityTitle": "Common Stock" } ], "transactionCount": 2, "leadershipEvents": [] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/people/{cik}/photo": { "get": { "summary": "Person photo", "description": "Person photo.", "operationId": "get-person-photo", "tags": [ "Ownership & Insiders" ], "x-tier": "public", "security": [], "parameters": [ { "name": "cik", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/people/{cik}/transactions": { "get": { "summary": "Person transactions", "description": "Insider transactions filed by this person.", "operationId": "get-person-transactions", "tags": [ "Ownership & Insiders" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "cik", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size, 1–100, default 20. Newest first.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 20 } }, { "name": "offset", "in": "query", "description": "Offset.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "from", "in": "query", "description": "First transaction date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last transaction date, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "codes", "in": "query", "description": "Form 4 transaction codes, comma-separated, e.g. P,S.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "transactions": { "type": "array", "items": { "type": "object", "properties": { "ticker": { "type": "string" }, "transactionDate": { "type": "string", "format": "date" }, "transactionCode": { "type": "string" }, "acquiredDisposed": { "type": "string" }, "shares": { "type": "integer" }, "pricePerShare": { "type": "number" }, "value": { "type": "number" }, "isDerivative": { "type": "boolean" }, "is10b51": { "type": "boolean" }, "securityTitle": { "type": "string" } } } }, "totalCount": { "type": "integer" }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "hasMore": { "type": "boolean" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "transactions": [ { "ticker": "SERV", "transactionDate": "2024-04-22", "transactionCode": "J", "acquiredDisposed": "A", "shares": 1050129, "pricePerShare": 2.42, "value": 2541312.1799999997, "isDerivative": false, "is10b51": false, "securityTitle": "Common Stock" }, { "ticker": "SERV", "transactionDate": "2023-07-31", "transactionCode": "P", "acquiredDisposed": "A", "shares": 62500, "pricePerShare": 4, "value": 250000, "isDerivative": false, "is10b51": false, "securityTitle": "Common Stock" } ], "totalCount": 2, "offset": 0, "limit": 2, "hasMore": false } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/scorecards/executives": { "get": { "summary": "Executive leaderboard", "description": "Executive credibility leaderboard (guidance kept vs missed).", "operationId": "get-executive-leaderboard", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "executives": { "type": "array", "items": { "type": "object", "properties": { "speaker_name": { "type": "string" }, "companies": { "type": "array", "items": { "type": "string" } }, "metrics": { "type": "array", "items": { "type": "string" } }, "n": { "type": "integer" }, "hits": { "type": "integer" }, "hit_rate": { "type": [ "number", "null" ] }, "sufficient": { "type": "boolean" }, "beats": { "type": "integer" }, "shortfalls": { "type": "integer" }, "avg_abs_error": { "type": "number" }, "avg_signed_error": { "type": "number" }, "avg_horizon_days": { "type": "number" }, "last_target_period": { "type": "string", "format": "date" } } } }, "min_predictions_for_rate": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "executives": [ { "speaker_name": "Amy Hood", "companies": [ "MSFT" ], "metrics": [ "cost_of_revenue", "effective_tax_rate" ], "n": 144, "hits": 28, "hit_rate": 0.19444444444444445, "sufficient": true, "beats": 83, "shortfalls": 61, "avg_abs_error": 0.05477642361111111, "avg_signed_error": 0.01678820138888889, "avg_horizon_days": 71.29166666666667, "last_target_period": "2026-06-30" }, { "speaker_name": "Ruth Porat", "companies": [ "GOOGL" ], "metrics": [ "dps" ], "n": 1, "hits": 1, "hit_rate": null, "sufficient": false, "beats": 0, "shortfalls": 0, "avg_abs_error": 0, "avg_signed_error": 0, "avg_horizon_days": 66, "last_target_period": "2024-06-30" } ], "min_predictions_for_rate": 10 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/scorecards/executives/{name}": { "get": { "summary": "Executive scorecard", "description": "One executive's scorecard.", "operationId": "get-executive-scorecard", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "executive": { "type": "object", "properties": { "speaker_name": { "type": "string" }, "companies": { "type": "array", "items": { "type": "string" } }, "metrics": { "type": "array", "items": { "type": "string" } }, "n": { "type": "integer" }, "hits": { "type": "integer" }, "hit_rate": { "type": "number" }, "sufficient": { "type": "boolean" }, "beats": { "type": "integer" }, "shortfalls": { "type": "integer" }, "avg_abs_error": { "type": "number" }, "avg_signed_error": { "type": "number" }, "avg_horizon_days": { "type": "number" }, "last_target_period": { "type": "string", "format": "date" }, "predictions": { "type": "array", "items": { "type": "object", "properties": { "observation_id": { "type": "string" }, "ticker": { "type": "string" }, "cik": { "type": "string" }, "std_key": { "type": "string" }, "kind": { "type": "string" }, "periodicity": { "type": "string" }, "change_basis": { "type": "string" }, "target_period_end": { "type": "string", "format": "date" }, "first_observed_at": { "type": "string", "format": "date" }, "horizon_days": { "type": "integer" }, "guided_low": { "type": "integer" }, "guided_high": { "type": "integer" }, "guided_unit": { "type": "string" }, "realized_value": { "type": "number" }, "within_range": { "type": "boolean" }, "midpoint_error_rel": { "type": "number" }, "reaffirm_count": { "type": "integer" }, "revision_seq": { "type": "integer" }, "speaker_name": { "type": "string" }, "evidence_quote": { "type": "string" }, "concept": { "type": "string" }, "external_id": { "type": "string" } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "executive": { "speaker_name": "Amy Hood", "companies": [ "MSFT" ], "metrics": [ "cost_of_revenue", "effective_tax_rate" ], "n": 144, "hits": 28, "hit_rate": 0.19444444444444445, "sufficient": true, "beats": 83, "shortfalls": 61, "avg_abs_error": 0.05477642361111111, "avg_signed_error": 0.01678820138888889, "avg_horizon_days": 71.29166666666667, "last_target_period": "2026-06-30", "predictions": [ { "observation_id": "281133", "ticker": "MSFT", "cik": "0000789019", "std_key": "cost_of_revenue", "kind": "level_usd", "periodicity": "quarterly", "change_basis": "level", "target_period_end": "2026-06-30", "first_observed_at": "2026-04-29", "horizon_days": 62, "guided_low": 29400000000, "guided_high": 29600000000, "guided_unit": "usd", "realized_value": 29525000000, "within_range": true, "midpoint_error_rel": 0.000847, "reaffirm_count": 0, "revision_seq": 0, "speaker_name": "Amy Hood", "evidence_quote": "we expect COGS of USD 29.4 billion to USD 29.6 billion", "concept": "COGS", "external_id": "26916" }, { "observation_id": "280378", "ticker": "MSFT", "cik": "0000789019", "std_key": "effective_tax_rate", "kind": "margin_pct", "periodicity": "quarterly", "change_basis": "level", "target_period_end": "2025-12-31", "first_observed_at": "2025-10-29", "horizon_days": 63, "guided_low": 19, "guided_high": 19, "guided_unit": "percent", "realized_value": 20.2877, "within_range": false, "midpoint_error_rel": 0.067774, "reaffirm_count": 0, "revision_seq": 0, "speaker_name": "Amy Hood", "evidence_quote": "And we expect our Q2 effective tax rate to be approximately 19%.", "concept": "effective tax rate guidance", "external_id": "8961" } ] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/scorecards/events": { "get": { "summary": "Scored earnings events", "description": "Earnings events with guidance outcomes, newest event first. `newestEventDate` and `newestEventAgeDays` say how current the scored set is; `stalenessNote` appears when the newest scored event is more than 45 days old (later calls are not scored yet).", "operationId": "get-scored-earnings-events", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "ticker", "in": "query", "description": "Filter by ticker.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Events, 1–1000, default 200.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 200 } }, { "name": "withCommitments", "in": "query", "description": "true = only events where at least one guidance commitment came due. It does not embed commitments; read them from /scorecards/events/{id}.", "schema": { "type": "string", "enum": [ "true", "false" ], "default": "false" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "object", "properties": { "document_id": { "type": "string" }, "ticker": { "type": "string" }, "cik": { "type": "string" }, "event_date": { "type": "string", "format": "date" }, "fiscal_year": { "type": "integer" }, "fiscal_quarter": { "type": "integer" }, "timing_class": { "type": "string" }, "abn_mkt_1d": { "type": "number" }, "abn_mkt_5d": { "type": "number" }, "abn_mkt_21d": { "type": "number" }, "abn_mkt_63d": { "type": "null" }, "abn_sec_1d": { "type": "number" }, "ret_1d": { "type": "number" }, "sector_symbol": { "type": "string" }, "resolved": { "type": "integer" }, "kept": { "type": "integer" }, "fidelity_rate": { "type": "null" } } } }, "newestEventDate": { "type": "string", "format": "date" }, "newestEventAgeDays": { "type": "integer" }, "stalenessNote": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "events": [ { "document_id": "34553", "ticker": "GD", "cik": "0000040533", "event_date": "2026-07-29", "fiscal_year": 2026, "fiscal_quarter": 2, "timing_class": "premarket", "abn_mkt_1d": -0.015717, "abn_mkt_5d": -0.060025, "abn_mkt_21d": -0.06245, "abn_mkt_63d": null, "abn_sec_1d": 0.000842, "ret_1d": -0.031105, "sector_symbol": "XLI", "resolved": 0, "kept": 0, "fidelity_rate": null }, { "document_id": "34552", "ticker": "PG", "cik": "0000080424", "event_date": "2026-07-29", "fiscal_year": 2026, "fiscal_quarter": 4, "timing_class": "premarket", "abn_mkt_1d": -0.003285, "abn_mkt_5d": -0.046972, "abn_mkt_21d": -0.060103, "abn_mkt_63d": null, "abn_sec_1d": -0.022119, "ret_1d": -0.018673, "sector_symbol": "XLP", "resolved": 0, "kept": 0, "fidelity_rate": null } ], "newestEventDate": "2026-07-29", "newestEventAgeDays": 95, "stalenessNote": "The newest scored event is 2026-07-29 (95 days ago): calls after it are not scored yet, not missing guidance." } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/scorecards/events/{id}": { "get": { "summary": "Scored event detail", "description": "One scored earnings event.", "operationId": "get-scored-event-detail", "tags": [ "Guidance & Scorecards" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "event": { "type": "object", "properties": { "document_id": { "type": "string" }, "ticker": { "type": "string" }, "cik": { "type": "string" }, "event_date": { "type": "string", "format": "date" }, "fiscal_year": { "type": "integer" }, "fiscal_quarter": { "type": "integer" }, "timing_class": { "type": "string" }, "abn_mkt_1d": { "type": "number" }, "abn_mkt_5d": { "type": "number" }, "abn_mkt_21d": { "type": "number" }, "abn_mkt_63d": { "type": "null" }, "abn_sec_1d": { "type": "number" }, "ret_1d": { "type": "number" }, "sector_symbol": { "type": "string" }, "resolved": { "type": "integer" }, "kept": { "type": "integer" }, "fidelity_rate": { "type": "null" }, "commitments": { "type": "array", "items": {} } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "event": { "document_id": "34553", "ticker": "GD", "cik": "0000040533", "event_date": "2026-07-29", "fiscal_year": 2026, "fiscal_quarter": 2, "timing_class": "premarket", "abn_mkt_1d": -0.015717, "abn_mkt_5d": -0.060025, "abn_mkt_21d": -0.06245, "abn_mkt_63d": null, "abn_sec_1d": 0.000842, "ret_1d": -0.031105, "sector_symbol": "XLI", "resolved": 0, "kept": 0, "fidelity_rate": null, "commitments": [] } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/pulse": { "get": { "summary": "Narrative pulse", "description": "What changed this week: lifecycle transitions, breadth spikes, momentum movers and newly tested causal claims; tickers or sector narrow it to themes those companies raised. Both optional. An empty `items` carries `emptyReason` (e.g. while a management-commentary release serves themes, the registry ranking is not computed).", "operationId": "get-narrative-pulse", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "tickers", "in": "query", "description": "Comma-separated tickers.", "schema": { "type": "string" } }, { "name": "sector", "in": "query", "description": "Sector name.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "asOf": { "type": "string", "format": "date" }, "universe": { "type": "object", "properties": { "activeNarratives": { "type": "integer" }, "issuers": { "type": "integer" }, "supportedObservations": { "type": "integer" }, "claimEdges": { "type": "integer" } } }, "items": { "type": "array", "items": {} }, "emptyReason": { "type": "string" }, "validatedStrip": { "type": "array", "items": { "type": "object", "properties": { "edgeId": { "type": "string" }, "label": { "type": "string" }, "scope": { "type": "string" }, "verdict": { "type": "string" }, "method": { "type": "string" }, "effectLabel": { "type": "string" }, "lagLabel": { "type": "string" }, "nEvents": { "type": "integer" }, "qValue": { "type": "number" }, "testedAt": { "type": "string", "format": "date" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "asOf": "2026-08-26", "universe": { "activeNarratives": 7158, "issuers": 1957, "supportedObservations": 596519, "claimEdges": 14 }, "items": [], "emptyReason": "The pulse ranks the theme registry's daily movers, and the registry is hidden while the management-commentary release gulf-redo7b-2026-10-14 serves themes; no weekly ranking is computed for that relea…", "validatedStrip": [ { "edgeId": "e-dccapex-power", "label": "Data-Center Capex Acceleration → Power & Grid Constraints", "scope": "power equipment & prime-power suppliers", "verdict": "supported", "method": "event_study", "effectLabel": "+19% power-gen orders", "lagLabel": "1Q lag", "nEvents": 12, "qValue": 0.02, "testedAt": "2026-06-28" }, { "edgeId": "e-ai-dccapex", "label": "Surging AI Compute Demand: Training & Inference → Data-Center Capex Acceleration", "scope": "hyperscalers + AI infrastructure buyers", "verdict": "supported", "method": "event_study", "effectLabel": "+38% capex growth YoY", "lagLabel": "1Q lag", "nEvents": 24, "qValue": 0.001, "testedAt": "2026-06-28" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/narratives": { "get": { "summary": "List narratives", "description": "Search, filter and sort the narrative registry (company and policy themes; dormant ones with includeDormant=1). Paged: the body carries `total`, `limit`, `offset`, `hasMore` and `nextOffset`; an empty list carries `emptyReason` (which catalog serves and whom it covers). An unknown `sort`, `source`, `themeScope` or `lifecycle`, or a number out of range, is a 400 naming the parameter.", "operationId": "get-list-narratives", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "search", "in": "query", "description": "Free text over name and description.", "schema": { "type": "string" } }, { "name": "sector", "in": "query", "description": "GICS sector name.", "schema": { "type": "string" } }, { "name": "tickers", "in": "query", "description": "Comma-separated tickers to scope by.", "schema": { "type": "string" } }, { "name": "countries", "in": "query", "description": "Comma-separated ISO alpha-2 issuer domiciles to scope by (e.g. AE,SA,QA,KW).", "schema": { "type": "string" } }, { "name": "ciks", "in": "query", "description": "Comma-separated issuer platform keys to scope by.", "schema": { "type": "string" } }, { "name": "includeDormant", "in": "query", "description": "1 to include themes with no activity in the trailing window (returned as lifecycleState=dormant); 0 (default) leaves them out.", "schema": { "type": "string", "enum": [ "0", "1" ] } }, { "name": "minBreadth", "in": "query", "description": "Minimum companies discussing the theme, 0–50 (default 0 = long tail). Not applied to company or regional themes.", "schema": { "type": "integer", "minimum": 0, "maximum": 50, "default": 0 } }, { "name": "source", "in": "query", "description": "all (default), companies or policy.", "schema": { "type": "string", "enum": [ "all", "companies", "policy" ] } }, { "name": "sort", "in": "query", "description": "relevance (default), breadth, momentum or recent.", "schema": { "type": "string", "enum": [ "relevance", "breadth", "momentum", "recent" ], "default": "relevance" } }, { "name": "limit", "in": "query", "description": "Page size, 1–200, default 40.", "schema": { "type": "integer", "minimum": 1, "maximum": 200, "default": 40 } }, { "name": "offset", "in": "query", "description": "Rows to skip (the previous `nextOffset`), default 0. 0–1000000, default 0.", "schema": { "type": "integer", "minimum": 0, "maximum": 1000000, "default": 0 } }, { "name": "activeOnly", "in": "query", "description": "1 lists only narratives mentioned in the last 28 days.", "schema": { "type": "string", "enum": [ "1", "0" ] } }, { "name": "lifecycle", "in": "query", "description": "Only narratives in this lifecycle state.", "schema": { "type": "string", "enum": [ "emerging", "accelerating", "broadening", "steady", "mature", "fading", "dormant" ] } }, { "name": "themeScope", "in": "query", "description": "Theme breadth: market-wide, regional or single-company themes; default all.", "schema": { "type": "string", "enum": [ "all", "market", "regional", "company" ], "default": "all" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "asOf": { "type": "string", "format": "date" }, "universeTotal": { "type": "integer" }, "policyOnlyTotal": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "narrativeId": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "lifecycleState": { "type": "string" }, "breadth": { "type": "integer" }, "breadthPrevQuarter": { "type": "integer" }, "momentum": { "type": "integer" }, "mentions28d": { "type": "integer" }, "netDirection": { "type": "number" }, "forwardShare": { "type": "number" }, "sectorCount": { "type": "integer" }, "matchedTickers": { "type": "array", "items": { "type": "string" } }, "matchedIssuers": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" } } } }, "matchedCountries": { "type": "array", "items": { "type": "string" } }, "lastActive": { "type": "string", "format": "date" }, "lastRaised": { "type": "string", "format": "date" }, "companyMentions": { "type": "integer" }, "policyMentions": { "type": "integer" }, "policyVoices": { "type": "integer" }, "policyVoiceNames": { "type": "array", "items": {} }, "themeScope": { "type": "string" }, "soleCompany": { "type": "null" } } } }, "total": { "type": "integer" }, "hiddenByFloor": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "asOf": "2026-10-06", "universeTotal": 7158, "policyOnlyTotal": 0, "items": [ { "narrativeId": 10021258, "name": "Regional geopolitical and supply chain disruption affecting project execution", "description": "Operating environment complexity in 2026 driven by regional geopolitical developments combined with ongoing supply chain disruption, creating execution challenges and uncertainty for project-based bus…", "lifecycleState": "accelerating", "breadth": 15, "breadthPrevQuarter": 10, "momentum": 14, "mentions28d": 23, "netDirection": 0.3157894736842105, "forwardShare": 0.08695652173913043, "sectorCount": 5, "matchedTickers": [ "1214", "2010" ], "matchedIssuers": [ { "cik": "XSAU000073", "ticker": "1214" }, { "cik": "XSAU000088", "ticker": "2010" } ], "matchedCountries": [ "SA", "OM" ], "lastActive": "2026-09-22", "lastRaised": "2026-09-22", "companyMentions": 23, "policyMentions": 0, "policyVoices": 0, "policyVoiceNames": [], "themeScope": "market", "soleCompany": null }, { "narrativeId": 10021237, "name": "Strategic revenue diversification toward non-funded income", "description": "Conscious bank-level strategy to build fee-based revenue streams across multiple business lines, reducing reliance on interest income through global markets, investment banking, and transaction servic…", "lifecycleState": "steady", "breadth": 17, "breadthPrevQuarter": 17, "momentum": -11, "mentions28d": 53, "netDirection": 0.8775510204081632, "forwardShare": 0.2830188679245283, "sectorCount": 2, "matchedTickers": [ "1010", "1050" ], "matchedIssuers": [ { "cik": "XSAU000055", "ticker": "1010" }, { "cik": "XSAU000058", "ticker": "1050" } ], "matchedCountries": [ "AE", "SA" ], "lastActive": "2026-08-06", "lastRaised": "2026-08-06", "companyMentions": 53, "policyMentions": 0, "policyVoices": 0, "policyVoiceNames": [], "themeScope": "market", "soleCompany": null } ], "total": 2257, "hiddenByFloor": 0, "limit": 2, "offset": 0, "hasMore": true, "nextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/narratives/facets": { "get": { "summary": "Narrative filter options", "description": "Filter options for narratives: issuer countries and issuers that are members of active themes, with theme counts.", "operationId": "get-narrative-filter-options", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "countries", "in": "query", "description": "Comma-separated ISO alpha-2 codes; restricts the company list only.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "countries": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "themes": { "type": "integer" }, "companies": { "type": "integer" } } } }, "companies": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" }, "country": { "type": "string" }, "themes": { "type": "integer" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "countries": [ { "code": "AE", "themes": 1985, "companies": 41 }, { "code": "QA", "themes": 1926, "companies": 46 } ], "companies": [ { "cik": "XDFM000003", "ticker": "EMIRATESNBD", "name": "Emirates NBD Bank PJSC", "country": "AE", "themes": 222 }, { "cik": "DSMD000005", "ticker": "ORDS", "name": "Ooredoo", "country": "QA", "themes": 205 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/narratives/{id}": { "get": { "summary": "Narrative detail", "description": "One narrative: header, daily metrics, member issuers with join dates and quotes, sector spread and its claim-graph edges.", "operationId": "get-narrative-detail", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "membersLimit", "in": "query", "description": "Members per page, 1–100.", "schema": { "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "membersOffset", "in": "query", "description": "Members to skip. 0–100000, default 0.", "schema": { "type": "integer", "minimum": 0, "maximum": 100000, "default": 0 } }, { "name": "membersSort", "in": "query", "description": "Member order: joined (first joiner first, as served), mentions or recent.", "schema": { "type": "string", "enum": [ "joined", "mentions", "recent" ] } }, { "name": "quotesPerMember", "in": "query", "description": "Quotes per member, 0–30.", "schema": { "type": "integer", "minimum": 0, "maximum": 30 } }, { "name": "member", "in": "query", "description": "One issuer's CIK or platform key. Any members* parameter adds membersTotal, membersOffset and membersNextOffset.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "narrativeId": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "lifecycleState": { "type": "string" }, "breadth": { "type": "integer" }, "sectorCount": { "type": "integer" }, "firstObserved": { "type": "string", "format": "date" }, "lastObserved": { "type": "string", "format": "date" }, "memberObservations": { "type": "integer" }, "netDirection": { "type": "number" }, "forwardShare": { "type": "number" }, "metrics": { "type": "array", "items": { "type": "object", "properties": { "date": { "type": "string", "format": "date" }, "volume": { "type": "integer" }, "volume28d": { "type": "integer" }, "velocity": { "type": "integer" }, "acceleration": { "type": "integer" }, "breadth": { "type": "integer" }, "netDirection": { "type": [ "integer", "null" ] }, "forwardShare": { "type": [ "integer", "null" ] }, "lifecycleState": { "type": "string" } } } }, "members": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "companyName": { "type": "string" }, "sector": { "type": "string" }, "joinedAt": { "type": "string", "format": "date" }, "lastObserved": { "type": "string", "format": "date" }, "observationCount": { "type": "integer" }, "netDirection": { "type": "number" }, "divergent": { "type": "boolean" }, "latestQuote": { "type": "object", "properties": { "observationId": { "type": "integer" }, "quote": { "type": "string" }, "statement": { "type": "string" }, "speakerName": { "type": "string" }, "speakerRole": { "type": "string" }, "ticker": { "type": "string" }, "cik": { "type": "string" }, "companyName": { "type": "string" }, "observedAt": { "type": "string", "format": "date" }, "observationType": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "verificationStatus": { "type": "string" }, "documentId": { "type": "integer" }, "transcriptExternalId": { "type": "string" }, "transcriptDate": { "type": "string", "format": "date" }, "fiscalLabel": { "type": "string" }, "docType": { "type": "string" }, "sourceSpan": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } } }, "relation": { "type": "string" }, "evidenceRole": { "type": "string" } } }, "quotes": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "quote": { "type": "string" }, "statement": { "type": "string" }, "speakerName": { "type": "string" }, "speakerRole": { "type": "string" }, "ticker": { "type": "string" }, "cik": { "type": "string" }, "companyName": { "type": "string" }, "observedAt": { "type": "string", "format": "date" }, "observationType": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "verificationStatus": { "type": "string" }, "documentId": { "type": "integer" }, "transcriptExternalId": { "type": "string" }, "transcriptDate": { "type": "string", "format": "date" }, "fiscalLabel": { "type": "string" }, "docType": { "type": "string" }, "sourceSpan": { "type": "object", "properties": { "start": { "type": "integer" }, "end": { "type": "integer" } } }, "relation": { "type": "string" }, "evidenceRole": { "type": "string" } } } } } } }, "policyVoices": { "type": "array", "items": {} }, "spread": { "type": "array", "items": { "type": "object", "properties": { "sector": { "type": "string" }, "firstMonth": { "type": "string" }, "joins": { "type": "array", "items": { "type": "object", "properties": { "month": { "type": "string" }, "tickers": { "type": "array", "items": { "type": "string" } }, "issuers": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" } } } } } } }, "issuerCount": { "type": "integer" } } } }, "edges": { "type": "array", "items": {} }, "nodes": { "type": "array", "items": {} }, "metricsGrain": { "type": "string" }, "definition": { "type": "object", "properties": { "inclusion": { "type": "string" }, "exclusion": { "type": "string" }, "whyUseful": { "type": "string" } } }, "membersTotal": { "type": "integer" }, "membersOffset": { "type": "integer" }, "membersNextOffset": { "type": "integer" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "narrativeId": 10021258, "name": "Regional geopolitical and supply chain disruption affecting project execution", "description": "Operating environment complexity in 2026 driven by regional geopolitical developments combined with ongoing supply chain disruption, creating execution challenges and uncertainty for project-based bus…", "status": "active", "asOf": "2026-10-06", "lifecycleState": "accelerating", "breadth": 15, "sectorCount": 5, "firstObserved": "2022-11-03", "lastObserved": "2026-09-22", "memberObservations": 23, "netDirection": 0.3157894736842105, "forwardShare": 0.08695652173913043, "metrics": [ { "date": "2022-12-31", "volume": 1, "volume28d": 1, "velocity": 1, "acceleration": 1, "breadth": 1, "netDirection": 1, "forwardShare": 0, "lifecycleState": "emerging" }, { "date": "2023-03-31", "volume": 0, "volume28d": 0, "velocity": -1, "acceleration": -2, "breadth": 1, "netDirection": null, "forwardShare": null, "lifecycleState": "emerging" } ], "members": [ { "cik": "XSAU000096", "ticker": "2082", "companyName": "ACWA Power Company", "sector": "Utilities", "joinedAt": "2022-11-03", "lastObserved": "2023-11-02", "observationCount": 2, "netDirection": 0.5, "divergent": false, "latestQuote": { "observationId": 0, "quote": "At the same time, we know all the context that we believe in high interest rates, inflation, which is subsidizing in some parts, but in some past remains acute particularly when we go to EPC contracts…", "statement": "Operating environment characterized by high interest rates, persistent inflation in EPC contracts, and ongoing supply chain disruptions from COVID and Russia-Ukraine geopolitical tensions", "speakerName": "Marco Arcelli", "speakerRole": "executive", "ticker": "2082", "cik": "XSAU000096", "companyName": "ACWA Power Company", "observedAt": "2023-11-02", "observationType": "current_assessment", "direction": null, "verificationStatus": "supported", "documentId": 36104, "transcriptExternalId": "103809", "transcriptDate": "2023-11-02", "fiscalLabel": "Q3 FY2023", "docType": "earnings_transcript", "sourceSpan": { "start": 7983, "end": 8455 }, "relation": "supports", "evidenceRole": "direct_development" }, "quotes": [ { "observationId": 0, "quote": "At the same time, we know all the context that we believe in high interest rates, inflation, which is subsidizing in some parts, but in some past remains acute particularly when we go to EPC contracts…", "statement": "Operating environment characterized by high interest rates, persistent inflation in EPC contracts, and ongoing supply chain disruptions from COVID and Russia-Ukraine geopolitical tensions", "speakerName": "Marco Arcelli", "speakerRole": "executive", "ticker": "2082", "cik": "XSAU000096", "companyName": "ACWA Power Company", "observedAt": "2023-11-02", "observationType": "current_assessment", "direction": null, "verificationStatus": "supported", "documentId": 36104, "transcriptExternalId": "103809", "transcriptDate": "2023-11-02", "fiscalLabel": "Q3 FY2023", "docType": "earnings_transcript", "sourceSpan": { "start": 7983, "end": 8455 }, "relation": "supports", "evidenceRole": "direct_development" }, { "observationId": 0, "quote": "But realistically, and as you all know, within the framework of sort of unprecedented global geopolitical tensions and significant economic stresses, which are -- there is no end in sight and which ar…", "statement": "Operating in persistent higher cost and interest rate environment with no end in sight, exacerbated by geopolitical tensions, economic stresses, and supply-demand imbalances from war.", "speakerName": "Suntharesan Padmanathan", "speakerRole": "executive", "ticker": "2082", "cik": "XSAU000096", "companyName": "ACWA Power Company", "observedAt": "2022-11-03", "observationType": "current_assessment", "direction": "increasing", "verificationStatus": "supported", "documentId": 36108, "transcriptExternalId": "152013", "transcriptDate": "2022-11-03", "fiscalLabel": "Q3 FY2022", "docType": "earnings_transcript", "sourceSpan": { "start": 4254, "end": 4812 }, "relation": "supports", "evidenceRole": "direct_development" } ] }, { "cik": "XMUS000029", "ticker": "VOES", "companyName": "Voltamp Energy SAOG", "sector": "Industrials", "joinedAt": "2025-03-17", "lastObserved": "2025-03-17", "observationCount": 1, "netDirection": 1, "divergent": false, "latestQuote": { "observationId": 0, "quote": "What are the negative contributors? Concerns are there in terms of supply chain issues. This is continuity -- continuing. There are -- they are impacting our production flow and utilization primarily…", "statement": "Supply chain issues from geopolitical conflicts (Gaza, Ukraine, Red Sea) and steep market demand are impacting production flow and utilization, with suppliers unable to confirm deliveries.", "speakerName": "Sayyid Bin Hamad Al-Busaidi", "speakerRole": "executive", "ticker": "VOES", "cik": "XMUS000029", "companyName": "Voltamp Energy SAOG", "observedAt": "2025-03-17", "observationType": "current_assessment", "direction": "increasing", "verificationStatus": "normalized", "documentId": 58127, "transcriptExternalId": "49767", "transcriptDate": "2025-03-17", "fiscalLabel": "Q4 FY2024", "docType": "earnings_transcript", "sourceSpan": { "start": 10596, "end": 11179 }, "relation": "supports", "evidenceRole": "direct_development" }, "quotes": [ { "observationId": 0, "quote": "What are the negative contributors? Concerns are there in terms of supply chain issues. This is continuity -- continuing. There are -- they are impacting our production flow and utilization primarily…", "statement": "Supply chain issues from geopolitical conflicts (Gaza, Ukraine, Red Sea) and steep market demand are impacting production flow and utilization, with suppliers unable to confirm deliveries.", "speakerName": "Sayyid Bin Hamad Al-Busaidi", "speakerRole": "executive", "ticker": "VOES", "cik": "XMUS000029", "companyName": "Voltamp Energy SAOG", "observedAt": "2025-03-17", "observationType": "current_assessment", "direction": "increasing", "verificationStatus": "normalized", "documentId": 58127, "transcriptExternalId": "49767", "transcriptDate": "2025-03-17", "fiscalLabel": "Q4 FY2024", "docType": "earnings_transcript", "sourceSpan": { "start": 10596, "end": 11179 }, "relation": "supports", "evidenceRole": "direct_development" } ] } ], "policyVoices": [], "spread": [ { "sector": "Utilities", "firstMonth": "2022-11", "joins": [ { "month": "2022-11", "tickers": [ "2082" ], "issuers": [ { "cik": "XSAU000096", "ticker": "2082" } ] } ], "issuerCount": 1 }, { "sector": "Industrials", "firstMonth": "2025-03", "joins": [ { "month": "2025-03", "tickers": [ "VOES" ], "issuers": [ { "cik": "XMUS000029", "ticker": "VOES" } ] }, { "month": "2026-03", "tickers": [ "4142" ], "issuers": [ { "cik": "XSAU000182", "ticker": "4142" } ] } ], "issuerCount": 9 } ], "edges": [], "nodes": [], "metricsGrain": "quarter", "definition": { "inclusion": "Management explicit characterization of operating environment as complex due to regional geopolitical factors and supply chain disruption; evidence of increased provisions for risk management; stateme…", "exclusion": "Generic references to market conditions, routine risk disclosures, company-specific execution issues without external driver attribution, or supply chain mentions without geopolitical context.", "whyUseful": "Analysts assessing duration and severity of regional operating headwinds for project-based industries; evaluating whether disruption is localized or spreading; comparing management confidence in norma…" }, "membersTotal": 15, "membersOffset": 0, "membersNextOffset": 2 } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/company/{id}": { "get": { "summary": "Company intelligence", "description": "Company intelligence summary: theme exposures, causal claims (`causalProfile`), the guidance credibility scorecard. An unknown or unpublished company is a 404 (`code` not_found).", "operationId": "get-company-intelligence", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string" }, "cik": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "exposures": { "type": "array", "items": {} }, "causalProfile": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "causeStatement": { "type": "string" }, "effectStatement": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "observedAt": { "type": "string", "format": "date" }, "quote": { "type": "string" }, "speakerName": { "type": "string" }, "edgeId": { "type": [ "string", "null" ] }, "edgeState": { "type": [ "string", "null" ] }, "validation": { "type": [ "object", "null" ], "properties": { "method": { "type": "string" }, "eventWindow": { "type": "string" }, "effectLabel": { "type": "string" }, "effectSize": { "type": "integer" }, "effectUnit": { "type": "string" }, "lagDays": { "type": "integer" }, "nEvents": { "type": "integer" }, "pValue": { "type": "number" }, "qValue": { "type": "number" }, "verdict": { "type": "string" }, "testedAt": { "type": "string", "format": "date" }, "scope": { "type": "string" }, "note": { "type": "string" } } } } } }, "credibility": { "type": "object", "properties": { "ticker": { "type": "string" }, "score": { "type": "null" }, "sectorPercentile": { "type": "null" }, "scoredCount": { "type": "integer" }, "deliveredCount": { "type": "integer" }, "beatCount": { "type": "integer" }, "missedCount": { "type": "integer" }, "pendingCount": { "type": "integer" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "concept": { "type": "string" }, "guidedAt": { "type": "string", "format": "date" }, "periodLabel": { "type": "string" }, "guidedValue": { "type": "integer" }, "unit": { "type": "string" }, "realizedValue": { "type": [ "integer", "null" ] }, "realizedSource": { "type": [ "string", "null" ] }, "errorPct": { "type": [ "number", "null" ] }, "verdict": { "type": "string" }, "quote": { "type": "string" }, "speakerName": { "type": "string" } } } }, "bestCall": { "type": "object", "properties": { "observationId": { "type": "integer" }, "concept": { "type": "string" }, "guidedAt": { "type": "string", "format": "date" }, "periodLabel": { "type": "string" }, "guidedValue": { "type": "integer" }, "unit": { "type": "string" }, "realizedValue": { "type": "integer" }, "realizedSource": { "type": "string" }, "errorPct": { "type": "number" }, "verdict": { "type": "string" }, "quote": { "type": "string" }, "speakerName": { "type": "string" } } }, "worstCall": { "type": "object", "properties": { "observationId": { "type": "integer" }, "concept": { "type": "string" }, "guidedAt": { "type": "string", "format": "date" }, "periodLabel": { "type": "string" }, "guidedValue": { "type": "integer" }, "unit": { "type": "string" }, "realizedValue": { "type": "integer" }, "realizedSource": { "type": "string" }, "errorPct": { "type": "integer" }, "verdict": { "type": "string" }, "quote": { "type": "string" }, "speakerName": { "type": "string" } } }, "coverageNote": { "type": "string" } } }, "forecast": { "type": "object", "properties": { "ticker": { "type": "string" }, "horizonLabel": { "type": "string" }, "abnormalReturnMeanPct": { "type": "number" }, "abnormalReturnBand": { "type": "array", "items": { "type": "number" } }, "fundamentalMetric": { "type": "string" }, "fundamentalDeltaLabel": { "type": "string" }, "attributions": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string" }, "label": { "type": "string" }, "detail": { "type": "string" }, "weightPct": { "type": "integer" }, "refId": { "type": "string" }, "edgeState": { "type": "string" } } } }, "modelLabel": { "type": "string" }, "backtestNote": { "type": "string" }, "asOf": { "type": "string", "format": "date" } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "ticker": "NVDA", "cik": "0001045810", "asOf": "2026-08-26", "exposures": [], "causalProfile": [ { "observationId": 3071, "causeStatement": "Agentic AI has arrived.", "effectStatement": "NVIDIA's Q1 FY2027 demand has gone parabolic.", "direction": "increasing", "observedAt": "2026-05-20", "quote": "The reason is simple, agentic AI has arrived.", "speakerName": "Jen-Hsun Huang", "edgeId": "e-ai-dccapex", "edgeState": "validated", "validation": { "method": "event_study", "eventWindow": "same + next fiscal quarter", "effectLabel": "+38% capex growth YoY", "effectSize": 38, "effectUnit": "%", "lagDays": 45, "nEvents": 24, "pValue": 0.0002, "qValue": 0.001, "verdict": "supported", "testedAt": "2026-06-28", "scope": "hyperscalers + AI infrastructure buyers", "note": "Strongest edge in the graph by q-value." } }, { "observationId": 744523, "causeStatement": "More compute availability", "effectStatement": "More profitable tokens generated and increased profit for services", "direction": null, "observedAt": "2026-08-26", "quote": "if we had more compute, we could generate more profitable tokens, which results in more profit for all of the services", "speakerName": "Jen-Hsun Huang", "edgeId": null, "edgeState": null, "validation": null } ], "credibility": { "ticker": "NVDA", "score": null, "sectorPercentile": null, "scoredCount": 2, "deliveredCount": 1, "beatCount": 1, "missedCount": 0, "pendingCount": 10, "rows": [ { "observationId": 744469, "concept": "third-party capital raising target", "guidedAt": "2026-08-26", "periodLabel": "will raise", "guidedValue": 500, "unit": "usd_billions", "realizedValue": null, "realizedSource": null, "errorPct": null, "verdict": "pending", "quote": "establish financing platforms that will raise over $500 billion of third-party capital.", "speakerName": "Colette Kress" }, { "observationId": 1904, "concept": "total revenue guidance", "guidedAt": "2025-08-27", "periodLabel": "outlook for the third quarter", "guidedValue": 54, "unit": "usd_billions", "realizedValue": 57, "realizedSource": "Q3 FY2026 as reported", "errorPct": 5.555555555555555, "verdict": "beat", "quote": "Total revenue is expected to be $54 billion, plus or minus 2%.", "speakerName": "Colette Kress" } ], "bestCall": { "observationId": 1904, "concept": "total revenue guidance", "guidedAt": "2025-08-27", "periodLabel": "outlook for the third quarter", "guidedValue": 54, "unit": "usd_billions", "realizedValue": 57, "realizedSource": "Q3 FY2026 as reported", "errorPct": 5.555555555555555, "verdict": "beat", "quote": "Total revenue is expected to be $54 billion, plus or minus 2%.", "speakerName": "Colette Kress" }, "worstCall": { "observationId": 743, "concept": "software revenue annual run rate", "guidedAt": "2024-08-28", "periodLabel": "exiting this year", "guidedValue": 2, "unit": "usd_billions", "realizedValue": 2, "realizedSource": "FY2025 Q4 call confirmation", "errorPct": 0, "verdict": "delivered", "quote": "We expect our software, SaaS and support revenue to approach a $2 billion annual run rate exiting this year", "speakerName": "Colette Kress" }, "coverageNote": "Guidance quotes and values are live extractions; reconciled verdicts cover the curated demo set. Full XBRL reconciliation ships with P3.3." }, "forecast": { "ticker": "NVDA", "horizonLabel": "next 2 quarters", "abnormalReturnMeanPct": 3.1, "abnormalReturnBand": [ 0.4, 5.8 ], "fundamentalMetric": "Data-center revenue growth", "fundamentalDeltaLabel": "+9 pts vs consensus path", "attributions": [ { "kind": "narrative", "label": "Surging AI Compute Demand accelerating", "detail": "Narrative #174 velocity and breadth both rising at the latest read.", "weightPct": 44, "refId": "174" }, { "kind": "edge", "label": "Validated: AI demand → data-center capex", "detail": "+38% capex growth, q<0.001, n=24 — the strongest edge in the graph.", "weightPct": 31, "refId": "e-ai-dccapex", "edgeState": "validated" } ], "modelLabel": "Preview model — every input shown above", "backtestNote": "We only score this against what was actually knowable at the time. Theme-momentum signals from before the registry went live are excluded, because we'd be marking our own homework.", "asOf": "2026-08-26" } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/company/{id}/claims": { "get": { "summary": "Company claims", "description": "Causal claims made by or about the company. An unknown or unpublished company is a 404 (`code` not_found).", "operationId": "get-company-claims", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string" }, "cik": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "claims": { "type": "array", "items": { "type": "object", "properties": { "observationId": { "type": "integer" }, "causeStatement": { "type": "string" }, "effectStatement": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "isForwardLooking": { "type": "boolean" }, "observedAt": { "type": "string", "format": "date" }, "themes": { "type": "array", "items": {} }, "edgeId": { "type": [ "string", "null" ] }, "edgeState": { "type": [ "string", "null" ] }, "validation": { "type": [ "object", "null" ], "properties": { "method": { "type": "string" }, "eventWindow": { "type": "string" }, "effectLabel": { "type": "string" }, "effectSize": { "type": "integer" }, "effectUnit": { "type": "string" }, "lagDays": { "type": "integer" }, "nEvents": { "type": "integer" }, "pValue": { "type": "number" }, "qValue": { "type": "number" }, "verdict": { "type": "string" }, "testedAt": { "type": "string", "format": "date" }, "scope": { "type": "string" }, "note": { "type": "string" } } }, "evidence": { "type": "object", "properties": { "observationId": { "type": "integer" }, "quote": { "type": "string" }, "statement": { "type": "string" }, "speakerName": { "type": "string" }, "speakerRole": { "type": "string" }, "ticker": { "type": "string" }, "cik": { "type": "string" }, "companyName": { "type": "string" }, "observedAt": { "type": "string", "format": "date" }, "observationType": { "type": "string" }, "direction": { "type": [ "string", "null" ] }, "verificationStatus": { "type": "string" }, "documentId": { "type": "integer" }, "transcriptExternalId": { "type": "string" }, "transcriptDate": { "type": "string", "format": "date" }, "fiscalLabel": { "type": "string" } } } } } }, "themeEdges": { "type": "array", "items": {} }, "nodes": { "type": "array", "items": {} }, "counts": { "type": "object", "properties": { "all": { "type": "integer" }, "validated": { "type": "integer" }, "refuted": { "type": "integer" }, "inconclusive": { "type": "integer" }, "claimed": { "type": "integer" } } }, "totalClaims": { "type": "integer" }, "truncatedCount": { "type": "integer" }, "coverageNote": { "type": "string" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "ticker": "NVDA", "cik": "0001045810", "asOf": "2026-08-26", "claims": [ { "observationId": 3071, "causeStatement": "Agentic AI has arrived.", "effectStatement": "NVIDIA's Q1 FY2027 demand has gone parabolic.", "direction": "increasing", "isForwardLooking": false, "observedAt": "2026-05-20", "themes": [], "edgeId": "e-ai-dccapex", "edgeState": "validated", "validation": { "method": "event_study", "eventWindow": "same + next fiscal quarter", "effectLabel": "+38% capex growth YoY", "effectSize": 38, "effectUnit": "%", "lagDays": 45, "nEvents": 24, "pValue": 0.0002, "qValue": 0.001, "verdict": "supported", "testedAt": "2026-06-28", "scope": "hyperscalers + AI infrastructure buyers", "note": "Strongest edge in the graph by q-value." }, "evidence": { "observationId": 3071, "quote": "The reason is simple, agentic AI has arrived.", "statement": "NVIDIA's Q1 FY2027 demand increased because agentic AI has arrived.", "speakerName": "Jen-Hsun Huang", "speakerRole": "executive", "ticker": "NVDA", "cik": "0001045810", "companyName": "NVIDIA Corporation", "observedAt": "2026-05-20", "observationType": "causal_claim", "direction": "increasing", "verificationStatus": "supported", "documentId": 1, "transcriptExternalId": "31919", "transcriptDate": "2026-05-20", "fiscalLabel": "Q1 FY2027" } }, { "observationId": 744523, "causeStatement": "More compute availability", "effectStatement": "More profitable tokens generated and increased profit for services", "direction": null, "isForwardLooking": true, "observedAt": "2026-08-26", "themes": [], "edgeId": null, "edgeState": null, "validation": null, "evidence": { "observationId": 744523, "quote": "if we had more compute, we could generate more profitable tokens, which results in more profit for all of the services", "statement": "If industry had more compute capacity, it could generate more profitable tokens and increase profit for services.", "speakerName": "Jen-Hsun Huang", "speakerRole": "executive", "ticker": "NVDA", "cik": "0001045810", "companyName": "NVIDIA Corporation", "observedAt": "2026-08-26", "observationType": "causal_claim", "direction": null, "verificationStatus": "supported", "documentId": 35778, "transcriptExternalId": "257198", "transcriptDate": "2026-08-26", "fiscalLabel": "Q2 FY2027" } } ], "themeEdges": [], "nodes": [], "counts": { "all": 708, "validated": 2, "refuted": 0, "inconclusive": 0, "claimed": 706 }, "totalClaims": 708, "truncatedCount": 308, "coverageNote": "Claims and quotes are live extractions. 2 of them resolve into a tested cause-and-effect link; the validation layer is a curated stand-in until the P3.3 test engine populates obs_edge_validation." } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/company/{id}/themes": { "get": { "summary": "Company themes", "description": "Themes the company is exposed to. Paged: the body carries `total`, `limit`, `offset`, `hasMore` and `nextOffset`; without a paging parameter every caller gets the first 25 (most mentioned first). An empty list carries `emptyReason`; an unknown or unpublished company is a 404 (`code` not_found).", "operationId": "get-company-themes", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Themes per page, 1–100, default 25.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "description": "Rows to skip (the previous `nextOffset`), default 0.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "sort", "in": "query", "description": "Theme order: mentions (default, as served), recent or breadth.", "schema": { "type": "string", "enum": [ "mentions", "recent", "breadth" ], "default": "mentions" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "ticker": { "type": "string" }, "cik": { "type": "string" }, "asOf": { "type": "string", "format": "date" }, "themes": { "type": "array", "items": {} }, "unlistedCount": { "type": "integer" }, "truncatedCount": { "type": "integer" }, "emptyReason": { "type": "string" }, "total": { "type": "integer" }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "hasMore": { "type": "boolean" }, "nextOffset": { "type": "null" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "ticker": "NVDA", "cik": "0001045810", "asOf": "2026-10-06", "themes": [], "unlistedCount": 0, "truncatedCount": 0, "emptyReason": "Themes come from the live management-commentary release gulf-redo7b-2026-10-14, which covers 222 companies (AE, BH, KW, OM, QA, SA); NVDA is in none of its themes. This is not a judgement that the com…", "total": 0, "limit": 2, "offset": 0, "hasMore": false, "nextOffset": null } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/company/{id}/presence": { "get": { "summary": "Company intelligence presence", "description": "What the intelligence surfaces hold for the company, per facet: `facets.themes` (present, `source` commentary or registry, the live `release`, and `reason` when there are none) and `facets.claims` (present, `count` of span-verified causal claims). `hasIntelligence` = any facet holds something; `hasThemes` = the company is in a served theme. An unknown or unpublished company is a 404 (`code` not_found).", "operationId": "get-company-intelligence-presence", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "hasIntelligence": { "type": "boolean" }, "hasThemes": { "type": "boolean" }, "facets": { "type": "object", "properties": { "themes": { "type": "object", "properties": { "present": { "type": "boolean" }, "source": { "type": "string" }, "release": { "type": "string" }, "reason": { "type": "string" } } }, "claims": { "type": "object", "properties": { "present": { "type": "boolean" }, "count": { "type": "integer" } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "0001045810", "hasIntelligence": true, "hasThemes": false, "facets": { "themes": { "present": false, "source": "commentary", "release": "gulf-redo7b-2026-10-14", "reason": "Themes come from the live management-commentary release gulf-redo7b-2026-10-14, which covers 222 companies (AE, BH, KW, OM, QA, SA); NVDA is in none of its themes. This is not a judgement that the com…" }, "claims": { "present": true, "count": 708 } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/transcripts/{transcriptId}/audio": { "get": { "summary": "Transcript audio", "description": "Earnings-call webcast audio (supports Range).", "operationId": "get-transcript-audio", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "transcriptId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Call date YYYY-MM-DD.", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "description": "OK" }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/transcripts/{transcriptId}/video/{file}": { "get": { "summary": "Transcript video", "description": "Earnings-call video as HLS VOD where one is stored (`hasVideo` in the index): `video.m3u8`, whose segment lines `vseg_NNNNN.ts?date=` are fetched from the same route; `sync.json`, when present, gives `audio_offset_seconds`, the seconds the video runs ahead of the audio recording.", "operationId": "get-transcript-video", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "transcriptId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "file", "in": "path", "required": true, "description": "`video.m3u8`, `vseg_NNNNN.ts` or `sync.json`.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "required": true, "description": "Call date YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "OK", "content": { "application/vnd.apple.mpegurl": { "schema": { "type": "string", "description": "HLS VOD playlist (video.m3u8)." } }, "video/mp2t": { "schema": { "type": "string", "format": "binary", "description": "One 4 s MPEG-TS segment (vseg_NNNNN.ts)." } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/tab-presence": { "get": { "summary": "Tab presence", "description": "Which data-dependent company tabs and sub-tabs have content (Management, Ownership, Filing Notes, Scorecard, Transactions, News/Events, Bonds, Map, Supply Chain). 404 for an unknown company.", "operationId": "get-tab-presence", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "management": { "type": "boolean" }, "ownership": { "type": "boolean" }, "filingNotes": { "type": "boolean" }, "scorecard": { "type": "boolean" }, "insiderTransactions": { "type": "boolean" }, "news": { "type": "boolean" }, "events": { "type": "boolean" }, "storyline": { "type": "boolean" }, "debt": { "type": "boolean" }, "mapAssets": { "type": "boolean" }, "mapAssetsPreview": { "type": "boolean" }, "digitalAssets": { "type": "boolean" }, "liveFleet": { "type": "boolean" }, "supplyChain": { "type": "boolean" }, "supplyChainPreview": { "type": "boolean" }, "analystEstimates": { "type": "boolean" }, "laws": { "type": "boolean" }, "regulators": { "type": "boolean" }, "centralBank": { "type": "boolean" }, "federalAwards": { "type": "boolean" }, "executiveActions": { "type": "boolean" }, "legislation": { "type": "boolean" }, "legal": { "type": "boolean" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "management": true, "ownership": true, "filingNotes": true, "scorecard": true, "insiderTransactions": true, "news": true, "events": true, "storyline": true, "debt": true, "mapAssets": false, "mapAssetsPreview": false, "digitalAssets": true, "liveFleet": false, "supplyChain": true, "supplyChainPreview": true, "analystEstimates": false, "laws": false, "regulators": false, "centralBank": false, "federalAwards": false, "executiveActions": true, "legislation": true, "legal": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/charting/series": { "post": { "summary": "Chart series", "description": "Resolve up to 8 chartable series (macro, fundamentals, stock/index/commodity prices) into aligned time series.", "operationId": "post-chart-series", "tags": [ "Analytics" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "series", "frequency" ], "properties": { "series": { "type": "array", "minItems": 1, "maxItems": 8, "items": { "type": "object", "required": [ "id", "descriptor", "transformation", "aggregation" ], "properties": { "id": { "type": "string", "pattern": "^[A-Za-z0-9_-]{1,64}$", "description": "Caller-chosen label echoed back with the series." }, "descriptor": { "$ref": "#/components/schemas/ChartSeriesDescriptor" }, "transformation": { "$ref": "#/components/schemas/Transformation" }, "aggregation": { "type": "string", "enum": [ "mean", "last", "sum" ] } } } }, "frequency": { "type": "string", "enum": [ "native", "daily", "weekly", "monthly", "quarterly", "annual" ] }, "startDate": { "type": "string", "format": "date" }, "endDate": { "type": "string", "format": "date" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/correlation/catalog": { "get": { "summary": "Series catalog", "description": "Series catalog: the macro indicators, fundamental metrics, companies, indices and commodities that POST /charting/series accepts. With `type`, only that part as {type, items, page}.", "operationId": "get-series-catalog", "tags": [ "Analytics" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "type", "in": "query", "description": "One part of the catalog.", "schema": { "type": "string", "enum": [ "macro", "fundamentals", "prices", "indices", "commodities" ] } }, { "name": "q", "in": "query", "description": "Words in its rows.", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size, 1–500, default 50.", "schema": { "type": "integer" } }, { "name": "offset", "in": "query", "description": "Rows to skip, default 0.", "schema": { "type": "integer" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "additionalProperties": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/central-bank": { "get": { "summary": "Central bank documents", "description": "Central Bank of the UAE documents that bear on the company (press releases, Base Rate decisions, public statements): where the text names it, or addresses the class of institution it is licensed as. Each carries the rule that tagged it and, for a name, the sentence. An unknown company is a 404.", "operationId": "get-central-bank-documents", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "cik": { "type": "string" }, "documents": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "integer" }, "docType": { "type": "string" }, "subtype": { "type": [ "string", "null" ] }, "title": { "type": "string" }, "eventDate": { "type": "string", "format": "date" }, "sourceUrl": { "type": "string" }, "basis": { "type": "string" }, "scopeClass": { "type": "string" }, "effect": { "type": "string" }, "evidenceQuote": { "type": "null" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "cik": "XDFM000003", "documents": [ { "documentId": 79565, "docType": "cbuae_base_rate_decision", "subtype": null, "title": "CBUAE Raises the Base Rate by 25 Basis Points", "eventDate": "2026-09-16", "sourceUrl": "https://centralbank.ae/media/dv3bo3ed/cbuae-raises-the-base-rate-by-25-basis-points-en.pdf", "basis": "sector", "scopeClass": "bank", "effect": "Sets the Base Rate on the CBUAE's Overnight Deposit Facility, the anchor for UAE interbank rates and for what banks and finance companies earn and pay at the central bank.", "evidenceQuote": null }, { "documentId": 80906, "docType": "cbuae_press_release", "subtype": "regulatory", "title": "CBUAE Updates AML/CFT/CPF Guidance For Licensed Financial Institutions", "eventDate": "2026-04-16", "sourceUrl": "https://centralbank.ae/media/baepfo4f/cbuae-updates-amlcftcpf-guidance-for-licensed-financial-institutions-en.pdf", "basis": "sector", "scopeClass": "bank", "effect": "Applies to all CBUAE-licensed institutions.", "evidenceQuote": null } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/laws/{docId}/document": { "get": { "summary": "Law document (PDF)", "description": "The stored PDF of a law, decree or resolution linked to the company (the platform's copy of the Dubai Legislation Portal file), by the `docId` that /laws lists. 404 when the instrument is not linked to the company or no copy in that language is held.", "operationId": "get-law-document-pdf", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "docId", "in": "path", "required": true, "description": "Instrument id from /companies/{id}/laws.", "schema": { "type": "string", "pattern": "^\\d{1,12}$" } }, { "name": "lang", "in": "query", "description": "Language of the copy.", "schema": { "type": "string", "enum": [ "ar", "en" ], "default": "ar" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/fed-financials/documents/{docId}": { "get": { "summary": "Fed financial-statement document", "description": "One Federal Reserve financial-statement document, exactly as the Board published it (PDF or HTML), by the document id the fed-financials grid and its sources cite. United States only (other countries 404). Public-domain material.", "operationId": "get-fed-financial-statement-document", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "docId", "in": "path", "required": true, "description": "Document id from /fed-financials or /fed-financials/source.", "schema": { "type": "string", "pattern": "^\\d{1,9}$" } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } }, "text/html": { "schema": { "type": "string" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/countries/{iso}/policy-text/documents/{documentId}/file": { "get": { "summary": "Policy document file (PDF)", "description": "The stored original PDF of a central-bank document (the copy the platform keeps of what the bank published), for the long reports whose extracted text loses tables and layout. 404 when no PDF copy is held.", "operationId": "get-policy-document-file-pdf", "tags": [ "Macro" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "iso", "in": "path", "required": true, "description": "ISO 3166-1 alpha-2 country code (e.g. US).", "schema": { "type": "string" } }, { "name": "documentId", "in": "path", "required": true, "description": "documentId from /policy-text/documents.", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/companies/{id}/transcripts/{transcriptId}/timeline": { "get": { "summary": "Transcript timeline", "description": "When each speaker turn starts in the call's recording: `{ turns: [{ speaker, role, section, startSeconds, endSeconds }] }`, in call order. `turns` is empty when the call carries no timings.", "operationId": "get-transcript-timeline", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Ticker symbol (e.g. NVDA), numeric SEC CIK (zero-padding optional), or the platform key of a non-SEC issuer (e.g. XSAU000001 — the `cik` field of the company payload). A bare ticker always resolves to the SEC registrant.", "schema": { "type": "string" } }, { "name": "transcriptId", "in": "path", "required": true, "description": "Transcript id from /companies/{id}/transcripts.", "schema": { "type": "string", "pattern": "^[\\w.-]{1,64}$" } }, { "name": "date", "in": "query", "description": "The call date from /companies/{id}/transcripts, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" }, "required": true } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "turns": { "type": "array", "items": { "type": "object", "properties": { "speaker": { "type": "string" }, "role": { "type": "string" }, "section": { "type": "string" }, "startSeconds": { "type": "number" }, "endSeconds": { "type": "number" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "turns": [ { "speaker": "Operator", "role": "operator", "section": "operator", "startSeconds": 0.1, "endSeconds": 19.31 }, { "speaker": "Janani Vemudeva", "role": "analyst", "section": "qa", "startSeconds": 20.62, "endSeconds": 54.85 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/earnings/coverage": { "get": { "summary": "Earnings calendar coverage", "description": "How far the earnings calendar covers each company: readiness, availability, monitoring state, the next date and how many upcoming periods are scheduled by the issuer or estimated, with a summary over the filtered set.", "operationId": "get-earnings-calendar-coverage", "tags": [ "Company Data" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "cik", "in": "query", "description": "Numeric CIK (1–10 digits) or platform key: one company.", "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Company name or ticker contains; at most 100 characters.", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Uppercase ISO alpha-2 market codes, comma-separated (e.g. AE,SA).", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Page size.", "schema": { "type": "integer", "minimum": 1, "maximum": 1000, "default": 500 } }, { "name": "offset", "in": "query", "description": "Rows to skip.", "schema": { "type": "integer", "minimum": 0, "maximum": 100000, "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "companies": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "company": { "type": "string" }, "ticker": { "type": "string" }, "country": { "type": "string" }, "readiness": { "type": "string" }, "monitoring": { "type": "string" }, "acceptedPeriods": { "type": "integer" }, "nextDate": { "type": [ "string", "null" ], "format": "date" }, "upcomingPeriods": { "type": "integer" }, "estimatedPeriods": { "type": "integer" }, "issuerScheduledPeriods": { "type": "integer" }, "assessedAt": { "type": "string", "format": "date-time" }, "availability": { "type": "string" } } } }, "total": { "type": "integer" }, "summary": { "type": "object", "properties": { "companies": { "type": "integer" }, "withUpcomingDates": { "type": "integer" }, "withEstimates": { "type": "integer" }, "withIssuerSchedules": { "type": "integer" } } }, "offset": { "type": "integer" }, "limit": { "type": "integer" }, "generatedAt": { "type": "string", "format": "date-time" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "companies": [ { "cik": "0000066740", "company": "3M CO", "ticker": "MMM", "country": "US", "readiness": "forecast_candidate", "monitoring": "source_discovery_needed", "acceptedPeriods": 72, "nextDate": "2027-01-19", "upcomingPeriods": 4, "estimatedPeriods": 4, "issuerScheduledPeriods": 0, "assessedAt": "2026-11-01T12:45:47.140Z", "availability": "available" }, { "cik": "0001866030", "company": "A2Z CUST2MATE SOLUTIONS CORP.", "ticker": "AZ", "country": "CA", "readiness": "history_missing", "monitoring": "source_discovery_needed", "acceptedPeriods": 0, "nextDate": null, "upcomingPeriods": 0, "estimatedPeriods": 0, "issuerScheduledPeriods": 0, "assessedAt": "2026-11-01T12:45:47.140Z", "availability": "history_missing" } ], "total": 1701, "summary": { "companies": 1701, "withUpcomingDates": 1350, "withEstimates": 1340, "withIssuerSchedules": 117 }, "offset": 0, "limit": 2, "generatedAt": "2026-11-01T12:51:43.703Z" } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/transcripts/topic-trends": { "get": { "summary": "Topic trends on calls", "description": "One curated topic's mentions on earnings calls: the quarterly trend and the companies ranked by mentions in the latest quarter, paged (`total`, `limit`, `offset`, `hasMore`, `nextOffset`). A topic not counted recently answers 503 `upstream_unavailable` with `Retry-After` while the count runs (a cold count reads every call since 2020); retry then.", "operationId": "get-topic-trends-on-calls", "tags": [ "Transcripts & Calls" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "topic", "in": "query", "description": "Curated topic id.", "schema": { "type": "string", "enum": [ "ai", "tariffs", "rates", "energy" ], "default": "ai" } }, { "name": "from", "in": "query", "description": "First day of the first quarter shown (the quarter holding it); default the latest eight quarters, YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "to", "in": "query", "description": "Last day of the last quarter shown (the quarter holding it), YYYY-MM-DD.", "schema": { "type": "string", "format": "date" } }, { "name": "search", "in": "query", "description": "Company name or ticker contains; at most 80 characters.", "schema": { "type": "string" } }, { "name": "countries", "in": "query", "description": "ISO alpha-2 codes, comma-separated.", "schema": { "type": "string" } }, { "name": "ciks", "in": "query", "description": "CIKs or platform keys, comma-separated.", "schema": { "type": "string" } }, { "name": "tickers", "in": "query", "description": "Tickers, comma-separated, at most 200.", "schema": { "type": "string" } }, { "name": "offset", "in": "query", "description": "Companies to skip.", "schema": { "type": "integer", "minimum": 0, "default": 0 } }, { "name": "limit", "in": "query", "description": "Companies per page.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 40 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "topic": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "terms": { "type": "array", "items": { "type": "string" } } } }, "asOf": { "type": "string", "format": "date" }, "available": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "format": "date" }, "label": { "type": "string" } } } }, "quarters": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "format": "date" }, "label": { "type": "string" } } } }, "rankQuarter": { "type": "object", "properties": { "start": { "type": "string", "format": "date" }, "label": { "type": "string" } } }, "series": { "type": "array", "items": { "type": "object", "properties": { "start": { "type": "string", "format": "date" }, "label": { "type": "string" }, "mentions": { "type": "integer" }, "companies": { "type": "integer" }, "callsMentioning": { "type": "integer" }, "callsHeld": { "type": "integer" } } } }, "total": { "type": "integer" }, "offset": { "type": "integer" }, "companies": { "type": "array", "items": { "type": "object", "properties": { "cik": { "type": "string" }, "ticker": { "type": "string" }, "name": { "type": "string" }, "countryCode": { "type": "string" }, "mentions": { "type": "array", "items": { "type": "integer" } }, "total": { "type": "integer" }, "callsMentioning": { "type": "integer" }, "callsHeld": { "type": "integer" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "topic": { "id": "ai", "label": "AI & machine learning", "terms": [ "AI", "artificial intelligence" ] }, "asOf": "2026-10-30", "available": [ { "start": "2020-01-01", "label": "Q1 2020" }, { "start": "2020-04-01", "label": "Q2 2020" } ], "quarters": [ { "start": "2024-10-01", "label": "Q4 2024" }, { "start": "2025-01-01", "label": "Q1 2025" } ], "rankQuarter": { "start": "2026-07-01", "label": "Q3 2026" }, "series": [ { "start": "2024-10-01", "label": "Q4 2024", "mentions": 1818, "companies": 502, "callsMentioning": 505, "callsHeld": 1332 }, { "start": "2025-01-01", "label": "Q1 2025", "mentions": 2294, "companies": 609, "callsMentioning": 617, "callsHeld": 1424 } ], "total": 1350, "offset": 0, "companies": [ { "cik": "0000813672", "ticker": "CDNS", "name": "Cadence Design Systems, Inc.", "countryCode": "US", "mentions": [ 11, 7 ], "total": 121, "callsMentioning": 7, "callsHeld": 7 }, { "cik": "0001067491", "ticker": "INFY", "name": "Infosys Limited", "countryCode": "IN", "mentions": [ 11, 14 ], "total": 154, "callsMentioning": 8, "callsHeld": 8 } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/narratives/featured": { "get": { "summary": "Featured narratives", "description": "The dashboard's featured themes: `{ themes: null }` while the pinned registry picks apply; a list replaces them while a commentary release is live.", "operationId": "get-featured-narratives", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "themes": { "type": "array", "items": { "type": "object", "properties": { "narrativeId": { "type": "integer" }, "name": { "type": "string" } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "themes": [ { "narrativeId": 10021237, "name": "Strategic revenue diversification toward non-funded income" }, { "narrativeId": 10021258, "name": "Regional geopolitical and supply chain disruption affecting project execution" } ] } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/narratives/metrics": { "get": { "summary": "Narrative sparklines", "description": "Compact weekly metric series per narrative, for row sparklines: `{ sparklines }` keyed by narrative id.", "operationId": "get-narrative-sparklines", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "ids", "in": "query", "description": "Narrative ids, comma-separated, at most 20; others are ignored.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "sparklines": { "type": "object", "properties": { "10021258": { "type": "object", "properties": { "dates": { "type": "array", "items": { "type": "string", "format": "date" } }, "volume28d": { "type": "array", "items": { "type": "integer" } }, "velocity": { "type": "array", "items": { "type": "integer" } }, "breadth": { "type": "array", "items": { "type": "integer" } }, "netDirection": { "type": "array", "items": { "type": [ "integer", "null" ] } } } } } } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "sparklines": { "10021258": { "dates": [ "2022-12-31", "2023-03-31" ], "volume28d": [ 1, 0 ], "velocity": [ 1, -1 ], "breadth": [ 1, 1 ], "netDirection": [ 1, null ] } } } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/intelligence/observations/{id}/context": { "get": { "summary": "Observation context", "description": "The sentence before and after one observation's verbatim quote, cut from its source document (never crossing the speaker's turn). 404 when the context is not available.", "operationId": "get-observation-context", "tags": [ "Intelligence" ], "x-tier": "free", "security": [ { "apiKey": [] }, { "cognitoIdToken": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "description": "Observation id (from annotations, narratives or claims).", "schema": { "type": "integer", "minimum": 1 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "properties": { "before": { "type": "string" }, "quote": { "type": "string" }, "after": { "type": "string" }, "truncatedBefore": { "type": "boolean" }, "truncatedAfter": { "type": "boolean" } }, "description": "Inferred from captured responses: every field shown was returned by a real call; a field may be absent or null on other calls.", "x-schema-source": "inferred" }, "example": { "before": "With me today from NVIDIA are Jensen Huang, President and Chief Executive Officer; and Colette Kress, Executive Vice President and Chief Financial Officer. ", "quote": "Our call is being webcast live on NVIDIA's Investor Relations website.", "after": " The webcast will be available for replay until the conference call to discuss our financial results for the second quarter of fiscal 2027. The content of today's call is NVIDIA's property.", "truncatedBefore": true, "truncatedAfter": true } } } }, "400": { "description": "A query parameter the route does not take (unknown_parameter), a value outside its type, enum or range (invalid_parameter), or a required one missing (missing_parameter); `param` names it. A request refused against this spec's parameter list is not metered.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Missing or invalid bearer token.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Unknown company, country, symbol or resource.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "Rate limited. Honour Retry-After.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } } }