{"openapi":"3.1.0","info":{"title":"OpenFilings API","version":"1.0.0","description":"Programmatic access to multi-market filings, as-filed financials, supply chain, people, and market data. Authenticate with an API key (`X-API-Key`). Base URL: `https://api.openfilings.org`.","contact":{"name":"OpenFilings","url":"https://openfilings.org/docs"},"x-openfilings-credits":{"default":1,"description":"Credits debited for a successful call. Failed requests are refunded. A call that is not listed costs default.","mcp":{"get_company_analysis":20,"get_company_climate":1,"get_company_financials":10,"get_company_institutional_holders":1,"get_company_people":1,"get_company_revenue_segments":10,"get_company_supply_chain":20,"get_entity":1,"get_filing":2,"get_filing_section":2,"get_fx":1,"get_macro":1,"get_manager_13f_holdings":1,"get_price_snapshot":1,"get_rates":1,"list_filing_sections":1,"list_filings":1,"list_markets":1,"list_news":3,"screen_analyst_stance":1,"screen_climate":1,"screen_fx_moves":1,"screen_holders":1,"screen_index_moves":1,"screen_insider_companies":1,"screen_issuers":1,"screen_press":1,"screen_rates":1,"screen_red_flags":1,"screen_street":1,"search_ticker":1}}},"paths":{"/api/user/watchlist":{"get":{"summary":"List your watchlist","operationId":"get_api_user_watchlist","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWatchlistResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1},"post":{"summary":"Add a ticker to your watchlist","operationId":"post_api_user_watchlist","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddUserWatchlistRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWatchlistResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/user/watchlist/{ticker}":{"patch":{"summary":"Update a watchlist entry","operationId":"patch_api_user_watchlist_by_ticker","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserWatchlistRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWatchlistResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1},"delete":{"summary":"Remove a ticker from your watchlist","operationId":"delete_api_user_watchlist_by_ticker","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWatchlistResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"tags":["Account"],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/user/notifications":{"get":{"tags":["Account"],"summary":"List notifications","operationId":"get_api_user_notifications","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Notification id for pagination","title":"Cursor"},"description":"Notification id for pagination"},{"name":"unread_only","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Unread Only"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"ISO8601 — items created after","title":"Since"},"description":"ISO8601 — items created after"},{"name":"since_hours","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Relative lower bound in hours (e.g. 24 = last 24h)","title":"Since Hours"},"description":"Relative lower bound in hours (e.g. 24 = last 24h)"},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"ISO8601 — items created at or before","title":"Until"},"description":"ISO8601 — items created at or before"},{"name":"event_types","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by event type (e.g. filing.discovered)","title":"Event Types"},"description":"Filter by event type (e.g. filing.discovered)"},{"name":"market_ids","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by market id (e.g. us, eu)","title":"Market Ids"},"description":"Filter by market id (e.g. us, eu)"},{"name":"categories","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by canonical filing category (e.g. material_event)","title":"Categories"},"description":"Filter by canonical filing category (e.g. material_event)"},{"name":"category_groups","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by coarse category group (e.g. periodic, mna)","title":"Category Groups"},"description":"Filter by coarse category group (e.g. periodic, mna)"},{"name":"tickers","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Filter by ticker","title":"Tickers"},"description":"Filter by ticker"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/user/notifications/unread-count":{"get":{"tags":["Account"],"summary":"Count unread notifications","operationId":"get_api_user_notifications_unread_count","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationUnreadCountResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/user/notifications/read-all":{"post":{"tags":["Account"],"summary":"Mark all notifications read","operationId":"post_api_user_notifications_read_all","responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/user/notifications/{notification_id}":{"get":{"tags":["Account"],"summary":"Get a notification","operationId":"get_api_user_notifications_by_notification_id","parameters":[{"name":"notification_id","in":"path","required":true,"schema":{"type":"string","title":"Notification Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/user/notifications/{notification_id}/read":{"patch":{"tags":["Account"],"summary":"Mark a notification read","operationId":"patch_api_user_notifications_by_notification_id_read","parameters":[{"name":"notification_id","in":"path","required":true,"schema":{"type":"string","title":"Notification Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/user/webhooks":{"get":{"tags":["Account"],"summary":"List webhooks","operationId":"get_api_user_webhooks","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserWebhookOut"},"title":"Response List User Webhooks Api User Webhooks Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1},"post":{"tags":["Account"],"summary":"Create a webhook","operationId":"post_api_user_webhooks","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWebhookCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWebhookOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/user/webhooks/{webhook_id}":{"patch":{"tags":["Account"],"summary":"Update a webhook","operationId":"patch_api_user_webhooks_by_webhook_id","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWebhookUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWebhookOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1},"delete":{"tags":["Account"],"summary":"Delete a webhook","operationId":"delete_api_user_webhooks_by_webhook_id","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/user/webhooks/{webhook_id}/test":{"post":{"tags":["Account"],"summary":"Send a test webhook","description":"Fire one signed `webhook.test` ping synchronously so integrators can\nverify their handler + HMAC verification without waiting for a real filing.","operationId":"post_api_user_webhooks_by_webhook_id_test","parameters":[{"name":"webhook_id","in":"path","required":true,"schema":{"type":"string","title":"Webhook Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserWebhookTestResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/markets":{"get":{"tags":["Markets"],"summary":"List markets in your plan","description":"Catalog of markets for the caller's plan.","operationId":"get_api_v1_markets","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductMarketsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/filings/resolve":{"get":{"tags":["Filings"],"summary":"Find a filing by ticker, form, and date","operationId":"get_api_v1_filings_resolve","parameters":[{"name":"ticker","in":"query","required":true,"schema":{"type":"string","minLength":1,"title":"Ticker"}},{"name":"market_id","in":"query","required":false,"schema":{"type":"string","default":"us","title":"Market Id"}},{"name":"form_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Form Type"}},{"name":"filing_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Date"}},{"name":"filing_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFilingResolveOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/tickers/{ticker}/filings":{"get":{"tags":["Filings"],"summary":"List a ticker's filings (single market)","description":"Filings for one ticker in one market. For cross-market queries use `GET /api/v1/filings/discover`.","operationId":"get_api_v1_tickers_by_ticker_filings","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"market_id","in":"query","required":false,"schema":{"type":"string","default":"us","title":"Market Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":10,"title":"Limit"}},{"name":"since_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":1990},{"type":"null"}],"description":"Period-end year lower bound (reporting_for >= since_year).","title":"Since Year"},"description":"Period-end year lower bound (reporting_for >= since_year)."},{"name":"form_types","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Form Types"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListFilingsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/filings/{filing_id}/kpis":{"get":{"tags":["Filings"],"summary":"Get a filing's KPIs","operationId":"get_api_v1_filings_by_filing_id_kpis","parameters":[{"name":"filing_id","in":"path","required":true,"schema":{"type":"string","title":"Filing Id"}},{"name":"include_groups","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Groups"}},{"name":"include_red_flags","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Red Flags"}},{"name":"include_gold","in":"query","required":false,"schema":{"type":"boolean","default":true,"title":"Include Gold"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFilingKpisOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/filings/{filing_id}/sections":{"get":{"tags":["Filings"],"summary":"List a filing's sections","operationId":"get_api_v1_filings_by_filing_id_sections","parameters":[{"name":"filing_id","in":"path","required":true,"schema":{"type":"string","title":"Filing Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFilingSectionsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/filings/{filing_id}/sections/{section_key}":{"get":{"tags":["Filings"],"summary":"Get one filing section","operationId":"get_api_v1_filings_by_filing_id_sections_by_section_key","parameters":[{"name":"filing_id","in":"path","required":true,"schema":{"type":"string","title":"Filing Id"}},{"name":"section_key","in":"path","required":true,"schema":{"type":"string","title":"Section Key"}},{"name":"content_format","in":"query","required":false,"schema":{"type":"string","default":"excerpt","title":"Content Format"}},{"name":"part","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Part"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductFilingSectionOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":2}},"/api/v1/entities/search":{"get":{"tags":["Entities"],"summary":"Search issuers","description":"Cross-market entity discovery (no filings). Same semantics as MCP `search_ticker`.\n\nUse query for company names, ticker for exchange symbols, lei/isin for structured IDs.\nPass market_id to disambiguate a ticker reused across markets (e.g. 7203 + jp).\nInspect entity.listings (and entities[] when ambiguous) before fetching filings.\nA name query can return several issuers (Toyota Motor vs Tsusho); entity is\nthe top hit and entities[] lists the others.","operationId":"get_api_v1_entities_search","parameters":[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Query"}},{"name":"ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Ticker"}},{"name":"cn_ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Cn Ticker"}},{"name":"hk_ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Hk Ticker"}},{"name":"lei","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Lei"}},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Market Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductSearchEntitiesOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/entities/lookup":{"get":{"tags":["Entities"],"summary":"Look up an issuer by LEI, ISIN, or ticker","description":"One catalogue issuer by LEI, ISIN, or ticker (+ market_id when ambiguous).","operationId":"get_api_v1_entities_lookup","parameters":[{"name":"lei","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Lei"}},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}},{"name":"canonical_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Canonical Key"}},{"name":"ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Ticker"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Market Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEntityLookupOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/filings/search":{"get":{"tags":["Filings"],"summary":"Full-text search filing sections","description":"Full-text search over filing section bodies (Latin markets).","operationId":"get_api_v1_filings_search","parameters":[{"name":"q","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":256,"description":"websearch_to_tsquery syntax","title":"Q"},"description":"websearch_to_tsquery syntax"},{"name":"registry","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Limit to one registry (us_sec, eu_esef, …). Default: all phase-1 Latin.","title":"Registry"},"description":"Limit to one registry (us_sec, eu_esef, …). Default: all phase-1 Latin."},{"name":"filed_from","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO date YYYY-MM-DD","title":"Filed From"},"description":"ISO date YYYY-MM-DD"},{"name":"filed_to","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO date YYYY-MM-DD","title":"Filed To"},"description":"ISO date YYYY-MM-DD"},{"name":"section_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":128},{"type":"null"}],"title":"Section Key"}},{"name":"lang","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Override query regconfig (english/simple/portuguese). Default: derived from registry so it matches how rows were indexed.","title":"Lang"},"description":"Override query regconfig (english/simple/portuguese). Default: derived from registry so it matches how rows were indexed."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":50,"minimum":1,"default":20,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilingSectionSearchOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/filings/discover":{"get":{"tags":["Filings"],"summary":"Discover filings across markets","description":"Cross-market filing discovery. Same payload as MCP `list_filings`.\n\nOmit market scoping: all resolved listings are searched. Use query for names,\nticker for symbols, lei/isin for structured IDs (not in ticker). Prefer\n`GET /filings/discover` over legacy `/tickers/{ticker}/filings?market_id=us`.","operationId":"get_api_v1_filings_discover","parameters":[{"name":"query","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Query"}},{"name":"ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Ticker"}},{"name":"cn_ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Cn Ticker"}},{"name":"hk_ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Hk Ticker"}},{"name":"lei","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Lei"}},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":10,"title":"Limit"}},{"name":"since_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":1990},{"type":"null"}],"title":"Since Year"}},{"name":"form_types","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Form Types"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductDiscoveryOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/filings/{filing_id}/earnings-event":{"get":{"tags":["Filings"],"summary":"Get a filing's earnings release","description":"SEC ex99-1 earnings flash attached to an 8-K Item 2.02 (same filing row).","operationId":"get_api_v1_filings_by_filing_id_earnings_event","parameters":[{"name":"filing_id","in":"path","required":true,"schema":{"type":"string","title":"Filing Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductEarningsEventOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/kpi-taxonomy":{"get":{"tags":["Financials"],"summary":"List KPI codes","description":"Canonical KPI line_item codes (income/balance/cashflow/shares).","operationId":"get_api_v1_kpi_taxonomy","parameters":[{"name":"statement_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Type"}},{"name":"market","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KpiTaxonomyOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/companies/financials":{"get":{"tags":["Financials"],"summary":"Get multi-year company financials","description":"Company + period financials (no filing_id). One call for a multi-year series.","operationId":"get_api_v1_companies_financials","parameters":[{"name":"ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Ticker"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Market Id"}},{"name":"lei","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Lei"}},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}},{"name":"canonical_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Canonical Key"}},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":1900},{"type":"null"}],"title":"Fiscal Year"}},{"name":"fiscal_year_from","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":1900},{"type":"null"}],"title":"Fiscal Year From"}},{"name":"fiscal_year_to","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":1900},{"type":"null"}],"title":"Fiscal Year To"}},{"name":"fiscal_period","in":"query","required":false,"schema":{"type":"string","default":"fy","title":"Fiscal Period"}},{"name":"statement_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Type"}},{"name":"line_items","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated canonical keys, or ALL (default)","title":"Line Items"},"description":"Comma-separated canonical keys, or ALL (default)"},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO date YYYY-MM-DD","title":"As Of"},"description":"ISO date YYYY-MM-DD"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyFinancialsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":10}},"/api/v1/tickers/{ticker}/press-releases":{"get":{"tags":["Press releases"],"summary":"List a ticker's press releases","description":"Press releases published by the issuer, newest first.","operationId":"get_api_v1_tickers_by_ticker_press_releases","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"market","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Listing market. Omit to resolve the issuer on its home market.","title":"Market"},"description":"Listing market. Omit to resolve the issuer on its home market."},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}},{"name":"subject_code","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":999,"minimum":1},{"type":"null"}],"title":"Subject Code"}},{"name":"tier","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":3,"minimum":1},{"type":"null"}],"title":"Tier"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListPressReleasesOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}},"/api/v1/filings/{filing_id}/press-releases":{"get":{"tags":["Press releases"],"summary":"List press releases around a filing","description":"Press releases near a filing date (±14 day window).\n\nFree plans get the preview, not a 403 — see the ticker route above.","operationId":"get_api_v1_filings_by_filing_id_press_releases","parameters":[{"name":"filing_id","in":"path","required":true,"schema":{"type":"string","title":"Filing Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListPressReleasesOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}},"/api/v1/documents/taxonomy":{"get":{"tags":["Documents"],"summary":"Get the document taxonomy","description":"Document taxonomy: categories (grouped), IR native types and subtypes.","operationId":"get_api_v1_documents_taxonomy","parameters":[{"name":"counts","in":"query","required":false,"schema":{"type":"boolean","description":"Include document_count per category","default":true,"title":"Counts"},"description":"Include document_count per category"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentTaxonomyOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/documents":{"get":{"tags":["Documents"],"summary":"List documents","description":"List documents (filings + IR publications) with taxonomy filters.","operationId":"get_api_v1_documents","parameters":[{"name":"ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"description":"Exchange symbol; pair with market when reused across markets (7203 + jp).","title":"Ticker"},"description":"Exchange symbol; pair with market when reused across markets (7203 + jp)."},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}},{"name":"lei","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Lei"}},{"name":"canonical_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Canonical Key"}},{"name":"market","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":8},{"type":"null"}],"description":"With an issuer identifier: disambiguates the ticker. Alone: market filter.","title":"Market"},"description":"With an issuer identifier: disambiguates the ticker. Alone: market filter."},{"name":"registry","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":40},{"type":"null"}],"title":"Registry"}},{"name":"category","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Repeatable: category=annual_report&category=proxy","default":[],"title":"Category"},"description":"Repeatable: category=annual_report&category=proxy"},{"name":"category_group","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Category Group"}},{"name":"native_type","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":64},{"type":"null"}],"title":"Native Type"}},{"name":"subtype","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":48},{"type":"null"}],"title":"Subtype"}},{"name":"origin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","pattern":"^(filing|ir)$"},{"type":"null"}],"title":"Origin"}},{"name":"from","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"From"}},{"name":"to","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"To"}},{"name":"fiscal_year","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2100,"minimum":1990},{"type":"null"}],"title":"Fiscal Year"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","description":"Only documents whose bytes are archived","default":false,"title":"Archived"},"description":"Only documents whose bytes are archived"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentListOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}},"/api/v1/documents/{document_id}":{"get":{"tags":["Documents"],"summary":"Get a document","description":"Document metadata, files and ZIP member manifest.","operationId":"get_api_v1_documents_by_document_id","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}},{"name":"member_offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Member Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentDetailOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}},"/api/v1/documents/{document_id}/content":{"get":{"tags":["Documents"],"summary":"Download a document","description":"Redirects (302) to a short-lived download URL for the document's raw bytes.","operationId":"get_api_v1_documents_by_document_id_content","parameters":[{"name":"document_id","in":"path","required":true,"schema":{"type":"string","title":"Document Id"}},{"name":"file_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Id"}}],"responses":{"302":{"description":"Redirect to a short-lived download URL for the raw bytes","content":{"application/json":{"schema":{}}}},"409":{"description":"Document not archived yet (`retryable` says whether to retry)"},"429":{"description":"Daily download quota exceeded"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":2}},"/api/v1/tickers/{ticker}/insider-transactions":{"get":{"tags":["People & insiders"],"summary":"List a ticker's insider transactions","description":"Insider transactions (SEC Form 4 and equivalents) reported for the issuer.","operationId":"get_api_v1_tickers_by_ticker_insider_transactions","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"market","in":"query","required":false,"schema":{"type":"string","default":"us","title":"Market"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}},{"name":"transaction_code","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":8},{"type":"null"}],"title":"Transaction Code"}},{"name":"acquired_disposed","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":4},{"type":"null"}],"title":"Acquired Disposed"}},{"name":"since_date","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ISO date YYYY-MM-DD","title":"Since Date"},"description":"ISO date YYYY-MM-DD"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":20,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListInsiderTransactionsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}},"/api/v1/tickers/{ticker}/corporate-events":{"get":{"tags":["Corporate events"],"summary":"List a ticker's corporate events","description":"One issuer's lifecycle timeline, newest first.\n\nEach event names the filing that evidences it and the regulator item\ncode that produced it, so a reader can check the claim. `kind`\n`acquisition_or_disposal` does not say which side the company was on —\nthe item code cannot distinguish them.","operationId":"get_api_v1_tickers_by_ticker_corporate_events","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"market","in":"query","required":false,"schema":{"type":"string","default":"us","title":"Market"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"acquisition_or_disposal | delisting | listing_removal | registration_terminated | control_change | restructuring | ipo | tender_offer_announced | tender_offer_completed | tender_offer_withdrawn | name_change | listing_deficiency | bankruptcy | cybersecurity_incident | auditor_change | non_reliance | late_filing_notice | restatement | audit_opinion | investigation_committee | going_concern | internal_control_weakness | exchange_status | regulatory_action | misconduct | guidance_revision | equity_offering | convertible_issue | capital_reduction | buyback | payment_default | business_suspension | dissolution | creditor_management | litigation","title":"Kind"},"description":"acquisition_or_disposal | delisting | listing_removal | registration_terminated | control_change | restructuring | ipo | tender_offer_announced | tender_offer_completed | tender_offer_withdrawn | name_change | listing_deficiency | bankruptcy | cybersecurity_incident | auditor_change | non_reliance | late_filing_notice | restatement | audit_opinion | investigation_committee | going_concern | internal_control_weakness | exchange_status | regulatory_action | misconduct | guidance_revision | equity_offering | convertible_issue | capital_reduction | buyback | payment_default | business_suspension | dissolution | creditor_management | litigation"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCorporateEventsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}},"/api/v1/tickers/{ticker}/signals":{"get":{"tags":["Disclosure signals"],"summary":"Get a ticker's disclosure-signal dossier","description":"One issuer's disclosure dossier.\n\n- `profile` — dilution over 12 months (stated new-share and\n  convertible percentages), latest non-clean audit opinion,\n  going-concern state, auditor changes, late filings, restatements,\n  investigations, forecast revisions up / down.\n- `patterns` — named combinations (`dilution_spiral`,\n  `audit_distress`, `auditor_churn`, `accounting_failure`,\n  `late_filer`, `guidance_cut_streak`, `exit_risk`), each with\n  `strength`, dates, a one-line `why` and the `event_ids` behind it.\n- `cases` — events grouped into stories (notices that cite each\n  other), newest first; each event carries `family`, `salience`\n  (`routine` | `notable`), typed `fields` and `evidence`.","operationId":"get_api_v1_tickers_by_ticker_signals","parameters":[{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"market","in":"query","required":false,"schema":{"type":"string","default":"us","title":"Market"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySignalsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}},"/api/v1/signals":{"get":{"tags":["Disclosure signals"],"summary":"Screen issuers by disclosure pattern","description":"Screen issuers by disclosure pattern, or by a single kind.\n\n`pattern` runs the pattern scan (patterns + profile). `kind` or\n`family` runs a SQL screen (one card per issuer, `match` says which\nkind hit and when). Passing both is a 400 — they are different engines.\nKind screens default to 7 days only so a bare call answers; pass\n`window_days` (1 to 1825) or `window` (7d, 1m, 3m, 6m, 1y, 3y, 5y).\nPattern screens keep their multi-year lookback unless you pass a window,\nwhich keeps issuers whose latest trigger falls inside it. A pattern page\nstill reruns that scan; the cursor only shortens the response.","operationId":"get_api_v1_signals","parameters":[{"name":"pattern","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"dilution_spiral | audit_distress | auditor_churn | accounting_failure | late_filer | guidance_cut_streak | exit_risk (omit: any)","title":"Pattern"},"description":"dilution_spiral | audit_distress | auditor_churn | accounting_failure | late_filer | guidance_cut_streak | exit_risk (omit: any)"},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"strength","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"strong | moderate","title":"Strength"},"description":"strong | moderate"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One disclosure kind (going_concern, litigation, auditor_change, …). SQL screen. Do not combine with pattern.","title":"Kind"},"description":"One disclosure kind (going_concern, litigation, auditor_change, …). SQL screen. Do not combine with pattern."},{"name":"family","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"dilution | audit | reporting | governance | distress | guidance | capital_return | legal. SQL screen. Do not combine with pattern.","title":"Family"},"description":"dilution | audit | reporting | governance | distress | guidance | capital_return | legal. SQL screen. Do not combine with pattern."},{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"title":"Window Days"}},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Alias for window_days: 7d, 1m, 3m, 6m, 1y, 3y, 5y. Must agree with window_days.","title":"Window"},"description":"Alias for window_days: 7d, 1m, 3m, 6m, 1y, 3y, 5y. Must agree with window_days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalScreenOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}},"/api/v1/signals/events":{"get":{"tags":["Disclosure signals"],"summary":"List disclosure-signal events","description":"The signal feed across issuers, newest first — the stream to alert on.","operationId":"get_api_v1_signals_events","parameters":[{"name":"family","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"dilution | audit | reporting | governance | distress | guidance | capital_return | legal","title":"Family"},"description":"dilution | audit | reporting | governance | distress | guidance | capital_return | legal"},{"name":"kinds","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated kinds (overrides family)","title":"Kinds"},"description":"Comma-separated kinds (overrides family)"},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Since"}},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Until"}},{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"title":"Window Days"}},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"7d, 1m, 3m, 6m, 1y, 3y, 5y. Do not combine with since.","title":"Window"},"description":"7d, 1m, 3m, 6m, 1y, 3y, 5y. Do not combine with since."},{"name":"salience","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"notable | routine","title":"Salience"},"description":"notable | routine"},{"name":"structured_only","in":"query","required":false,"schema":{"type":"boolean","description":"Only events whose document has been read into fields","default":false,"title":"Structured Only"},"description":"Only events whose document has been read into fields"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalEventsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}},"/api/v1/signals/base-rates":{"get":{"tags":["Disclosure signals"],"summary":"Get market reaction base rates per signal","description":"How each signal has moved prices: abnormal return vs the market\nbenchmark (S&P 500, Nikkei 225, KOSPI, Hang Seng, Shanghai Composite)\nat 2, 5 and 20 trading days after the last close before the event, per\nmarket, kind and variant (direction, status, opinion, salience,\nauthority): n, mean, median, quartiles, share negative, t-stat.","operationId":"get_api_v1_signals_base_rates","parameters":[{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SignalBaseRatesOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/red-flags/screen":{"get":{"tags":["Filings"],"summary":"Screen issuers by red flag","description":"Issuers with a red flag in the window, one card each.\n\nThe card is the newest filing in the window that still has a flag\njudged `event`, or not yet judged. Boilerplate and unclear are left\nout. A bare call uses 90 days; pass `window_days` (1 to 1825) or\n`window` for any other length. Metered.","operationId":"get_api_v1_red_flags_screen","parameters":[{"name":"rule_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Exact rule id","title":"Rule Id"},"description":"Exact rule id"},{"name":"severity","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"CRITICAL, HIGH, MEDIUM, or LOW","title":"Severity"},"description":"CRITICAL, HIGH, MEDIUM, or LOW"},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"title":"Window Days"}},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"7d, 1m, 3m, 6m, 1y, 3y, 5y. Must agree with window_days.","title":"Window"},"description":"7d, 1m, 3m, 6m, 1y, 3y, 5y. Must agree with window_days."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RedFlagScreenOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/street/screen":{"get":{"tags":["Companies"],"summary":"Screen issuers by analyst recommendation","description":"Issuers by analyst recommendation, one card each.\n\nA dual listing is several rows. The card uses the home listing when\nthat listing has a snapshot; otherwise the listing with the most\nanalysts, and `match.listing` says which. `match.as_of` is the\ndate of the weekly sweep. Metered.","operationId":"get_api_v1_street_screen","parameters":[{"name":"recommendation_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"strong_buy, buy, hold, sell, or strong_sell","title":"Recommendation Key"},"description":"strong_buy, buy, hold, sell, or strong_sell"},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"description":"Keep snapshots dated within this many days. A bare call uses 21.","title":"Window Days"},"description":"Keep snapshots dated within this many days. A bare call uses 21."},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"7d, 1m, 3m, 6m, 1y, 3y, 5y. Must agree with window_days.","title":"Window"},"description":"7d, 1m, 3m, 6m, 1y, 3y, 5y. Must agree with window_days."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StreetScreenOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/screen":{"get":{"tags":["Companies"],"summary":"Screen issuers by intersecting signals","description":"Issuers that match every include and none of the excludes.\n\nOne `window_days` applies to every dated predicate. A bare call uses\n21 days. `exclude_pattern` is the exception: a pattern is a\nmulti-year state, so it keeps its own lookback. At least one include\nis required. Metered.","operationId":"get_api_v1_screen","parameters":[{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"title":"Window Days"}},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Window"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"street","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated recommendation keys","title":"Street"},"description":"Comma-separated recommendation keys"},{"name":"insider","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"A or D","title":"Insider"},"description":"A or D"},{"name":"pattern","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pattern"}},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"red_flag","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Rule id to require","title":"Red Flag"},"description":"Rule id to require"},{"name":"holders","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"director, officer, or shareholder. Defaults to director when only min_tenure_years is sent.","title":"Holders"},"description":"director, officer, or shareholder. Defaults to director when only min_tenure_years is sent."},{"name":"min_tenure_years","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":80,"minimum":1},{"type":"null"}],"title":"Min Tenure Years"}},{"name":"analyst","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"strong_buy, buy, hold, sell, strong_sell, or no_conviction","title":"Analyst"},"description":"strong_buy, buy, hold, sell, strong_sell, or no_conviction"},{"name":"analyst_source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"call or filing. Omit to prefer the call.","title":"Analyst Source"},"description":"call or filing. Omit to prefer the call."},{"name":"exclude_red_flag","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclude Red Flag"}},{"name":"exclude_pattern","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclude Pattern"}},{"name":"exclude_kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exclude Kind"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerScreenOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/holders/screen":{"get":{"tags":["Companies"],"summary":"Screen issuers by mandate length","description":"Issuers with a current mandate at least this many years old.\n\n`officer` and `director` are a seat. `shareholder` is a disclosed\nholding. `match.since_meaning` says which. A relation with no dated\nmandate in scope is a 400, not an empty page. Metered.","operationId":"get_api_v1_holders_screen","parameters":[{"name":"relation","in":"query","required":false,"schema":{"type":"string","description":"director, officer, or shareholder","default":"director","title":"Relation"},"description":"director, officer, or shareholder"},{"name":"min_tenure_years","in":"query","required":false,"schema":{"type":"integer","maximum":80,"minimum":1,"default":10,"title":"Min Tenure Years"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerScreenOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/climate/screen":{"get":{"tags":["Companies"],"summary":"Screen issuers by climate target","description":"Issuers with a published climate target. Empty while that licence is off.","operationId":"get_api_v1_climate_screen","parameters":[{"name":"near_term_status","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Near Term Status"}},{"name":"net_zero_year_max","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":2200,"minimum":1990},{"type":"null"}],"title":"Net Zero Year Max"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerScreenOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/press/screen":{"get":{"tags":["Companies"],"summary":"Screen issuers by press tier","description":"One issuer per tier in the window: the latest release, not every wire.","operationId":"get_api_v1_press_screen","parameters":[{"name":"tier","in":"query","required":false,"schema":{"type":"string","default":"tier_1","title":"Tier"}},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"title":"Window Days"}},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Window"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerScreenOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/analyst/screen":{"get":{"tags":["Companies"],"summary":"Screen issuers by our analyst verdict","description":"Issuers by our analyst verdict. Call is the latest primary earnings call.\n\nFiling is the latest annual report. A bare call has no date window:\nthe row is already the latest verdict. Metered.","operationId":"get_api_v1_analyst_screen","parameters":[{"name":"stance","in":"query","required":true,"schema":{"type":"string","description":"Comma-separated: strong_buy, buy, hold, sell, strong_sell, no_conviction","title":"Stance"},"description":"Comma-separated: strong_buy, buy, hold, sell, strong_sell, no_conviction"},{"name":"source","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"call or filing. Omit to prefer the call.","title":"Source"},"description":"call or filing. Omit to prefer the call."},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"title":"Window Days"}},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Window"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":25,"title":"Limit"}},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cursor"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IssuerScreenOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/fx/movers":{"get":{"tags":["Market data"],"summary":"Largest currency moves","description":"Largest stored currency moves against USD.\n\n`change_pct` > 0 means the currency gained against the dollar.\n`usd_change_pct` and `local_per_usd` are the raw quote. A currency\nwith no stored history is omitted.","operationId":"get_api_v1_fx_movers","parameters":[{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"title":"Window Days"}},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Window"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"default":5,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoversOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/macro/index-moves":{"get":{"tags":["Market data"],"summary":"Largest index moves","description":"Largest stored index moves. The dates in each row are the closes used.","operationId":"get_api_v1_macro_index_moves","parameters":[{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"title":"Window Days"}},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Window"}},{"name":"category","in":"query","required":false,"schema":{"type":"string","default":"equity_index","title":"Category"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":20,"minimum":1,"default":5,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MoversOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/fx/rates":{"get":{"tags":["Market data"],"summary":"Get FX rates","description":"Spot FX rates, in local currency units per 1 USD.","operationId":"get_api_v1_fx_rates","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FxRatesResponse"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/macro/rates":{"get":{"tags":["Market data"],"summary":"Get policy and government bond rates","description":"US Treasury constant-maturity yields, G10 10-year government bond yields, and central-bank policy rates.","operationId":"get_api_v1_macro_rates","parameters":[{"name":"group","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated groups: ust,gov10y,ea_curve,policy (default all)","title":"Group"},"description":"Comma-separated groups: ust,gov10y,ea_curve,policy (default all)"},{"name":"min_value","in":"query","required":false,"schema":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"Keep policy or gov10y rows at or above this level","title":"Min Value"},"description":"Keep policy or gov10y rows at or above this level"},{"name":"window_days","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":1825,"minimum":1},{"type":"null"}],"title":"Window Days"}},{"name":"window","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Window"}},{"name":"changed","in":"query","required":false,"schema":{"type":"boolean","description":"Keep rows whose level differs from the point N days earlier","default":false,"title":"Changed"},"description":"Keep rows whose level differs from the point N days earlier"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MacroRatesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/macro/weo/areas":{"get":{"tags":["Market data"],"summary":"List IMF World Economic Outlook countries","description":"Countries (not IMF aggregates) in the latest — or given — IMF WEO vintage.","operationId":"get_api_v1_macro_weo_areas","parameters":[{"name":"vintage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"WEO vintage YYYY-MM","title":"Vintage"},"description":"WEO vintage YYYY-MM"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeoAreasResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/macro/weo":{"get":{"tags":["Market data"],"summary":"Get IMF World Economic Outlook series","description":"IMF WEO series for one vintage; `is_forecast` follows the IMF last-actual year.","operationId":"get_api_v1_macro_weo","parameters":[{"name":"area","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":8,"description":"ISO3, e.g. FRA","title":"Area"},"description":"ISO3, e.g. FRA"},{"name":"subject","in":"query","required":false,"schema":{"type":"string","default":"NGDP_RPCH","title":"Subject"}},{"name":"vintage","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"WEO vintage YYYY-MM","title":"Vintage"},"description":"WEO vintage YYYY-MM"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WeoSeriesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/companies/{market}/{ticker}/institutional-holders":{"get":{"tags":["Companies"],"summary":"List institutional holders","description":"Form 13F managers holding the issuer, one row per house.\n\n`total` counts houses after successor CIKs are folded together.\n`limit` (default 25, max 500) and `offset` page that set, largest\nposition first.","operationId":"get_api_v1_companies_by_market_by_ticker_institutional_holders","parameters":[{"name":"market","in":"path","required":true,"schema":{"type":"string","title":"Market"}},{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":25,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstitutionalHoldersOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/institutional-managers/{manager_cik}":{"get":{"tags":["Companies"],"summary":"Get a 13F manager's holdings","description":"One Form 13F manager's latest book, largest positions first.","operationId":"get_api_v1_institutional_managers_by_manager_cik","parameters":[{"name":"manager_cik","in":"path","required":true,"schema":{"type":"string","title":"Manager Cik"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","default":100,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Manager13fBookOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/companies/{market}/{ticker}/market-snapshot":{"get":{"tags":["Companies"],"summary":"Get market snapshot","description":"Latest quote and market capitalisation for the issuer.","operationId":"get_api_v1_companies_by_market_by_ticker_market_snapshot","parameters":[{"name":"market","in":"path","required":true,"schema":{"type":"string","title":"Market"}},{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"range","in":"query","required":false,"schema":{"type":"string","description":"Yahoo daily close history window (1mo, 6mo, 1y, 2y, 5y, max)","default":"1y","title":"Range"},"description":"Yahoo daily close history window (1mo, 6mo, 1y, 2y, 5y, max)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketSnapshot"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/companies/{market}/{ticker}/earnings-releases":{"get":{"tags":["Companies"],"summary":"Get earnings calendar","description":"Street earnings calendar rows for this issuer (upcoming + recent reported).","operationId":"get_api_v1_companies_by_market_by_ticker_earnings_releases","parameters":[{"name":"market","in":"path","required":true,"schema":{"type":"string","title":"Market"}},{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":40,"minimum":1,"default":8,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EarningsCalendarResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/lifecycle-events":{"get":{"tags":["Corporate events"],"summary":"List corporate events across markets","description":"Market-wide lifecycle tape — who left the list, which bids completed.\n\nPublic like the insider-trades explorer. Each row still names the\nfiling that evidences it.","operationId":"get_api_v1_lifecycle_events","parameters":[{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"}},{"name":"kinds","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated kinds when not filtering to one","title":"Kinds"},"description":"Comma-separated kinds when not filtering to one"},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"}},{"name":"since","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Since"}},{"name":"until","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Until"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":80},{"type":"null"}],"description":"Issuer name, ticker, or LEI fragment","title":"Q"},"description":"Issuer name, ticker, or LEI fragment"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"exclude_debt","in":"query","required":false,"schema":{"type":"boolean","description":"Drop LSE Official List note/bond cancellations (Exits tape)","default":true,"title":"Exclude Debt"},"description":"Drop LSE Official List note/bond cancellations (Exits tape)"},{"name":"page_by","in":"query","required":false,"schema":{"type":"string","description":"issuer = page of companies with all their events; event = raw rows","default":"issuer","title":"Page By"},"description":"issuer = page of companies with all their events; event = raw rows"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MarketLifecycleEventsOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/companies/{market}/{ticker}/supply-chain":{"get":{"tags":["Companies"],"summary":"Get supply chain","description":"Named supplier↔customer edges + anonymous concentration disclosures.","operationId":"get_api_v1_companies_by_market_by_ticker_supply_chain","parameters":[{"name":"market","in":"path","required":true,"schema":{"type":"string","title":"Market"}},{"name":"ticker","in":"path","required":true,"schema":{"type":"string","title":"Ticker"}},{"name":"as_of","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"As-of date (YYYY-MM-DD); only used when include_expired=false","title":"As Of"},"description":"As-of date (YYYY-MM-DD); only used when include_expired=false"},{"name":"include_expired","in":"query","required":false,"schema":{"type":"boolean","description":"Include edges past valid_to (default true — no 1y display cutoff)","default":true,"title":"Include Expired"},"description":"Include edges past valid_to (default true — no 1y display cutoff)"},{"name":"disclosure_limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":80,"title":"Disclosure Limit"}},{"name":"hops","in":"query","required":false,"schema":{"type":"integer","maximum":2,"minimum":1,"description":"1 = direct edges only, 2 = also walk one step from resolved counterparties","default":1,"title":"Hops"},"description":"1 = direct edges only, 2 = also walk one step from resolved counterparties"},{"name":"include_correlations","in":"query","required":false,"schema":{"type":"boolean","description":"Attach multi-horizon price correlations on hop-1 resolved edges","default":true,"title":"Include Correlations"},"description":"Attach multi-horizon price correlations on hop-1 resolved edges"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanySupplyChainOut"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/people":{"get":{"tags":["People & insiders"],"summary":"Search people","description":"Directory of officers, directors, and major shareholders.","operationId":"get_api_v1_people","parameters":[{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":2},{"type":"null"}],"description":"Search on the person / institution name","title":"Q"},"description":"Search on the person / institution name"},{"name":"kind","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"One of person, institution","title":"Kind"},"description":"One of person, institution"},{"name":"relation","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Current role filter: officer, director, major_shareholder, significant_control","title":"Relation"},"description":"Current role filter: officer, director, major_shareholder, significant_control"},{"name":"market","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Market id of the issuer","title":"Market"},"description":"Market id of the issuer"},{"name":"canonical_key","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"All parties holding a current role at one issuer","title":"Canonical Key"},"description":"All parties holding a current role at one issuer"},{"name":"ticker","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"description":"Listed symbol; pass market_id when ambiguous","title":"Ticker"},"description":"Listed symbol; pass market_id when ambiguous"},{"name":"market_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"description":"Issuer listing market with ticker (identity). Distinct from `market`, which filters all people on a market.","title":"Market Id"},"description":"Issuer listing market with ticker (identity). Distinct from `market`, which filters all people on a market."},{"name":"lei","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":32},{"type":"null"}],"title":"Lei"}},{"name":"isin","in":"query","required":false,"schema":{"anyOf":[{"type":"string","maxLength":16},{"type":"null"}],"title":"Isin"}},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"companies (mandate count, default), ownership (max stake), name, name_desc, tenure (longest current filing-derived mandate; needs since_date, excludes MarketScreener), renewal (until_date in the next 180 days — term up for renewal, not outgoing; almost only CN)","default":"companies","title":"Sort"},"description":"companies (mandate count, default), ownership (max stake), name, name_desc, tenure (longest current filing-derived mandate; needs since_date, excludes MarketScreener), renewal (until_date in the next 180 days — term up for renewal, not outgoing; almost only CN)"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"min_tenure_years","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":80,"minimum":1},{"type":"null"}],"description":"Current mandate started at least this many years ago. since_date is the seat for an officer or director, and the disclosed holding for a major shareholder.","title":"Min Tenure Years"},"description":"Current mandate started at least this many years ago. since_date is the seat for an officer or director, and the disclosed holding for a major shareholder."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/people/facets":{"get":{"tags":["People & insiders"],"summary":"Get people search facets","description":"Counts by kind, relation, and market for the people search filters.","operationId":"get_api_v1_people_facets","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PeopleFacetsResponse"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/people/{slug}":{"get":{"tags":["People & insiders"],"summary":"Get a person","description":"Profile for `<name-slug>-<id prefix>`; the name part is decorative.","operationId":"get_api_v1_people_by_slug","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonProfileResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/people/{slug}/companies":{"get":{"tags":["People & insiders"],"summary":"List a person's roles and holdings","description":"Paged mandates — institutional holders run to hundreds of positions.","operationId":"get_api_v1_people_by_slug_companies","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"relation","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relation"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonRolesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":1}},"/api/v1/people/{slug}/insider-transactions":{"get":{"tags":["People & insiders"],"summary":"List a person's insider transactions","description":"Insider transactions attributed to this party.\n\nFree plans get the preview, not a 403 — same stripping as the ticker\nand filing routes.","operationId":"get_api_v1_people_by_slug_insider_transactions","parameters":[{"name":"slug","in":"path","required":true,"schema":{"type":"string","title":"Slug"}},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Limit"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonInsiderTransactionsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"x-openfilings-credits":3}}},"components":{"schemas":{"AddUserWatchlistRequest":{"properties":{"ticker":{"type":"string","maxLength":32,"minLength":1,"title":"Ticker"},"notification_form_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Notification Form Types"},"portfolio_weight_pct":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"null"}],"title":"Portfolio Weight Pct"}},"type":"object","required":["ticker"],"title":"AddUserWatchlistRequest"},"CompanyCorporateEventsOut":{"properties":{"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"count":{"type":"integer","title":"Count","default":0},"total_count":{"type":"integer","title":"Total Count","default":0},"items":{"items":{"$ref":"#/components/schemas/CorporateEventOut"},"type":"array","title":"Items"},"kinds":{"additionalProperties":{"type":"integer"},"type":"object","title":"Kinds","description":"Event count per kind for this issuer"},"lifecycle":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Lifecycle","description":"Whether the issuer still reports"}},"additionalProperties":true,"type":"object","title":"CompanyCorporateEventsOut"},"CompanyFinancialsEntityOut":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei"},"isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Isin"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"}},"type":"object","title":"CompanyFinancialsEntityOut"},"CompanyFinancialsOut":{"properties":{"canonical_key":{"type":"string","title":"Canonical Key"},"entity":{"$ref":"#/components/schemas/CompanyFinancialsEntityOut"},"query":{"$ref":"#/components/schemas/CompanyFinancialsQueryOut"},"currency_latest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency Latest"},"periods":{"items":{"$ref":"#/components/schemas/CompanyFinancialsPeriodOut"},"type":"array","title":"Periods"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"earnings":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Earnings"}},"type":"object","required":["canonical_key","entity","query"],"title":"CompanyFinancialsOut"},"CompanyFinancialsPeriodOut":{"properties":{"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fiscal Year"},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Period"},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period End"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Date"},"form_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Form Type"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"values":{"additionalProperties":{"anyOf":[{"type":"number"},{"type":"null"}]},"type":"object","title":"Values"}},"type":"object","title":"CompanyFinancialsPeriodOut"},"CompanyFinancialsQueryOut":{"properties":{"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fiscal Year"},"fiscal_year_from":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fiscal Year From"},"fiscal_year_to":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fiscal Year To"},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Period"},"statement_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Type"},"line_items":{"items":{"type":"string"},"type":"array","title":"Line Items"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"}},"type":"object","title":"CompanyFinancialsQueryOut"},"CompanySignalsOut":{"properties":{"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"canonical_key":{"type":"string","title":"Canonical Key"},"profile":{"additionalProperties":true,"type":"object","title":"Profile","description":"Windowed indicators: dilution_12m, audit, reporting, governance, guidance_12m"},"patterns":{"items":{"$ref":"#/components/schemas/SignalPatternOut"},"type":"array","title":"Patterns"},"cases":{"items":{"$ref":"#/components/schemas/SignalCaseOut"},"type":"array","title":"Cases"},"count":{"type":"integer","title":"Count","default":0}},"type":"object","required":["canonical_key","profile"],"title":"CompanySignalsOut"},"CompanySupplyChainOut":{"properties":{"market":{"type":"string","title":"Market"},"ticker":{"type":"string","title":"Ticker"},"canonical_key":{"type":"string","title":"Canonical Key"},"as_of":{"type":"string","title":"As Of"},"generated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Generated At"},"center":{"additionalProperties":true,"type":"object","title":"Center"},"nodes":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Nodes"},"edges":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Edges"},"disclosures":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Disclosures"},"estimates":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Estimates"},"stats":{"$ref":"#/components/schemas/CompanySupplyChainStatsOut"}},"additionalProperties":true,"type":"object","required":["market","ticker","canonical_key","as_of","center"],"title":"CompanySupplyChainOut","description":"Named edges + anonymous disclosures for workbench graph UI.\n\n`estimates` is reserved for Satelight overlays and must stay separate\nfrom `edges` (never promote sell-side % into Tier-1 edges)."},"CompanySupplyChainStatsOut":{"properties":{"edge_count":{"type":"integer","title":"Edge Count","default":0},"disclosure_count":{"type":"integer","title":"Disclosure Count","default":0},"named_customer_count":{"type":"integer","title":"Named Customer Count","default":0},"named_supplier_count":{"type":"integer","title":"Named Supplier Count","default":0},"anonymous_disclosure_count":{"type":"integer","title":"Anonymous Disclosure Count","default":0},"estimate_count":{"type":"integer","title":"Estimate Count","default":0}},"type":"object","title":"CompanySupplyChainStatsOut"},"CorporateEventOut":{"properties":{"id":{"type":"string","title":"Id"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"has_company_page":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Company Page"},"kind":{"type":"string","title":"Kind"},"event_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Date","description":"YYYY-MM-DD"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"source_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Detail","description":"Regulator item code the event was read from"},"deal_form":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Form"},"counterparty_raw_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Raw Name"},"counterparty_canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Canonical Key"},"counterparty_ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Ticker"},"counterparty_market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Market Id"},"filer_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filer Role","description":"Which side the filer took, when the text says"},"evidence_quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evidence Quote","description":"Sentence the event was read from"},"consideration_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Consideration Amount"},"consideration_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consideration Currency"},"confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence"}},"additionalProperties":true,"type":"object","required":["id","kind"],"title":"CorporateEventOut"},"DocumentArchiveStateOut":{"properties":{"status":{"type":"string","title":"Status"},"reason":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reason"},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archived At"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"byte_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Byte Size"}},"additionalProperties":true,"type":"object","required":["status"],"title":"DocumentArchiveStateOut"},"DocumentDetailOut":{"properties":{"id":{"type":"string","title":"Id"},"origin":{"type":"string","title":"Origin","description":"filing (regulator disclosure) or ir (issuer website)"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"ir_document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ir Document Id"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"category_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Label"},"category_group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Group"},"native_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Native Type"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"display_title":{"type":"string","title":"Display Title"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"document_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Date"},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period End"},"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fiscal Year"},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Period"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"archive":{"$ref":"#/components/schemas/DocumentArchiveStateOut"},"links":{"$ref":"#/components/schemas/DocumentLinksOut"},"files":{"items":{"$ref":"#/components/schemas/DocumentFileOut"},"type":"array","title":"Files"},"members":{"$ref":"#/components/schemas/DocumentMembersOut"}},"additionalProperties":true,"type":"object","required":["id","origin","display_title","archive","links","members"],"title":"DocumentDetailOut"},"DocumentFileOut":{"properties":{"id":{"type":"string","title":"Id"},"role":{"type":"string","title":"Role"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"byte_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Byte Size"},"sha256":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sha256"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Download path; null for files inside a package"}},"additionalProperties":true,"type":"object","required":["id","role"],"title":"DocumentFileOut"},"DocumentLinksOut":{"properties":{"self":{"type":"string","title":"Self"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Present once the raw bytes are stored"}},"additionalProperties":true,"type":"object","required":["self"],"title":"DocumentLinksOut"},"DocumentListOut":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DocumentOut"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"Pass back as `cursor` for the next page"},"limit":{"type":"integer","title":"Limit"}},"additionalProperties":true,"type":"object","required":["limit"],"title":"DocumentListOut"},"DocumentMembersOut":{"properties":{"total":{"type":"integer","title":"Total","default":0},"offset":{"type":"integer","title":"Offset","default":0},"items":{"items":{"$ref":"#/components/schemas/DocumentFileOut"},"type":"array","title":"Items"}},"type":"object","title":"DocumentMembersOut"},"DocumentOut":{"properties":{"id":{"type":"string","title":"Id"},"origin":{"type":"string","title":"Origin","description":"filing (regulator disclosure) or ir (issuer website)"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"ir_document_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ir Document Id"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"category_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Label"},"category_group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Group"},"native_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Native Type"},"subtype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subtype"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"display_title":{"type":"string","title":"Display Title"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language"},"document_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Date"},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period End"},"fiscal_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fiscal Year"},"fiscal_period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Period"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"archive":{"$ref":"#/components/schemas/DocumentArchiveStateOut"},"links":{"$ref":"#/components/schemas/DocumentLinksOut"}},"additionalProperties":true,"type":"object","required":["id","origin","display_title","archive","links"],"title":"DocumentOut"},"DocumentTaxonomyCategoryOut":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"group":{"type":"string","title":"Group"},"document_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Document Count"}},"type":"object","required":["id","label","group"],"title":"DocumentTaxonomyCategoryOut"},"DocumentTaxonomyGroupOut":{"properties":{"id":{"type":"string","title":"Id"},"categories":{"items":{"$ref":"#/components/schemas/DocumentTaxonomyCategoryOut"},"type":"array","title":"Categories"}},"type":"object","required":["id"],"title":"DocumentTaxonomyGroupOut"},"DocumentTaxonomyOut":{"properties":{"version":{"type":"integer","title":"Version"},"groups":{"items":{"$ref":"#/components/schemas/DocumentTaxonomyGroupOut"},"type":"array","title":"Groups"},"origins":{"additionalProperties":{"type":"string"},"type":"object","title":"Origins"},"ir_native_types":{"items":{"type":"string"},"type":"array","title":"Ir Native Types"},"ir_subtypes":{"items":{"type":"string"},"type":"array","title":"Ir Subtypes"},"ir_mapping":{"additionalProperties":true,"type":"object","title":"Ir Mapping"},"archive_statuses":{"items":{"type":"string"},"type":"array","title":"Archive Statuses"},"file_roles":{"items":{"type":"string"},"type":"array","title":"File Roles"}},"additionalProperties":true,"type":"object","required":["version"],"title":"DocumentTaxonomyOut"},"EarningsCalendarItemOut":{"properties":{"id":{"type":"string","title":"Id"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"yahoo_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Yahoo Symbol"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"phase":{"type":"string","title":"Phase"},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Date"},"report_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report At"},"call_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Call At"},"fiscal_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Label"},"fiscal_period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Fiscal Period End"},"eps_estimate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Eps Estimate"},"revenue_estimate":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Revenue Estimate"},"eps_actual":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Eps Actual"},"revenue_actual":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Revenue Actual"},"eps_surprise_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Eps Surprise Pct"},"revenue_surprise_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Revenue Surprise Pct"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"}},"type":"object","required":["id","phase"],"title":"EarningsCalendarItemOut","description":"One Street earnings release row for the Agenda financier list."},"EarningsCalendarResponse":{"properties":{"window":{"type":"string","title":"Window"},"scope":{"type":"string","title":"Scope"},"date_from":{"type":"string","title":"Date From"},"date_to":{"type":"string","title":"Date To"},"total":{"type":"integer","title":"Total","default":0},"items":{"items":{"$ref":"#/components/schemas/EarningsCalendarItemOut"},"type":"array","title":"Items"},"generated_at":{"type":"string","title":"Generated At"}},"type":"object","required":["window","scope","date_from","date_to","generated_at"],"title":"EarningsCalendarResponse"},"FilingSectionSearchHitOut":{"properties":{"filing_id":{"type":"string","title":"Filing Id"},"section_key":{"type":"string","title":"Section Key"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filed At"},"lang":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lang"},"rank":{"type":"number","title":"Rank","default":0.0},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"form_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Form Type"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"snippet":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Snippet"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"slug_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug Path"},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accession"}},"type":"object","required":["filing_id","section_key"],"title":"FilingSectionSearchHitOut","description":"One ranked `filing_sections` full-text hit."},"FilingSectionSearchOut":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FilingSectionSearchHitOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total","default":0},"total_capped":{"type":"boolean","title":"Total Capped","default":false},"limit":{"type":"integer","title":"Limit","default":20},"offset":{"type":"integer","title":"Offset","default":0},"q":{"type":"string","title":"Q","default":""}},"type":"object","title":"FilingSectionSearchOut","description":"`GET /api/v1/filings/search` — full-text hits over section bodies."},"FxRateEntry":{"properties":{"rate":{"type":"number","title":"Rate"},"fetched_at":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fetched At"},"last_updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Updated"}},"type":"object","required":["rate"],"title":"FxRateEntry"},"FxRatesResponse":{"properties":{"rates":{"additionalProperties":{"$ref":"#/components/schemas/FxRateEntry"},"type":"object","title":"Rates"},"supported":{"items":{"type":"string"},"type":"array","title":"Supported"}},"type":"object","required":["rates"],"title":"FxRatesResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InstitutionalHolderRowOut":{"properties":{"manager_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager Name"},"manager_cik":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager Cik"},"value_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value Usd"},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Shares"},"pct_portfolio":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pct Portfolio"},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Date"}},"additionalProperties":true,"type":"object","title":"InstitutionalHolderRowOut","description":"One Form 13F house on an issuer (latest report)."},"InstitutionalHoldersOut":{"properties":{"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"holders":{"items":{"$ref":"#/components/schemas/InstitutionalHolderRowOut"},"type":"array","title":"Holders"},"holder_count":{"type":"integer","title":"Holder Count","default":0},"total":{"type":"integer","title":"Total","default":0},"offset":{"type":"integer","title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","default":25},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"}},"additionalProperties":true,"type":"object","title":"InstitutionalHoldersOut","description":"`GET …/institutional-holders` — paged Form 13F invert."},"IssuerScreenItem":{"properties":{"canonical_key":{"type":"string","title":"Canonical Key"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"as_of":{"type":"string","title":"As Of"},"match":{"$ref":"#/components/schemas/IssuerScreenMatch"}},"type":"object","required":["canonical_key","as_of","match"],"title":"IssuerScreenItem"},"IssuerScreenMatch":{"properties":{"predicate":{"type":"string","title":"Predicate"}},"additionalProperties":true,"type":"object","required":["predicate"],"title":"IssuerScreenMatch"},"IssuerScreenOut":{"properties":{"engine":{"type":"string","title":"Engine"},"as_of":{"type":"string","title":"As Of"},"window_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Window Days"},"count":{"type":"integer","title":"Count","default":0},"has_more":{"type":"boolean","title":"Has More","default":false},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/IssuerScreenItem"},"type":"array","title":"Items"}},"additionalProperties":true,"type":"object","required":["engine","as_of"],"title":"IssuerScreenOut","description":"One row per issuer. Metered. Extra fields describe the predicate."},"KpiFactSourceOut":{"properties":{"concept":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Concept","description":"Taxonomy concept, e.g. us-gaap name"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role"},"contextref":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contextref"}},"additionalProperties":true,"type":"object","title":"KpiFactSourceOut","description":"One reported fact a displayed KPI was computed from."},"KpiGroupValueOut":{"properties":{"value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit","description":"Currency code, PCT, or a ratio unit"},"yoy_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Yoy Pct","description":"Change vs prior year, in percent"},"prior_year_value":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Prior Year Value"},"flag":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flag"},"basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Basis","description":"How the value was derived"},"sources":{"items":{"$ref":"#/components/schemas/KpiFactSourceOut"},"type":"array","title":"Sources"}},"additionalProperties":true,"type":"object","title":"KpiGroupValueOut"},"KpiPeriodContextOut":{"properties":{"period_basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Basis","description":"e.g. fy, q, ytd_6m"},"period_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Label"},"flow_duration_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Flow Duration Days"},"ttm_method":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ttm Method"},"ttm_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ttm Status"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"}},"additionalProperties":true,"type":"object","title":"KpiPeriodContextOut","description":"What period the flow figures cover (quarter, year-to-date, full year) and TTM status."},"KpiRedFlagOut":{"properties":{"severity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Severity","description":"HIGH | MEDIUM | LOW"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category","description":"LIQUIDITY | DILUTION | CONCENTRATION | GOVERNANCE | PROFITABILITY | …"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail"},"rule_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule Id"},"sources":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Sources"}},"additionalProperties":true,"type":"object","title":"KpiRedFlagOut","description":"Rule-based warning. Kept as plain strings (not enums) so a new rule\ncategory can never turn the KPI response into a validation error."},"KpiSourceOut":{"properties":{"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"Document the KPIs were read from"},"filed_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filed At","description":"Filing date, YYYY-MM-DD"},"cik":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cik","description":"Filer identifier at the regulator"},"accession":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accession"},"form_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Form Type"},"doc_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Doc Id","description":"EDINET document id (Japan)"},"edinet_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Edinet Code","description":"EDINET filer code (Japan)"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"'pending' while the filing's KPIs are still being extracted"}},"additionalProperties":true,"type":"object","title":"KpiSourceOut"},"KpiTaxonomyItemOut":{"properties":{"key":{"type":"string","title":"Key"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"statement_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Type"},"statement_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Statement Title"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"markets":{"items":{"type":"string"},"type":"array","title":"Markets"}},"type":"object","required":["key"],"title":"KpiTaxonomyItemOut"},"KpiTaxonomyOut":{"properties":{"items":{"items":{"$ref":"#/components/schemas/KpiTaxonomyItemOut"},"type":"array","title":"Items"},"count":{"type":"integer","title":"Count","default":0},"statement_types":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Statement Types"}},"type":"object","title":"KpiTaxonomyOut"},"KpiYoyPeriodsOut":{"properties":{"flow_current_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Current End"},"flow_prior_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Flow Prior End"},"instant_current":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instant Current"},"instant_prior":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Instant Prior"}},"additionalProperties":true,"type":"object","title":"KpiYoyPeriodsOut","description":"Period ends the year-over-year comparison uses (flows vs balance-sheet instants)."},"MacroRateItem":{"properties":{"series_id":{"type":"string","title":"Series Id"},"source":{"type":"string","title":"Source"},"source_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Key"},"ref_area":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ref Area"},"rate_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rate Kind"},"tenor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tenor"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"},"value_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value Pct"},"day_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Day Change"},"window_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Window Change"},"prior_as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Prior As Of"},"window_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Window Days"}},"type":"object","required":["series_id","source"],"title":"MacroRateItem"},"MacroRatesResponse":{"properties":{"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"},"items":{"items":{"$ref":"#/components/schemas/MacroRateItem"},"type":"array","title":"Items"},"supported":{"items":{"type":"string"},"type":"array","title":"Supported"}},"type":"object","title":"MacroRatesResponse"},"Manager13fBookOut":{"properties":{"manager_cik":{"type":"string","title":"Manager Cik"},"manager_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Manager Name"},"report_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Report Date","description":"Latest 13F period, YYYY-MM-DD"},"status":{"type":"string","enum":["ok","no_holdings"],"title":"Status"},"holdings":{"items":{"$ref":"#/components/schemas/Manager13fHoldingOut"},"type":"array","title":"Holdings"},"holding_count":{"type":"integer","title":"Holding Count","default":0},"total":{"type":"integer","title":"Total","default":0},"offset":{"type":"integer","title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","default":100},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"value_scale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value Scale"}},"additionalProperties":true,"type":"object","required":["manager_cik","status"],"title":"Manager13fBookOut"},"Manager13fHoldingOut":{"properties":{"cusip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Cusip"},"name_of_issuer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name Of Issuer"},"title_of_class":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title Of Class"},"value_usd":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value Usd"},"value_usd_thousands":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Value Usd Thousands"},"value_scale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Value Scale","description":"'reported_thousands' when the filer reported in $000s"},"shares":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Shares"},"share_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Share Type"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"},"isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Isin"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"}},"additionalProperties":true,"type":"object","title":"Manager13fHoldingOut"},"MarketHistoryPoint":{"properties":{"date":{"type":"string","title":"Date"},"price":{"type":"number","title":"Price"},"open":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Open"},"high":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"High"},"low":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Low"},"volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Volume"}},"type":"object","required":["date","price"],"title":"MarketHistoryPoint"},"MarketLifecycleEventsOut":{"properties":{"count":{"type":"integer","title":"Count","default":0},"issuer_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Issuer Count","description":"Issuers on this page (page_by=issuer)"},"total_count":{"type":"integer","title":"Total Count","default":0},"offset":{"type":"integer","title":"Offset","default":0},"limit":{"type":"integer","title":"Limit","default":50},"next_offset":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Next Offset"},"page_by":{"type":"string","enum":["issuer","event"],"title":"Page By"},"has_more":{"type":"boolean","title":"Has More","default":false},"items":{"items":{"$ref":"#/components/schemas/CorporateEventOut"},"type":"array","title":"Items"},"kinds":{"additionalProperties":{"type":"integer"},"type":"object","title":"Kinds"}},"additionalProperties":true,"type":"object","required":["page_by"],"title":"MarketLifecycleEventsOut"},"MarketSnapshot":{"properties":{"ticker":{"type":"string","title":"Ticker"},"provider":{"type":"string","title":"Provider"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"},"price":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"exchange":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Exchange"},"day_change":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Day Change"},"day_change_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Day Change Pct"},"volume":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Volume"},"history":{"items":{"$ref":"#/components/schemas/MarketHistoryPoint"},"type":"array","title":"History"},"market_cap":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Market Cap"},"shares_outstanding":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Shares Outstanding"},"pe_trailing":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pe Trailing"},"pe_forward":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Pe Forward"},"eps_ttm":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Eps Ttm"},"beta":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Beta"},"fifty_two_week_high":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fifty Two Week High"},"fifty_two_week_low":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fifty Two Week Low"},"dividend_yield":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Dividend Yield"},"fund_total_assets":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Fund Total Assets"},"chart_range":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chart Range"},"price_coverage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Price Coverage"},"price_first_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Price First Date"},"price_last_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Price Last Date"},"price_points":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Price Points"},"price_freshness":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Price Freshness"},"price_as_of_age_sec":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Price As Of Age Sec"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["ticker","provider"],"title":"MarketSnapshot"},"MoveRow":{"properties":{"change_pct":{"type":"number","title":"Change Pct"},"window_start":{"type":"string","title":"Window Start"},"window_end":{"type":"string","title":"Window End"},"requested_days":{"type":"integer","title":"Requested Days"}},"additionalProperties":true,"type":"object","required":["change_pct","window_start","window_end","requested_days"],"title":"MoveRow"},"MoversOut":{"properties":{"engine":{"type":"string","title":"Engine"},"as_of":{"type":"string","title":"As Of"},"window_days":{"type":"integer","title":"Window Days"},"basis":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Basis"},"count":{"type":"integer","title":"Count","default":0},"missing":{"type":"integer","title":"Missing","default":0},"gainers":{"items":{"$ref":"#/components/schemas/MoveRow"},"type":"array","title":"Gainers"},"losers":{"items":{"$ref":"#/components/schemas/MoveRow"},"type":"array","title":"Losers"}},"type":"object","required":["engine","as_of","window_days"],"title":"MoversOut","description":"Largest stored moves over the requested window. No network on this call."},"NotificationItem":{"properties":{"id":{"type":"string","title":"Id"},"event_type":{"type":"string","title":"Event Type"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"press_release_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Press Release Id"},"insider_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Insider Transaction Id"},"event_transcript_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Transcript Id"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"category":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"payload":{"additionalProperties":true,"type":"object","title":"Payload"},"read_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Read At"},"created_at":{"type":"string","title":"Created At"}},"type":"object","required":["id","event_type","created_at"],"title":"NotificationItem","description":"Stable inbox item schema — shared by workbench, mobile, webhooks pointer."},"NotificationListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/NotificationItem"},"type":"array","title":"Items"},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"unread_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Unread Count"}},"type":"object","title":"NotificationListResponse"},"NotificationUnreadCountResponse":{"properties":{"unread_count":{"type":"integer","title":"Unread Count"}},"type":"object","required":["unread_count"],"title":"NotificationUnreadCountResponse"},"PeopleFacetItem":{"properties":{"id":{"type":"string","title":"Id"},"count":{"type":"integer","title":"Count","default":0}},"type":"object","required":["id"],"title":"PeopleFacetItem"},"PeopleFacetsResponse":{"properties":{"kinds":{"items":{"$ref":"#/components/schemas/PeopleFacetItem"},"type":"array","title":"Kinds"},"relations":{"items":{"$ref":"#/components/schemas/PeopleFacetItem"},"type":"array","title":"Relations"},"markets":{"items":{"$ref":"#/components/schemas/PeopleFacetItem"},"type":"array","title":"Markets"}},"type":"object","title":"PeopleFacetsResponse"},"PersonEntityRefOut":{"properties":{"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"}},"type":"object","title":"PersonEntityRefOut","description":"Resolved issuer listing coordinates (market + ticker) for this party."},"PersonFilingOut":{"properties":{"filing_id":{"type":"string","title":"Filing Id"},"form_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Form Type"},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Date"},"reporting_for":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reporting For"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"},"html_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Html Url"},"source_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Label"},"relation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relation"},"role_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Title"}},"type":"object","required":["filing_id"],"title":"PersonFilingOut"},"PersonHoldingOut":{"properties":{"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"},"relation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relation"},"role_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Title"},"ownership_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ownership Pct"},"shares_raw":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shares Raw"},"shareholding_raw":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shareholding Raw"},"shareholding_normalized":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Shareholding Normalized"},"relationship_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relationship Note"},"control_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Control Note"},"as_of_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of Date"},"source_tag":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Tag"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"is_current":{"type":"boolean","title":"Is Current","default":false}},"type":"object","title":"PersonHoldingOut"},"PersonIdentifiersOut":{"properties":{"sec_reporter_cik":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sec Reporter Cik"},"ms_insider_slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ms Insider Slug"},"ch_officer_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ch Officer Id"},"entity_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Entity Key"},"entity_ref":{"anyOf":[{"$ref":"#/components/schemas/PersonEntityRefOut"},{"type":"null"}]}},"type":"object","title":"PersonIdentifiersOut"},"PersonInsiderSummaryOut":{"properties":{"count":{"type":"integer","title":"Count","default":0},"last_transaction_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Transaction Date"},"match":{"type":"string","title":"Match","default":"none"}},"type":"object","title":"PersonInsiderSummaryOut","description":"Aggregates only — the rows themselves are Pro-gated (plan §4.4)."},"PersonInsiderTransactionsResponse":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Isin"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"count":{"type":"integer","title":"Count","default":0},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count"},"insider_transactions":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Insider Transactions"},"item_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Item Count"},"has_more_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has More Locked"},"access":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Access"},"access_meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Access Meta"},"upgrade_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Upgrade Required"},"upgrade_feature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Upgrade Feature"},"upgrade_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Upgrade Message"},"party_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Party Id"},"match":{"type":"string","title":"Match","default":"none"}},"type":"object","title":"PersonInsiderTransactionsResponse","description":"Same rows as the ticker/filing routes, plus how the party was matched."},"PersonListItem":{"properties":{"id":{"type":"string","title":"Id"},"slug":{"type":"string","title":"Slug"},"name":{"type":"string","title":"Name"},"kind":{"type":"string","title":"Kind","default":"person"},"birth_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Birth Date"},"role_count":{"type":"integer","title":"Role Count","default":0},"company_count":{"type":"integer","title":"Company Count","default":0},"has_current_role":{"type":"boolean","title":"Has Current Role","default":true},"top_ownership_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Top Ownership Pct"},"as_of_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of Date"},"relations":{"items":{"type":"string"},"type":"array","title":"Relations"},"markets":{"items":{"type":"string"},"type":"array","title":"Markets"},"sources":{"items":{"type":"string"},"type":"array","title":"Sources"},"primary_role":{"anyOf":[{"$ref":"#/components/schemas/PersonPrimaryRoleOut"},{"type":"null"}]}},"type":"object","required":["id","slug","name"],"title":"PersonListItem"},"PersonListResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PersonListItem"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Count"}},"type":"object","required":["items","limit","offset"],"title":"PersonListResponse"},"PersonPrimaryRoleOut":{"properties":{"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"relation":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relation"},"role_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Title"},"ownership_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ownership Pct"},"since_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Since Date"},"until_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Until Date"}},"type":"object","title":"PersonPrimaryRoleOut","description":"The one role a directory row shows — highest stake, else most recent."},"PersonProfileResponse":{"properties":{"id":{"type":"string","title":"Id"},"slug":{"type":"string","title":"Slug"},"name":{"type":"string","title":"Name"},"name_normalized":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name Normalized"},"kind":{"type":"string","title":"Kind","default":"person"},"birth_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Birth Date"},"identifiers":{"$ref":"#/components/schemas/PersonIdentifiersOut"},"first_seen_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Seen At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"stats":{"$ref":"#/components/schemas/PersonStatsOut"},"roles":{"items":{"$ref":"#/components/schemas/PersonRoleOut"},"type":"array","title":"Roles"},"roles_total":{"type":"integer","title":"Roles Total","default":0},"holdings":{"items":{"$ref":"#/components/schemas/PersonHoldingOut"},"type":"array","title":"Holdings"},"filings":{"items":{"$ref":"#/components/schemas/PersonFilingOut"},"type":"array","title":"Filings"},"insider_summary":{"$ref":"#/components/schemas/PersonInsiderSummaryOut"}},"type":"object","required":["id","slug","name"],"title":"PersonProfileResponse"},"PersonRoleOut":{"properties":{"id":{"type":"string","title":"Id"},"canonical_key":{"type":"string","title":"Canonical Key"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"},"relation":{"type":"string","title":"Relation"},"role_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Role Title"},"age":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Age"},"since_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Since Date"},"until_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Until Date"},"as_of_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of Date"},"is_current":{"type":"boolean","title":"Is Current","default":false},"ownership_pct":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Ownership Pct"},"shares_raw":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shares Raw"},"shareholding_raw":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Shareholding Raw"},"shareholding_normalized":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Shareholding Normalized"},"shareholding_disclosed":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Shareholding Disclosed"},"relationship_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Relationship Note"},"control_note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Control Note"},"governance_detail":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Governance Detail"},"source_tag":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Tag"},"source_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Url"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"}},"type":"object","required":["id","canonical_key","relation"],"title":"PersonRoleOut"},"PersonRolesResponse":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PersonRoleOut"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total","default":0},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"},"party_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Party Id"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"}},"type":"object","required":["items","limit","offset"],"title":"PersonRolesResponse"},"PersonStatsOut":{"properties":{"role_count":{"type":"integer","title":"Role Count","default":0},"company_count":{"type":"integer","title":"Company Count","default":0},"current_role_count":{"type":"integer","title":"Current Role Count","default":0},"markets":{"items":{"type":"string"},"type":"array","title":"Markets"},"sources":{"items":{"type":"string"},"type":"array","title":"Sources"}},"type":"object","title":"PersonStatsOut"},"ProductDiscoveryOut":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"entity":{"$ref":"#/components/schemas/ProductEntityOut"},"markets":{"items":{"$ref":"#/components/schemas/ProductMarketFilingsBlockOut"},"type":"array","title":"Markets"},"total_count":{"type":"integer","title":"Total Count","default":0},"markets_searched":{"items":{"type":"string"},"type":"array","title":"Markets Searched"},"markets_skipped":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Markets Skipped"},"resolution_hints":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Resolution Hints"},"resolve_timing_ms":{"anyOf":[{"additionalProperties":{"type":"integer"},"type":"object"},{"type":"null"}],"title":"Resolve Timing Ms"},"retry_after":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retry After"},"poll_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Poll Url"},"ambiguous":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ambiguous"},"entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProductEntityOut"},"type":"array"},{"type":"null"}],"title":"Entities"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"}},"additionalProperties":true,"type":"object","required":["entity"],"title":"ProductDiscoveryOut","description":"Cross-market discovery — MCP `list_filings` / REST `GET /filings/discover`."},"ProductEarningsEventOut":{"properties":{"filing_id":{"type":"string","title":"Filing Id"},"earnings_event":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Earnings Event"}},"type":"object","required":["filing_id"],"title":"ProductEarningsEventOut"},"ProductEntityAliasOut":{"properties":{"type":{"type":"string","title":"Type"},"value":{"type":"string","title":"Value"}},"type":"object","required":["type","value"],"title":"ProductEntityAliasOut"},"ProductEntityIdentifiersOut":{"properties":{"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei"},"isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Isin"},"isins":{"items":{"type":"string"},"type":"array","title":"Isins"},"sec_cik":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sec Cik"},"org_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Id"},"yahoo_symbol":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Yahoo Symbol"}},"type":"object","title":"ProductEntityIdentifiersOut"},"ProductEntityIndustryOut":{"properties":{"group":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Group"},"sic":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sic"},"damodaran":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Damodaran"},"industry_local":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Industry Local"}},"type":"object","title":"ProductEntityIndustryOut"},"ProductEntityLinksOut":{"properties":{"filings_discover":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filings Discover"},"company_page":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Page"}},"type":"object","title":"ProductEntityLinksOut"},"ProductEntityListingOut":{"properties":{"market_id":{"type":"string","title":"Market Id"},"ticker":{"type":"string","title":"Ticker"},"registry":{"type":"string","title":"Registry"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"score":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Score"},"hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hint"},"primary":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Primary"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"}},"additionalProperties":true,"type":"object","required":["market_id","ticker","registry"],"title":"ProductEntityListingOut"},"ProductEntityLookupOut":{"properties":{"canonical_key":{"type":"string","title":"Canonical Key"},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"display_name_local":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name Local"},"identifiers":{"$ref":"#/components/schemas/ProductEntityIdentifiersOut"},"aliases":{"items":{"$ref":"#/components/schemas/ProductEntityAliasOut"},"type":"array","title":"Aliases"},"listings":{"items":{"$ref":"#/components/schemas/ProductEntityListingOut"},"type":"array","title":"Listings"},"industry":{"$ref":"#/components/schemas/ProductEntityIndustryOut"},"links":{"$ref":"#/components/schemas/ProductEntityLinksOut"},"provenance":{"$ref":"#/components/schemas/ProductEntityProvenanceOut"}},"additionalProperties":true,"type":"object","required":["canonical_key","identifiers","industry","links","provenance"],"title":"ProductEntityLookupOut","description":"Deterministic entity registry record — `GET /entities/lookup`."},"ProductEntityOut":{"properties":{"lei":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Lei"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"display_names":{"items":{"type":"string"},"type":"array","title":"Display Names"},"listings":{"items":{"$ref":"#/components/schemas/ProductEntityListingOut"},"type":"array","title":"Listings"},"ambiguous":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ambiguous"}},"type":"object","title":"ProductEntityOut"},"ProductEntityProvenanceOut":{"properties":{"resolution_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resolution Status"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"}},"type":"object","title":"ProductEntityProvenanceOut"},"ProductFilingKpisOut":{"properties":{"filing_id":{"type":"string","title":"Filing Id"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"company":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company"},"period":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period"},"period_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period Label"},"period_end":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Period End"},"currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currency"},"reporting_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Reporting Currency"},"accounting_standard":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Standard"},"accounting_standard_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Accounting Standard Label"},"source":{"$ref":"#/components/schemas/KpiSourceOut"},"canonical":{"additionalProperties":{"anyOf":[{"type":"number"},{"type":"null"}]},"type":"object","title":"Canonical","description":"KPI code → value in reporting currency units. Codes: GET /api/v1/kpi-taxonomy."},"gold_financials":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Gold Financials","description":"Extended Japan (EDINET) financial fields, keyed by field name."},"yoy_periods":{"anyOf":[{"$ref":"#/components/schemas/KpiYoyPeriodsOut"},{"type":"null"}]},"period_context":{"anyOf":[{"$ref":"#/components/schemas/KpiPeriodContextOut"},{"type":"null"}]},"notes":{"items":{"type":"string"},"type":"array","title":"Notes"},"field_notes":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Field Notes","description":"KPI code → note on how that field is defined"},"groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/src__product__api__schemas__KpiGroupOut"},"type":"array"},{"type":"null"}],"title":"Groups","description":"Statement-grouped display values (include_groups=true)"},"red_flags":{"anyOf":[{"items":{"$ref":"#/components/schemas/KpiRedFlagOut"},"type":"array"},{"type":"null"}],"title":"Red Flags","description":"Rule-based warnings (include_red_flags=true)"},"red_flag_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Red Flag Count"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"provenance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance"}},"type":"object","required":["filing_id"],"title":"ProductFilingKpisOut"},"ProductFilingResolveOut":{"properties":{"status":{"type":"string","title":"Status"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"form_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Form Type"},"provenance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"},"official_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Official Url"},"filing":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Filing"},"earnings_event":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Earnings Event"},"insider_transactions":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Insider Transactions"},"insider_transaction_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Insider Transaction Count"},"proxy_statement":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Proxy Statement"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"job":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Job"},"parse_runs":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Parse Runs"},"retry_after":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retry After"},"poll_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Poll Url"}},"type":"object","required":["status"],"title":"ProductFilingResolveOut"},"ProductFilingSectionOut":{"properties":{"filing_id":{"type":"string","title":"Filing Id"},"section_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Key"},"item_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Number"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"content_format":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Format"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content"},"truncated":{"type":"boolean","title":"Truncated","default":false},"char_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Char Count"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"provenance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"}},"type":"object","required":["filing_id"],"title":"ProductFilingSectionOut"},"ProductFilingSectionsOut":{"properties":{"filing_id":{"type":"string","title":"Filing Id"},"parse_run_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parse Run Id"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"section_count":{"type":"integer","title":"Section Count","default":0},"sections":{"items":{"anyOf":[{"$ref":"#/components/schemas/ProductSectionSummary"},{"additionalProperties":true,"type":"object"}]},"type":"array","title":"Sections"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"provenance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"table_of_contents":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Table Of Contents"}},"type":"object","required":["filing_id"],"title":"ProductFilingSectionsOut"},"ProductListFilingsOut":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"provenance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance"},"sync_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sync Status"},"count":{"type":"integer","title":"Count","default":0},"filings":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Filings"},"since_year":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Since Year"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"retry_after":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Retry After"},"poll_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Poll Url"}},"type":"object","title":"ProductListFilingsOut"},"ProductListInsiderTransactionsOut":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Isin"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"count":{"type":"integer","title":"Count","default":0},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count"},"insider_transactions":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Insider Transactions"},"item_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Item Count"},"has_more_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has More Locked"},"access":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Access"},"access_meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Access Meta"},"upgrade_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Upgrade Required"},"upgrade_feature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Upgrade Feature"},"upgrade_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Upgrade Message"}},"type":"object","title":"ProductListInsiderTransactionsOut"},"ProductListPressReleasesOut":{"properties":{"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Isin"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"count":{"type":"integer","title":"Count","default":0},"total_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Total Count"},"press_releases":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Press Releases"},"item_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Item Count"},"has_more_locked":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has More Locked"},"access":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Access"},"access_meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Access Meta"},"upgrade_required":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Upgrade Required"},"upgrade_feature":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Upgrade Feature"},"upgrade_message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Upgrade Message"}},"type":"object","title":"ProductListPressReleasesOut"},"ProductMarketFilingsBlockOut":{"properties":{"market_id":{"type":"string","title":"Market Id"},"ticker":{"type":"string","title":"Ticker"},"provenance":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provenance"},"count":{"type":"integer","title":"Count","default":0},"filings":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Filings"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"},"hint":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hint"},"sync_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sync Status"}},"additionalProperties":true,"type":"object","required":["market_id","ticker"],"title":"ProductMarketFilingsBlockOut"},"ProductMarketOut":{"properties":{"id":{"type":"string","title":"Id"},"label":{"type":"string","title":"Label"},"short_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Short Label"},"min_plan":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Min Plan"},"registries":{"items":{"type":"string"},"type":"array","title":"Registries"},"default_form_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Form Type"}},"type":"object","required":["id","label"],"title":"ProductMarketOut"},"ProductMarketsOut":{"properties":{"plan":{"type":"string","title":"Plan"},"is_admin":{"type":"boolean","title":"Is Admin","default":false},"markets":{"items":{"$ref":"#/components/schemas/ProductMarketOut"},"type":"array","title":"Markets"},"allowed_market_ids":{"items":{"type":"string"},"type":"array","title":"Allowed Market Ids"},"filtered_by_plan":{"type":"boolean","title":"Filtered By Plan","default":false},"all_markets":{"type":"boolean","title":"All Markets","default":false}},"type":"object","required":["plan"],"title":"ProductMarketsOut"},"ProductSearchEntitiesOut":{"properties":{"entity":{"$ref":"#/components/schemas/ProductEntityOut"},"markets_skipped":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Markets Skipped"},"resolve_timing_ms":{"anyOf":[{"additionalProperties":{"type":"integer"},"type":"object"},{"type":"null"}],"title":"Resolve Timing Ms"},"ambiguous":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Ambiguous"},"entities":{"anyOf":[{"items":{"$ref":"#/components/schemas/ProductEntityOut"},"type":"array"},{"type":"null"}],"title":"Entities"},"message":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Message"}},"additionalProperties":true,"type":"object","required":["entity"],"title":"ProductSearchEntitiesOut","description":"Entity search — MCP `search_ticker` / REST `GET /entities/search`."},"ProductSectionSummary":{"properties":{"section_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Section Key"},"item_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Item Number"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"char_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Char Count"}},"type":"object","title":"ProductSectionSummary"},"RedFlagScreenItem":{"properties":{"canonical_key":{"type":"string","title":"Canonical Key"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"as_of":{"type":"string","title":"As Of"},"match":{"$ref":"#/components/schemas/RedFlagScreenMatch"}},"type":"object","required":["canonical_key","as_of","match"],"title":"RedFlagScreenItem"},"RedFlagScreenMatch":{"properties":{"predicate":{"type":"string","title":"Predicate","default":"red_flag"},"rule_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule Id"},"severity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Severity"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"filing_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Date"},"llm_verdict":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Llm Verdict"},"window_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Window Days"}},"type":"object","title":"RedFlagScreenMatch"},"RedFlagScreenOut":{"properties":{"engine":{"type":"string","title":"Engine","default":"red_flag"},"as_of":{"type":"string","title":"As Of"},"rule_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rule Id"},"severity":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Severity"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"window_days":{"type":"integer","title":"Window Days"},"count":{"type":"integer","title":"Count","default":0},"has_more":{"type":"boolean","title":"Has More","default":false},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/RedFlagScreenItem"},"type":"array","title":"Items"}},"type":"object","required":["as_of","window_days"],"title":"RedFlagScreenOut","description":"Issuers with a red flag in the caller's window. Metered."},"SignalBaseRateOut":{"properties":{"market_id":{"type":"string","title":"Market Id"},"kind":{"type":"string","title":"Kind"},"variant":{"type":"string","title":"Variant","description":"direction / status / opinion / salience / authority, or 'all'"},"horizon":{"type":"integer","title":"Horizon","description":"Trading days after the last close before the event"},"n":{"type":"integer","title":"N"},"mean":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Mean","description":"Clipped mean abnormal return (fraction)"},"median":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Median","description":"Median abnormal return (fraction)"},"p25":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"P25"},"p75":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"P75"},"share_negative":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Share Negative"},"t_stat":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"T Stat"},"benchmark":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Benchmark"}},"additionalProperties":true,"type":"object","required":["market_id","kind","variant","horizon","n"],"title":"SignalBaseRateOut"},"SignalBaseRatesOut":{"properties":{"count":{"type":"integer","title":"Count","default":0},"items":{"items":{"$ref":"#/components/schemas/SignalBaseRateOut"},"type":"array","title":"Items"}},"type":"object","title":"SignalBaseRatesOut"},"SignalCaseOut":{"properties":{"case_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Case Id"},"latest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest"},"kinds":{"items":{"type":"string"},"type":"array","title":"Kinds"},"events":{"items":{"$ref":"#/components/schemas/SignalEventOut"},"type":"array","title":"Events"}},"type":"object","title":"SignalCaseOut"},"SignalEventOut":{"properties":{"id":{"type":"string","title":"Id"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"has_company_page":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Has Company Page"},"kind":{"type":"string","title":"Kind"},"event_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Event Date","description":"YYYY-MM-DD"},"filing_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filing Id"},"source":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source"},"source_detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Detail","description":"Regulator item code the event was read from"},"deal_form":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deal Form"},"counterparty_raw_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Raw Name"},"counterparty_canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Canonical Key"},"counterparty_ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Ticker"},"counterparty_market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Counterparty Market Id"},"filer_role":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Filer Role","description":"Which side the filer took, when the text says"},"evidence_quote":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Evidence Quote","description":"Sentence the event was read from"},"consideration_amount":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Consideration Amount"},"consideration_currency":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Consideration Currency"},"confidence":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Confidence"},"family":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Family","description":"dilution | audit | reporting | governance | distress | guidance | capital_return | legal"},"salience":{"anyOf":[{"type":"string","enum":["routine","notable"]},{"type":"null"}],"title":"Salience","description":"routine = e.g. a mandated auditor rotation with no other signal within a year"},"status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Status","description":"Stage the document reports (decided, lifted, …)"},"effective_date":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Effective Date"},"case_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Case Id","description":"Shared by notices of one story"},"fields":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Fields","description":"Typed facts for the kind (forecast table, audit firm, conversion price…)"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"evidence":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Evidence","description":"{url, quotes, references}"},"market_reaction":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Market Reaction","description":"{benchmark, ref_date, car_2, car_5, car_20} abnormal returns"},"base_rate":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Base Rate","description":"Typical reaction to this signal in this market: {horizon_days, median, share_negative, n}"}},"additionalProperties":true,"type":"object","required":["id","kind"],"title":"SignalEventOut","description":"A corporate event read as a disclosure signal."},"SignalEventsOut":{"properties":{"count":{"type":"integer","title":"Count","default":0},"offset":{"type":"integer","title":"Offset","default":0},"items":{"items":{"$ref":"#/components/schemas/SignalEventOut"},"type":"array","title":"Items"}},"type":"object","title":"SignalEventsOut"},"SignalPatternOut":{"properties":{"id":{"type":"string","enum":["dilution_spiral","audit_distress","auditor_churn","accounting_failure","late_filer","guidance_cut_streak","exit_risk"],"title":"Id"},"label":{"type":"string","title":"Label"},"strength":{"type":"string","enum":["strong","moderate"],"title":"Strength"},"since":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Since"},"latest":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Latest"},"event_ids":{"items":{"type":"string"},"type":"array","title":"Event Ids"},"why":{"type":"string","title":"Why"}},"type":"object","required":["id","label","strength","why"],"title":"SignalPatternOut"},"SignalScreenItemOut":{"properties":{"canonical_key":{"type":"string","title":"Canonical Key"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"patterns":{"items":{"$ref":"#/components/schemas/SignalPatternOut"},"type":"array","title":"Patterns"},"profile":{"additionalProperties":true,"type":"object","title":"Profile"}},"type":"object","required":["canonical_key"],"title":"SignalScreenItemOut"},"SignalScreenOut":{"properties":{"as_of":{"type":"string","title":"As Of"},"pattern":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pattern"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"total_count":{"type":"integer","title":"Total Count","default":0},"count":{"type":"integer","title":"Count","default":0},"offset":{"type":"integer","title":"Offset","default":0},"has_more":{"type":"boolean","title":"Has More","default":false},"items":{"items":{"$ref":"#/components/schemas/SignalScreenItemOut"},"type":"array","title":"Items"}},"type":"object","required":["as_of"],"title":"SignalScreenOut"},"StreetScreenItem":{"properties":{"canonical_key":{"type":"string","title":"Canonical Key"},"ticker":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ticker"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"company_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Company Name"},"as_of":{"type":"string","title":"As Of"},"match":{"$ref":"#/components/schemas/StreetScreenMatch"}},"type":"object","required":["canonical_key","as_of","match"],"title":"StreetScreenItem"},"StreetScreenMatch":{"properties":{"predicate":{"type":"string","title":"Predicate","default":"street"},"recommendation_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recommendation Key"},"recommendation_mean":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Recommendation Mean"},"analyst_count":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Analyst Count"},"listing":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Listing"},"as_of":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"As Of"},"window_days":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Window Days"}},"type":"object","title":"StreetScreenMatch"},"StreetScreenOut":{"properties":{"engine":{"type":"string","title":"Engine","default":"street"},"as_of":{"type":"string","title":"As Of"},"recommendation_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Recommendation Key"},"market_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market Id"},"window_days":{"type":"integer","title":"Window Days"},"count":{"type":"integer","title":"Count","default":0},"has_more":{"type":"boolean","title":"Has More","default":false},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor"},"items":{"items":{"$ref":"#/components/schemas/StreetScreenItem"},"type":"array","title":"Items"}},"type":"object","required":["as_of","window_days"],"title":"StreetScreenOut","description":"Issuers by published analyst recommendation. Metered. One row per issuer."},"UpdateUserWatchlistRequest":{"properties":{"notification_form_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Notification Form Types"}},"type":"object","title":"UpdateUserWatchlistRequest"},"UserWatchlistEntry":{"properties":{"ticker":{"type":"string","title":"Ticker"},"canonical_key":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Canonical Key"},"known_to_system":{"type":"boolean","title":"Known To System","default":false},"display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Display Name"},"market":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Market"},"registry":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Registry"},"resolution_status":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resolution Status"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"isin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Isin"},"notification_form_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Notification Form Types"}},"type":"object","required":["ticker"],"title":"UserWatchlistEntry"},"UserWatchlistResponse":{"properties":{"tickers":{"items":{"type":"string"},"type":"array","title":"Tickers"},"entries":{"items":{"$ref":"#/components/schemas/UserWatchlistEntry"},"type":"array","title":"Entries"},"watchlist_max":{"type":"integer","title":"Watchlist Max","default":0},"watchlist_unlimited":{"type":"boolean","title":"Watchlist Unlimited","default":true}},"type":"object","required":["tickers"],"title":"UserWatchlistResponse"},"UserWebhookCreate":{"properties":{"url":{"type":"string","maxLength":2048,"minLength":8,"title":"Url"},"event_types":{"items":{"type":"string"},"type":"array","title":"Event Types"},"secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secret"},"active":{"type":"boolean","title":"Active","default":true}},"type":"object","required":["url"],"title":"UserWebhookCreate"},"UserWebhookOut":{"properties":{"id":{"type":"string","title":"Id"},"url":{"type":"string","title":"Url"},"event_types":{"items":{"type":"string"},"type":"array","title":"Event Types"},"secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secret"},"active":{"type":"boolean","title":"Active"},"created_at":{"type":"string","title":"Created At"},"updated_at":{"type":"string","title":"Updated At"}},"type":"object","required":["id","url","event_types","secret","active","created_at","updated_at"],"title":"UserWebhookOut"},"UserWebhookTestResult":{"properties":{"ok":{"type":"boolean","title":"Ok"},"status_code":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Status Code"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["ok"],"title":"UserWebhookTestResult"},"UserWebhookUpdate":{"properties":{"url":{"anyOf":[{"type":"string","maxLength":2048,"minLength":8},{"type":"null"}],"title":"Url"},"event_types":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Event Types"},"secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secret"},"active":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Active"}},"type":"object","title":"UserWebhookUpdate","description":"Partial update — omitted fields are left unchanged."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WeoAreaItem":{"properties":{"area":{"type":"string","title":"Area"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Kind"}},"type":"object","required":["area"],"title":"WeoAreaItem"},"WeoAreasResponse":{"properties":{"vintage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vintage"},"vintages":{"items":{"type":"string"},"type":"array","title":"Vintages"},"items":{"items":{"$ref":"#/components/schemas/WeoAreaItem"},"type":"array","title":"Items"},"total":{"type":"integer","title":"Total","default":0}},"type":"object","title":"WeoAreasResponse"},"WeoPoint":{"properties":{"t":{"type":"string","title":"T"},"v":{"type":"number","title":"V"},"is_forecast":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Forecast"}},"type":"object","required":["t","v"],"title":"WeoPoint"},"WeoSeriesResponse":{"properties":{"area":{"type":"string","title":"Area"},"subject":{"type":"string","title":"Subject"},"vintage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Vintage"},"vintages":{"items":{"type":"string"},"type":"array","title":"Vintages"},"status":{"type":"string","title":"Status","default":"empty"},"series_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Series Id"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label"},"unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Unit"},"scale":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scale"},"ref_area":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Ref Area"},"area_label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Area Label"},"area_kind":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Area Kind"},"points":{"items":{"$ref":"#/components/schemas/WeoPoint"},"type":"array","title":"Points"}},"type":"object","required":["area","subject"],"title":"WeoSeriesResponse"},"src__product__api__schemas__KpiGroupOut":{"properties":{"id":{"type":"string","title":"Id","description":"income | balance | cashflow | …"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"kpis":{"additionalProperties":{"$ref":"#/components/schemas/KpiGroupValueOut"},"type":"object","title":"Kpis","description":"Display label → value"}},"additionalProperties":true,"type":"object","required":["id"],"title":"KpiGroupOut"}},"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key from openfilings.org → My Page → API Keys."},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth access token (same realm as the website / MCP)."}}},"servers":[{"url":"https://api.openfilings.org"}],"tags":[{"name":"Markets","description":"Markets covered by your plan."},{"name":"Entities","description":"Issuer search and identity lookup."},{"name":"Filings","description":"Filing history, full-text search, sections, and KPIs."},{"name":"Financials","description":"As-filed multi-year series and the KPI taxonomy."},{"name":"Companies","description":"Earnings releases, supply chain, quotes, and holders."},{"name":"Press releases","description":"Issuer press releases."},{"name":"People & insiders","description":"Officers, directors, and insider transactions."},{"name":"Corporate events","description":"Corporate actions and issuer lifecycle events."},{"name":"Disclosure signals","description":"Auditor changes, non-clean opinions, restatements, investigations, dilution, distress and forecast revisions read from issuers' own notices — per-issuer dossier with computed profile and named patterns, a pattern screen, and the feed."},{"name":"Market data","description":"FX and policy rates."},{"name":"Documents","description":"Raw document archive (Business plan)."},{"name":"Account","description":"Watchlist, notifications, and webhooks."}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}]}