{"openapi":"3.1.0","info":{"title":"DataPorium Data API","version":"1.0.0","description":"REST API for DataPorium data: stocks and companies, financial statements, markets, economy, real estate, healthcare, elections, energy, government activity and more. Every request needs an API key (sign up at https://dataporium.tech/pricing). Full documentation with example answers: https://dataporium.tech/api-docs. The same data is also available to AI assistants through the MCP server at https://mcp.dataporium.io/mcp.","termsOfService":"https://dataporium.tech/terms-of-use","contact":{"name":"DataPorium","url":"https://dataporium.tech","email":"info@dataporium.tech"}},"externalDocs":{"description":"DataPorium API documentation","url":"https://dataporium.tech/api-docs"},"servers":[{"url":"https://api.dataporium.io","description":"DataPorium Data API"}],"security":[{"apiKey":[]}],"tags":[{"name":"Stock Directory"},{"name":"Company Information"},{"name":"Quote"},{"name":"News"},{"name":"Stock Performance"},{"name":"Financial Statements"},{"name":"Earnings & Events"},{"name":"Shareholder Data"},{"name":"Insider Trades"},{"name":"US Elections"},{"name":"Politician Trades"},{"name":"Government Contracts"},{"name":"Lobbying"},{"name":"Patents"},{"name":"Trademarks"},{"name":"Private Fundraising"},{"name":"Short Interest"},{"name":"Drug Approvals"},{"name":"Healthcare Providers"},{"name":"Options Data"},{"name":"Market Hours"},{"name":"Economics"},{"name":"Industry Metrics"},{"name":"Forex"},{"name":"Commodity"},{"name":"Futures Positioning"},{"name":"Agriculture"},{"name":"Gas Prices"},{"name":"Electricity Rates & Grid Prices"},{"name":"Local Economy"},{"name":"Layoffs"},{"name":"Colleges"},{"name":"Industries"},{"name":"Banks"},{"name":"Consumer Complaints"},{"name":"Recalls"},{"name":"Transportation"},{"name":"Facility Compliance & Emissions"},{"name":"Employer Salaries"},{"name":"Mortgage Lending"},{"name":"Real Estate"},{"name":"Flood Claims & Disasters"}],"paths":{"/symbols-list":{"get":{"tags":["Stock Directory"],"summary":"Symbols by Exchange","description":"Search and retrieve company symbols, names, and identifiers across multiple exchanges.\n\nRequired: Choose ONE filter - symbol, company_name, or cik. Only one filter is needed per request.","operationId":"symbols_list","parameters":[{"name":"symbol","in":"query","required":true,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":true,"description":"Company name - searches in primary and alternate names (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"cik","in":"query","required":true,"description":"SEC CIK number (choose ONE filter)","schema":{"type":"string"},"example":"320193"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/company-info":{"get":{"tags":["Company Information"],"summary":"Company Info","description":"Get comprehensive company profile and fundamental data.\n\nRequired: Choose ONE filter - symbol or company_name. Only one filter is needed per request.","operationId":"company_info","parameters":[{"name":"symbol","in":"query","required":true,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":true,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/business-segments":{"get":{"tags":["Company Information"],"summary":"Business Segments","description":"Access detailed company business segment data including revenue breakdowns by geography, product lines, and business divisions.","operationId":"business_segments","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"fiscal_yearqtr","in":"query","required":false,"description":"Fiscal year (optional, annual data only)","schema":{"type":"string"},"example":"FY2024"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/business-segments/quarterly":{"get":{"tags":["Company Information"],"summary":"Business Segments (Quarterly)","description":"Revenue per fiscal quarter by business segment, product or service, region, country and other views (end markets, sales channels, customer types), from company filings. Includes parent and child items for drill-down, eliminations and corporate items, total revenue for each quarter and a flag for fourth quarters that are calculated as full year minus the first three quarters.\n\nRequired: symbol or cik. The answer is {symbol, company_name, total, limit, offset, sort, order, rows, about}. Annual figures stay in /business-segments.","operationId":"business_segments_quarterly","parameters":[{"name":"symbol","in":"query","required":false,"description":"Ticker (give symbol or cik)","schema":{"type":"string"},"example":"AAPL"},{"name":"cik","in":"query","required":false,"description":"Company registration number (give symbol or cik)","schema":{"type":"string"},"example":"320193"},{"name":"perspective","in":"query","required":false,"description":"segment, product, region, country, end_market, channel, customer, subsegment; comma-separated (default all)","schema":{"type":"string"},"example":"product"},{"name":"fiscal_year","in":"query","required":false,"description":"Company fiscal year","schema":{"type":"integer"},"example":2025},{"name":"fiscal_quarter","in":"query","required":false,"description":"Fiscal quarter 1 to 4","schema":{"type":"integer"},"example":4},{"name":"from_date","in":"query","required":false,"description":"Quarters ending on or after this date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2023-01-01"},{"name":"to_date","in":"query","required":false,"description":"Quarters ending on or before this date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2025-12-31"},{"name":"include_derived","in":"query","required":false,"description":"Include calculated fourth quarters (default true)","schema":{"type":"boolean"},"example":true},{"name":"latest_only","in":"query","required":false,"description":"Only the latest value of each quarter (default true)","schema":{"type":"boolean"},"example":true},{"name":"leaf_only","in":"query","required":false,"description":"Only rows that are not parents of other rows","schema":{"type":"boolean"},"example":false},{"name":"sort","in":"query","required":false,"description":"period_end (default), fiscal_period, revenue, name, perspective or filed_date","schema":{"type":"string"},"example":"period_end"},{"name":"order","in":"query","required":false,"description":"asc or desc (default desc)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 5000 (default 500)","schema":{"type":"integer"},"example":500},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/business-segments/views":{"get":{"tags":["Company Information"],"summary":"Business Segment Views","description":"Which revenue views (business segments, products and services, regions, countries and others) a company reports, and how much quarterly history each has. Views that are reported only once a year are marked annual only.\n\nRequired: symbol or cik. The answer is {symbol, company_name, views, about}.","operationId":"business_segments_views","parameters":[{"name":"symbol","in":"query","required":false,"description":"Ticker (give symbol or cik)","schema":{"type":"string"},"example":"MSFT"},{"name":"cik","in":"query","required":false,"description":"Company registration number (give symbol or cik)","schema":{"type":"string"},"example":"789019"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/business-segments/detail":{"get":{"tags":["Company Information"],"summary":"Business Segment Details","description":"Every revenue breakdown list a company reports in its SEC filings for one fiscal year, quarter or half-year, with all levels (for example segment > therapeutic area > drug > region), the parent of each item, partial lists, corporate and elimination items, and why a fourth quarter or second half-year is not shown.\n\nRequired: symbol or cik. Two lists are two separate splits of the same revenue: never add two breakdown_ids together. The answer is {symbol, company_name, currency, fiscal_type, fiscal_period, periods, rows, truncated, notes, about}.","operationId":"business_segments_detail","parameters":[{"name":"symbol","in":"query","required":false,"description":"Ticker (give symbol or cik)","schema":{"type":"string"},"example":"PFE"},{"name":"cik","in":"query","required":false,"description":"Company registration number (give symbol or cik)","schema":{"type":"string"},"example":"78003"},{"name":"fiscal_type","in":"query","required":false,"description":"annual, quarterly or half_year (default annual)","schema":{"type":"string"},"example":"quarterly"},{"name":"fiscal_period","in":"query","required":false,"description":"FY2025, 2025Q3 or 2025H1; all for every annual or half-year period (default: the latest)","schema":{"type":"string"},"example":"2025Q3"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/logo":{"get":{"tags":["Company Information"],"summary":"Company Logo","description":"Retrieve company logo images in various formats and sizes.","operationId":"logo","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/ma-transactions-summary":{"get":{"tags":["Company Information"],"summary":"Mergers & Investments","description":"Access mergers, acquisitions, and investment transaction data for a company.\n\nRequired: Choose ONE filter - symbol or company_name. Optional: transaction_stage, transaction_classification, date_announced can be added to refine results.","operationId":"ma_transactions_summary","parameters":[{"name":"symbol","in":"query","required":false,"description":"Company ticker symbol - searches both buyer and target (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name - searches both buyer and target (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"transaction_stage","in":"query","required":false,"description":"Completed, Pending, Cancelled (optional)","schema":{"type":"string"},"example":"Completed"},{"name":"transaction_classification","in":"query","required":false,"description":"Merger, Acquisition, Private Equity, Venture Capital (optional)","schema":{"type":"string"},"example":"Acquisition"},{"name":"date_announced","in":"query","required":false,"description":"Date (YYYY-MM-DD) (optional)","schema":{"type":"string"},"example":"2024-01-15"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/sec-filings":{"get":{"tags":["Company Information"],"summary":"SEC Filings","description":"Access company SEC filing documents and accession numbers.","operationId":"sec_filings","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"cik","in":"query","required":false,"description":"SEC CIK number (choose ONE filter)","schema":{"type":"string"},"example":"320193"},{"name":"accessionnumber","in":"query","required":false,"description":"SEC accession number (choose ONE filter)","schema":{"type":"string"},"example":"0000320193-24-000123"},{"name":"form_type","in":"query","required":false,"description":"Filing form type (optional)","schema":{"type":"string"},"example":"10-K"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/presentations":{"get":{"tags":["Company Information"],"summary":"Presentations","description":"Access company investor presentations and earnings presentations.","operationId":"presentations","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/industry":{"get":{"tags":["Company Information"],"summary":"Industry Classification","description":"Comprehensive industry and sector classification data for companies including NAICS, SIC, and revenue-based classifications.\n\nRequired: Choose ONE filter - symbol or company_name. Only one filter is needed per request.","operationId":"industry","parameters":[{"name":"symbol","in":"query","required":true,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":true,"description":"Company name - case-insensitive (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/stock-price-1d":{"get":{"tags":["Quote"],"summary":"Stock Price (1-Day)","description":"Real-time and historical daily price data with OHLCV (Open, High, Low, Close, Volume) for stocks, ETFs and indexes, e.g. AAPL, SPY, QQQ, TLT, GLD, ^GSPC (S&P 500; ^SPX also works), ^DJI, ^IXIC, ^RUT and ^VIX. In a URL, write ^ as %5E (ticker=%5EGSPC).","operationId":"stock_price_1d","parameters":[{"name":"ticker","in":"query","required":false,"description":"Ticker of a stock, ETF or index, e.g. AAPL, SPY or ^GSPC (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/stock-price-5m":{"get":{"tags":["Quote"],"summary":"Stock Price (5-Minute)","description":"Intraday price data with 5-minute intervals for stocks, ETFs and indexes (e.g. AAPL, SPY, QQQ, ^GSPC, ^VIX), for day trading and technical analysis.","operationId":"stock_price_5m","parameters":[{"name":"ticker","in":"query","required":false,"description":"Ticker of a stock, ETF or index, e.g. AAPL, SPY or ^GSPC (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/stock-news":{"get":{"tags":["News"],"summary":"Stock News","description":"Latest news articles and headlines related to specific stocks and companies.","operationId":"stock_news","parameters":[{"name":"ticker","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/press-release":{"get":{"tags":["News"],"summary":"Press Releases","description":"Official company press releases and announcements.","operationId":"press_release","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/gain-loss":{"get":{"tags":["Stock Performance"],"summary":"Stock Performance","description":"Historical stock performance metrics showing gains and losses over various time periods.","operationId":"gain_loss","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"status","in":"query","required":false,"description":"Performance status: gainer or loser (choose ONE filter)","schema":{"type":"string"},"example":"gainer"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/industry-performance":{"get":{"tags":["Stock Performance"],"summary":"Industry Performance","description":"Aggregate performance metrics for entire industries, showing average price changes and trends.","operationId":"industry_performance","parameters":[{"name":"industry","in":"query","required":false,"description":"Industry name (choose ONE filter)","schema":{"type":"string"},"example":"Biotechnology"},{"name":"exchange","in":"query","required":false,"description":"Stock exchange (choose ONE filter)","schema":{"type":"string"},"example":"NASDAQ"},{"name":"date","in":"query","required":false,"description":"Specific date (optional)","schema":{"type":"string"},"example":"2024-12-01"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/industry-performance-pe":{"get":{"tags":["Stock Performance"],"summary":"Industry P/E","description":"Industry-level Price-to-Earnings ratios and valuation metrics.","operationId":"industry_performance_pe","parameters":[{"name":"industry","in":"query","required":false,"description":"Industry name (choose ONE filter)","schema":{"type":"string"},"example":"Biotechnology"},{"name":"exchange","in":"query","required":false,"description":"Stock exchange (choose ONE filter)","schema":{"type":"string"},"example":"NASDAQ"},{"name":"date","in":"query","required":false,"description":"Specific date (optional)","schema":{"type":"string"},"example":"2024-12-01"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/sector-performance":{"get":{"tags":["Stock Performance"],"summary":"Sector Performance","description":"Broad market sector performance metrics and trends.","operationId":"sector_performance","parameters":[{"name":"sector","in":"query","required":false,"description":"Market sector (choose ONE filter)","schema":{"type":"string"},"example":"Energy"},{"name":"exchange","in":"query","required":false,"description":"Stock exchange (choose ONE filter)","schema":{"type":"string"},"example":"NASDAQ"},{"name":"date","in":"query","required":false,"description":"Specific date (optional)","schema":{"type":"string"},"example":"2024-12-01"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/sector-performance-pe":{"get":{"tags":["Stock Performance"],"summary":"Sector P/E","description":"Historical sector-level Price-to-Earnings ratios tracking valuation trends across market sectors.\n\nRequired: Choose ONE filter - sector or exchange. Optional: date can be added as secondary filter. Available sectors: Basic Materials, Communication Services, Consumer Cyclical, Consumer Defensive, Energy, Financial Services, Healthcare, Industrials, Real Estate, Technology, Utilities.","operationId":"sector_performance_pe","parameters":[{"name":"sector","in":"query","required":true,"description":"Market sector classification (choose ONE filter)","schema":{"type":"string"},"example":"Technology"},{"name":"exchange","in":"query","required":true,"description":"Stock exchange: NASDAQ, NYSE, AMEX (choose ONE filter)","schema":{"type":"string"},"example":"NASDAQ"},{"name":"date","in":"query","required":false,"description":"Specific date (optional, YYYY-MM-DD)","schema":{"type":"string"},"example":"2024-12-01"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/income-statements":{"get":{"tags":["Financial Statements"],"summary":"Income Statement","description":"Detailed income statements with full line items from SEC filings.","operationId":"income_statements","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"fiscal_year","in":"query","required":false,"description":"Fiscal year (combine with fiscal_qtr)","schema":{"type":"string"},"example":"2024"},{"name":"fiscal_qtr","in":"query","required":false,"description":"Fiscal quarter (combine with fiscal_year)","schema":{"type":"string"},"example":"Q2"},{"name":"fiscal_year_qtr","in":"query","required":false,"description":"Combined fiscal year and quarter","schema":{"type":"string"},"example":"2024Q2"},{"name":"period_type","in":"query","required":false,"description":"Annual or Quarterly (optional)","schema":{"type":"string"},"example":"Quarterly"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/income-statements-summary":{"get":{"tags":["Financial Statements"],"summary":"Income Summary","description":"Summarized income statement data with key revenue, expense, and profitability metrics.","operationId":"income_statements_summary","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"fiscal_year","in":"query","required":false,"description":"Fiscal year (combine with fiscal_qtr)","schema":{"type":"string"},"example":"2024"},{"name":"fiscal_qtr","in":"query","required":false,"description":"Fiscal quarter (combine with fiscal_year)","schema":{"type":"string"},"example":"Q2"},{"name":"fiscal_year_qtr","in":"query","required":false,"description":"Combined fiscal year and quarter","schema":{"type":"string"},"example":"2024Q2"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/balance-sheet-statements":{"get":{"tags":["Financial Statements"],"summary":"Balance Sheet","description":"Complete balance sheet data showing assets, liabilities, and equity.","operationId":"balance_sheet_statements","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"fiscal_year","in":"query","required":false,"description":"Fiscal year (combine with fiscal_qtr)","schema":{"type":"string"},"example":"2024"},{"name":"fiscal_qtr","in":"query","required":false,"description":"Fiscal quarter (combine with fiscal_year)","schema":{"type":"string"},"example":"Q2"},{"name":"fiscal_year_qtr","in":"query","required":false,"description":"Combined fiscal year and quarter","schema":{"type":"string"},"example":"2024Q2"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/balance-sheet-statements-summary":{"get":{"tags":["Financial Statements"],"summary":"Balance Sheet Summary","description":"Summarized balance sheet data with key asset, liability, and equity metrics.","operationId":"balance_sheet_statements_summary","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"fiscal_year","in":"query","required":false,"description":"Fiscal year (combine with fiscal_qtr)","schema":{"type":"string"},"example":"2024"},{"name":"fiscal_qtr","in":"query","required":false,"description":"Fiscal quarter (combine with fiscal_year)","schema":{"type":"string"},"example":"Q2"},{"name":"fiscal_year_qtr","in":"query","required":false,"description":"Combined fiscal year and quarter","schema":{"type":"string"},"example":"2024Q2"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/cash-flow-statements":{"get":{"tags":["Financial Statements"],"summary":"Cash Flow","description":"Detailed cash flow statements showing operating, investing, and financing activities.","operationId":"cash_flow_statements","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"fiscal_year","in":"query","required":false,"description":"Fiscal year (combine with fiscal_qtr)","schema":{"type":"string"},"example":"2024"},{"name":"fiscal_qtr","in":"query","required":false,"description":"Fiscal quarter (combine with fiscal_year)","schema":{"type":"string"},"example":"Q2"},{"name":"fiscal_year_qtr","in":"query","required":false,"description":"Combined fiscal year and quarter","schema":{"type":"string"},"example":"2024Q2"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/cash-flow-statements-summary":{"get":{"tags":["Financial Statements"],"summary":"Cash Flow Summary","description":"Summarized cash flow data showing operating, investing, and financing cash flows.","operationId":"cash_flow_statements_summary","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"fiscal_year","in":"query","required":false,"description":"Fiscal year (combine with fiscal_qtr)","schema":{"type":"string"},"example":"2024"},{"name":"fiscal_qtr","in":"query","required":false,"description":"Fiscal quarter (combine with fiscal_year)","schema":{"type":"string"},"example":"Q2"},{"name":"fiscal_year_qtr","in":"query","required":false,"description":"Combined fiscal year and quarter","schema":{"type":"string"},"example":"2024Q2"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/earnings-transcripts":{"get":{"tags":["Earnings & Events"],"summary":"Earnings Transcripts","description":"Full text transcripts from earnings calls and investor presentations.","operationId":"earnings_transcripts","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"year","in":"query","required":false,"description":"Year of earnings call (optional)","schema":{"type":"string"},"example":"2024"},{"name":"quarter","in":"query","required":false,"description":"Quarter (optional)","schema":{"type":"string"},"example":"Q2"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/earnings-split-calendar":{"get":{"tags":["Earnings & Events"],"summary":"Earnings & Split Calendar","description":"Upcoming and historical earnings dates, stock splits, and dividend dates.","operationId":"earnings_split_calendar","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/ipo-calendar":{"get":{"tags":["Earnings & Events"],"summary":"IPO Calendar","description":"IPO listings and offering details by company.","operationId":"ipo_calendar","parameters":[{"name":"symbol","in":"query","required":false,"description":"IPO ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"ABNB"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Airbnb"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/market-calendar":{"get":{"tags":["Earnings & Events"],"summary":"Market Calendar","description":"Comprehensive economic and market event calendar with 400+ event types.","operationId":"market_calendar","parameters":[{"name":"event_name","in":"query","required":true,"description":"Economic event name (e.g., FOMC_Meeting, Nonfarm_Payrolls, CPI, GDP, Retail_Sales, etc.)","schema":{"type":"string"},"example":"FOMC_Meeting"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/shareholders-by-type":{"get":{"tags":["Shareholder Data"],"summary":"Shareholders by Type","description":"Shareholder ownership breakdown by investor type (institutional, retail, insider).","operationId":"shareholders_by_type","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/shareholders-geo":{"get":{"tags":["Shareholder Data"],"summary":"Geographic Shareholders","description":"Shareholder geographic distribution by country and region.","operationId":"shareholders_geo","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/shareholders-class":{"get":{"tags":["Shareholder Data"],"summary":"Shareholders Class","description":"Share class structure details including voting rights and class distinctions.","operationId":"shareholders_class","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"GOOGL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Alphabet Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/shareholders-quarterly":{"get":{"tags":["Shareholder Data"],"summary":"Quarterly Shareholders","description":"Quarterly shareholder data with changes in institutional holdings.","operationId":"shareholders_quarterly","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."},{"name":"period","in":"query","required":false,"description":"Quarter period (e.g., 2024Q3)","schema":{"type":"string"},"example":"2024Q3"},{"name":"year","in":"query","required":false,"description":"Year filter","schema":{"type":"string"},"example":"2024"},{"name":"qtr","in":"query","required":false,"description":"Quarter (Q1, Q2, Q3, Q4)","schema":{"type":"string"},"example":"Q2"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/shareholders-quarterly-summary":{"get":{"tags":["Shareholder Data"],"summary":"Quarterly Shareholders Summary","description":"Summarized quarterly shareholder data with aggregate statistics.","operationId":"shareholders_quarterly_summary","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/insider-transactions":{"get":{"tags":["Insider Trades"],"summary":"Insider List","description":"List of all insider transactions including buys, sells, and option exercises.","operationId":"insider_transactions","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/insider-holdings-summary":{"get":{"tags":["Insider Trades"],"summary":"Insider Summary","description":"Aggregated insider ownership and recent transaction summary.","operationId":"insider_holdings_summary","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/insider-transaction-history":{"get":{"tags":["Insider Trades"],"summary":"Insider Transactions","description":"Historical insider transaction data with detailed transaction history.","operationId":"insider_transaction_history","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/elections/races":{"get":{"tags":["US Elections"],"summary":"Election Races","description":"US elections as races: president, U.S. Senate, U.S. House, governor, other statewide offices, state legislature, ballot measures and judicial races, each with the winner or leader, the runner-up, votes and shares, total votes, margin, party margin, swing against the previous comparable race, whether the winning party changed, live reporting progress and the status of the numbers.\n\nAll filters are optional and can be combined. The answer is {total, limit, offset, sort, order, rows, about}; sort is year, state, office, district, total_votes, margin, rd_margin, swing or name.","operationId":"elections_races","parameters":[{"name":"year","in":"query","required":false,"description":"Election year","schema":{"type":"integer"},"example":2024},{"name":"year_from","in":"query","required":false,"description":"First election year","schema":{"type":"integer"},"example":2016},{"name":"year_to","in":"query","required":false,"description":"Last election year","schema":{"type":"integer"},"example":2024},{"name":"office","in":"query","required":false,"description":"president, us_senate, us_house, governor, lt_governor, attorney_general, secretary_of_state, treasurer, other_statewide, state_senate, state_house, ballot_measure or judicial (comma-separated)","schema":{"type":"string"},"example":"us_senate"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s), comma-separated (US for the national race)","schema":{"type":"string"},"example":"TX"},{"name":"district","in":"query","required":false,"description":"District number such as 07 (00 = at large)","schema":{"type":"string"},"example":"07"},{"name":"special","in":"query","required":false,"description":"true = special elections only, false = without them","schema":{"type":"boolean"},"example":false},{"name":"status","in":"query","required":false,"description":"live, state_certified or certified_final","schema":{"type":"string"},"example":"certified_final"},{"name":"winner_party","in":"query","required":false,"description":"Party of the winner or leader: D, R or other","schema":{"type":"string"},"example":"R"},{"name":"flipped","in":"query","required":false,"description":"true = the winning party changed since the previous comparable race","schema":{"type":"boolean"},"example":true},{"name":"margin_max","in":"query","required":false,"description":"Largest margin in points (close races)","schema":{"type":"number"},"example":5},{"name":"margin_min","in":"query","required":false,"description":"Smallest margin in points (landslides)","schema":{"type":"number"},"example":30},{"name":"q","in":"query","required":false,"description":"Text in the race title or a candidate name","schema":{"type":"string"},"example":"Cruz"},{"name":"race","in":"query","required":false,"description":"One race by race_id","schema":{"type":"string"},"example":"2024-president"},{"name":"sort","in":"query","required":false,"description":"Sort field (see the endpoint description)","schema":{"type":"string"},"example":"year"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page (default 50 to 100, at most 1000)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/elections/results":{"get":{"tags":["US Elections"],"summary":"Election Results by Area","description":"The result of one race by area: the race header and every candidate with votes and share, then one row per state, congressional district, county, city or town, or precinct with total votes, Democratic, Republican and other shares, the leader, margin, party margin, swing, flip and turnout.\n\nThe answer is {race, choices, level, total, limit, offset, sort, order, rows, about}. sort is name, total_votes, rd_margin, margin, swing, dem_pct, rep_pct, turnout or state.","operationId":"elections_results","parameters":[{"name":"race","in":"query","required":true,"description":"The race_id from /elections/races","schema":{"type":"string"},"example":"2024-president"},{"name":"level","in":"query","required":false,"description":"state, county, cousub, cd or precinct (default: the top level of the race)","schema":{"type":"string"},"example":"county"},{"name":"state","in":"query","required":false,"description":"Only areas of this state","schema":{"type":"string"},"example":"TX"},{"name":"county","in":"query","required":false,"description":"Only areas inside this county (5-digit code); needed for precincts","schema":{"type":"string"},"example":"48453"},{"name":"q","in":"query","required":false,"description":"Area name contains this text","schema":{"type":"string"},"example":"Travis"},{"name":"include_choices","in":"query","required":false,"description":"true = each candidate's votes in every row (top 8)","schema":{"type":"boolean"},"example":false},{"name":"compact","in":"query","required":false,"description":"true = short rows for maps, up to 4000 rows","schema":{"type":"boolean"},"example":false},{"name":"sort","in":"query","required":false,"description":"Sort field (see the endpoint description)","schema":{"type":"string"},"example":"year"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page (default 50 to 100, at most 1000)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/elections/candidates":{"get":{"tags":["US Elections"],"summary":"Election Candidates","description":"Candidates for president, U.S. Senate, U.S. House, governor and other statewide offices, with party, home state, years and the number of races and wins. Pass slug for one candidate with every race: year, office, state, party, votes, share and result. Members of Congress carry an official portrait link.\n\nThe list answer is {total, limit, offset, sort, order, rows, about}; with slug it is {candidate, races, about}. sort is name, last_year, first_year, races or wins.","operationId":"elections_candidates","parameters":[{"name":"slug","in":"query","required":false,"description":"One candidate by slug","schema":{"type":"string"},"example":"ted-cruz-tx"},{"name":"q","in":"query","required":false,"description":"Name contains this text","schema":{"type":"string"},"example":"Cruz"},{"name":"state","in":"query","required":false,"description":"Home state","schema":{"type":"string"},"example":"TX"},{"name":"party","in":"query","required":false,"description":"Latest party: D, R or other","schema":{"type":"string"},"example":"R"},{"name":"office","in":"query","required":false,"description":"Ran for this office (comma-separated office codes)","schema":{"type":"string"},"example":"us_senate"},{"name":"year","in":"query","required":false,"description":"Ran in this election year","schema":{"type":"integer"},"example":2024},{"name":"won","in":"query","required":false,"description":"true = won at least one race","schema":{"type":"boolean"},"example":true},{"name":"in_congress","in":"query","required":false,"description":"true = current or former member of Congress","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"Sort field (see the endpoint description)","schema":{"type":"string"},"example":"year"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page (default 50 to 100, at most 1000)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/elections/geography/{level}/{code}":{"get":{"tags":["US Elections"],"summary":"Election Area Profile","description":"One area in full: a state, county, city or town, congressional district or the nation. Every race with a result in the area (leader, shares, margin, swing, flip), partisan lean, bellwether record, split tickets, turnout by election and main demographics.\n\nThe answer is {area, lean, bellwether, races, split_tickets, turnout, demographics, about}.","operationId":"elections_geography_level_code","parameters":[{"name":"level","in":"path","required":true,"description":"national, state, county, cousub, cd, sldu or sldl (in the path)","schema":{"type":"string"},"example":"county"},{"name":"code","in":"path","required":true,"description":"Area code (in the path)","schema":{"type":"string"},"example":"48453"},{"name":"offices","in":"query","required":false,"description":"Only these offices in the race list (comma-separated)","schema":{"type":"string"},"example":"president,us_senate"},{"name":"year_from","in":"query","required":false,"description":"First election year","schema":{"type":"integer"},"example":2016},{"name":"year_to","in":"query","required":false,"description":"Last election year","schema":{"type":"integer"},"example":2024}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/elections/area":{"get":{"tags":["US Elections"],"summary":"Election Area Summary","description":"The latest elections for a state, county and city in one call: for each level (nation, state, county, city or town when matched) the last presidential results with margin, shift and flip, the last Senate and governor races, partisan lean and turnout. Made for pages and assistants that show the elections of a place.\n\nThe answer is {levels, coverage_note, about}.","operationId":"elections_area","parameters":[{"name":"state","in":"query","required":false,"description":"State code","schema":{"type":"string"},"example":"TX"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county code","schema":{"type":"string"},"example":"48453"},{"name":"county","in":"query","required":false,"description":"County name (with state)","schema":{"type":"string"},"example":"Travis"},{"name":"place_fips","in":"query","required":false,"description":"7-digit city code","schema":{"type":"string"},"example":"4805000"},{"name":"city","in":"query","required":false,"description":"City or town name (with state)","schema":{"type":"string"},"example":"Austin"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/elections/summary":{"get":{"tags":["US Elections"],"summary":"Election Analysis","description":"Analysis views over the election data: national presidential vote by year, seats won in Congress and governorships, control of state legislatures, areas that flipped or swung most, bellwether states and counties, split tickets, partisan lean, county results next to demographics, and what is loaded.\n\nThe answer is {view, total, limit, offset, rows, about}.","operationId":"elections_summary","parameters":[{"name":"view","in":"query","required":false,"description":"trend, seats, legislatures, flips, swing, bellwethers, split_tickets, lean, demographics or coverage","schema":{"type":"string"},"example":"trend"},{"name":"year","in":"query","required":false,"description":"Election year","schema":{"type":"integer"},"example":2024},{"name":"office","in":"query","required":false,"description":"Office filter (flips and swing). For demographics: president (default), us_senate, governor or us_house, the county results of that race next to county demographics","schema":{"type":"string"},"example":"president"},{"name":"level","in":"query","required":false,"description":"state, county or cd","schema":{"type":"string"},"example":"county"},{"name":"state","in":"query","required":false,"description":"State code(s)","schema":{"type":"string"},"example":"TX"},{"name":"chamber","in":"query","required":false,"description":"us_house, us_senate, governor, state_senate or state_house","schema":{"type":"string"},"example":"us_house"},{"name":"kind","in":"query","required":false,"description":"split_tickets: senate, house or governor","schema":{"type":"string"},"example":"senate"},{"name":"min_elections","in":"query","required":false,"description":"bellwethers: fewest presidential elections","schema":{"type":"integer"},"example":2},{"name":"sort","in":"query","required":false,"description":"Sort field (depends on the view)","schema":{"type":"string"},"example":"swing"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 3500 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/elections/turnout":{"get":{"tags":["US Elections"],"summary":"Election Turnout","description":"Voter turnout by state or county and election: votes in the biggest race, citizen voting-age population from the matching five-year survey, turnout as a share of citizen adults and, where reported, ballots cast and turnout of registered voters.\n\nThe answer is {total, limit, offset, sort, order, rows, about}; sort is turnout, top_office_votes, cvap, name, year or registered_turnout.","operationId":"elections_turnout","parameters":[{"name":"year","in":"query","required":false,"description":"Election year","schema":{"type":"integer"},"example":2024},{"name":"level","in":"query","required":false,"description":"state or county (default state)","schema":{"type":"string"},"example":"county"},{"name":"state","in":"query","required":false,"description":"State code(s)","schema":{"type":"string"},"example":"TX"},{"name":"q","in":"query","required":false,"description":"Area name contains this text","schema":{"type":"string"},"example":"Travis"},{"name":"min_turnout","in":"query","required":false,"description":"Lowest turnout, % of citizen voting-age population","schema":{"type":"number"},"example":60},{"name":"max_turnout","in":"query","required":false,"description":"Highest turnout, % of citizen voting-age population","schema":{"type":"number"},"example":80},{"name":"sort","in":"query","required":false,"description":"Sort field (see the endpoint description)","schema":{"type":"string"},"example":"year"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page (default 50 to 100, at most 1000)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/elections/live/races":{"get":{"tags":["US Elections"],"summary":"Election Night Races","description":"Races that are being counted right now on election night, each with the candidate who is leading and the runner-up, votes and shares, the lead in votes and points, the percent of precincts reported and the time of the last change. Counts are unofficial and still changing. A race is only ever shown as leading, never as won.\n\nAll filters are optional. The answer is {updated_at, unofficial, note, total, rows}. Before any state starts counting the rows list is empty.","operationId":"elections_live_races","parameters":[{"name":"office","in":"query","required":false,"description":"president, us_senate, us_house, governor, lt_governor, attorney_general, secretary_of_state, treasurer, other_statewide, state_senate, state_house, ballot_measure or judicial (comma-separated)","schema":{"type":"string"},"example":"us_senate"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s), comma-separated","schema":{"type":"string"},"example":"GA"},{"name":"close","in":"query","required":false,"description":"true = only close races (lead under 5 points)","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"updated, margin, state, office, total_votes or reported","schema":{"type":"string"},"example":"updated"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page (default 100, at most 500)","schema":{"type":"integer"},"example":25},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/elections/live/summary":{"get":{"tags":["US Elections"],"summary":"Election Night Summary","description":"One light answer for an election night page: for each office how many races are being counted and how many are led by each party, for every state whether live results are coming in and when they last changed, and the next counting windows. All numbers are unofficial.\n\nNo parameters. The answer is {updated_at, unofficial, note, has_live, is_live, election, offices, states, windows, district_lines}.","operationId":"elections_live_summary","parameters":[],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades":{"get":{"tags":["Politician Trades"],"summary":"Politician Trades","description":"Stock trades reported by members of the US Congress in their official House and Senate financial disclosure filings: who traded, party, chamber, state, ticker, asset name and class, buy or sell, amount range, who holds the asset (held_by), trade date, filing date and a link to the official filing.\n\nAll filters are optional and can be combined. Lists use commas (symbol=AAPL,MSFT). The answer is {total, limit, offset, sort, order, rows, about}; total is the number of matching trades.","operationId":"politician_trades","parameters":[{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated (BRK.B and BRK-B both work)","schema":{"type":"string"},"example":"NVDA"},{"name":"member_id","in":"query","required":false,"description":"Official member ID(s) (Bioguide), comma-separated","schema":{"type":"string"},"example":"P000197"},{"name":"member_name","in":"query","required":false,"description":"Part of the member's name","schema":{"type":"string"},"example":"Pelosi"},{"name":"party","in":"query","required":false,"description":"Party on the trade date: D, R, I (or Democrat, Republican, Independent)","schema":{"type":"string"},"example":"R"},{"name":"chamber","in":"query","required":false,"description":"house or senate","schema":{"type":"string"},"example":"senate"},{"name":"trade_type","in":"query","required":false,"description":"buy, sell, or purchase, sale, sale_partial, sale_full, exchange, other","schema":{"type":"string"},"example":"buy"},{"name":"asset_class","in":"query","required":false,"description":"Asset class as filed, e.g. Stock, ETF, Stock Option, Corporate Bond","schema":{"type":"string"},"example":"Stock"},{"name":"held_by","in":"query","required":false,"description":"Who holds the asset: Self, Spouse, Joint or Child","schema":{"type":"string"},"example":"Spouse"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s), comma-separated","schema":{"type":"string"},"example":"TX"},{"name":"trade_from","in":"query","required":false,"description":"Trades on or after this trade date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"trade_to","in":"query","required":false,"description":"Trades on or before this trade date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-06-30"},{"name":"filed_from","in":"query","required":false,"description":"Filed on or after this date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-09-01"},{"name":"filed_to","in":"query","required":false,"description":"Filed on or before this date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-09-30"},{"name":"days","in":"query","required":false,"description":"Only trades from the last N days (by trade date)","schema":{"type":"integer"},"example":90},{"name":"amount_min","in":"query","required":false,"description":"Smallest estimated amount in US dollars (middle of the range)","schema":{"type":"number"},"example":100000},{"name":"amount_max","in":"query","required":false,"description":"Largest estimated amount in US dollars (middle of the range)","schema":{"type":"number"},"example":1000000},{"name":"late_filing","in":"query","required":false,"description":"true = only trades filed more than 45 days after the trade","schema":{"type":"boolean"},"example":true},{"name":"has_symbol","in":"query","required":false,"description":"true = only trades with a known ticker","schema":{"type":"boolean"},"example":true},{"name":"include_other_filers","in":"query","required":false,"description":"Also include filers who are not members of Congress (default false)","schema":{"type":"boolean"},"example":false},{"name":"sort","in":"query","required":false,"description":"trade_date (default), filed_date, amount_mid, member_name, symbol or filing_delay_days","schema":{"type":"string"},"example":"amount_mid"},{"name":"order","in":"query","required":false,"description":"asc or desc (default desc)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/summary":{"get":{"tags":["Politician Trades"],"summary":"Politician Trades Summary","description":"Totals of congressional trades for charts and analytics, grouped by party, member, symbol, month, year, chamber, trade type, asset class, who holds the asset, state, amount range or filing delay. Two groupings at once make a cross table, for example month and party.\n\nRequired: group_by. Every filter of /politician-trades also works here (member_id, member_name, asset_class, held_by, state, trade_from, trade_to, filed_from, filed_to, amount_min, amount_max, late_filing, has_symbol, include_other_filers). The answer is {group_by, date_basis, sort, order, total_groups, limit, offset, groups, totals, about}.","operationId":"politician_trades_summary","parameters":[{"name":"group_by","in":"query","required":true,"description":"One or two of: party, member, symbol, month, year, chamber, trade_type, asset_class, held_by, state, amount_bucket, delay_bucket","schema":{"type":"string"},"example":"party"},{"name":"date_basis","in":"query","required":false,"description":"For month and year: trade (trade date, default) or filed (filing date)","schema":{"type":"string"},"example":"trade"},{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"NVDA"},{"name":"party","in":"query","required":false,"description":"D, R or I (party on the trade date)","schema":{"type":"string"},"example":"D"},{"name":"chamber","in":"query","required":false,"description":"house or senate","schema":{"type":"string"},"example":"house"},{"name":"trade_type","in":"query","required":false,"description":"buy, sell or a detailed type","schema":{"type":"string"},"example":"buy"},{"name":"days","in":"query","required":false,"description":"Only trades from the last N days","schema":{"type":"integer"},"example":365},{"name":"sort","in":"query","required":false,"description":"trades, buys, sells, buy_value, sell_value, net_value, members, symbols, last_trade_date, first_trade_date, avg_filing_delay_days, median_filing_delay_days, late_filings or key (default: key for month, year and buckets, otherwise trades)","schema":{"type":"string"},"example":"buys"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Groups per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Groups to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/members":{"get":{"tags":["Politician Trades"],"summary":"Politician Trades Members","description":"Members of Congress who reported trades, with party, chamber, state, district, whether they are in office, trade counts, buys, sells, estimated values, average filing delay, late filings and their five most traded symbols.\n\nAll filters are optional. Also accepted: trade_type, asset_class, held_by, trade_from, trade_to, filed_from, filed_to, late_filing, include_other_filers. The answer is {total, limit, offset, sort, order, rows, about}.","operationId":"politician_trades_members","parameters":[{"name":"member_name","in":"query","required":false,"description":"Part of the member's name","schema":{"type":"string"},"example":"Collins"},{"name":"member_id","in":"query","required":false,"description":"Official member ID(s), comma-separated","schema":{"type":"string"},"example":"C001035"},{"name":"party","in":"query","required":false,"description":"Member's current party: D, R or I","schema":{"type":"string"},"example":"R"},{"name":"chamber","in":"query","required":false,"description":"house or senate","schema":{"type":"string"},"example":"senate"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"TX"},{"name":"in_office","in":"query","required":false,"description":"true = only members in office today","schema":{"type":"boolean"},"example":true},{"name":"country","in":"query","required":false,"description":"US (default), DE (German Bundestag) or NL (Dutch House of Representatives). With DE or NL the rows are members with side_jobs, interests and outside income (income_total, income_latest) instead of trades; sort income, side_jobs, interests or name","schema":{"type":"string"},"example":"US"},{"name":"symbol","in":"query","required":false,"description":"Only count trades in these tickers","schema":{"type":"string"},"example":"NVDA"},{"name":"days","in":"query","required":false,"description":"Only count trades from the last N days","schema":{"type":"integer"},"example":365},{"name":"sort","in":"query","required":false,"description":"trades (default), buys, sells, buy_value, sell_value, net_value, symbols, last_trade_date, late_filings, avg_filing_delay_days or name","schema":{"type":"string"},"example":"trades"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Members per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Members to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/symbols":{"get":{"tags":["Politician Trades"],"summary":"Politician Trades Symbols","description":"Tickers traded by members of Congress, with company name, trades, buys, sells, estimated buy and sell value, net value, distinct members, the split by party and the last trade date.\n\nAll filters are optional. Every filter of /politician-trades also works here. The answer is {total, limit, offset, sort, order, rows, about}.","operationId":"politician_trades_symbols","parameters":[{"name":"q","in":"query","required":false,"description":"Part of a ticker or company name","schema":{"type":"string"},"example":"nvid"},{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"AAPL"},{"name":"party","in":"query","required":false,"description":"D, R or I (party on the trade date)","schema":{"type":"string"},"example":"D"},{"name":"chamber","in":"query","required":false,"description":"house or senate","schema":{"type":"string"},"example":"house"},{"name":"trade_type","in":"query","required":false,"description":"buy, sell or a detailed type","schema":{"type":"string"},"example":"buy"},{"name":"days","in":"query","required":false,"description":"Only trades from the last N days","schema":{"type":"integer"},"example":90},{"name":"sort","in":"query","required":false,"description":"trades (default), buys, sells, buy_value, sell_value, net_value, members, last_trade_date or symbol","schema":{"type":"string"},"example":"buys"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Symbols per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Symbols to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/member-search":{"get":{"tags":["Politician Trades"],"summary":"Politician Member Search","description":"Find any member of Congress, current or former, with or without reported trades, by name, nickname or initials (for example Pelosi, Bernie or AOC).\n\nThe answer is {q, rows, about}.","operationId":"politician_trades_member_search","parameters":[{"name":"q","in":"query","required":true,"description":"Name, part of a name, nickname or initials","schema":{"type":"string"},"example":"AOC"},{"name":"in_office","in":"query","required":false,"description":"true = only members in office today","schema":{"type":"boolean"},"example":true},{"name":"country","in":"query","required":false,"description":"US (default), DE (Germany) or NL (Netherlands)","schema":{"type":"string"},"example":"US"},{"name":"limit","in":"query","required":false,"description":"Members to return, 1 to 50 (default 10)","schema":{"type":"integer"},"example":10}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/net-worth":{"get":{"tags":["Politician Trades"],"summary":"Politician Net Worth","description":"Net worth of members of Congress from their yearly financial disclosure reports, per member and report year: assets and liabilities as ranges, net worth range and middle estimate, number of assets, the share held by the member, spouse, jointly and by children, and the five largest assets.\n\nAll filters are optional. The answer is {total, limit, offset, sort, order, rows, about}.","operationId":"politician_trades_net_worth","parameters":[{"name":"member_id","in":"query","required":false,"description":"Official member ID(s), comma-separated","schema":{"type":"string"},"example":"P000197"},{"name":"member_name","in":"query","required":false,"description":"Name, nickname or initials","schema":{"type":"string"},"example":"Pelosi"},{"name":"year","in":"query","required":false,"description":"Report year (the calendar year the report covers)","schema":{"type":"integer"},"example":2024},{"name":"latest","in":"query","required":false,"description":"true = each member's latest year with figures (default without year and member_id)","schema":{"type":"boolean"},"example":true},{"name":"chamber","in":"query","required":false,"description":"house or senate","schema":{"type":"string"},"example":"senate"},{"name":"party","in":"query","required":false,"description":"D, R or I","schema":{"type":"string"},"example":"D"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"CA"},{"name":"in_office","in":"query","required":false,"description":"true = only members in office today","schema":{"type":"boolean"},"example":true},{"name":"data_status","in":"query","required":false,"description":"parsed (with figures) or paper (scanned, no figures)","schema":{"type":"string"},"example":"parsed"},{"name":"min_net_worth","in":"query","required":false,"description":"Smallest net_worth_mid in US dollars","schema":{"type":"number"},"example":10000000},{"name":"sort","in":"query","required":false,"description":"net_worth (default), net_worth_min, net_worth_max, assets, liabilities, assets_count, name or year","schema":{"type":"string"},"example":"net_worth"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":20},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/net-worth/summary":{"get":{"tags":["Politician Trades"],"summary":"Politician Net Worth Summary","description":"Net worth of members of Congress grouped by party, chamber, state or report year: members, median, average and total net worth (middle estimates), median assets and liabilities, members worth over $1 million and $10 million, and the richest member of each group.\n\nThe answer is {group_by, year, groups, about}.","operationId":"politician_trades_net_worth_summary","parameters":[{"name":"group_by","in":"query","required":false,"description":"party (default), chamber, state or year","schema":{"type":"string"},"example":"party"},{"name":"year","in":"query","required":false,"description":"Report year","schema":{"type":"integer"},"example":2024},{"name":"chamber","in":"query","required":false,"description":"house or senate","schema":{"type":"string"},"example":"house"},{"name":"party","in":"query","required":false,"description":"D, R or I","schema":{"type":"string"},"example":"R"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"TX"},{"name":"in_office","in":"query","required":false,"description":"true = only members in office today","schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/assets":{"get":{"tags":["Politician Trades"],"summary":"Politician Assets","description":"The assets listed in a member's yearly financial disclosure report, with asset class, ticker, who holds it, the value range as filed and an estimate, and the income it paid; plus the report's net worth, its liabilities and the report years available. Or, with a ticker, the members whose latest report lists that stock.\n\nmember_id or ticker is required. The answer is {member_id, year, total, rows, summary, liabilities, years, facets, about}; summary, liabilities, years and facets come with member_id.","operationId":"politician_trades_assets","parameters":[{"name":"member_id","in":"query","required":false,"description":"Official member ID (required unless ticker is given)","schema":{"type":"string"},"example":"P000197"},{"name":"year","in":"query","required":false,"description":"Report year (default: latest with figures)","schema":{"type":"integer"},"example":2024},{"name":"ticker","in":"query","required":false,"description":"Ticker; without member_id: the members holding it","schema":{"type":"string"},"example":"NVDA"},{"name":"held_by","in":"query","required":false,"description":"Self, Spouse, Joint or Child","schema":{"type":"string"},"example":"Spouse"},{"name":"asset_class","in":"query","required":false,"description":"One or more of our asset classes, comma-separated","schema":{"type":"string"},"example":"Stock,ETF"},{"name":"min_value","in":"query","required":false,"description":"Smallest value_estimate in US dollars","schema":{"type":"number"},"example":1000000},{"name":"max_value","in":"query","required":false,"description":"Largest value_estimate in US dollars","schema":{"type":"number"},"example":5000000},{"name":"q","in":"query","required":false,"description":"Part of the asset name","schema":{"type":"string"},"example":"Apple"},{"name":"sort","in":"query","required":false,"description":"value (default), name, asset_class, held_by or line","schema":{"type":"string"},"example":"value"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/interests":{"get":{"tags":["Politician Trades"],"summary":"Politician Interests (Germany and Netherlands)","description":"Side jobs, outside income, company stakes, donations and benefits (Germany), and side activities, side income, gifts and paid travel (Netherlands) reported by members of the German Bundestag (from 2013) and the Dutch House of Representatives. These countries publish no stock trades.\n\nAlso accepted: state (German state, English name), in_office, category, ticker, order. The answer is {country, total, limit, offset, sort, order, rows, as_of, about}.","operationId":"politician_trades_interests","parameters":[{"name":"country","in":"query","required":true,"description":"DE (Germany) or NL (Netherlands)","schema":{"type":"string"},"example":"DE"},{"name":"member_id","in":"query","required":false,"description":"Member id(s), comma-separated","schema":{"type":"string"},"example":"DE-175826"},{"name":"member_name","in":"query","required":false,"description":"Part of the member's name","schema":{"type":"string"},"example":"Engelhard"},{"name":"party","in":"query","required":false,"description":"Party key or short name(s), comma-separated","schema":{"type":"string"},"example":"cdu,csu"},{"name":"interest_type","in":"query","required":false,"description":"side_job, side_income, stake, donation, gift, travel, prior_job, or income (any row with an amount)","schema":{"type":"string"},"example":"stake"},{"name":"year_from","in":"query","required":false,"description":"From this reporting year","schema":{"type":"integer"},"example":2021},{"name":"year_to","in":"query","required":false,"description":"Up to this reporting year","schema":{"type":"integer"},"example":2025},{"name":"org_type","in":"query","required":false,"description":"Organization type, e.g. Private company, Foundation, Association or club","schema":{"type":"string"},"example":"Private company"},{"name":"q","in":"query","required":false,"description":"Words in the role, organization or description (original language)","schema":{"type":"string"},"example":"Aufsichtsrat"},{"name":"has_amount","in":"query","required":false,"description":"true = only rows with an amount","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"year (default), yearly_value, amount, reported_date, start_date, member_name, organization or category","schema":{"type":"string"},"example":"yearly_value"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/interests/summary":{"get":{"tags":["Politician Trades"],"summary":"Politician Interests Summary (Germany and Netherlands)","description":"Totals of the German and Dutch disclosures grouped by party, member, year, type, category, organization type, state, organization or ticker: record counts and outside income in euros.\n\nEvery filter of /politician-trades/interests also works here (member_id, member_name, party, state, in_office, interest_type, org_type, q). The answer is {country, group_by, total_groups, groups, totals, currency, as_of, about}.","operationId":"politician_trades_interests_summary","parameters":[{"name":"country","in":"query","required":true,"description":"DE (Germany) or NL (Netherlands)","schema":{"type":"string"},"example":"DE"},{"name":"group_by","in":"query","required":false,"description":"party (default), member, year, interest_type, category, org_type, state, organization or ticker; one or two","schema":{"type":"string"},"example":"party"},{"name":"year_from","in":"query","required":false,"description":"From this year","schema":{"type":"integer"},"example":2021},{"name":"year_to","in":"query","required":false,"description":"Up to this year","schema":{"type":"integer"},"example":2025},{"name":"listed_only","in":"query","required":false,"description":"true = only records linked to a listed company","schema":{"type":"boolean"},"example":false},{"name":"sort","in":"query","required":false,"description":"income (default), interests, members, side_jobs, stakes, with_amount, income_range_min or key","schema":{"type":"string"},"example":"income"},{"name":"limit","in":"query","required":false,"description":"Groups to return (default 100)","schema":{"type":"integer"},"example":20}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/politician-trades/holdings":{"get":{"tags":["Politician Trades"],"summary":"Politician Holdings (Germany)","description":"Company stakes disclosed by members of the German Bundestag: company, legal form, organization type, city, since and until dates and the latest reported income from the stake. The Netherlands publishes no holdings.\n\nAlso accepted: member_id, party, in_office, ticker, order, offset. The answer is {country, total, limit, offset, rows, currency, as_of}.","operationId":"politician_trades_holdings","parameters":[{"name":"country","in":"query","required":false,"description":"DE (default)","schema":{"type":"string"},"example":"DE"},{"name":"member_name","in":"query","required":false,"description":"Part of the member's name","schema":{"type":"string"},"example":"Klose"},{"name":"listed_only","in":"query","required":false,"description":"true = only stakes in listed companies","schema":{"type":"boolean"},"example":false},{"name":"q","in":"query","required":false,"description":"Part of the company name","schema":{"type":"string"},"example":"GmbH"},{"name":"sort","in":"query","required":false,"description":"since_date (default), company_name, member_name or income","schema":{"type":"string"},"example":"since_date"},{"name":"limit","in":"query","required":false,"description":"Rows per page (default 50)","schema":{"type":"integer"},"example":50}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/government-contracts":{"get":{"tags":["Government Contracts"],"summary":"Government Contracts","description":"Federal government prime contracts of listed companies, from official US government data: contract awards of $1 million or more with the agency, amount, award date, period of performance, place of performance, product or service category and description. A company includes the units it owns today.\n\nAll filters are optional and can be combined. The answer is {total, limit, offset, sort, order, data_as_of, latest_award_date, rows, about}. The demo key works with symbol=AAPL, MSFT or WMT.","operationId":"government_contracts","parameters":[{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"LMT"},{"name":"q","in":"query","required":false,"description":"Words in the description, unit name or contract ID","schema":{"type":"string"},"example":"F-35"},{"name":"agency","in":"query","required":false,"description":"Awarding agency (exact name; comma-separated)","schema":{"type":"string"},"example":"Department of Defense"},{"name":"sub_agency","in":"query","required":false,"description":"Awarding sub-agency (exact name)","schema":{"type":"string"},"example":"Department of the Navy"},{"name":"award_type","in":"query","required":false,"description":"Definitive Contract, Delivery Order, Purchase Order or Bpa Call","schema":{"type":"string"},"example":"Definitive Contract"},{"name":"min_amount","in":"query","required":false,"description":"Smallest amount in US dollars","schema":{"type":"number"},"example":100000000},{"name":"max_amount","in":"query","required":false,"description":"Largest amount in US dollars","schema":{"type":"number"},"example":500000000},{"name":"fiscal_year","in":"query","required":false,"description":"Awarded in this US fiscal year (October to September)","schema":{"type":"integer"},"example":2025},{"name":"date_from","in":"query","required":false,"description":"Awarded on or after (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"date_to","in":"query","required":false,"description":"Awarded on or before (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-06-30"},{"name":"state","in":"query","required":false,"description":"Place of performance, two-letter US state code","schema":{"type":"string"},"example":"TX"},{"name":"product_code","in":"query","required":false,"description":"Product or service code or its start","schema":{"type":"string"},"example":"AC"},{"name":"naics_code","in":"query","required":false,"description":"Industry code or its first digits","schema":{"type":"string"},"example":"3364"},{"name":"active_only","in":"query","required":false,"description":"true = only contracts whose period of performance has not ended","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"award_date (default), amount, start_date, end_date, symbol or agency","schema":{"type":"string"},"example":"amount"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/government-contracts/summary":{"get":{"tags":["Government Contracts"],"summary":"Government Contracts Summary","description":"Federal contract obligations of listed companies (contracts of every size) for charts and rankings: by US fiscal year, by fiscal quarter, by awarding agency, or companies ranked by obligations.\n\nThe answer is {group_by, total_groups, groups, totals, current_fiscal_year, data_as_of, about}.","operationId":"government_contracts_summary","parameters":[{"name":"group_by","in":"query","required":true,"description":"fiscal_year, quarter, agency, symbol, country or sector (of the company headquarters)","schema":{"type":"string"},"example":"fiscal_year"},{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"LMT"},{"name":"agency","in":"query","required":false,"description":"Awarding agency (exact name); not with group_by=quarter","schema":{"type":"string"},"example":"National Aeronautics and Space Administration"},{"name":"fiscal_year_from","in":"query","required":false,"description":"First US fiscal year","schema":{"type":"integer"},"example":2020},{"name":"fiscal_year_to","in":"query","required":false,"description":"Last US fiscal year","schema":{"type":"integer"},"example":2025},{"name":"country","in":"query","required":false,"description":"Country of the company headquarters (comma-separated; Unknown = not known)","schema":{"type":"string"},"example":"United States"},{"name":"sector","in":"query","required":false,"description":"Company sector (comma-separated)","schema":{"type":"string"},"example":"Technology"},{"name":"industry","in":"query","required":false,"description":"Company industry (comma-separated)","schema":{"type":"string"},"example":"Biotechnology"},{"name":"company","in":"query","required":false,"description":"Stock search: the start of a ticker or part of a company name","schema":{"type":"string"},"example":"lock"},{"name":"sort","in":"query","required":false,"description":"amount, key, agencies, companies, company_name, country or sector (default: key for fiscal_year and quarter, else amount)","schema":{"type":"string"},"example":"amount"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Groups per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":20},{"name":"offset","in":"query","required":false,"description":"Groups to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/lobbying":{"get":{"tags":["Lobbying"],"summary":"Lobbying Reports","description":"Federal lobbying of listed companies from the quarterly lobbying reports filed with the US Congress, 2015 to today: the lobbying firm or the company itself (in-house), the amount, the issues lobbied with the specific bills and topics, and the government entities contacted.\n\nAll filters are optional and can be combined. The answer is {total, limit, offset, sort, order, data_as_of, latest_filed_date, rows, about}. The demo key works with symbol=AAPL, MSFT or WMT.","operationId":"lobbying","parameters":[{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"AMZN"},{"name":"q","in":"query","required":false,"description":"Words in the issue descriptions, client or firm name","schema":{"type":"string"},"example":"tariffs"},{"name":"issue","in":"query","required":false,"description":"General issue code(s), comma-separated (see /lobbying/summary?group_by=issue)","schema":{"type":"string"},"example":"TAX,TRD"},{"name":"year","in":"query","required":false,"description":"One year","schema":{"type":"integer"},"example":2025},{"name":"quarter","in":"query","required":false,"description":"Quarter 1 to 4","schema":{"type":"integer"},"example":2},{"name":"year_from","in":"query","required":false,"description":"First year","schema":{"type":"integer"},"example":2020},{"name":"year_to","in":"query","required":false,"description":"Last year","schema":{"type":"integer"},"example":2026},{"name":"in_house","in":"query","required":false,"description":"true = the company's own reports, false = outside firms","schema":{"type":"boolean"},"example":false},{"name":"registrant","in":"query","required":false,"description":"Part of the lobbying firm name","schema":{"type":"string"},"example":"Akin"},{"name":"entity","in":"query","required":false,"description":"Part of a government entity contacted","schema":{"type":"string"},"example":"Defense"},{"name":"min_amount","in":"query","required":false,"description":"Smallest amount in US dollars","schema":{"type":"number"},"example":100000},{"name":"sort","in":"query","required":false,"description":"period (default), amount, filed_date, symbol or registrant_name","schema":{"type":"string"},"example":"amount"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/lobbying/summary":{"get":{"tags":["Lobbying"],"summary":"Lobbying Summary","description":"Lobbying spending of listed companies for charts and rankings: by quarter, by year or companies ranked by spending; and reports by issue, by government entity contacted or by outside lobbying firm.\n\nThe answer is {group_by, total_groups, groups, totals, data_as_of, about}.","operationId":"lobbying_summary","parameters":[{"name":"group_by","in":"query","required":true,"description":"quarter, year, symbol, issue, entity, registrant, country, sector, issue_year or contracts","schema":{"type":"string"},"example":"year"},{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"AMZN"},{"name":"issue","in":"query","required":false,"description":"Issue code(s); only with issue, entity or registrant","schema":{"type":"string"},"example":"TAX"},{"name":"year","in":"query","required":false,"description":"One year","schema":{"type":"integer"},"example":2025},{"name":"year_from","in":"query","required":false,"description":"First year","schema":{"type":"integer"},"example":2020},{"name":"year_to","in":"query","required":false,"description":"Last year","schema":{"type":"integer"},"example":2026},{"name":"country","in":"query","required":false,"description":"Country of the company headquarters (comma-separated; Unknown = not known)","schema":{"type":"string"},"example":"United States"},{"name":"sector","in":"query","required":false,"description":"Company sector (comma-separated)","schema":{"type":"string"},"example":"Technology"},{"name":"industry","in":"query","required":false,"description":"Company industry (comma-separated)","schema":{"type":"string"},"example":"Biotechnology"},{"name":"company","in":"query","required":false,"description":"Stock search: the start of a ticker or part of a company name","schema":{"type":"string"},"example":"micro"},{"name":"sort","in":"query","required":false,"description":"amount, reports, companies or key; for symbol also in_house, outside, firms, company_name, country or sector; for issue also amount_split; for contracts: lobbying, contracts or ratio","schema":{"type":"string"},"example":"amount"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Groups per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":20},{"name":"offset","in":"query","required":false,"description":"Groups to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/patents":{"get":{"tags":["Patents"],"summary":"Patents","description":"US patents granted to listed companies since 2015, from official US government data: title, grant and filing dates, patent type, main technology class, number of claims, inventors, the US patents it cites and how often later US patents cite it.\n\nAll filters are optional and can be combined. The answer is {total, limit, offset, sort, order, data_as_of, rows, about}. The demo key works with symbol=AAPL, MSFT or WMT.","operationId":"patents","parameters":[{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"AAPL"},{"name":"q","in":"query","required":false,"description":"Words in the title","schema":{"type":"string"},"example":"battery"},{"name":"section","in":"query","required":false,"description":"Technology section(s) A to H or Y, or design","schema":{"type":"string"},"example":"G"},{"name":"cpc_class","in":"query","required":false,"description":"Technology class (CPC subclass) or its start","schema":{"type":"string"},"example":"G06N"},{"name":"patent_type","in":"query","required":false,"description":"utility, design, plant or reissue","schema":{"type":"string"},"example":"utility"},{"name":"year_from","in":"query","required":false,"description":"First grant year","schema":{"type":"integer"},"example":2020},{"name":"year_to","in":"query","required":false,"description":"Last grant year","schema":{"type":"integer"},"example":2026},{"name":"date_from","in":"query","required":false,"description":"Granted on or after (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"date_to","in":"query","required":false,"description":"Granted on or before (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-06-30"},{"name":"min_cited_by","in":"query","required":false,"description":"Only patents cited at least this many times","schema":{"type":"integer"},"example":10},{"name":"sort","in":"query","required":false,"description":"grant_date (default), cited_by, claims, filing_date or symbol","schema":{"type":"string"},"example":"cited_by"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/patents/summary":{"get":{"tags":["Patents"],"summary":"Patents Summary","description":"Patent counts of listed companies for charts and rankings: by grant year, by technology section, by technology class, or companies ranked by patents.\n\nThe answer is {group_by, total_groups, groups, totals, data_as_of, about}.","operationId":"patents_summary","parameters":[{"name":"group_by","in":"query","required":true,"description":"year, section, cpc_class, symbol, country or sector (of the company headquarters)","schema":{"type":"string"},"example":"year"},{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"AAPL"},{"name":"section","in":"query","required":false,"description":"Technology section(s) A to H or Y, or design","schema":{"type":"string"},"example":"H"},{"name":"year_from","in":"query","required":false,"description":"First grant year","schema":{"type":"integer"},"example":2020},{"name":"year_to","in":"query","required":false,"description":"Last grant year","schema":{"type":"integer"},"example":2025},{"name":"country","in":"query","required":false,"description":"Country of the company headquarters (comma-separated; Unknown = not known)","schema":{"type":"string"},"example":"Japan"},{"name":"sector","in":"query","required":false,"description":"Company sector (comma-separated)","schema":{"type":"string"},"example":"Technology"},{"name":"industry","in":"query","required":false,"description":"Company industry (comma-separated)","schema":{"type":"string"},"example":"Biotechnology"},{"name":"company","in":"query","required":false,"description":"Stock search: the start of a ticker or part of a company name","schema":{"type":"string"},"example":"apple"},{"name":"sort","in":"query","required":false,"description":"patents, cited_by, claims or key; for symbol also company_name, country or sector","schema":{"type":"string"},"example":"patents"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Groups per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":20},{"name":"offset","in":"query","required":false,"description":"Groups to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/trademarks/filings":{"get":{"tags":["Trademarks"],"summary":"Trademark Filings","description":"US trademark (brand name and logo) applications filed and registrations issued since 2000 for one listed company (all its trademark owners, also other share classes) or one owner, by year, by class of goods and services, or by year and class. From official public data, updated weekly.\n\nThe answer is {ticker, owner, group_by, owners, rows: [{year, class_code, class_name, applications, registrations}], totals, data_through, about}. Before the first load it has note \"Data is being prepared\" and no rows. The demo key works only with its allowed tickers, for example AAPL.","operationId":"trademarks_filings","parameters":[{"name":"ticker","in":"query","required":false,"description":"Ticker of a listed company (or owner)","schema":{"type":"string"},"example":"AAPL"},{"name":"owner","in":"query","required":false,"description":"One owner: owner_id or slug from /trademarks/owners","schema":{"type":"string"},"example":"nike-inc-1234"},{"name":"group_by","in":"query","required":false,"description":"year (default), class or year_class","schema":{"type":"string"},"example":"year"},{"name":"year_from","in":"query","required":false,"description":"First year (default 2000)","schema":{"type":"integer"},"example":2015},{"name":"year_to","in":"query","required":false,"description":"Last year (default: the newest)","schema":{"type":"integer"},"example":2025},{"name":"class","in":"query","required":false,"description":"Class(es) 1 to 45, comma-separated","schema":{"type":"string"},"example":"9,42"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/trademarks/rankings":{"get":{"tags":["Trademarks"],"summary":"Trademark Rankings","description":"Top trademark filers in a period and class, ranked by applications or registrations: each trademark owner, or listed companies with all their owners together.\n\nThe answer is {group_by, period, class_code, class_name, by, total, rows, totals_all_filers, data_through, about}. Demo keys get at most 10 rows.","operationId":"trademarks_rankings","parameters":[{"name":"group_by","in":"query","required":false,"description":"owner (default) or ticker","schema":{"type":"string"},"example":"ticker"},{"name":"year_from","in":"query","required":false,"description":"First year (default: the last complete year)","schema":{"type":"integer"},"example":2025},{"name":"year_to","in":"query","required":false,"description":"Last year (default: year_from)","schema":{"type":"integer"},"example":2025},{"name":"class","in":"query","required":false,"description":"One class 1 to 45 (default: all classes)","schema":{"type":"integer"},"example":25},{"name":"by","in":"query","required":false,"description":"applications (default) or registrations","schema":{"type":"string"},"example":"applications"},{"name":"ticker","in":"query","required":false,"description":"Only these tickers, comma-separated (up to 500)","schema":{"type":"string"},"example":"AAPL,MSFT,NKE"},{"name":"listed_only","in":"query","required":false,"description":"true = only owners linked to a listed company","schema":{"type":"boolean"},"example":true},{"name":"country","in":"query","required":false,"description":"Owner country code(s)","schema":{"type":"string"},"example":"US"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":20},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/trademarks/owners":{"get":{"tags":["Trademarks"],"summary":"Trademark Owners","description":"Find trademark owners (companies and other organizations with several filings since 2000, and every owner linked to a listed company) by name, ticker, country or state. /trademarks/owners/{owner} gives one owner with its years and top classes.\n\nThe answer is {total, rows: [{owner_id, slug, name, country, state, ticker, listed_company, applications, registrations, first_year, last_year}], data_through, about}. /trademarks/totals gives all filers (also individuals, not named) by year or class, and /trademarks/classes the 45 classes with plain names.","operationId":"trademarks_owners","parameters":[{"name":"q","in":"query","required":false,"description":"Part of the owner name","schema":{"type":"string"},"example":"nike"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of listed companies","schema":{"type":"string"},"example":"NKE"},{"name":"country","in":"query","required":false,"description":"Owner country code(s)","schema":{"type":"string"},"example":"US"},{"name":"state","in":"query","required":false,"description":"US state code(s)","schema":{"type":"string"},"example":"OR"},{"name":"listed_only","in":"query","required":false,"description":"true = only owners linked to a listed company","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"applications, registrations, name or last_year","schema":{"type":"string"},"example":"applications"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/private-fundraising":{"get":{"tags":["Private Fundraising"],"summary":"Private Fundraising","description":"Private securities offerings of US and foreign companies and investment funds since 2009, from official public filings: issuer, place, industry group, filing date, total offering amount, amount sold, investors, minimum investment, exemptions claimed and fund type. Updated daily.\n\nAll filters are optional and can be combined. The answer is {total, limit, offset, sort, order, filings, filters, data_date, rows, about}. /private-fundraising/companies/{slug} gives one issuer with its offerings and every filing. The demo key works with state=CA, NY or TX and returns at most 10 rows.","operationId":"private_fundraising","parameters":[{"name":"q","in":"query","required":false,"description":"Part of the issuer name","schema":{"type":"string"},"example":"robotics"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of listed issuers, comma-separated","schema":{"type":"string"},"example":"MRNA"},{"name":"listed","in":"query","required":false,"description":"true = only listed issuers","schema":{"type":"boolean"},"example":true},{"name":"industry","in":"query","required":false,"description":"Industry group(s) as label or slug (see /private-fundraising/options)","schema":{"type":"string"},"example":"biotechnology"},{"name":"category","in":"query","required":false,"description":"Industry category, for example technology or health_care","schema":{"type":"string"},"example":"technology"},{"name":"state","in":"query","required":false,"description":"State(s) of the main office, comma-separated","schema":{"type":"string"},"example":"CA"},{"name":"kind","in":"query","required":false,"description":"all (default), operating or fund","schema":{"type":"string"},"example":"operating"},{"name":"fund_type","in":"query","required":false,"description":"hedge_fund, private_equity_fund, venture_capital_fund or other_fund","schema":{"type":"string"},"example":"venture_capital_fund"},{"name":"exemption","in":"query","required":false,"description":"Exemption(s) claimed, for example 506b or 506c","schema":{"type":"string"},"example":"506c"},{"name":"revenue_range","in":"query","required":false,"description":"Revenue range(s) of operating companies","schema":{"type":"string"},"example":"1m_to_5m"},{"name":"min_sold","in":"query","required":false,"description":"Amount sold at least (US dollars)","schema":{"type":"integer"},"example":10000000},{"name":"max_sold","in":"query","required":false,"description":"Amount sold at most (US dollars)","schema":{"type":"integer"},"example":50000000},{"name":"date_from","in":"query","required":false,"description":"First filing date","schema":{"type":"string"},"example":"2026"},{"name":"date_to","in":"query","required":false,"description":"Last filing date","schema":{"type":"string"},"example":"2026-09-30"},{"name":"filings","in":"query","required":false,"description":"latest (default), new or all","schema":{"type":"string"},"example":"latest"},{"name":"sort","in":"query","required":false,"description":"filed_on (default), amount_sold, offering_amount, amount_remaining, investors, min_investment, first_sale_date or name","schema":{"type":"string"},"example":"amount_sold"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/private-fundraising/totals":{"get":{"tags":["Private Fundraising"],"summary":"Private Fundraising Totals","description":"Private fundraising totals for charts and rankings: offerings, issuers, funds and operating companies, amount sold, offering amount, medians and investors, by quarter, year, month, industry, category, sector, state, country, fund type, exemption, revenue range or entity type.\n\nThe answer is {group_by, basis, period, totals, rows, total, data_date, about}.","operationId":"private_fundraising_totals","parameters":[{"name":"group_by","in":"query","required":false,"description":"quarter (default), year, month, industry, category, sector, state, country, fund_type, exemption, revenue_range, entity_type or none","schema":{"type":"string"},"example":"state"},{"name":"basis","in":"query","required":false,"description":"new (default), latest or all","schema":{"type":"string"},"example":"new"},{"name":"kind","in":"query","required":false,"description":"all (default), operating or fund","schema":{"type":"string"},"example":"operating"},{"name":"date_from","in":"query","required":false,"description":"First filing date","schema":{"type":"string"},"example":"2025"},{"name":"date_to","in":"query","required":false,"description":"Last filing date","schema":{"type":"string"},"example":"2025"},{"name":"sort","in":"query","required":false,"description":"For non-time groups: filings (default), group or any number, for example amount_sold","schema":{"type":"string"},"example":"amount_sold"},{"name":"limit","in":"query","required":false,"description":"Groups per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":10}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/short-interest":{"get":{"tags":["Short Interest"],"summary":"Short Interest","description":"Short interest of US stocks and ETFs: the number of shares sold short and not yet bought back, reported twice a month, with the change since the last report, the average daily volume and days to cover. History from 2017 to today.\n\nThe answer is {total, limit, offset, sort, order, data_as_of, rows, latest (one symbol only), about}. Each row has symbol, settlement_date, security_name, market, short_interest, previous_short_interest, change_shares, change_pct, avg_daily_volume, days_to_cover, split_flag and revised. The demo key works with symbol=AAPL, MSFT or WMT.","operationId":"short_interest","parameters":[{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated, up to 50. Leave empty and give settlement_date to list every symbol on that date","schema":{"type":"string"},"example":"GME"},{"name":"settlement_date","in":"query","required":false,"description":"One settlement date (YYYY-MM-DD), or latest for the newest one","schema":{"type":"string"},"example":"latest"},{"name":"date_from","in":"query","required":false,"description":"Settlement dates on or after (YYYY-MM-DD)","schema":{"type":"string"},"example":"2025-01-01"},{"name":"date_to","in":"query","required":false,"description":"Settlement dates on or before (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-06-30"},{"name":"market","in":"query","required":false,"description":"nyse, nasdaq, nasdaq_global, nasdaq_capital, nyse_american, nyse_arca, bzx, otc or listed (every market except OTC); comma-separated","schema":{"type":"string"},"example":"nyse"},{"name":"min_short_interest","in":"query","required":false,"description":"Smallest short interest in shares","schema":{"type":"integer"},"example":1000000},{"name":"min_days_to_cover","in":"query","required":false,"description":"Smallest days to cover","schema":{"type":"number"},"example":5},{"name":"sort","in":"query","required":false,"description":"settlement_date (default), short_interest, change_pct, change_shares, days_to_cover or symbol","schema":{"type":"string"},"example":"days_to_cover"},{"name":"order","in":"query","required":false,"description":"asc or desc (default desc; asc for symbol)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/short-interest/ranking":{"get":{"tags":["Short Interest"],"summary":"Most Shorted Stocks","description":"Stocks ranked on one settlement date by short percent of shares outstanding, days to cover, short interest or other measures, with company name, sector, industry, country, price and market cap. Filter by market, sector, industry, country, size, volume and price, or search by ticker or company name.\n\nAll filters are optional and can be combined. The answer is {settlement_date, total, limit, offset, sort, order, rows, about}. A sort value outside the list returns an error that names the allowed values. Requires a full API key.","operationId":"short_interest_ranking","parameters":[{"name":"settlement_date","in":"query","required":false,"description":"Settlement date (YYYY-MM-DD); default the newest","schema":{"type":"string"},"example":"2026-08-31"},{"name":"market","in":"query","required":false,"description":"nyse, nasdaq, nasdaq_global, nasdaq_capital, nyse_american, nyse_arca, bzx, otc or listed (every market except OTC); comma-separated","schema":{"type":"string"},"example":"listed"},{"name":"sector","in":"query","required":false,"description":"Company sector(s), comma-separated","schema":{"type":"string"},"example":"Healthcare,Technology"},{"name":"industry","in":"query","required":false,"description":"Company industry(ies), comma-separated","schema":{"type":"string"},"example":"Biotechnology"},{"name":"country","in":"query","required":false,"description":"Country of the company headquarters, comma-separated (Unknown = not known)","schema":{"type":"string"},"example":"United States"},{"name":"stocks_only","in":"query","required":false,"description":"true (default) = only stocks; false = also ETFs and funds","schema":{"type":"boolean"},"example":true},{"name":"min_market_cap","in":"query","required":false,"description":"Smallest market cap in US dollars","schema":{"type":"number"},"example":300000000},{"name":"min_avg_volume","in":"query","required":false,"description":"Smallest average daily volume in shares","schema":{"type":"integer"},"example":100000},{"name":"min_price","in":"query","required":false,"description":"Smallest share price","schema":{"type":"number"},"example":5},{"name":"min_short_pct","in":"query","required":false,"description":"Smallest short percent of shares outstanding","schema":{"type":"number"},"example":10},{"name":"min_days_to_cover","in":"query","required":false,"description":"Smallest days to cover","schema":{"type":"number"},"example":5},{"name":"q","in":"query","required":false,"description":"Company search: the start of a ticker or part of a company or security name (up to 60 characters)","schema":{"type":"string"},"example":"bio"},{"name":"sort","in":"query","required":false,"description":"short_pct (default), days_to_cover, short_interest, change_pct, change_shares, short_value, market_cap, avg_daily_volume, price, symbol, company_name, sector, industry, country or market","schema":{"type":"string"},"example":"short_pct"},{"name":"order","in":"query","required":false,"description":"asc or desc (default desc; asc for symbol, company_name, sector, industry, country and market)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 500 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/short-interest/summary":{"get":{"tags":["Short Interest"],"summary":"Short Interest Summary","description":"Short interest grouped for charts and rankings: by sector, industry or country of the company, by short percent bucket, or total short interest per settlement date.\n\nThe answer is {group_by, settlement_date (not for group_by=date), total_groups, groups, totals, about}. Each group carries its name under the group_by key (sector, industry, country, bucket or date). Requires a full API key.","operationId":"short_interest_summary","parameters":[{"name":"group_by","in":"query","required":true,"description":"sector, industry, country (of the company headquarters), bucket (short percent ranges) or date (settlement dates)","schema":{"type":"string"},"example":"sector"},{"name":"settlement_date","in":"query","required":false,"description":"Settlement date (YYYY-MM-DD); default the newest. Not used with group_by=date","schema":{"type":"string"},"example":"2026-08-31"},{"name":"market","in":"query","required":false,"description":"nyse, nasdaq, nyse_american, otc or listed (default listed), as in the ranking","schema":{"type":"string"},"example":"nyse"},{"name":"sector","in":"query","required":false,"description":"Company sector(s), comma-separated","schema":{"type":"string"},"example":"Technology"},{"name":"industry","in":"query","required":false,"description":"Company industry(ies), comma-separated","schema":{"type":"string"},"example":"Biotechnology"},{"name":"country","in":"query","required":false,"description":"Country(ies) of the company headquarters, comma-separated","schema":{"type":"string"},"example":"China"},{"name":"stocks_only","in":"query","required":false,"description":"true (default) = only stocks","schema":{"type":"boolean"},"example":true},{"name":"min_market_cap","in":"query","required":false,"description":"Smallest market cap in US dollars (not used with group_by=date)","schema":{"type":"number"},"example":300000000},{"name":"company","in":"query","required":false,"description":"Company search: the start of a ticker or part of a company name","schema":{"type":"string"},"example":"micro"},{"name":"symbol","in":"query","required":false,"description":"One ticker; with group_by=date it gives the history of that ticker","schema":{"type":"string"},"example":"GME"},{"name":"sort","in":"query","required":false,"description":"short_value (default), short_interest, stocks, avg_short_pct, weighted_short_pct, market_cap or key","schema":{"type":"string"},"example":"short_value"},{"name":"order","in":"query","required":false,"description":"asc or desc (default desc; asc for key)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Groups per page, 1 to 500 (default 30); with group_by=date, the number of settlement dates","schema":{"type":"integer"},"example":30}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/short-interest/dates":{"get":{"tags":["Short Interest"],"summary":"Short Interest Dates","description":"The settlement dates that have short interest data, newest first, with the number of symbols and the total shares sold short on each date.\n\nThe answer is {rows, about}. Works with demo keys.","operationId":"short_interest_dates","parameters":[{"name":"limit","in":"query","required":false,"description":"Dates per page, 1 to 500 (default 60, newest first)","schema":{"type":"integer"},"example":60}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/short-interest/filters":{"get":{"tags":["Short Interest"],"summary":"Short Interest Filters","description":"The choices for the sector, industry and country filters of the ranking and the summary: the names used today, each with the number of stocks that have short interest on the newest settlement date.\n\nThe answer is {settlement_date, sectors, industries, countries}. Each entry is {name, stocks}; industries also have sector. Requires a full API key.","operationId":"short_interest_filters","parameters":[],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/fails-to-deliver":{"get":{"tags":["Short Interest"],"summary":"Fails to Deliver","description":"Fails to deliver of one US stock or ETF: shares a seller did not deliver to the buyer by the settlement date, for every settlement day with an open balance, from official public market data published twice a month. Also totals per half-month, the largest day and runs of consecutive days with large fails. Data from 2017.\n\nThe answer is {symbol, ticker, company_name, securities, data_as_of, total, limit, offset, rows, periods, max, latest, about, period_about}. Each row has settlement_date, quantity, price, value, run_days, flagged, symbol and cusip. The demo key works with symbol=AAPL, MSFT or WMT.","operationId":"fails_to_deliver","parameters":[{"name":"symbol","in":"query","required":true,"description":"One ticker (class shares also as BRKB or BRK.B)","schema":{"type":"string"},"example":"GME"},{"name":"date_from","in":"query","required":false,"description":"First settlement date: YYYY-MM-DD, YYYY-MM or YYYY","schema":{"type":"string"},"example":"2025-10"},{"name":"date_to","in":"query","required":false,"description":"Last settlement date: YYYY-MM-DD, YYYY-MM or YYYY","schema":{"type":"string"},"example":"2026-09-30"},{"name":"order","in":"query","required":false,"description":"Daily rows: desc (newest first, default) or asc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Daily rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Daily rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/fails-to-deliver/ranking":{"get":{"tags":["Short Interest"],"summary":"Fails to Deliver Ranking","description":"Securities ranked by their fails to deliver in one half-month (default the newest), by value or by shares, with days with fails, averages, the largest day, the longest run of large fails and the flagged mark. Give symbol=A,B,C to get the rows of chosen tickers, for example as a column next to another list.\n\nThe answer is {period, total, limit, offset, sort, order, rows, about, period_about}. A sort value outside the list returns an error that names the allowed values.","operationId":"fails_to_deliver_ranking","parameters":[{"name":"period","in":"query","required":false,"description":"latest (default) or a date inside the half-month","schema":{"type":"string"},"example":"2026-09-01"},{"name":"symbol","in":"query","required":false,"description":"Only these tickers, comma-separated, up to 100","schema":{"type":"string"},"example":"GME,AMC,TSLA"},{"name":"q","in":"query","required":false,"description":"Part of a ticker, symbol or security name","schema":{"type":"string"},"example":"game"},{"name":"listed_only","in":"query","required":false,"description":"true = only securities matched to a ticker of the site","schema":{"type":"boolean"},"example":true},{"name":"flagged_only","in":"query","required":false,"description":"true = only securities with 10,000+ shares on 5 or more settlement days in a row","schema":{"type":"boolean"},"example":true},{"name":"min_value","in":"query","required":false,"description":"Smallest largest-day value in US dollars","schema":{"type":"number"},"example":1000000},{"name":"min_quantity","in":"query","required":false,"description":"Smallest largest-day quantity in shares","schema":{"type":"integer"},"example":100000},{"name":"sort","in":"query","required":false,"description":"max_value (default), avg_value, total_value, max_quantity, avg_quantity, total_quantity, last_quantity, days_with_fails, longest_run or symbol","schema":{"type":"string"},"example":"avg_value"},{"name":"order","in":"query","required":false,"description":"asc or desc (default desc; asc for symbol)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 500 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/fails-to-deliver/periods":{"get":{"tags":["Short Interest"],"summary":"Fails to Deliver Periods","description":"The half-month periods that have fails to deliver data, newest first, with the number of settlement days and securities and the daily numbers of all securities added up.\n\nThe answer is {total, rows, about}.","operationId":"fails_to_deliver_periods","parameters":[{"name":"limit","in":"query","required":false,"description":"Periods per page, 1 to 500 (default 48, newest first)","schema":{"type":"integer"},"example":24}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/drug-approvals":{"get":{"tags":["Drug Approvals"],"summary":"Drug Approvals","description":"Drug approvals from official government data, for the US and 13 other countries (country filter). US: every original approval of a new drug, a biologic (including vaccines, blood products, allergenics and cell and gene therapies) or a generic drug, tentative approvals of generics, and every approval of a new use for a drug already on the market (for example a new indication). Each approval has the brand and generic names, the kind of approval, the review priority, a novel drug flag and the listed company that holds the drug today.\n\nAll filters are optional and can be combined. The answer is {country, total, limit, offset, sort, order, data_as_of, rows, ignored, about}. Rows of other countries carry date_precision (year when only the year is published, so no day is shown) and approval_id for the detail endpoint. US rows also carry center, product_category, name_source (set when a missing name was filled in from other official data) and note. The demo key works with symbol=AAPL, MSFT or WMT.","operationId":"drug_approvals","parameters":[{"name":"country","in":"query","required":false,"description":"US (default) or a country code from /drug-approvals/countries, for example EU, GB, JP, CN, CA. Other countries have the fields they publish; filters they cannot use are listed in the answer under ignored","schema":{"type":"string"},"example":"EU"},{"name":"symbol","in":"query","required":false,"description":"Ticker(s) of the listed company, comma-separated","schema":{"type":"string"},"example":"LLY"},{"name":"q","in":"query","required":false,"description":"Words in the brand name, generic name or holder name","schema":{"type":"string"},"example":"semaglutide"},{"name":"generic","in":"query","required":false,"description":"Words in the generic (active ingredient) name","schema":{"type":"string"},"example":"semaglutide"},{"name":"company","in":"query","required":false,"description":"Words in the holder or company name","schema":{"type":"string"},"example":"novo"},{"name":"year_from","in":"query","required":false,"description":"Approved in this year or later","schema":{"type":"integer"},"example":2020},{"name":"year_to","in":"query","required":false,"description":"Approved in this year or earlier","schema":{"type":"integer"},"example":2025},{"name":"type","in":"query","required":false,"description":"US: new_drug, biologic or generic. Other countries: drug, generic, biologic, biosimilar, vaccine, atmp or otc. Comma-separated","schema":{"type":"string"},"example":"biologic"},{"name":"review","in":"query","required":false,"description":"priority or standard (countries that publish review speed)","schema":{"type":"string"},"example":"priority"},{"name":"kind","in":"query","required":false,"description":"US: kind of approval as in category. Other countries: route code such as full_new_active or generic","schema":{"type":"string"},"example":"New molecular entity"},{"name":"form","in":"query","required":false,"description":"US only: words in the dosage form","schema":{"type":"string"},"example":"tablet"},{"name":"product_category","in":"query","required":false,"description":"US: vaccine, blood product, allergenic, gene therapy, cell therapy, tissue product or other biologic","schema":{"type":"string"},"example":"gene therapy"},{"name":"center","in":"query","required":false,"description":"US: CDER (drugs and most biologics) or CBER (vaccines, blood products, allergenics, cell and gene therapies)","schema":{"type":"string"},"example":"CBER"},{"name":"missing_name","in":"query","required":false,"description":"US: true = only approvals that have no brand and no generic name yet","schema":{"type":"boolean"},"example":true},{"name":"application_type","in":"query","required":false,"description":"NDA, BLA or ANDA; comma-separated","schema":{"type":"string"},"example":"NDA,BLA"},{"name":"approval_kind","in":"query","required":false,"description":"original or supplement (a new use)","schema":{"type":"string"},"example":"original"},{"name":"approval_status","in":"query","required":false,"description":"approved or tentative","schema":{"type":"string"},"example":"approved"},{"name":"novel_only","in":"query","required":false,"description":"true = only novel drugs","schema":{"type":"boolean"},"example":true},{"name":"priority_only","in":"query","required":false,"description":"true = only approvals with a priority review","schema":{"type":"boolean"},"example":true},{"name":"category","in":"query","required":false,"description":"Kind of approval, e.g. New molecular entity, Generic drug","schema":{"type":"string"},"example":"New dosage form"},{"name":"matched_only","in":"query","required":false,"description":"true = only drugs of listed companies","schema":{"type":"boolean"},"example":true},{"name":"date_from","in":"query","required":false,"description":"Approved on or after (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"date_to","in":"query","required":false,"description":"Approved on or before (YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-06-30"},{"name":"days","in":"query","required":false,"description":"Only approvals from the last N days","schema":{"type":"integer"},"example":30},{"name":"sort","in":"query","required":false,"description":"approval_date (default), brand_name, generic_name, symbol, holder_name, application_number, type, kind, review or form (form: US only). Sorting is done on the whole list, not on the page","schema":{"type":"string"},"example":"approval_date"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/drug-approvals/summary":{"get":{"tags":["Drug Approvals"],"summary":"Drug Approvals Summary","description":"Counts of US drug approvals for charts, grouped by year, month, application type, kind of approval, original or supplement, or listed company.\n\nRequired: group_by. Every filter of /drug-approvals also works here. The answer is {group_by, sort, order, total_groups, groups, totals, data_as_of, about}.","operationId":"drug_approvals_summary","parameters":[{"name":"group_by","in":"query","required":true,"description":"year, month, application_type, category or symbol (US also approval_kind, product_category and center)","schema":{"type":"string"},"example":"year"},{"name":"country","in":"query","required":false,"description":"US (default) or a country code from /drug-approvals/countries","schema":{"type":"string"},"example":"EU"},{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"PFE"},{"name":"novel_only","in":"query","required":false,"description":"true = only novel drugs","schema":{"type":"boolean"},"example":true},{"name":"date_from","in":"query","required":false,"description":"Approved on or after (YYYY-MM-DD)","schema":{"type":"string"},"example":"2015-01-01"},{"name":"sort","in":"query","required":false,"description":"approvals, novel_drugs, new_drug_approvals, new_use_approvals, generic_approvals, priority_reviews, last_approval_date or key (default: key for year and month)","schema":{"type":"string"},"example":"key"},{"name":"limit","in":"query","required":false,"description":"Groups per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/drug-approvals/companies":{"get":{"tags":["Drug Approvals"],"summary":"Drug Approvals by Company","description":"Listed companies with drug approvals: approvals, novel drugs, new drugs, new uses, generics, priority reviews, the first and last approval date, the latest novel drug and the holder names matched to the company with their match method.\n\nAll filters are optional. The answer is {total, limit, offset, sort, order, data_as_of, rows, about}.","operationId":"drug_approvals_companies","parameters":[{"name":"symbol","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"MRK"},{"name":"q","in":"query","required":false,"description":"Part of a ticker or company name","schema":{"type":"string"},"example":"Pfizer"},{"name":"date_from","in":"query","required":false,"description":"Count approvals on or after (YYYY-MM-DD)","schema":{"type":"string"},"example":"2021-01-01"},{"name":"sort","in":"query","required":false,"description":"approvals (default), novel_drugs, new_drug_approvals, new_use_approvals, generic_approvals, last_approval_date or symbol","schema":{"type":"string"},"example":"novel_drugs"},{"name":"limit","in":"query","required":false,"description":"Companies per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":20}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/drug-approvals/countries":{"get":{"tags":["Drug Approvals"],"summary":"Drug Approval Countries","description":"The countries that have drug approvals, with approval counts, date range, the fields each country publishes (review speed, approval route, new-ingredient flag, listed-company match, day-level dates), notes about gaps, the types and routes to filter by, and for the US the kinds, dosage forms and product categories.\n\nNo parameters. A full API key is needed. The answer is {countries, us, about}.","operationId":"drug_approvals_countries","parameters":[],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/drug-approvals/detail":{"get":{"tags":["Drug Approvals"],"summary":"Drug Approval Detail","description":"Everything about one approval: the application, the products with strengths, dosage form, route and marketing status, every submission with its date, kind, review priority, status and links to approval letters, labels and reviews, the listed company, and label text (indications, warnings, boxed warning, dosage) when a label exists.\n\nA full API key is needed. The answer is {country, approval, approvals, sponsor, application, products, submissions, latest_label_link, label, notes}.","operationId":"drug_approvals_detail","parameters":[{"name":"application_number","in":"query","required":false,"description":"US application number","schema":{"type":"string"},"example":"NDA215256"},{"name":"country","in":"query","required":false,"description":"Country code (default US)","schema":{"type":"string"},"example":"EU"},{"name":"approval_id","in":"query","required":false,"description":"Approval id of a row of another country","schema":{"type":"string"},"example":"EU:ema:EMEA/H/C/006693"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/hospitals":{"get":{"tags":["Healthcare Providers"],"summary":"Hospitals","description":"Every active Medicare-certified hospital in the US (identified by its CCN) from official US government data: type, ownership, beds, emergency services, teaching status, the overall star rating (1 to 5), the health system and its listed owner, and the latest yearly financials from the hospital cost reports.\n\nAll filters are optional and can be combined. The answer is {total, limit, offset, sort, order, rows, about, as_of}. This data needs a full API key (demo keys are limited to their demo tickers).","operationId":"healthcare_hospitals","parameters":[{"name":"q","in":"query","required":false,"description":"Hospital name (any part), city or CCN","schema":{"type":"string"},"example":"mayo clinic"},{"name":"ccn","in":"query","required":false,"description":"CCN(s), comma-separated","schema":{"type":"string"},"example":"240010"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s), comma-separated","schema":{"type":"string"},"example":"TX"},{"name":"city","in":"query","required":false,"description":"City","schema":{"type":"string"},"example":"Houston"},{"name":"zip","in":"query","required":false,"description":"5-digit ZIP code(s), comma-separated","schema":{"type":"string"},"example":"77030"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code(s), comma-separated","schema":{"type":"string"},"example":"48201"},{"name":"hospital_type","in":"query","required":false,"description":"Short-term acute care (or acute), Critical access, Psychiatric, Rehabilitation, Long-term care, Children's, Rural emergency, Veterans Affairs, Military","schema":{"type":"string"},"example":"acute"},{"name":"ownership","in":"query","required":false,"description":"nonprofit, for-profit or government","schema":{"type":"string"},"example":"for-profit"},{"name":"system_id","in":"query","required":false,"description":"Health system ID or slug","schema":{"type":"string"},"example":"hca-healthcare"},{"name":"ticker","in":"query","required":false,"description":"Listed owner of the health system","schema":{"type":"string"},"example":"HCA"},{"name":"emergency_services","in":"query","required":false,"description":"true = only hospitals with emergency services","schema":{"type":"boolean"},"example":true},{"name":"teaching","in":"query","required":false,"description":"true = only teaching hospitals","schema":{"type":"boolean"},"example":true},{"name":"star_rating_min","in":"query","required":false,"description":"Smallest overall star rating, 1 to 5","schema":{"type":"integer"},"example":4},{"name":"beds_min","in":"query","required":false,"description":"Smallest number of beds","schema":{"type":"integer"},"example":200},{"name":"sort","in":"query","required":false,"description":"net_patient_revenue (default), beds, star_rating, name, discharges, operating_margin_pct, net_income, net_margin_pct, affiliated_clinicians, occupancy_pct, uncompensated_care_cost, fte_employees, state","schema":{"type":"string"},"example":"beds"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 500 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/hospitals/{ccn}":{"get":{"tags":["Healthcare Providers"],"summary":"Hospital Detail","description":"One hospital by its CCN: the full profile, organization NPIs with how each was linked, the health system and listed owner, financials for every loaded fiscal year, quality measures with the national median, and the clinicians who work there by specialty.","operationId":"healthcare_hospitals_ccn","parameters":[{"name":"ccn","in":"path","required":true,"description":"CCN in the path","schema":{"type":"string"},"example":"360180"},{"name":"include","in":"query","required":false,"description":"npis, system, financials, quality, clinicians; comma-separated","schema":{"type":"string"},"example":"financials,quality"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/hospitals/summary":{"get":{"tags":["Healthcare Providers"],"summary":"Hospital Summary","description":"Hospital totals for maps and rankings, grouped by state, hospital type, ownership, star rating, health system or teaching status: hospitals, beds, discharges, net patient revenue, net income, average star rating, hospitals with emergency services and hospitals in a system.","operationId":"healthcare_hospitals_summary","parameters":[{"name":"group_by","in":"query","required":false,"description":"state (default), hospital_type, ownership, star_rating, system or teaching","schema":{"type":"string"},"example":"ownership"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"CA"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/health-systems":{"get":{"tags":["Healthcare Providers"],"summary":"Health Systems","description":"US health systems (two or more hospitals under one home office or common ownership in the official records, completed with a 2023 list of US health systems): hospitals, states, beds, affiliated clinicians, revenue and net income of the member hospitals, average star rating, headquarters and listed owner.","operationId":"healthcare_health_systems","parameters":[{"name":"q","in":"query","required":false,"description":"Part of the system name","schema":{"type":"string"},"example":"kaiser"},{"name":"state","in":"query","required":false,"description":"Systems with a hospital in these states","schema":{"type":"string"},"example":"FL"},{"name":"ticker","in":"query","required":false,"description":"Listed owner(s), comma-separated","schema":{"type":"string"},"example":"HCA,THC,CYH,UHS"},{"name":"sort","in":"query","required":false,"description":"hospital_count (default), total_beds, net_patient_revenue, clinician_count, name, avg_star_rating, net_income, discharges, states_count","schema":{"type":"string"},"example":"net_patient_revenue"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/health-systems/{system_id}":{"get":{"tags":["Healthcare Providers"],"summary":"Health System Detail","description":"One health system by ID or slug: member hospitals with match_method and confidence, the financial roll-up by fiscal year, group practices linked by keys, and the 2023 profile (physicians, primary care physicians, nurse practitioners, outpatient sites, nursing homes, teaching, insurance plans; as of 2023).","operationId":"healthcare_health_systems_system_id","parameters":[{"name":"system_id","in":"path","required":true,"description":"System ID or slug in the path","schema":{"type":"string"},"example":"kaiser-permanente"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/hospital-financials":{"get":{"tags":["Healthcare Providers"],"summary":"Hospital Financials","description":"Yearly hospital financials from the hospital cost reports for the last fiscal years: total and net patient revenue, operating expenses, operating income and margin on patient care, other income, net income and margin, beds, discharges, patient days, occupancy, Medicare and Medicaid share of inpatient days, employees, charity care, bad debt, uncompensated care, cost-to-charge ratio, total costs and total assets.","operationId":"healthcare_hospital_financials","parameters":[{"name":"ccn","in":"query","required":false,"description":"CCN(s), comma-separated","schema":{"type":"string"},"example":"240010"},{"name":"system_id","in":"query","required":false,"description":"Health system ID or slug","schema":{"type":"string"},"example":"hca-healthcare"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"NY"},{"name":"fiscal_year","in":"query","required":false,"description":"One fiscal year","schema":{"type":"integer"},"example":2024},{"name":"year_from","in":"query","required":false,"description":"First fiscal year","schema":{"type":"integer"},"example":2020},{"name":"sort","in":"query","required":false,"description":"net_patient_revenue (default), net_income, operating_margin_pct, fiscal_year, beds, discharges, uncompensated_care_cost, net_margin_pct","schema":{"type":"string"},"example":"net_income"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/hospital-quality":{"get":{"tags":["Healthcare Providers"],"summary":"Hospital Quality","description":"Main hospital quality measures: readmission and death rates, patient safety, infections (ratio of observed to expected), patient survey results and timely care, with the official comparison with the national rate where one exists, the number of cases, the period and the national median. Also lists every measure with its national median and quartiles.","operationId":"healthcare_hospital_quality","parameters":[{"name":"measure_id","in":"query","required":false,"description":"Measure ID(s), e.g. mortality_heart_attack, readmission_heart_failure, would_recommend, infection_c_diff, ed_time_minutes","schema":{"type":"string"},"example":"mortality_heart_attack"},{"name":"measure_group","in":"query","required":false,"description":"readmission, mortality, safety, infection, patient_experience, timely_care","schema":{"type":"string"},"example":"mortality"},{"name":"ccn","in":"query","required":false,"description":"CCN(s)","schema":{"type":"string"},"example":"330101"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"MA"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/providers":{"get":{"tags":["Healthcare Providers"],"summary":"Providers (NPI)","description":"Every US health care provider with a National Provider Identifier (about 9.5 million active): individual clinicians (doctors, nurse practitioners, therapists, counselors, pharmacists) and organizations (hospitals, clinics, group practices, pharmacies, labs), with specialty, practice address, phone, status and Medicare enrollment.","operationId":"healthcare_providers","parameters":[{"name":"q","in":"query","required":false,"description":"Name (any part) or a 10-digit NPI","schema":{"type":"string"},"example":"john smith"},{"name":"specialty","in":"query","required":false,"description":"Specialty name or part of it","schema":{"type":"string"},"example":"cardiology"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"MN"},{"name":"city","in":"query","required":false,"description":"City of the practice","schema":{"type":"string"},"example":"Rochester"},{"name":"zip","in":"query","required":false,"description":"5-digit ZIP code(s)","schema":{"type":"string"},"example":"55905"},{"name":"entity_type","in":"query","required":false,"description":"individual or organization","schema":{"type":"string"},"example":"individual"},{"name":"medicare","in":"query","required":false,"description":"true = only clinicians enrolled in Medicare","schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/providers/{npi}":{"get":{"tags":["Healthcare Providers"],"summary":"Provider Detail","description":"One provider by NPI: the registry record (all specialties, practice address, dates, active or deactivated), Medicare enrollment (specialties, medical school, graduation year, telehealth, accepts assignment), group practices with their health system, hospital affiliations, and for an organization NPI the hospital (CCN) or group practice it belongs to. Every link is by key with match_method and confidence.","operationId":"healthcare_providers_npi","parameters":[{"name":"npi","in":"path","required":true,"description":"NPI in the path","schema":{"type":"string"},"example":"1003000126"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/providers/summary":{"get":{"tags":["Healthcare Providers"],"summary":"Provider Counts","description":"Counts of active providers by state, specialty, Medicare specialty or entity type, for maps and rankings.","operationId":"healthcare_providers_summary","parameters":[{"name":"group_by","in":"query","required":false,"description":"state (default), specialty, medicare_specialty or entity_type","schema":{"type":"string"},"example":"medicare_specialty"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/specialties":{"get":{"tags":["Healthcare Providers"],"summary":"Specialties","description":"Provider specialties (taxonomy codes) with readable names and the number of active providers, and the Medicare specialties of enrolled clinicians with their counts.","operationId":"healthcare_specialties","parameters":[{"name":"q","in":"query","required":false,"description":"Part of a specialty name","schema":{"type":"string"},"example":"cardio"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/groups":{"get":{"tags":["Healthcare Providers"],"summary":"Group Practices","description":"Medicare group practices (identified by their group ID): name, number of clinicians, location, main specialties, the organization NPI found by the group ID in the enrollment records (with confidence) and, where the group belongs to a hospital or its parent organization, the hospital and health system.","operationId":"healthcare_groups","parameters":[{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"MN"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/procedures":{"get":{"tags":["Healthcare Providers"],"summary":"Medicare Procedures","description":"Medicare services billed by doctors, other clinicians and organizations: one row per provider (NPI), year, procedure code and place of service (facility or office), with services, patients, the average submitted charge, allowed amount and Medicare payment, from official US government data. The newest 3 data years are kept.\n\nnpi= or code= is required. The answer is {total, limit, offset, sort, order, year, rows, about, as_of}.","operationId":"healthcare_procedures","parameters":[{"name":"npi","in":"query","required":false,"description":"10-digit NPI","schema":{"type":"string"},"example":"1003000126"},{"name":"code","in":"query","required":false,"description":"Procedure code(s), comma-separated","schema":{"type":"string"},"example":"99213"},{"name":"state","in":"query","required":false,"description":"Two-letter state of the provider","schema":{"type":"string"},"example":"CA"},{"name":"year","in":"query","required":false,"description":"Data year (default newest)","schema":{"type":"integer"},"example":2024},{"name":"place_of_service","in":"query","required":false,"description":"facility or office","schema":{"type":"string"},"example":"office"},{"name":"category","in":"query","required":false,"description":"E&M, Procedure, Imaging, Test, Treatment, Anesthesia, DME, Other","schema":{"type":"string"},"example":"Imaging"},{"name":"lab","in":"query","required":false,"description":"true = lab test codes only","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"total_paid (default), services, beneficiaries, avg_paid, avg_allowed, avg_submitted, code","schema":{"type":"string"},"example":"services"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 500","schema":{"type":"integer"},"example":50}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/procedures/codes":{"get":{"tags":["Healthcare Providers"],"summary":"Procedure Codes","description":"Procedure codes ranked by Medicare payments, services or providers, nationally or in one state, with their public category, subcategory and family. /healthcare/procedures/codes/{code} gives one code by year, by state and its top 25 providers.","operationId":"healthcare_procedures_codes","parameters":[{"name":"q","in":"query","required":false,"description":"Code or category words","schema":{"type":"string"},"example":"knee"},{"name":"state","in":"query","required":false,"description":"Two-letter state (default national)","schema":{"type":"string"},"example":"FL"},{"name":"category","in":"query","required":false,"description":"Public category","schema":{"type":"string"},"example":"Procedure"},{"name":"sort","in":"query","required":false,"description":"total_paid (default), services, providers, beneficiaries, avg_paid, code","schema":{"type":"string"},"example":"services"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/procedures/providers":{"get":{"tags":["Healthcare Providers"],"summary":"Procedure Providers and Summary","description":"Providers ranked by their yearly Medicare totals (payments, services, patients, codes, drug payments, average patient age and risk score), and /healthcare/procedures/summary with totals by state, provider type, category, place of service or year for charts.","operationId":"healthcare_procedures_providers","parameters":[{"name":"provider_type","in":"query","required":false,"description":"Medicare provider type","schema":{"type":"string"},"example":"Cardiology"},{"name":"group_by","in":"query","required":false,"description":"summary: state, provider_type, category, subcategory, place_of_service, year","schema":{"type":"string"},"example":"state"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/lab-tests":{"get":{"tags":["Healthcare Providers"],"summary":"Lab Tests","description":"Medicare lab tests (general laboratory, molecular testing and anatomic pathology codes) ranked nationally or by state, with the lab group and the national lab fee schedule rate of the newest quarter. /healthcare/lab-tests/providers ranks labs and other providers by lab payments; /healthcare/lab-tests/summary groups by lab_group, state or year; /healthcare/lab-fee-schedule lists the quarterly rates.","operationId":"healthcare_lab_tests","parameters":[{"name":"lab_group","in":"query","required":false,"description":"e.g. Clinical Chemistry, Immunoassay, Genetic Analysis","schema":{"type":"string"},"example":"Genetic Analysis"},{"name":"code","in":"query","required":false,"description":"lab-fee-schedule: code(s)","schema":{"type":"string"},"example":"80053"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/hospital-procedures":{"get":{"tags":["Healthcare Providers"],"summary":"Hospital Stays and Outpatient Services","description":"Medicare hospital stays per hospital (CCN) and diagnosis related group (DRG): discharges, average covered charges, average total payment and average Medicare payment; and outpatient services per hospital and ambulatory payment classification (APC). /healthcare/hospital-procedures/codes lists DRG or APC codes with national totals; /codes/{code} gives one code by year and state with its top hospitals.","operationId":"healthcare_hospital_procedures","parameters":[{"name":"ccn","in":"query","required":false,"description":"Hospital CCN","schema":{"type":"string"},"example":"240010"},{"name":"code","in":"query","required":false,"description":"DRG (3 digits) or APC (4 digits)","schema":{"type":"string"},"example":"470"},{"name":"setting","in":"query","required":false,"description":"inpatient or outpatient","schema":{"type":"string"},"example":"inpatient"},{"name":"ticker","in":"query","required":false,"description":"Listed owner of the hospitals","schema":{"type":"string"},"example":"HCA"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/prescriptions":{"get":{"tags":["Healthcare Providers"],"summary":"Medicare Prescriptions","description":"Medicare prescription drug (Part D) claims per prescriber (NPI), drug (brand and generic name) and year: claims, 30-day fills, day supply, drug cost and patients. /healthcare/prescriptions/prescribers ranks prescribers; /healthcare/prescriptions/summary groups by state, prescriber type or year.","operationId":"healthcare_prescriptions","parameters":[{"name":"npi","in":"query","required":false,"description":"10-digit NPI","schema":{"type":"string"},"example":"1003000126"},{"name":"drug","in":"query","required":false,"description":"Drug ID, slug or name","schema":{"type":"string"},"example":"eliquis"},{"name":"state","in":"query","required":false,"description":"Two-letter state of the prescriber","schema":{"type":"string"},"example":"FL"},{"name":"prescriber_type","in":"query","required":false,"description":"e.g. Cardiology, Nurse Practitioner","schema":{"type":"string"},"example":"Cardiology"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/prescriptions/drugs":{"get":{"tags":["Healthcare Providers"],"summary":"Medicare Drugs","description":"Drugs ranked by Medicare cost, claims, prescribers or patients, nationally or in one state, with the listed company of the maker where a reviewed link exists. /healthcare/prescriptions/drugs/{drug} gives one drug: totals by year and state, spending by manufacturer, top prescribers, Medicaid use by quarter, NDC count, RxNorm IDs and application numbers.","operationId":"healthcare_prescriptions_drugs","parameters":[{"name":"ticker","in":"query","required":false,"description":"Listed company","schema":{"type":"string"},"example":"LLY"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/drug-spending":{"get":{"tags":["Healthcare Providers"],"summary":"Drug Spending","description":"Total Medicare prescription drug spending per drug and manufacturer by year (5 years per release), grouped by drug, manufacturer, listed company or year. Manufacturers are linked to listed companies with a reviewed list (current owner).","operationId":"healthcare_drug_spending","parameters":[{"name":"group_by","in":"query","required":false,"description":"drug, manufacturer, company, year","schema":{"type":"string"},"example":"company"},{"name":"ticker","in":"query","required":false,"description":"Listed company","schema":{"type":"string"},"example":"BMY"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/medicaid-drugs":{"get":{"tags":["Healthcare Providers"],"summary":"Medicaid Drugs","description":"Medicaid drug use per drug product (NDC labeler and product code), state (US = national) and year or quarter: prescriptions, units, amount reimbursed and the Medicaid share, with brand and generic names, labeler and the Medicare drug link. /healthcare/medicaid-drugs/summary groups by state, quarter or year.","operationId":"healthcare_medicaid_drugs","parameters":[{"name":"state","in":"query","required":false,"description":"Two-letter state","schema":{"type":"string"},"example":"NY"},{"name":"quarter","in":"query","required":false,"description":"1 to 4 (default whole year)","schema":{"type":"integer"},"example":1}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/payments":{"get":{"tags":["Healthcare Providers"],"summary":"Payments to Doctors and Hospitals","description":"Payments and other transfers of value from drug and medical device companies to doctors (NPI) and teaching hospitals (CCN), one row per recipient, company, nature of payment and related product per program year: number of payments, amount, first and last date. kind: general, research, research_pi (lead investigator, not added to totals), ownership.","operationId":"healthcare_payments","parameters":[{"name":"npi","in":"query","required":false,"description":"Doctor NPI","schema":{"type":"string"},"example":"1003000126"},{"name":"ticker","in":"query","required":false,"description":"Listed company","schema":{"type":"string"},"example":"PFE"},{"name":"kind","in":"query","required":false,"description":"general, research, research_pi, ownership","schema":{"type":"string"},"example":"general"},{"name":"nature","in":"query","required":false,"description":"Nature of payment","schema":{"type":"string"},"example":"Consulting Fee"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/payments/companies":{"get":{"tags":["Healthcare Providers"],"summary":"Paying Companies, Recipients and Summary","description":"Paying companies ranked by general, research and ownership amounts with their listed company link; /payments/companies/{payer} gives one company (totals by year and kind, natures, top products, top recipients); /payments/recipients ranks doctors and teaching hospitals; /payments/summary groups by state, nature, kind, year or product.","operationId":"healthcare_payments_companies","parameters":[{"name":"q","in":"query","required":false,"description":"Company name words","schema":{"type":"string"},"example":"stryker"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/companies/{ticker}":{"get":{"tags":["Healthcare Providers"],"summary":"Listed Company Medicare Summary","description":"A listed company's Medicare prescription drug spending (its linked manufacturers: totals per year and the top drugs of the newest year), its payments to doctors and teaching hospitals (totals per year and kind, natures, top products), its certified labs (labs: lab companies such as DGX and LH) and its device clearances, approvals, recalls and adverse event reports (devices: device makers such as MDT, ABT and BSX). has_data is false when the company has none of these.","operationId":"healthcare_companies_ticker","parameters":[{"name":"ticker","in":"path","required":true,"description":"Ticker in the path","schema":{"type":"string"},"example":"PFE"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/labs":{"get":{"tags":["Healthcare Providers"],"summary":"Certified Labs","description":"Every active US laboratory with a federal lab certificate (about 300,000, all payers, not only Medicare) from official US government data: lab type, segment (independent_reference, pol = physician office, hospital, other), certificate type, accrediting bodies, yearly test volume, ownership, address and area, the listed lab company (reviewed list) and links to an organization NPI and a hospital CCN.\n\nAll filters are optional and can be combined. The answer is {total, limit, offset, sort, order, rows, about, as_of}. /healthcare/labs/{clia_id} gives one lab with its Medicare lab tests. This data needs a full API key.","operationId":"healthcare_labs","parameters":[{"name":"state","in":"query","required":false,"description":"Two-letter state code(s), comma-separated","schema":{"type":"string"},"example":"TX"},{"name":"segment","in":"query","required":false,"description":"independent_reference, pol, hospital, other (comma list)","schema":{"type":"string"},"example":"independent_reference"},{"name":"lab_type","in":"query","required":false,"description":"Lab type name (Independent lab, Physician office, Hospital, Pharmacy, Nursing home, ...) or its 2-digit code","schema":{"type":"string"},"example":"Pharmacy"},{"name":"certificate_type","in":"query","required":false,"description":"waiver, ppm, compliance, accreditation, registration","schema":{"type":"string"},"example":"accreditation"},{"name":"accreditation","in":"query","required":false,"description":"CAP, COLA, Joint Commission, AABB, AOA, ASHI, A2LA","schema":{"type":"string"},"example":"CAP"},{"name":"ticker","in":"query","required":false,"description":"Listed lab company","schema":{"type":"string"},"example":"LH"},{"name":"company","in":"query","required":false,"description":"Lab company name, also for private companies","schema":{"type":"string"},"example":"ARUP Laboratories"},{"name":"q","in":"query","required":false,"description":"Lab name words or a lab certificate number","schema":{"type":"string"},"example":"mayo"},{"name":"city","in":"query","required":false,"description":"City","schema":{"type":"string"},"example":"Houston"},{"name":"zip","in":"query","required":false,"description":"5-digit ZIP code","schema":{"type":"string"},"example":"77030"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code","schema":{"type":"string"},"example":"48201"},{"name":"min_volume","in":"query","required":false,"description":"Smallest yearly test volume","schema":{"type":"integer"},"example":1000000},{"name":"npi","in":"query","required":false,"description":"Linked organization NPI","schema":{"type":"string"},"example":"1891731626"},{"name":"ccn","in":"query","required":false,"description":"Linked hospital CCN","schema":{"type":"string"},"example":"240010"},{"name":"sort","in":"query","required":false,"description":"test_volume (default), name, certified_since, state, waived_volume","schema":{"type":"string"},"example":"test_volume"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 500 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/labs/summary":{"get":{"tags":["Healthcare Providers"],"summary":"Lab Counts and Lab Companies","description":"Lab counts and reported yearly test volumes grouped by segment, lab type, certificate type, state, volume band, ownership, accreditation or company, and the yearly trend since 2012 (group_by=year or segment_year). /healthcare/labs/companies lists the listed and large private lab companies with labs, states, test volumes and the Medicare lab payments of their linked NPIs.","operationId":"healthcare_labs_summary","parameters":[{"name":"group_by","in":"query","required":false,"description":"segment, lab_type, certificate_type, state, volume_band, ownership, accreditation, company, segment_state, year, segment_year","schema":{"type":"string"},"example":"state"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"CA"},{"name":"segment","in":"query","required":false,"description":"independent_reference, pol, hospital, other","schema":{"type":"string"},"example":"pol"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/lab-tests/segments":{"get":{"tags":["Healthcare Providers"],"summary":"Medicare Lab Tests by Segment and Category","description":"Medicare Part B lab tests (services, allowed and paid amounts) by lab segment (independent_lab, pathology_practice, physician_office, hospital_setting, other), test category (chemistry, hematology, immunology, microbiology, molecular_infectious, molecular_genetic, pla, pathology, toxicology, urinalysis, transfusion, collection), place of service, year or code, from 100% of claims of labs, doctors and suppliers. group_by=code adds the lab fee schedule rate and the 2016 private insurer median. /healthcare/lab-tests/private-prices gives private insurer prices next to the Medicare rate.","operationId":"healthcare_lab_tests_segments","parameters":[{"name":"group_by","in":"query","required":false,"description":"segment, category, year, place, segment_year, category_year, segment_category, code","schema":{"type":"string"},"example":"segment_year"},{"name":"year","in":"query","required":false,"description":"Data year","schema":{"type":"integer"},"example":2025},{"name":"segment","in":"query","required":false,"description":"Medicare lab segment","schema":{"type":"string"},"example":"independent_lab"},{"name":"category","in":"query","required":false,"description":"Test category","schema":{"type":"string"},"example":"molecular_genetic"},{"name":"q","in":"query","required":false,"description":"group_by=code: code prefix","schema":{"type":"string"},"example":"813"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/device-procedures":{"get":{"tags":["Healthcare Providers"],"summary":"Device Procedures","description":"Medicare Part B procedures that use medical devices (joint replacement, spine, pacemakers and defibrillators, heart valves, coronary and peripheral stents, neurostimulators, eye lenses, hearing implants, imaging and more) by device category, subcategory, code, place of service (office, surgery center, hospital outpatient, hospital inpatient, ...), billing provider group or year, from 100% of claims of doctors and surgery centers. Add state to get the same answers for one state (state totals of billed services, 2022 to 2024, split into office and facility). /healthcare/device-procedures/states gives every state at once (with equipment and supplies unless kind=procedures).","operationId":"healthcare_device_procedures","parameters":[{"name":"group_by","in":"query","required":false,"description":"category, subcategory, code, place, year, provider, category_year, category_place, subcategory_year","schema":{"type":"string"},"example":"code"},{"name":"category","in":"query","required":false,"description":"cardiac_rhythm, cardiac_monitoring, structural_heart, coronary, ep_ablation, heart_assist, vascular, vascular_access, joint, spine, neurostim, hearing, ophthalmic, urology, breast, wound, imaging","schema":{"type":"string"},"example":"joint"},{"name":"code","in":"query","required":false,"description":"One procedure code","schema":{"type":"string"},"example":"27447"},{"name":"place","in":"query","required":false,"description":"office, facility (hospital, surgery center, emergency room and nursing facility together), independent_lab, hospital_outpatient, hospital_inpatient, emergency, asc, nursing, home, other. With state: office or facility only","schema":{"type":"string"},"example":"asc"},{"name":"state","in":"query","required":false,"description":"Two-letter state code: uses the state totals (billed services, years 2022 to 2024)","schema":{"type":"string"},"example":"TX"},{"name":"year","in":"query","required":false,"description":"Data year (2021 to 2025; with state 2022 to 2024). The answer lists the years in years","schema":{"type":"integer"},"example":2025},{"name":"q","in":"query","required":false,"description":"group_by=code: code prefix","schema":{"type":"string"},"example":"332"},{"name":"sort","in":"query","required":false,"description":"group_by=code: procedures, paid or code","schema":{"type":"string"},"example":"paid"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/device-procedures/hospitals":{"get":{"tags":["Healthcare Providers"],"summary":"Device Hospital Stays and Outpatient Services","description":"Medicare hospital stays (inpatient, by diagnosis related group) and hospital outpatient services (by ambulatory payment classification) in device-heavy groups, such as hip and knee replacement, pacemaker and defibrillator implants, transcatheter valves, coronary stents and spinal fusion, by category, code, state, hospital or year.","operationId":"healthcare_device_procedures_hospitals","parameters":[{"name":"group_by","in":"query","required":false,"description":"category, code, state, hospital, year, category_year","schema":{"type":"string"},"example":"hospital"},{"name":"setting","in":"query","required":false,"description":"inpatient or outpatient","schema":{"type":"string"},"example":"inpatient"},{"name":"category","in":"query","required":false,"description":"Device category","schema":{"type":"string"},"example":"structural_heart"},{"name":"state","in":"query","required":false,"description":"Two-letter state code(s)","schema":{"type":"string"},"example":"TX"},{"name":"year","in":"query","required":false,"description":"Data year; the answer lists the years in years","schema":{"type":"integer"},"example":2024},{"name":"sort","in":"query","required":false,"description":"group_by=hospital: cases, medicare_paid or name","schema":{"type":"string"},"example":"medicare_paid"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/device-procedures/icd":{"get":{"tags":["Healthcare Providers"],"summary":"California Inpatient Procedures by ICD-10-PCS Code","description":"California only, all payers: the number of times each ICD-10-PCS procedure code was reported on a hospital stay, by year (2015 holds October to December only), with the official code description, the public procedure category and our device category. Source: California Department of Health Care Access and Information (HCAI), Hospital Inpatient - Diagnosis, Procedure, and External Cause Codes, data.chhs.ca.gov. Modified by Dataporium: codes grouped into categories.","operationId":"healthcare_device_procedures_icd","parameters":[{"name":"state","in":"query","required":true,"description":"CA","schema":{"type":"string"},"example":"CA"},{"name":"group_by","in":"query","required":false,"description":"code, category, device_category, device_subcategory, clinical_domain, year, device_category_year","schema":{"type":"string"},"example":"device_category"},{"name":"device_category","in":"query","required":false,"description":"Device category","schema":{"type":"string"},"example":"joint"},{"name":"q","in":"query","required":false,"description":"Words in the description or a code prefix","schema":{"type":"string"},"example":"knee"},{"name":"year","in":"query","required":false,"description":"Data year","schema":{"type":"integer"},"example":2025}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/medical-equipment":{"get":{"tags":["Healthcare Providers"],"summary":"Medical Equipment and Supplies","description":"Medicare medical equipment, devices and supplies (glucose monitors and test strips, insulin pumps, sleep apnea machines, oxygen, wheelchairs, hospital beds, braces and artificial limbs) by code, device category, state or year, with the public code descriptions. /healthcare/medical-equipment/referrers ranks the doctors who ordered the most.","operationId":"healthcare_medical_equipment","parameters":[{"name":"group_by","in":"query","required":false,"description":"code, category, state, year, category_year","schema":{"type":"string"},"example":"code"},{"name":"category","in":"query","required":false,"description":"diabetes, sleep_respiratory, mobility, orthotics_prosthetics, wound","schema":{"type":"string"},"example":"diabetes"},{"name":"q","in":"query","required":false,"description":"Words or a code","schema":{"type":"string"},"example":"glucose"},{"name":"sort","in":"query","required":false,"description":"group_by=code: paid (default), code, description, category, beneficiaries, services, suppliers, ordering_doctors","schema":{"type":"string"},"example":"services"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/devices/approvals":{"get":{"tags":["Healthcare Providers"],"summary":"Device Approvals","description":"FDA medical device marketing decisions: 510(k) clearances, De Novo grants, PMA approvals and PMA supplements, with decision and received dates, review days, applicant, listed company (reviewed list, current owner), product code and device name. /healthcare/devices lists the device product codes with class, specialty and counts.","operationId":"healthcare_devices_approvals","parameters":[{"name":"ticker","in":"query","required":false,"description":"Listed device maker","schema":{"type":"string"},"example":"ISRG"},{"name":"pathway","in":"query","required":false,"description":"510k, de_novo, pma, pma_supplement (comma list)","schema":{"type":"string"},"example":"pma"},{"name":"q","in":"query","required":false,"description":"Device or applicant words, or a K, P or DEN number","schema":{"type":"string"},"example":"knee"},{"name":"year","in":"query","required":false,"description":"Decision year","schema":{"type":"integer"},"example":2025},{"name":"group_by","in":"query","required":false,"description":"year, pathway, company, specialty, year_pathway","schema":{"type":"string"},"example":"year_pathway"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/devices/recalls":{"get":{"tags":["Healthcare Providers"],"summary":"Device Recalls and Adverse Events","description":"FDA medical device recalls, one row per recalled product, with class (I most serious, II, III), status, dates, firm, listed company, product code, description and reason; group_by gives totals by year, class, root cause or company. /healthcare/devices/adverse-events gives adverse event report counts (all, death, injury, malfunction) by year received, product code or listed company.","operationId":"healthcare_devices_recalls","parameters":[{"name":"ticker","in":"query","required":false,"description":"Listed device maker","schema":{"type":"string"},"example":"MDT"},{"name":"recall_class","in":"query","required":false,"description":"I, II, III","schema":{"type":"string"},"example":"I"},{"name":"group_by","in":"query","required":false,"description":"year, class, root_cause, company, year_class","schema":{"type":"string"},"example":"year_class"},{"name":"sort","in":"query","required":false,"description":"Rows: initiated_date (default, newest first), posted_date, product, recall_class, firm, status, reason","schema":{"type":"string"},"example":"firm"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"asc"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/devices/companies":{"get":{"tags":["Healthcare Providers"],"summary":"Device Makers","description":"About 90 listed medical device makers (reviewed list of company and brand names, including companies they bought) with 510(k), De Novo, PMA and supplement counts, recalls (and class I), and adverse event reports (deaths, injuries, malfunctions). /healthcare/devices/companies/{ticker} adds approvals and recalls by year, the newest approvals and recalls, and the product codes with the most reports.","operationId":"healthcare_devices_companies","parameters":[{"name":"sort","in":"query","required":false,"description":"approvals, recalls, class1_recalls, events, ticker","schema":{"type":"string"},"example":"recalls"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/healthcare/drugs/adverse-events/{drug}":{"get":{"tags":["Healthcare Providers"],"summary":"Drug Side-Effect Reports","description":"Side-effect reports for one medicine, counted per active ingredient by the year received: totals, reports by year (all, serious, naming a death, naming a hospital stay), the 25 reactions named most often over all years and the last 5 years, patient sex and age group, and links to the Medicare drug pages and listed companies. /healthcare/drugs/adverse-events ranks drugs (group_by=drug) or gives one drug by year (drug=); /healthcare/drugs/adverse-events/reactions gives the reactions of one drug (drug=) or the drugs with the most reports of one reaction (reaction=).","operationId":"healthcare_drugs_adverse_events_drug","parameters":[{"name":"drug","in":"path","required":true,"description":"Generic or brand name, Medicare drug page slug or application number","schema":{"type":"string"},"example":"eliquis"},{"name":"period","in":"query","required":false,"description":"Reactions: all (default) or recent (last 5 years)","schema":{"type":"string"},"example":"recent"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/options-callsputs":{"get":{"tags":["Options Data"],"summary":"Options Calls & Puts","description":"Options chain data including calls and puts with strikes, prices, and Greeks.","operationId":"options_callsputs","parameters":[{"name":"symbol","in":"query","required":false,"description":"Stock ticker symbol (choose ONE filter)","schema":{"type":"string"},"example":"AAPL"},{"name":"company_name","in":"query","required":false,"description":"Company name (choose ONE filter)","schema":{"type":"string"},"example":"Apple Inc."}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/exchange-holiday":{"get":{"tags":["Market Hours"],"summary":"Exchange Holidays","description":"Market holiday schedule for various exchanges.","operationId":"exchange_holiday","parameters":[{"name":"exchange","in":"query","required":true,"description":"Exchange name (NYSE, NASDAQ, LSE, TSX, etc.)","schema":{"type":"string"},"example":"NYSE"},{"name":"date","in":"query","required":false,"description":"Specific date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2024-12-25"},{"name":"year","in":"query","required":false,"description":"Year (YYYY)","schema":{"type":"string"},"example":"2024"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/exchange-hours":{"get":{"tags":["Market Hours"],"summary":"Exchange Hours","description":"Trading hours for different exchanges including pre-market and after-hours.","operationId":"exchange_hours","parameters":[{"name":"exchange","in":"query","required":true,"description":"Exchange name (NYSE, NASDAQ, LSE, etc.)","schema":{"type":"string"},"example":"NYSE"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/economic-metrics":{"get":{"tags":["Economics"],"summary":"Economic Metrics","description":"Economic indicators and metrics including GDP, inflation, unemployment, and more.\n\nRequired: economic_metrics - choose one metric name from the available list above.","operationId":"economic_metrics","parameters":[{"name":"economic_metrics","in":"query","required":true,"description":"Economic metric name. Available: GDP, real_GDP, real_GDP_Per_Capita, nominal_Potential_GDP, CPI, inflation, inflation_Rate, unemployment_Rate, consumer_Sentiment, durable_Goods, federal_Funds, industrial_Production_Total_Index, initial_Claims, retail_Sales, retail_Money_Funds, total_Non_farm_Payroll, total_Vehicle_Sales, new_Privately_Owned_HousingUnits_Started_Total_Units, 15Year_Fixed_Rate_Mortgage_Average, 30Year_Fixed_Rate_Mortgage_Average, 3Month_Or_90Day_Rates_And_Yields_Certificates_Of_Deposit, commercial_Bank_Interest_Rate_On_Credit_Card_Plans__All_Accounts, smoothed_US_Recession_Probabilities","schema":{"type":"string"},"example":"GDP"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/treasury-yields":{"get":{"tags":["Economics"],"summary":"Treasury Yields","description":"Daily US Treasury par yield curve rates for 12 maturities from 1 month to 30 years, from 1990 (official US government data). Daily, weekly or monthly rows with date filters and paging.\n\nAll filters are optional. The answer is {as_of, frequency, maturities, total, limit, offset, order, rows, about}.","operationId":"treasury_yields","parameters":[{"name":"maturity","in":"query","required":false,"description":"Maturities, comma-separated: 1m, 2m, 3m, 6m, 1y, 2y, 3y, 5y, 7y, 10y, 20y, 30y (default all)","schema":{"type":"string"},"example":"2y,10y"},{"name":"date_from","in":"query","required":false,"description":"First date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2024-01-01"},{"name":"date_to","in":"query","required":false,"description":"Last date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2024-12-31"},{"name":"frequency","in":"query","required":false,"description":"daily (default), weekly or monthly","schema":{"type":"string"},"example":"monthly"},{"name":"order","in":"query","required":false,"description":"asc or desc by date (default desc)","schema":{"type":"string"},"example":"asc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 5000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/treasury-yields/curve":{"get":{"tags":["Economics"],"summary":"Yield Curve","description":"The US Treasury yield curve on one day compared with the curve 1 week, 1, 3 or 6 months, or 1, 2 or 5 years earlier, with the 10-year minus 2-year and 10-year minus 3-month spreads.\n\nAll parameters are optional. The answer is {as_of, curves: [{label, date, points, spread_10y_2y, spread_10y_3m, inverted_10y_2y}], about}.","operationId":"treasury_yields_curve","parameters":[{"name":"date","in":"query","required":false,"description":"Day of the curve (YYYY-MM-DD); default the newest","schema":{"type":"string"},"example":"2020-03-16"},{"name":"compare","in":"query","required":false,"description":"Earlier curves, comma-separated: 1w, 1m, 3m, 6m, 1y, 2y, 5y (default 1m,1y)","schema":{"type":"string"},"example":"1m,1y"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/fed-decisions":{"get":{"tags":["Economics"],"summary":"Fed Rate Decisions","description":"Federal Reserve (FOMC) interest rate decisions since 1994 and the scheduled meetings ahead: meeting dates, hike, cut or hold, the change in basis points and the federal funds target range, plus the current target range and the next meeting (official US government data).\n\nAll filters are optional. The answer is {current_target, next_meeting, last_decision, total, limit, offset, order, rows, about}.","operationId":"fed_decisions","parameters":[{"name":"status","in":"query","required":false,"description":"decided or upcoming","schema":{"type":"string"},"example":"upcoming"},{"name":"decision","in":"query","required":false,"description":"hike, cut or hold; comma-separated","schema":{"type":"string"},"example":"cut"},{"name":"meeting_type","in":"query","required":false,"description":"scheduled or unscheduled","schema":{"type":"string"},"example":"scheduled"},{"name":"year","in":"query","required":false,"description":"Meetings in one year","schema":{"type":"integer"},"example":2024},{"name":"date_from","in":"query","required":false,"description":"Meetings ending on or after this date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2020-01-01"},{"name":"date_to","in":"query","required":false,"description":"Meetings ending on or before this date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2020-12-31"},{"name":"order","in":"query","required":false,"description":"asc or desc by meeting date (default desc)","schema":{"type":"string"},"example":"asc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 500 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/inflation-categories":{"get":{"tags":["Economics"],"summary":"Inflation by Category","description":"US consumer prices for 25 categories (core, services, food, groceries, restaurants, energy, gasoline, electricity, shelter, rent, new and used vehicles, car insurance, airline fares, apparel, medical care and more), monthly from 2000, with 12-month and 1-month changes (official US government data).\n\nAll filters are optional. The answer is {as_of, categories, total, limit, offset, sort, order, rows, about}.","operationId":"inflation_categories","parameters":[{"name":"category","in":"query","required":false,"description":"Category keys, comma-separated, e.g. core, food, food_at_home, energy, gasoline, shelter, rent, used_cars_trucks","schema":{"type":"string"},"example":"gasoline,shelter"},{"name":"group","in":"query","required":false,"description":"Groups, comma-separated: Broad groups, Food, Energy, Housing, Transportation, Medical care, Other","schema":{"type":"string"},"example":"Energy"},{"name":"month_from","in":"query","required":false,"description":"First month (YYYY-MM)","schema":{"type":"string"},"example":"2024-01"},{"name":"month_to","in":"query","required":false,"description":"Last month (YYYY-MM)","schema":{"type":"string"},"example":"2025-12"},{"name":"latest","in":"query","required":false,"description":"true = only the newest month","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"month (default), yoy_pct, mom_pct or category","schema":{"type":"string"},"example":"yoy_pct"},{"name":"order","in":"query","required":false,"description":"asc or desc (default desc; asc for category)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 5000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/corporate-bond-yields":{"get":{"tags":["Economics"],"summary":"Corporate Bond Yields","description":"Yields of high-grade US corporate bonds (rated AAA, AA and A) for 2, 5, 10 and 30 year maturities, monthly averages from 1984, with the Treasury yields of the same maturities and the spreads (official US government data).\n\nAll filters are optional. The answer is {as_of, total, limit, offset, order, rows, about}.","operationId":"corporate_bond_yields","parameters":[{"name":"month_from","in":"query","required":false,"description":"First month (YYYY-MM)","schema":{"type":"string"},"example":"2020-01"},{"name":"month_to","in":"query","required":false,"description":"Last month (YYYY-MM)","schema":{"type":"string"},"example":"2026-08"},{"name":"order","in":"query","required":false,"description":"asc or desc by month (default desc)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 120)","schema":{"type":"integer"},"example":120},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/us-trade":{"get":{"tags":["Economics"],"summary":"US Trade","description":"Monthly US goods exports, imports and trade balance in US dollars from January 2015: the US total, each partner country or trade group, and each product group (2-digit HS chapter) (official US government data).\n\nAll filters are optional. The answer is {as_of, total, limit, offset, sort, order, rows, about}.","operationId":"us_trade","parameters":[{"name":"dimension","in":"query","required":false,"description":"total (default), country, group or product","schema":{"type":"string"},"example":"country"},{"name":"code","in":"query","required":false,"description":"Country codes (5700 China, 1220 Canada, 2010 Mexico), group codes (0003 European Union) or HS chapters (27, 84, 87); comma-separated","schema":{"type":"string"},"example":"5700"},{"name":"q","in":"query","required":false,"description":"Part of the country or product group name","schema":{"type":"string"},"example":"germany"},{"name":"month","in":"query","required":false,"description":"One month (YYYY-MM)","schema":{"type":"string"},"example":"2026-07"},{"name":"month_from","in":"query","required":false,"description":"First month (YYYY-MM)","schema":{"type":"string"},"example":"2025-01"},{"name":"month_to","in":"query","required":false,"description":"Last month (YYYY-MM)","schema":{"type":"string"},"example":"2025-12"},{"name":"sort","in":"query","required":false,"description":"month (default), exports, imports, balance, total_trade or name","schema":{"type":"string"},"example":"imports"},{"name":"order","in":"query","required":false,"description":"asc or desc (default desc; asc for name)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 5000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/us-trade/summary":{"get":{"tags":["Economics"],"summary":"US Trade Summary","description":"Top US trading partners or product groups over a period (the last 12 months, this year so far, a year or a month), with exports, imports, balance, total trade and shares of the US total.\n\nAll filters are optional. The answer is {as_of, period, us_total, total, limit, offset, sort, order, rows, about}.","operationId":"us_trade_summary","parameters":[{"name":"dimension","in":"query","required":false,"description":"country (default), group or product","schema":{"type":"string"},"example":"product"},{"name":"period","in":"query","required":false,"description":"last_12_months (default), ytd, year (with year) or month (with month)","schema":{"type":"string"},"example":"year"},{"name":"year","in":"query","required":false,"description":"For period=year","schema":{"type":"integer"},"example":2025},{"name":"month","in":"query","required":false,"description":"For period=month (YYYY-MM)","schema":{"type":"string"},"example":"2026-07"},{"name":"code","in":"query","required":false,"description":"Codes to include, comma-separated","schema":{"type":"string"},"example":"5700,2010"},{"name":"q","in":"query","required":false,"description":"Part of the name","schema":{"type":"string"},"example":"vehicles"},{"name":"sort","in":"query","required":false,"description":"total_trade (default), exports, imports, balance or name","schema":{"type":"string"},"example":"balance"},{"name":"order","in":"query","required":false,"description":"asc or desc (default desc; asc for name)","schema":{"type":"string"},"example":"asc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 500 (default 20)","schema":{"type":"integer"},"example":10},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/industry-metrics":{"get":{"tags":["Industry Metrics"],"summary":"Industry Metrics Over Time","description":"The numbers of one industry over time, from official US government statistics: market size (revenue and the number of firms, for the US and each state, counted every five years; quarterly revenue of about 100 service industries), share of GDP and value added, producer price indexes, industrial output and capacity use, monthly retail and wholesale sales, and manufacturers' shipments and new orders. Each series comes with its values.\n\nThe answer is {industry, total, limit, offset, series: [... points: [{period, value, preliminary}]], about}. Demo keys: 2-digit sectors only (for example 52 or 31-33).","operationId":"industry_metrics","parameters":[{"name":"industry","in":"query","required":false,"description":"Industry code(s), comma-separated, or a page name (or give series_id)","schema":{"type":"string"},"example":"325412"},{"name":"series_id","in":"query","required":false,"description":"Series id(s) from /industry-metrics/series, comma-separated","schema":{"type":"string"},"example":"1201"},{"name":"dataset","in":"query","required":false,"description":"revenue, retail_sales, wholesale_sales, shipments, gdp, ppi, output or capacity (comma-separated)","schema":{"type":"string"},"example":"ppi"},{"name":"metric","in":"query","required":false,"description":"e.g. revenue, firms, sales, shipments, new_orders, value_added, share_of_gdp, price_index, production_index, utilization","schema":{"type":"string"},"example":"revenue,firms"},{"name":"frequency","in":"query","required":false,"description":"annual, quarterly or monthly","schema":{"type":"string"},"example":"monthly"},{"name":"area_type","in":"query","required":false,"description":"country (default) or state","schema":{"type":"string"},"example":"country"},{"name":"state","in":"query","required":false,"description":"US state(s): 2-letter code or name","schema":{"type":"string"},"example":"CA"},{"name":"seasonally_adjusted","in":"query","required":false,"description":"true or false (default: both where both exist)","schema":{"type":"string"},"example":"true"},{"name":"from","in":"query","required":false,"description":"First period: YYYY, YYYY-MM or YYYY-MM-DD","schema":{"type":"string"},"example":"2020-01"},{"name":"to","in":"query","required":false,"description":"Last period: YYYY, YYYY-MM or YYYY-MM-DD","schema":{"type":"string"},"example":"2026-08"},{"name":"order","in":"query","required":false,"description":"asc (default, oldest first) or desc","schema":{"type":"string"},"example":"asc"},{"name":"limit","in":"query","required":false,"description":"Values per page, 1 to 5000 (default 2000)","schema":{"type":"integer"},"example":2000},{"name":"offset","in":"query","required":false,"description":"Values to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/industry-metrics/series":{"get":{"tags":["Industry Metrics"],"summary":"Industry Metric Series","description":"Lists and searches the series: which industries have which numbers, with the frequency, unit, first and last period, number of values and the newest value. datasets counts the series per dataset, metric, frequency and area type.\n\nThe answer is {total, limit, offset, sort, order, rows, datasets, about}. Also accepts metric, frequency, area_type, state and seasonally_adjusted like /industry-metrics.","operationId":"industry_metrics_series","parameters":[{"name":"industry","in":"query","required":false,"description":"Industry code(s) or page name","schema":{"type":"string"},"example":"3254"},{"name":"parent","in":"query","required":false,"description":"Only official codes directly below this one (00 = the sectors)","schema":{"type":"string"},"example":"31-33"},{"name":"level","in":"query","required":false,"description":"Code level(s): 2 sector to 6","schema":{"type":"string"},"example":"3"},{"name":"dataset","in":"query","required":false,"description":"Dataset(s), comma-separated","schema":{"type":"string"},"example":"output"},{"name":"q","in":"query","required":false,"description":"Words in the industry title","schema":{"type":"string"},"example":"semiconductor"},{"name":"code_system","in":"query","required":false,"description":"naics (official codes) or own (groupings)","schema":{"type":"string"},"example":"naics"},{"name":"sort","in":"query","required":false,"description":"industry_code (default), industry_title, last_period, observations or last_value","schema":{"type":"string"},"example":"industry_code"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/industry-metrics/latest":{"get":{"tags":["Industry Metrics"],"summary":"Industry Rankings (Latest Period)","description":"One period of one dataset across industries (or states): the value, the value a year earlier with the change over 12 months, and the previous period with its change (for the five-yearly revenue, the count five years before). Ranks industries by market size, producer price growth, output growth or capacity use, or the states by revenue in an industry.\n\nThe answer is {dataset, metric, frequency, seasonally_adjusted, period, total, limit, offset, sort, order, rows, about}. Demo keys: at most 10 rows.","operationId":"industry_metrics_latest","parameters":[{"name":"dataset","in":"query","required":true,"description":"revenue, retail_sales, wholesale_sales, shipments, gdp, ppi, output or capacity","schema":{"type":"string"},"example":"ppi"},{"name":"metric","in":"query","required":false,"description":"Metric (default by dataset)","schema":{"type":"string"},"example":"price_index"},{"name":"frequency","in":"query","required":false,"description":"annual, quarterly or monthly (default by dataset)","schema":{"type":"string"},"example":"monthly"},{"name":"area_type","in":"query","required":false,"description":"country (rank industries, default) or state (rank states; give an industry)","schema":{"type":"string"},"example":"country"},{"name":"industry","in":"query","required":false,"description":"Industry code(s) or page name","schema":{"type":"string"},"example":"325412"},{"name":"parent","in":"query","required":false,"description":"Only official codes directly below this one (00 = the sectors)","schema":{"type":"string"},"example":"31-33"},{"name":"level","in":"query","required":false,"description":"Code level(s): 2 sector to 6","schema":{"type":"string"},"example":"3"},{"name":"period","in":"query","required":false,"description":"The period to rank: YYYY, YYYY-MM or YYYY-MM-DD","schema":{"type":"string"},"example":"2026-08"},{"name":"sort","in":"query","required":false,"description":"change_1y_pct, change_prev_pct, value or industry_code","schema":{"type":"string"},"example":"change_1y_pct"},{"name":"order","in":"query","required":false,"description":"desc (default) or asc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/fx":{"get":{"tags":["Forex"],"summary":"FX Conversion","description":"Foreign exchange rates and currency conversion data with historical rates.\n\nRequired: currency_conversion. Optional: Choose ONE interval type (one_min_interval, five_min_interval, one_hour_interval, one_day_interval, one_week_interval, one_month_interval). Additional date filters (date, year, quarter, month) can narrow results.","operationId":"fx","parameters":[{"name":"currency_conversion","in":"query","required":true,"description":"Currency pair (e.g., USD-EUR, GBP-JPY)","schema":{"type":"string"},"example":"USD-EUR"},{"name":"one_min_interval","in":"query","required":false,"description":"1-minute interval","schema":{"type":"string"},"example":"1m"},{"name":"five_min_interval","in":"query","required":false,"description":"5-minute interval","schema":{"type":"string"},"example":"5m"},{"name":"one_hour_interval","in":"query","required":false,"description":"1-hour interval","schema":{"type":"string"},"example":"1h"},{"name":"one_day_interval","in":"query","required":false,"description":"Daily interval","schema":{"type":"string"},"example":"1d"},{"name":"one_week_interval","in":"query","required":false,"description":"Weekly interval","schema":{"type":"string"},"example":"1w"},{"name":"one_month_interval","in":"query","required":false,"description":"Monthly interval","schema":{"type":"string"},"example":"1mo"},{"name":"date","in":"query","required":false,"description":"Specific date (YYYY-MM-DD)","schema":{"type":"string"},"example":"2024-01-15"},{"name":"year","in":"query","required":false,"description":"Year filter","schema":{"type":"string"},"example":"2024"},{"name":"quarter","in":"query","required":false,"description":"Quarter (1-4)","schema":{"type":"string"},"example":"2"},{"name":"month","in":"query","required":false,"description":"Month (1-12)","schema":{"type":"string"},"example":"6"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/commodity-price-1d":{"get":{"tags":["Commodity"],"summary":"Commodity Price (1-Day)","description":"Daily commodity prices for futures including energy, metals, and agriculture.","operationId":"commodity_price_1d","parameters":[{"name":"symbol","in":"query","required":false,"description":"Commodity ticker (e.g., GC=F for gold, CL=F for crude oil) (choose ONE filter)","schema":{"type":"string"},"example":"GC=F"},{"name":"name","in":"query","required":false,"description":"Commodity name (choose ONE filter)","schema":{"type":"string"},"example":"Crude Oil"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/commodity-price-5m":{"get":{"tags":["Commodity"],"summary":"Commodity Price (5-Minute)","description":"Intraday commodity prices with 5-minute intervals for active trading.","operationId":"commodity_price_5m","parameters":[{"name":"symbol","in":"query","required":false,"description":"Commodity ticker (choose ONE filter)","schema":{"type":"string"},"example":"GC=F"},{"name":"name","in":"query","required":false,"description":"Commodity name (choose ONE filter)","schema":{"type":"string"},"example":"Gold"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/futures-positioning":{"get":{"tags":["Futures Positioning"],"summary":"Futures Positioning History","description":"Weekly futures positions by type of trader for one US futures market, from official public data: the net position (long minus short contracts) of every trader group, its weekly change and its share of open interest, as of each Tuesday since 1986. Futures only; options are not included.\n\nThe answer is {market, report, categories, view, filters, total, limit, offset, order, rows, as_of, about}. Before the first data load the answer has note: \"Data is being prepared\" and no rows.","operationId":"futures_positioning","parameters":[{"name":"market","in":"query","required":true,"description":"Site symbol, page name or market code","schema":{"type":"string"},"example":"GC=F"},{"name":"report","in":"query","required":false,"description":"legacy, disaggregated or financial (default depends on the market)","schema":{"type":"string"},"example":"disaggregated"},{"name":"category","in":"query","required":false,"description":"Trader group(s) of the report, comma-separated (default: all)","schema":{"type":"string"},"example":"managed_money"},{"name":"view","in":"query","required":false,"description":"net (default) or full","schema":{"type":"string"},"example":"net"},{"name":"from","in":"query","required":false,"description":"First week: YYYY-MM-DD, YYYY-MM or YYYY","schema":{"type":"string"},"example":"2016"},{"name":"to","in":"query","required":false,"description":"Last week: YYYY-MM-DD, YYYY-MM or YYYY","schema":{"type":"string"},"example":"2026-09"},{"name":"order","in":"query","required":false,"description":"asc (default, oldest first) or desc","schema":{"type":"string"},"example":"asc"},{"name":"with_predecessor","in":"query","required":false,"description":"Include the weeks of the same market under its older code (default true)","schema":{"type":"boolean"},"example":true},{"name":"limit","in":"query","required":false,"description":"Weeks per page, up to 2500 (1000 with view=full)","schema":{"type":"integer"},"example":2500},{"name":"offset","in":"query","required":false,"description":"Weeks to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/futures-positioning/markets/{market}":{"get":{"tags":["Futures Positioning"],"summary":"Futures Market Positioning (Latest Week)","description":"One futures market with the newest week of every trader grouping it is in: open interest, its change, the number of traders, and per trader group long, short, spreading and net contracts, the weekly changes, shares of open interest and trader counts. /futures-positioning/markets lists the markets (about 400 active) with their asset group and the site symbol they link to.\n\nThe answer is {market, latest, as_of, about}. An unknown market answers 404.","operationId":"futures_positioning_markets_market","parameters":[{"name":"market","in":"path","required":true,"description":"In the path: site symbol, page name or market code","schema":{"type":"string"},"example":"GC=F"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/futures-positioning/latest":{"get":{"tags":["Futures Positioning"],"summary":"Most Net Long and Net Short Futures","description":"One week across many futures markets for one trader group: long, short and net contracts, the weekly change, net as a share of open interest, and where the net position stands in its 3-year range (net_index_3y: 0 = most net short, 100 = most net long of the last 3 years).\n\nThe answer is {report, category, label, report_date, filters, total, limit, offset, sort, order, rows, as_of, about}.","operationId":"futures_positioning_latest","parameters":[{"name":"group","in":"query","required":false,"description":"Asset group(s), comma-separated, or commodities","schema":{"type":"string"},"example":"commodities"},{"name":"site_page","in":"query","required":false,"description":"commodities, forex or crypto","schema":{"type":"string"},"example":"commodities"},{"name":"site_only","in":"query","required":false,"description":"Only markets linked to a site symbol","schema":{"type":"boolean"},"example":true},{"name":"report","in":"query","required":false,"description":"legacy, disaggregated or financial","schema":{"type":"string"},"example":"disaggregated"},{"name":"category","in":"query","required":false,"description":"One trader group of the report","schema":{"type":"string"},"example":"managed_money"},{"name":"date","in":"query","required":false,"description":"Week, YYYY-MM-DD (the newest report on or before it)","schema":{"type":"string"},"example":"2026-09-29"},{"name":"min_open_interest","in":"query","required":false,"description":"Leave out markets with less open interest (default 1000)","schema":{"type":"integer"},"example":1000},{"name":"sort","in":"query","required":false,"description":"net_pct (default), net, net_change, long, short, open_interest, net_index or name","schema":{"type":"string"},"example":"net_pct"},{"name":"order","in":"query","required":false,"description":"desc (most net long first) or asc (most net short first)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, up to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/agriculture/commodities":{"get":{"tags":["Agriculture"],"summary":"Agriculture Commodities","description":"The crops and livestock with US statistics (corn, soybeans, wheat, cotton, rice, sorghum, barley, oats, hay, peanuts, sugar beets, potatoes, cattle, hogs), each with its page name, the site futures symbols it relates to and its newest US numbers: production, value of production, yield, planted and harvested area, price received by farmers (month and marketing year) and inventory, with the value a year earlier, the change and a forecast flag. From official government statistics.\n\nThe answer is {total, rows, about}. Before the first data load the answer has note: \"Data is being prepared\" and no rows.","operationId":"agriculture_commodities","parameters":[{"name":"commodity","in":"query","required":false,"description":"Commodity name(s), comma-separated (default: all)","schema":{"type":"string"},"example":"corn"},{"name":"symbol","in":"query","required":false,"description":"A site futures symbol: the commodities related to it","schema":{"type":"string"},"example":"ZC=F"},{"name":"kind","in":"query","required":false,"description":"crop or livestock","schema":{"type":"string"},"example":"crop"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/agriculture/stats":{"get":{"tags":["Agriculture"],"summary":"Agriculture Statistics","description":"Crop and livestock statistics of one commodity since 2000: production, value of production, yield, area planted and harvested, prices received by farmers and inventories, for the US, a state or a county. view=series gives the values over time, view=ranking ranks the states (or the counties of a state) on one statistic and period, and view=list shows which statistics exist.\n\nBefore the first data load the answer has note: \"Data is being prepared\". An unknown commodity answers 404.","operationId":"agriculture_stats","parameters":[{"name":"commodity","in":"query","required":true,"description":"corn, soybeans, wheat, cotton, rice, sorghum, barley, oats, hay, peanuts, sugar_beets, potatoes, cattle or hogs","schema":{"type":"string"},"example":"corn"},{"name":"view","in":"query","required":false,"description":"series (default), ranking or list","schema":{"type":"string"},"example":"ranking"},{"name":"statistic","in":"query","required":false,"description":"production, production_value, yield, area_planted, area_harvested, price_received or inventory","schema":{"type":"string"},"example":"production"},{"name":"item","in":"query","required":false,"description":"all (default) or a class such as winter, upland or beef_cows","schema":{"type":"string"},"example":"all"},{"name":"unit","in":"query","required":false,"description":"Unit, for example bu, bu_per_acre, acres, usd_per_bu, head (default: the main unit)","schema":{"type":"string"},"example":"bu"},{"name":"frequency","in":"query","required":false,"description":"annual, marketing_year, monthly or point","schema":{"type":"string"},"example":"annual"},{"name":"state","in":"query","required":false,"description":"US state code or name (series: that state; ranking: its counties)","schema":{"type":"string"},"example":"IA"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county code (series)","schema":{"type":"string"},"example":"19109"},{"name":"level","in":"query","required":false,"description":"Ranking: state (default) or county","schema":{"type":"string"},"example":"county"},{"name":"period","in":"query","required":false,"description":"Ranking: the year (YYYY) or day (YYYY-MM-DD)","schema":{"type":"string"},"example":"2025"},{"name":"from","in":"query","required":false,"description":"First period: YYYY, YYYY-MM or YYYY-MM-DD","schema":{"type":"string"},"example":"2010"},{"name":"to","in":"query","required":false,"description":"Last period: YYYY, YYYY-MM or YYYY-MM-DD","schema":{"type":"string"},"example":"2026"},{"name":"limit","in":"query","required":false,"description":"Values (series, up to 5000) or rows (ranking, up to 1000) per page","schema":{"type":"integer"},"example":1000},{"name":"offset","in":"query","required":false,"description":"Values or rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/agriculture/prices":{"get":{"tags":["Agriculture"],"summary":"Agriculture Prices","description":"Farm prices. kind=received (monthly prices received by farmers for the US or a state, from the crop statistics) or kind=cash (daily and weekly cash prices of the main grain and livestock markets, from official market reports; latest=true gives the newest price of each market with its change from about a week and a year earlier). Cash prices are not futures prices.\n\nThe answer is {kind, total, limit, offset, rows, about}.","operationId":"agriculture_prices","parameters":[{"name":"kind","in":"query","required":false,"description":"cash (default) or received","schema":{"type":"string"},"example":"received"},{"name":"commodity","in":"query","required":false,"description":"Commodity name(s), comma-separated","schema":{"type":"string"},"example":"corn"},{"name":"state","in":"query","required":false,"description":"US state code or name","schema":{"type":"string"},"example":"IA"},{"name":"frequency","in":"query","required":false,"description":"Received: monthly (default), marketing_year or annual","schema":{"type":"string"},"example":"monthly"},{"name":"market","in":"query","required":false,"description":"Cash: market(s), comma-separated","schema":{"type":"string"},"example":"iowa"},{"name":"item","in":"query","required":false,"description":"Cash: item(s); received: all (default) or a class","schema":{"type":"string"},"example":"corn"},{"name":"delivery","in":"query","required":false,"description":"Cash: delivery point type(s)","schema":{"type":"string"},"example":"country_elevator"},{"name":"latest","in":"query","required":false,"description":"Cash: the newest price of each market with its changes","schema":{"type":"boolean"},"example":true},{"name":"from","in":"query","required":false,"description":"First date: YYYY, YYYY-MM or YYYY-MM-DD","schema":{"type":"string"},"example":"2025-01-01"},{"name":"to","in":"query","required":false,"description":"Last date: YYYY, YYYY-MM or YYYY-MM-DD","schema":{"type":"string"},"example":"2026-10-01"},{"name":"order","in":"query","required":false,"description":"desc (default, newest first) or asc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, up to 1000 (default 500)","schema":{"type":"integer"},"example":500},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/gas-prices":{"get":{"tags":["Gas Prices"],"summary":"Gas Prices","description":"Weekly retail pump prices in US dollars per gallon, taxes included, from the official US government weekly survey: regular, midgrade and premium gasoline, all grades together, and diesel, for the United States, its fuel regions, 9 states (CA, CO, FL, MA, MN, NY, OH, TX, WA) and 10 cities (Boston, Chicago, Cleveland, Denver, Houston, Los Angeles, Miami, New York City, San Francisco, Seattle).\n\nAll filters are optional. The answer is {total, limit, offset, sort, order, unit, as_of, rows, about}; as_of is the newest survey week.","operationId":"gas_prices","parameters":[{"name":"area","in":"query","required":false,"description":"Area code(s) or name(s), comma-separated: US; regions R1 East Coast, R1A New England, R1B Central Atlantic, R1C Lower Atlantic, R2 Midwest, R3 Gulf Coast, R4 Rocky Mountain, R5 West Coast, R5X West Coast except California; a state code; or a city name","schema":{"type":"string"},"example":"CA"},{"name":"area_type","in":"query","required":false,"description":"country, region, state or city","schema":{"type":"string"},"example":"state"},{"name":"state","in":"query","required":false,"description":"State of the area (states and cities)","schema":{"type":"string"},"example":"TX"},{"name":"product","in":"query","required":false,"description":"regular, midgrade, premium, all_grades or diesel (comma-separated; default all)","schema":{"type":"string"},"example":"regular"},{"name":"date_from","in":"query","required":false,"description":"First week: YYYY-MM-DD, YYYY-MM or YYYY","schema":{"type":"string"},"example":"2025-01-01"},{"name":"date_to","in":"query","required":false,"description":"Last week: YYYY-MM-DD, YYYY-MM or YYYY","schema":{"type":"string"},"example":"2025-12-31"},{"name":"latest","in":"query","required":false,"description":"true = only the newest week, with the changes","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"week_date (default), price_usd, area_name or area_code; with latest=true also change_1w, change_4w, change_52w, change_52w_pct","schema":{"type":"string"},"example":"price_usd"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/gas-prices/local":{"get":{"tags":["Gas Prices"],"summary":"Daily Local Gas Prices","description":"Daily average retail pump prices in US dollars per gallon for the United States, every state and DC, about 470 metro areas and about 3,100 counties: regular, midgrade, premium and diesel (counties: regular). A separate daily series from the weekly survey of /gas-prices; the two are never combined.\n\nAll filters are optional. The answer is {total, limit, offset, sort, order, unit, as_of, rows, about}; as_of is the newest day.","operationId":"gas_prices_local","parameters":[{"name":"area","in":"query","required":false,"description":"Area code(s) or exact name(s), comma-separated: US, a state code (AZ), a 5-digit county FIPS code (04013) or a metro area code (a CBSA code such as 38060, or a code like CA_ORANGE_COUNTY)","schema":{"type":"string"},"example":"AZ"},{"name":"area_type","in":"query","required":false,"description":"country, state, metro or county (comma-separated)","schema":{"type":"string"},"example":"county"},{"name":"state","in":"query","required":false,"description":"US state: 2-letter code or name","schema":{"type":"string"},"example":"AZ"},{"name":"county","in":"query","required":false,"description":"County name with or without the word County (add state)","schema":{"type":"string"},"example":"Maricopa"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code(s)","schema":{"type":"string"},"example":"04013"},{"name":"metro","in":"query","required":false,"description":"Part of a metro area name","schema":{"type":"string"},"example":"Phoenix"},{"name":"product","in":"query","required":false,"description":"regular, midgrade, premium or diesel (comma-separated; default all)","schema":{"type":"string"},"example":"regular"},{"name":"date_from","in":"query","required":false,"description":"First day: YYYY-MM-DD, YYYY-MM or YYYY","schema":{"type":"string"},"example":"2026-01-01"},{"name":"date_to","in":"query","required":false,"description":"Last day: YYYY-MM-DD, YYYY-MM or YYYY","schema":{"type":"string"},"example":"2026-12-31"},{"name":"latest","in":"query","required":false,"description":"true = only the newest day, with the changes","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"price_date (default), price_usd, area_name or area_code; with latest=true area_name (default), price_usd, change_1d, change_1w, change_1m, change_1y or change_1y_pct","schema":{"type":"string"},"example":"price_usd"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/gas-prices/local/nearest":{"get":{"tags":["Gas Prices"],"summary":"Nearest Local Gas Price","description":"The most local daily gas prices for a place: its county (regular), the metro area the county belongs to and its state (regular, midgrade, premium, diesel), most local first.\n\nGive at least one of state, county + state, county_fips or metro_code. The answer is {query, areas, nearest, as_of, unit, about}.","operationId":"gas_prices_local_nearest","parameters":[{"name":"state","in":"query","required":false,"description":"US state: 2-letter code or name (needed with county)","schema":{"type":"string"},"example":"CA"},{"name":"county","in":"query","required":false,"description":"County name with or without the word County","schema":{"type":"string"},"example":"Orange"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code","schema":{"type":"string"},"example":"06059"},{"name":"metro_code","in":"query","required":false,"description":"Metro area code (a CBSA code or a code from /gas-prices/local); used when no county is given","schema":{"type":"string"},"example":"38060"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/electricity-rates":{"get":{"tags":["Electricity Rates & Grid Prices"],"summary":"Electricity Rates by Utility","description":"Average electricity prices in cents per kWh by utility, state and year from official public data, for homes (residential), businesses (commercial), industry and transportation, with customers, sales in MWh and revenue, the price a year earlier, the change and the state average. Each row has the kind of service the utility sells: bundled (power and delivery), delivery_only (the delivery part only, in states with retail choice), energy_only (power only) or retail_bundled (a retailer selling both).\n\nThe answer is {year, sector, total, limit, offset, sort, order, rows, about, as_of}. Before the first load the rows are empty and note says \"Data is being prepared\".","operationId":"electricity_rates","parameters":[{"name":"state","in":"query","required":false,"description":"US state, 2-letter code (comma-separated for several)","schema":{"type":"string"},"example":"TX"},{"name":"sector","in":"query","required":false,"description":"residential (default), commercial, industrial, transportation or all","schema":{"type":"string"},"example":"residential"},{"name":"year","in":"query","required":false,"description":"A year such as 2024, or latest (default)","schema":{"type":"string"},"example":"latest"},{"name":"service_type","in":"query","required":false,"description":"bundled, energy_only, delivery_only or retail_bundled (comma-separated)","schema":{"type":"string"},"example":"bundled"},{"name":"ownership","in":"query","required":false,"description":"investor_owned, cooperative, municipal, political_subdivision, state, federal, retail_marketer, community_choice, behind_the_meter or other","schema":{"type":"string"},"example":"cooperative"},{"name":"q","in":"query","required":false,"description":"Part of the utility name","schema":{"type":"string"},"example":"Edison"},{"name":"min_customers","in":"query","required":false,"description":"Only utilities with at least this many customers in the sector","schema":{"type":"integer"},"example":10000},{"name":"sort","in":"query","required":false,"description":"avg_price_cents (default), customers, sales_mwh, revenue_usd, change_pct, utility_name or state","schema":{"type":"string"},"example":"customers"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/electricity-rates/states":{"get":{"tags":["Electricity Rates & Grid Prices"],"summary":"Electricity Rates by State","description":"Average electricity price, customers, sales, revenue, the average monthly bill and the average use per customer for every state, DC and the US, by sector and year, with the change from a year earlier.","operationId":"electricity_rates_states","parameters":[{"name":"state","in":"query","required":false,"description":"A state code, US, or several (comma-separated). With state you get the history","schema":{"type":"string"},"example":"CA,US"},{"name":"sector","in":"query","required":false,"description":"residential, commercial, industrial, transportation or all (comma-separated)","schema":{"type":"string"},"example":"residential"},{"name":"year","in":"query","required":false,"description":"A year such as 2024, or latest (default for the ranking)","schema":{"type":"string"},"example":"latest"},{"name":"year_from","in":"query","required":false,"description":"With state: first year","schema":{"type":"integer"},"example":2024},{"name":"year_to","in":"query","required":false,"description":"With state: last year","schema":{"type":"integer"},"example":2025},{"name":"sort","in":"query","required":false,"description":"avg_price_cents (default), customers, sales_mwh, revenue_usd, avg_monthly_bill_usd, avg_monthly_kwh, change_pct or state","schema":{"type":"string"},"example":"avg_monthly_bill_usd"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/electricity-rates/utilities/{utility_id}":{"get":{"tags":["Electricity Rates & Grid Prices"],"summary":"One Utility","description":"One utility: its name, ownership and states, every year by state, kind of service and sector (customers, sales, revenue, average price), the counties it serves and its state averages.","operationId":"electricity_rates_utilities_utility_id","parameters":[{"name":"utility_id","in":"path","required":true,"description":"Utility id from /electricity-rates (in the path)","schema":{"type":"integer"},"example":1015},{"name":"state","in":"query","required":false,"description":"Only this state (a utility can serve several)","schema":{"type":"string"},"example":"TX"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/electricity-rates/county/{county_fips}":{"get":{"tags":["Electricity Rates & Grid Prices"],"summary":"Electricity Prices of a County","description":"The utilities that serve a county with their home, business and industry prices in the county's state, the typical home price there (weighted by home customers), and the state averages with the monthly bill. For delivery-only utilities est_full_price_cents adds the state's average energy price; where retailers sell power and delivery together, state_retail_choice_price_cents gives their average price.","operationId":"electricity_rates_county_county_fips","parameters":[{"name":"county_fips","in":"path","required":true,"description":"5-digit county FIPS code (in the path)","schema":{"type":"string"},"example":"48453"},{"name":"year","in":"query","required":false,"description":"A year such as 2024, or latest (default)","schema":{"type":"string"},"example":"latest"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/grid-prices/locations":{"get":{"tags":["Electricity Rates & Grid Prices"],"summary":"Grid Price Locations","description":"The grids with wholesale prices (texas: Texas grid, california: California grid, new_york: New York grid), the states they serve, their hubs and load zones, the time zone, the price interval and the first and last hour stored. A grid whose first_hour is empty has no prices yet.","operationId":"grid_prices_locations","parameters":[],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/grid-prices":{"get":{"tags":["Electricity Rates & Grid Prices"],"summary":"Grid Prices","description":"Wholesale electricity prices in US dollars per MWh (divide by 10 for cents per kWh) of a grid's hubs and load zones by hour, day or month: the real-time average, lowest and highest price and the day-ahead price. Wholesale prices are not what homes pay; they can be negative and can spike to the market caps.","operationId":"grid_prices","parameters":[{"name":"grid","in":"query","required":true,"description":"texas, california or new_york","schema":{"type":"string"},"example":"new_york"},{"name":"location","in":"query","required":false,"description":"Hub or load zone code(s), comma-separated (see /grid-prices/locations). Default: every location","schema":{"type":"string"},"example":"NYC"},{"name":"frequency","in":"query","required":false,"description":"hourly (default), daily or monthly","schema":{"type":"string"},"example":"daily"},{"name":"date_from","in":"query","required":false,"description":"First local day, YYYY-MM-DD","schema":{"type":"string"},"example":"2026-09-01"},{"name":"date_to","in":"query","required":false,"description":"Last local day, YYYY-MM-DD (default: the newest day)","schema":{"type":"string"},"example":"2026-09-30"},{"name":"order","in":"query","required":false,"description":"asc (default) or desc by time","schema":{"type":"string"},"example":"asc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 5000 (default 1000)","schema":{"type":"integer"},"example":1000},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/grid-prices/latest":{"get":{"tags":["Electricity Rates & Grid Prices"],"summary":"Latest Grid Prices","description":"Each hub and load zone of a grid: its newest hour (real-time and day-ahead price), its newest full local day (average, lowest, highest, day-ahead average) with the change from the day before, and the 7-day and 30-day averages.","operationId":"grid_prices_latest","parameters":[{"name":"grid","in":"query","required":true,"description":"texas, california or new_york","schema":{"type":"string"},"example":"new_york"},{"name":"location","in":"query","required":false,"description":"Hub or load zone code(s), comma-separated. Default: all","schema":{"type":"string"},"example":"NYC"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/local-jobs":{"get":{"tags":["Local Economy"],"summary":"Local Jobs (Unemployment)","description":"Monthly labor force, employed, unemployed and unemployment rate for every US state, metro area, county and city of 25,000 people or more, since January 2010, from official US government labor statistics.\n\nThe answer is {total, limit, offset, seasonal, seasonally_adjusted, as_of, rows, about}. Area codes match the other area endpoints: state FIPS 48, county FIPS 48453, metro CBSA 12420.","operationId":"local_jobs","parameters":[{"name":"area_type","in":"query","required":false,"description":"state, metro, county or city","schema":{"type":"string"},"example":"county"},{"name":"state","in":"query","required":false,"description":"2-letter code or name, comma-separated","schema":{"type":"string"},"example":"TX"},{"name":"county","in":"query","required":false,"description":"County name, with or without the word County","schema":{"type":"string"},"example":"Travis"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code","schema":{"type":"string"},"example":"48453"},{"name":"metro","in":"query","required":false,"description":"Part of a metro area name","schema":{"type":"string"},"example":"Austin"},{"name":"metro_code","in":"query","required":false,"description":"Metro area CBSA code","schema":{"type":"string"},"example":"12420"},{"name":"city","in":"query","required":false,"description":"City name (add state)","schema":{"type":"string"},"example":"Austin"},{"name":"area_code","in":"query","required":false,"description":"Area code(s): state FIPS, county FIPS, CBSA code or city code (state + place FIPS)","schema":{"type":"string"},"example":"4805000"},{"name":"name","in":"query","required":false,"description":"Part of the area name","schema":{"type":"string"},"example":"Orange"},{"name":"seasonal","in":"query","required":false,"description":"nsa (default, every area) or sa (states only)","schema":{"type":"string"},"example":"nsa"},{"name":"date_from","in":"query","required":false,"description":"First month: YYYY-MM or YYYY-MM-DD","schema":{"type":"string"},"example":"2024-01"},{"name":"date_to","in":"query","required":false,"description":"Last month","schema":{"type":"string"},"example":"2026-12"},{"name":"latest","in":"query","required":false,"description":"true = newest month of each area, with the change from a year earlier","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"month (default), unemployment_rate, labor_force, employed, unemployed or area_name; with latest=true also unemployment_rate_change_1y, employed_change_1y_pct, labor_force_change_1y_pct","schema":{"type":"string"},"example":"unemployment_rate"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/local-wages":{"get":{"tags":["Local Economy"],"summary":"Local Wages (Jobs and Pay)","description":"Quarterly business locations (establishments), jobs and pay for the US, every state, metro area and county since 2015: total pay, average weekly pay, the change from a year earlier, and private-sector jobs and pay. Covers all jobs that pay into unemployment insurance.\n\nThe answer is {total, limit, offset, sort, order, as_of, rows, about}; as_of is the newest quarter, e.g. 2026-Q1.","operationId":"local_wages","parameters":[{"name":"area_type","in":"query","required":false,"description":"country, state, metro or county","schema":{"type":"string"},"example":"county"},{"name":"state","in":"query","required":false,"description":"2-letter code or name","schema":{"type":"string"},"example":"IL"},{"name":"county","in":"query","required":false,"description":"County name","schema":{"type":"string"},"example":"Cook"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code","schema":{"type":"string"},"example":"17031"},{"name":"metro","in":"query","required":false,"description":"Part of a metro area name","schema":{"type":"string"},"example":"Chicago"},{"name":"metro_code","in":"query","required":false,"description":"Metro area CBSA code","schema":{"type":"string"},"example":"16980"},{"name":"area_code","in":"query","required":false,"description":"US, state FIPS, county FIPS or CBSA code","schema":{"type":"string"},"example":"US"},{"name":"year","in":"query","required":false,"description":"Only this year","schema":{"type":"integer"},"example":2025},{"name":"quarter","in":"query","required":false,"description":"Only this quarter (1 to 4)","schema":{"type":"integer"},"example":4},{"name":"latest","in":"query","required":false,"description":"true = only the newest quarter","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"quarter (default), avg_weekly_wage, employment, establishments, total_wages, employment_change_1y_pct, avg_weekly_wage_change_1y_pct or area_name","schema":{"type":"string"},"example":"avg_weekly_wage"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/building-permits":{"get":{"tags":["Local Economy"],"summary":"Building Permits","description":"New privately owned homes authorized by building permits, by month or year, for the US, every state, metro area and county: homes (housing units), buildings and construction value, split into single-family, 2 units, 3 to 4 units and 5 or more units. These are permits (homes approved to be built), not sales of new homes.\n\nThe answer is {total, limit, offset, period_type, as_of, rows, about}.","operationId":"building_permits","parameters":[{"name":"area_type","in":"query","required":false,"description":"country, state, metro or county","schema":{"type":"string"},"example":"county"},{"name":"state","in":"query","required":false,"description":"2-letter code or name","schema":{"type":"string"},"example":"TX"},{"name":"county","in":"query","required":false,"description":"County name","schema":{"type":"string"},"example":"Travis"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code","schema":{"type":"string"},"example":"48453"},{"name":"metro","in":"query","required":false,"description":"Part of a metro area name","schema":{"type":"string"},"example":"Dallas"},{"name":"metro_code","in":"query","required":false,"description":"Metro area CBSA code","schema":{"type":"string"},"example":"19100"},{"name":"area_code","in":"query","required":false,"description":"US, state FIPS, county FIPS or CBSA code","schema":{"type":"string"},"example":"US"},{"name":"period_type","in":"query","required":false,"description":"month (default) or year","schema":{"type":"string"},"example":"month"},{"name":"date_from","in":"query","required":false,"description":"First period: YYYY-MM or YYYY","schema":{"type":"string"},"example":"2025-01"},{"name":"date_to","in":"query","required":false,"description":"Last period","schema":{"type":"string"},"example":"2026-12"},{"name":"latest","in":"query","required":false,"description":"true = newest period of each area, with comparisons","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"period (default), units_total, units_single_family, units_5plus_units, value_total or area_name; with latest=true also units_change_1y_pct, ytd_units_total, ytd_change_pct, last_12m_units_total","schema":{"type":"string"},"example":"units_total"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/migration":{"get":{"tags":["Local Economy"],"summary":"Migration (Moves In and Out)","description":"Yearly household moves in and out of every US state and county, from official US government statistics based on where people filed their federal tax returns in two years in a row: movers in and out as returns (about one per household), people and income, net moves, net per 1,000 residents, moves from and to other countries, and the 10 largest origins and destinations.\n\nThe answer is {total, limit, offset, sort, order, as_of, rows, about}; as_of is the newest pair of years, e.g. 2022-2023.","operationId":"migration","parameters":[{"name":"area_type","in":"query","required":false,"description":"state or county","schema":{"type":"string"},"example":"county"},{"name":"state","in":"query","required":false,"description":"2-letter code or name","schema":{"type":"string"},"example":"FL"},{"name":"county","in":"query","required":false,"description":"County name","schema":{"type":"string"},"example":"Miami-Dade"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code","schema":{"type":"string"},"example":"12086"},{"name":"area_code","in":"query","required":false,"description":"State or county FIPS code(s)","schema":{"type":"string"},"example":"12"},{"name":"year","in":"query","required":false,"description":"Second year of the pair","schema":{"type":"integer"},"example":2023},{"name":"latest","in":"query","required":false,"description":"true = only the newest pair of years","schema":{"type":"boolean"},"example":true},{"name":"include_top","in":"query","required":false,"description":"true = add the 10 largest origins and destinations","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"year (default), net_people, net_returns, net_income, net_per_1000, inflow_people, outflow_people or area_name","schema":{"type":"string"},"example":"net_people"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/layoffs/events":{"get":{"tags":["Layoffs"],"summary":"Layoff Events","description":"Layoffs by company, place, industry and date, newest first. One event is one layoff with every source that mentions it attached: state WARN notices, SEC Form 8-K Item 2.05 filings and news reports, never counted twice. Each event is confirmed (an official filing exists: a WARN notice or an SEC filing) or reported (news reports only).\n\nThe answer is {filters, total, limit, offset, sort, order, as_of, rows, about}. as_of gives the newest event, WARN notice, SEC filing and news date. Before the first load is finished the answer has note: \"Data is being prepared\" and no rows.","operationId":"layoffs_events","parameters":[{"name":"company","in":"query","required":false,"description":"Words in the company name","schema":{"type":"string"},"example":"Intel"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s), comma-separated","schema":{"type":"string"},"example":"INTC"},{"name":"state","in":"query","required":false,"description":"2-letter codes or names, comma-separated","schema":{"type":"string"},"example":"CA"},{"name":"naics","in":"query","required":false,"description":"Industry code prefix (sectors as 31-33, 44-45, 48-49)","schema":{"type":"string"},"example":"31-33"},{"name":"country","in":"query","required":false,"description":"ISO 2-letter country codes, comma-separated","schema":{"type":"string"},"example":"US"},{"name":"date_from","in":"query","required":false,"description":"Announced on or after (YYYY, YYYY-MM or YYYY-MM-DD)","schema":{"type":"string"},"example":"2026-01-01"},{"name":"date_to","in":"query","required":false,"description":"Announced on or before","schema":{"type":"string"},"example":"2026-12-31"},{"name":"source_type","in":"query","required":false,"description":"warn, sec or news (comma-separated)","schema":{"type":"string"},"example":"warn"},{"name":"status","in":"query","required":false,"description":"confirmed or reported","schema":{"type":"string"},"example":"confirmed"},{"name":"min_workers","in":"query","required":false,"description":"Only events with at least this many workers stated","schema":{"type":"integer"},"example":100},{"name":"sort","in":"query","required":false,"description":"date (default), workers, company or first_seen","schema":{"type":"string"},"example":"date"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 200 (default 25)","schema":{"type":"integer"},"example":25},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/layoffs/summary":{"get":{"tags":["Layoffs"],"summary":"Layoffs Summary","description":"Layoff events and workers counted by state, county, industry, country, month, year, source type, status or ticker, with every filter of /layoffs/events. By state, each row also has the jobs of the state and the workers as a percent of them.\n\nThe answer is {by, filters, total, total_events, total_workers, rows, as_of, about}; by=state also has employment_period and warn_states.","operationId":"layoffs_summary","parameters":[{"name":"by","in":"query","required":true,"description":"state, county, industry, country, month, year, source_type, status or ticker","schema":{"type":"string"},"example":"state"},{"name":"date_from","in":"query","required":false,"description":"Announced on or after","schema":{"type":"string"},"example":"2026-01-01"},{"name":"naics","in":"query","required":false,"description":"Industry code prefix","schema":{"type":"string"},"example":"52"},{"name":"sort","in":"query","required":false,"description":"events (default), workers, name or period","schema":{"type":"string"},"example":"events"},{"name":"limit","in":"query","required":false,"description":"Rows per page (default 100)","schema":{"type":"integer"},"example":100}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/layoffs/companies":{"get":{"tags":["Layoffs"],"summary":"Companies by Layoffs","description":"Companies ranked by the number of layoff events and the workers affected over the last 30, 90 or 365 days (or all time), with the ticker of listed companies, the states, the industry and the date of the newest layoff.\n\nThe answer is {days, filters, total, rows, as_of, about}.","operationId":"layoffs_companies","parameters":[{"name":"days","in":"query","required":false,"description":"30, 90 (default), 365 or 0 for all time","schema":{"type":"integer"},"example":90},{"name":"state","in":"query","required":false,"description":"2-letter codes or names","schema":{"type":"string"},"example":"TX"},{"name":"naics","in":"query","required":false,"description":"Industry code prefix","schema":{"type":"string"},"example":"51"},{"name":"listed","in":"query","required":false,"description":"true: only companies with a ticker","schema":{"type":"boolean"},"example":true},{"name":"status","in":"query","required":false,"description":"confirmed or reported","schema":{"type":"string"},"example":"confirmed"},{"name":"sort","in":"query","required":false,"description":"events (default), workers, latest or company","schema":{"type":"string"},"example":"workers"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 500 (default 50)","schema":{"type":"integer"},"example":50}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/layoffs/company/{ticker}":{"get":{"tags":["Layoffs"],"summary":"Company Layoffs","description":"The layoffs of one listed company: totals (all time and the last 12 months), layoffs by year and by state, and its newest layoff events. events is empty when the company has none.","operationId":"layoffs_company_ticker","parameters":[{"name":"ticker","in":"path","required":true,"description":"Ticker in the path","schema":{"type":"string"},"example":"INTC"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/layoffs/state/{state}":{"get":{"tags":["Layoffs"],"summary":"State Layoffs","description":"The layoffs of one US state: totals (last 12 months and all time), WARN notice coverage, layoffs by month (24 months), the top counties, industries and companies of the last 12 months, the 25 newest events, and the official monthly layoffs and discharges (JOLTS, seasonally adjusted, thousands) and weekly initial unemployment claims of the state.","operationId":"layoffs_state_state","parameters":[{"name":"state","in":"path","required":true,"description":"2-letter state code in the path","schema":{"type":"string"},"example":"CA"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/layoffs/industry/{naics}":{"get":{"tags":["Layoffs"],"summary":"Industry Layoffs","description":"The layoffs of one industry by its official US industry code (NAICS, 2 to 6 digits; sectors as 31-33, 44-45, 48-49): totals, layoffs by month, the top states and companies, the newest events and, when the sector has one, its official monthly layoffs and discharges (JOLTS).","operationId":"layoffs_industry_naics","parameters":[{"name":"naics","in":"path","required":true,"description":"Industry code in the path","schema":{"type":"string"},"example":"31-33"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/layoffs/overview":{"get":{"tags":["Layoffs"],"summary":"Layoffs Overview","description":"Everything for a layoffs dashboard in one call: totals of the last 30 and 90 days (events, workers, confirmed and reported), the 25 newest events, the last 12 months by state, industry and country, the last 24 months by month, the official US layoffs and discharges (JOLTS) and initial unemployment claims, and the states whose WARN notices are included.","operationId":"layoffs_overview","parameters":[],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/layoffs/official/jolts":{"get":{"tags":["Layoffs"],"summary":"Official Layoffs (JOLTS)","description":"The official monthly count of layoffs and discharges (thousands) and the layoffs and discharges rate (percent of employment) from the Job Openings and Labor Turnover Survey (JOLTS), for the US, the states and the JOLTS industries.","operationId":"layoffs_official_jolts","parameters":[{"name":"area","in":"query","required":false,"description":"US or state codes, comma-separated","schema":{"type":"string"},"example":"US"},{"name":"industry","in":"query","required":false,"description":"JOLTS industry code (default 000000)","schema":{"type":"string"},"example":"000000"},{"name":"seasonal","in":"query","required":false,"description":"sa (default) or nsa","schema":{"type":"string"},"example":"sa"},{"name":"latest","in":"query","required":false,"description":"true: the newest month of each series","schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/layoffs/official/claims":{"get":{"tags":["Layoffs"],"summary":"Unemployment Claims","description":"Weekly unemployment insurance claims for the US and every state: initial claims, continued claims and the insured unemployment rate, plus the seasonally adjusted US initial claims.","operationId":"layoffs_official_claims","parameters":[{"name":"state","in":"query","required":false,"description":"US or state codes, comma-separated","schema":{"type":"string"},"example":"US"},{"name":"date_from","in":"query","required":false,"description":"Weeks ending on or after","schema":{"type":"string"},"example":"2026-01-01"},{"name":"latest","in":"query","required":false,"description":"true: the newest week of each area","schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/colleges":{"get":{"tags":["Colleges"],"summary":"Colleges","description":"US colleges operating now, from official public data: cost (tuition and fees, cost of attendance, net price after grants), admission rate and SAT average, undergraduates, completion and retention rates, median student debt and median earnings of former students 6 and 10 years after entry, debt to earnings and repayment rate. /colleges/{college} gives one college (by college_id or page name) with every measure, its net price by family income, its programs, its yearly history, its earnings rank and the medians of its state, of colleges of the same kind and of all US colleges.\n\nThe answer is {total, limit, offset, sort, order, filters, min_enrollment, data_date, rows, about}. Before the first load the answer has note \"Data is being prepared\".","operationId":"colleges","parameters":[{"name":"q","in":"query","required":false,"description":"Part of the college name, or a college_id","schema":{"type":"string"},"example":"university of texas"},{"name":"state","in":"query","required":false,"description":"2-letter state code(s) or names, comma-separated","schema":{"type":"string"},"example":"TX"},{"name":"county","in":"query","required":false,"description":"County name (add state)","schema":{"type":"string"},"example":"Travis"},{"name":"city","in":"query","required":false,"description":"City name (add state)","schema":{"type":"string"},"example":"Austin"},{"name":"ownership","in":"query","required":false,"description":"public, private_nonprofit, for_profit","schema":{"type":"string"},"example":"public"},{"name":"level","in":"query","required":false,"description":"four_year, two_year, less_than_two_year","schema":{"type":"string"},"example":"four_year"},{"name":"max_net_price","in":"query","required":false,"description":"Net price at most (dollars a year)","schema":{"type":"integer"},"example":15000},{"name":"sort","in":"query","required":false,"description":"enrollment (default), name, admission_rate, net_price, tuition_in_state, earnings_10yr, median_debt, debt_to_earnings, completion_rate and more","schema":{"type":"string"},"example":"earnings_10yr"},{"name":"order","in":"query","required":false,"description":"asc or desc (default depends on the sort)","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/colleges/summary":{"get":{"tags":["Colleges"],"summary":"College Summary","description":"Totals and medians of the colleges of the US, a state, a county, a city or a ZIP code, or grouped by state, county, ownership or level: colleges, undergraduate and graduate students, counts by ownership and level, and the medians across colleges (each college counts once) of tuition, net price, admission, completion and retention rates, median debt and earnings.\n\nThe answer is {group_by, filters, data_date, totals, rows (with group_by), about}.","operationId":"colleges_summary","parameters":[{"name":"group_by","in":"query","required":false,"description":"none (default), state, county, ownership or level","schema":{"type":"string"},"example":"state"},{"name":"state","in":"query","required":false,"description":"2-letter state code(s)","schema":{"type":"string"},"example":"CA"},{"name":"ownership","in":"query","required":false,"description":"public, private_nonprofit, for_profit","schema":{"type":"string"},"example":"public"},{"name":"level","in":"query","required":false,"description":"four_year, two_year, less_than_two_year","schema":{"type":"string"},"example":"four_year"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/colleges/programs":{"get":{"tags":["Colleges"],"summary":"College Programs and Majors","description":"College programs (one field of study at one credential at one college) with graduates, median debt, median earnings 1 and 4 years after graduation and the national median of the field. The programs of one college, one field across colleges ranked by earnings or debt, or with group_by=field the fields of study (majors) ranked by the median earnings of their programs.\n\nThe answer is {group_by, total, limit, offset, sort, order, filters, data_date, rows, about}.","operationId":"colleges_programs","parameters":[{"name":"college","in":"query","required":false,"description":"One college: college_id or page name","schema":{"type":"string"},"example":"166027"},{"name":"field","in":"query","required":false,"description":"Field code(s), 4 digits or a 2-digit family","schema":{"type":"string"},"example":"1107"},{"name":"credential","in":"query","required":false,"description":"certificate, associate, bachelor, master, doctoral, professional and more","schema":{"type":"string"},"example":"bachelor"},{"name":"group_by","in":"query","required":false,"description":"program (default) or field","schema":{"type":"string"},"example":"field"},{"name":"sort","in":"query","required":false,"description":"earnings_1yr (default), earnings_4yr, median_debt, debt_to_earnings, completions and more","schema":{"type":"string"},"example":"earnings_1yr"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/industries":{"get":{"tags":["Industries"],"summary":"Industry List","description":"The official US industry codes (NAICS, 2 to 6 digits) with their titles and the parent and child tree: 20 sectors, subsectors, industry groups, industries and national industries. /industries/{code} gives one code (or page name) with its parent, its path from the sector down and its children.\n\nThe answer is {version, total, limit, offset, sort, order, rows, about}. /industries/{code} accepts a code (522110, 52 or 31-33) or a page name (commercial-banking-522110) and answers {industry, parent, path, children, about}.","operationId":"industries","parameters":[{"name":"version","in":"query","required":false,"description":"Code edition: 2022 (default) or 2017","schema":{"type":"integer"},"example":2022},{"name":"q","in":"query","required":false,"description":"Words in the industry title","schema":{"type":"string"},"example":"software publishers"},{"name":"code","in":"query","required":false,"description":"Code prefix, e.g. 52 or 5221, or a sector range like 31-33","schema":{"type":"string"},"example":"5221"},{"name":"level","in":"query","required":false,"description":"Level(s), comma-separated: 2 sector, 3 subsector, 4 industry group, 5 industry, 6 national industry","schema":{"type":"string"},"example":"2"},{"name":"parent","in":"query","required":false,"description":"Only the direct children of this code","schema":{"type":"string"},"example":"522"},{"name":"sector","in":"query","required":false,"description":"Only codes in this sector","schema":{"type":"string"},"example":"52"},{"name":"sort","in":"query","required":false,"description":"code (default), title or level","schema":{"type":"string"},"example":"code"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/industry-area-stats":{"get":{"tags":["Industries"],"summary":"Businesses, Employees and Payroll by Industry","description":"Yearly number of business locations (establishments), paid employees and annual payroll by industry code and area, from official US government statistics: the US, states, metro and micro areas, counties (sectors to 4-digit industry groups) and ZIP codes (sectors), since 2017, with average pay, the business size mix, the change from the year before and the share of the area total. /industry-area-stats/years lists the years loaded for each area level.\n\nThe answer is {total, limit, offset, sort, order, years, rows, about}. /industry-area-stats/years answers {levels: [{area_type, year, areas, code_edition}], latest: {area_type: year}}. Area codes match the other area endpoints.","operationId":"industry_area_stats","parameters":[{"name":"industry","in":"query","required":false,"description":"Industry code(s), comma-separated (00 = all industries), or a page name","schema":{"type":"string"},"example":"522110"},{"name":"industry_level","in":"query","required":false,"description":"0 all industries, 2 sector, 3 subsector, 4 industry group, 5 industry, 6 national industry","schema":{"type":"string"},"example":"2"},{"name":"parent","in":"query","required":false,"description":"Only the codes directly below this one (00 = the sectors)","schema":{"type":"string"},"example":"52"},{"name":"area_type","in":"query","required":false,"description":"country, state, metro, county or zip","schema":{"type":"string"},"example":"state"},{"name":"state","in":"query","required":false,"description":"2-letter code or name","schema":{"type":"string"},"example":"TX"},{"name":"county","in":"query","required":false,"description":"County name (add state)","schema":{"type":"string"},"example":"Travis"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code","schema":{"type":"string"},"example":"48453"},{"name":"metro","in":"query","required":false,"description":"Part of a metro area name","schema":{"type":"string"},"example":"Austin"},{"name":"metro_code","in":"query","required":false,"description":"Metro area CBSA code","schema":{"type":"string"},"example":"12420"},{"name":"zip","in":"query","required":false,"description":"5-digit ZIP code(s)","schema":{"type":"string"},"example":"78701"},{"name":"area_code","in":"query","required":false,"description":"US, state FIPS, CBSA code, county FIPS or ZIP code","schema":{"type":"string"},"example":"48"},{"name":"year","in":"query","required":false,"description":"A year, latest (default) or all","schema":{"type":"string"},"example":"all"},{"name":"year_from","in":"query","required":false,"description":"First year (implies year=all)","schema":{"type":"integer"},"example":2019},{"name":"year_to","in":"query","required":false,"description":"Last year (implies year=all)","schema":{"type":"integer"},"example":2023},{"name":"sort","in":"query","required":false,"description":"employees (default), establishments, annual_payroll, avg_annual_pay, employees_change_1y_pct, share_of_area_employees_pct, year, industry_code or area_name","schema":{"type":"string"},"example":"employees"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/banks":{"get":{"tags":["Banks"],"summary":"Banks and Credit Unions","description":"Every US bank and credit union, from official public data, with the newest quarter's numbers: total assets, deposits, loans, equity, profit (year to date and the quarter), return on assets and equity, capital ratio, net interest margin, noncurrent loans, branches, employees and members. /banks/{id} gives one institution (by id such as b628 or cu5536, or its page name) with the change from a year before, its branch count and deposits, and its failure when it failed.\n\nThe answer is {total, limit, offset, sort, order, rows, about}. /banks/{id} answers {bank, latest, year_ago, branches, failure, about}; /banks/{id}/financials gives every quarter of one institution (period_from, period_to, order, limit up to 1000) and /banks/{id}/branches its branches of one year (year, state, sort deposits, name, city or established_date).","operationId":"banks","parameters":[{"name":"q","in":"query","required":false,"description":"Words in the name","schema":{"type":"string"},"example":"navy federal"},{"name":"kind","in":"query","required":false,"description":"bank or credit_union (default both)","schema":{"type":"string"},"example":"bank"},{"name":"state","in":"query","required":false,"description":"State(s) of the head office: 2-letter code or name","schema":{"type":"string"},"example":"TX"},{"name":"city","in":"query","required":false,"description":"City of the head office (add state)","schema":{"type":"string"},"example":"Austin"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code(s)","schema":{"type":"string"},"example":"48453"},{"name":"zip","in":"query","required":false,"description":"5-digit ZIP code(s)","schema":{"type":"string"},"example":"78701"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of the listed holding company","schema":{"type":"string"},"example":"JPM"},{"name":"holding_company","in":"query","required":false,"description":"Words in the holding company name","schema":{"type":"string"},"example":"wells fargo"},{"name":"status","in":"query","required":false,"description":"active (default), inactive, failed or all","schema":{"type":"string"},"example":"active"},{"name":"listed","in":"query","required":false,"description":"true: only institutions with a listed holding company","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"total_assets (default), total_deposits, net_income_ytd, roa, name, established_date or closed_date","schema":{"type":"string"},"example":"total_assets"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/banks/screener":{"get":{"tags":["Banks"],"summary":"Bank Screener","description":"Rank banks and credit unions on one quarter (the newest of each kind by default) with min and max filters on any number, plus the change in assets and deposits from a year before. /banks/totals gives all institutions together by quarter (the history since 1984) or by head-office state.\n\nThe answer is {periods, total, limit, offset, sort, order, rows, about}. /banks/totals takes by (period or state), kind, period, period_from and period_to and answers {by, rows, about}.","operationId":"banks_screener","parameters":[{"name":"kind","in":"query","required":false,"description":"bank or credit_union","schema":{"type":"string"},"example":"bank"},{"name":"state","in":"query","required":false,"description":"State(s) of the head office","schema":{"type":"string"},"example":"CA"},{"name":"period","in":"query","required":false,"description":"Quarter end or latest (default)","schema":{"type":"string"},"example":"latest"},{"name":"total_assets_min","in":"query","required":false,"description":"Total assets at least (US dollars)","schema":{"type":"number"},"example":1000000000},{"name":"roa_min","in":"query","required":false,"description":"Return on assets at least (percent a year)","schema":{"type":"number"},"example":1},{"name":"capital_ratio_min","in":"query","required":false,"description":"Capital ratio at least (percent)","schema":{"type":"number"},"example":10},{"name":"sort","in":"query","required":false,"description":"Any number, name or state (default total_assets)","schema":{"type":"string"},"example":"roa"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/bank-branches":{"get":{"tags":["Banks"],"summary":"Bank Branches and Deposits","description":"Branches of every bank and credit union in an area (state, county, city, ZIP or a map box), one year as of June 30, with the address, map position and deposits (bank branches). /bank-branches/totals gives branches, institutions and deposits by state, county or institution, with each one's share of the area's deposits (deposit market share).\n\n/bank-branches answers {years, total, total_deposits, rows, about}; /bank-branches/totals answers {by, years, total, rows, about}.","operationId":"bank_branches","parameters":[{"name":"state","in":"query","required":false,"description":"State(s)","schema":{"type":"string"},"example":"TX"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code(s)","schema":{"type":"string"},"example":"48453"},{"name":"city","in":"query","required":false,"description":"City (add state)","schema":{"type":"string"},"example":"Austin"},{"name":"zip","in":"query","required":false,"description":"ZIP code(s)","schema":{"type":"string"},"example":"78701"},{"name":"kind","in":"query","required":false,"description":"bank or credit_union","schema":{"type":"string"},"example":"bank"},{"name":"year","in":"query","required":false,"description":"A year, latest (default), or all (totals by state or county)","schema":{"type":"string"},"example":"latest"},{"name":"by","in":"query","required":false,"description":"Totals only: state, county or institution","schema":{"type":"string"},"example":"institution"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000","schema":{"type":"integer"},"example":200}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/bank-failures":{"get":{"tags":["Banks"],"summary":"Bank Failures","description":"US bank failures and assisted rescues since 1934 with the bank, place, date, assets and deposits at the last report, the estimated cost and the bank that took over the deposits, plus totals for everything that matches. /bank-failures/years gives the failures per year.\n\nThe answer is {total, summary, limit, offset, sort, order, rows, about}. /bank-failures/years answers {rows: [{year, failures, assistance, total_assets, total_deposits, estimated_loss}], about}.","operationId":"bank_failures","parameters":[{"name":"year","in":"query","required":false,"description":"One year","schema":{"type":"integer"},"example":2023},{"name":"year_from","in":"query","required":false,"description":"First year","schema":{"type":"integer"},"example":2008},{"name":"year_to","in":"query","required":false,"description":"Last year","schema":{"type":"integer"},"example":2012},{"name":"state","in":"query","required":false,"description":"State(s)","schema":{"type":"string"},"example":"GA"},{"name":"event_type","in":"query","required":false,"description":"failure (default), assistance or all","schema":{"type":"string"},"example":"failure"},{"name":"q","in":"query","required":false,"description":"Words in the bank or acquirer name","schema":{"type":"string"},"example":"first"},{"name":"sort","in":"query","required":false,"description":"failure_date (default), total_assets, total_deposits, estimated_loss or name","schema":{"type":"string"},"example":"total_assets"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/consumer-complaints/totals":{"get":{"tags":["Consumer Complaints"],"summary":"Complaints Over Time","description":"Monthly (or yearly) counts of the complaints consumers sent about financial companies (credit reports, debt collection, mortgages, bank accounts, credit cards, loans, money transfers and more), from official public data, since December 2011, with how the companies answered. Counts only: no single complaint and no complaint text.\n\nThe answer is {by, filters, as_of, rows, about}. Before the first data load the rows are empty and note says \"Data is being prepared\".","operationId":"consumer_complaints_totals","parameters":[{"name":"by","in":"query","required":false,"description":"month (default) or year","schema":{"type":"string"},"example":"month"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of the listed company","schema":{"type":"string"},"example":"JPM"},{"name":"company","in":"query","required":false,"description":"Company id(s) or page name(s)","schema":{"type":"string"},"example":"jpmorgan-chase-and-co"},{"name":"bank_id","in":"query","required":false,"description":"Bank or credit union id(s) from /banks","schema":{"type":"string"},"example":"b3510"},{"name":"product_group","in":"query","required":false,"description":"credit_reports, debt_collection, mortgages, bank_accounts, credit_cards, prepaid_cards, money_transfers, student_loans, vehicle_loans, personal_loans, debt_credit_management or other","schema":{"type":"string"},"example":"credit_cards"},{"name":"state","in":"query","required":false,"description":"Consumer's state(s): 2-letter code or name","schema":{"type":"string"},"example":"TX"},{"name":"date_from","in":"query","required":false,"description":"First month (YYYY-MM or YYYY)","schema":{"type":"string"},"example":"2024-01"},{"name":"date_to","in":"query","required":false,"description":"Last month (YYYY-MM or YYYY)","schema":{"type":"string"},"example":"2026-08"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/consumer-complaints/breakdown":{"get":{"tags":["Consumer Complaints"],"summary":"Complaints Breakdown","description":"Complaints split by one field and ranked: by company, product group, product, sub-product, issue, sub-issue or the consumer's state, for everything or with the same filters as /consumer-complaints/totals. Default period: the 12 newest complete months.\n\nThe answer is {by, filters, total, complaints, limit, offset, sort, order, as_of, rows, about}.","operationId":"consumer_complaints_breakdown","parameters":[{"name":"by","in":"query","required":true,"description":"company, product_group, product, sub_product, issue, sub_issue or state","schema":{"type":"string"},"example":"company"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of the listed company","schema":{"type":"string"},"example":"COF"},{"name":"product_group","in":"query","required":false,"description":"Product group(s)","schema":{"type":"string"},"example":"mortgages"},{"name":"state","in":"query","required":false,"description":"Consumer's state(s)","schema":{"type":"string"},"example":"CA"},{"name":"sort","in":"query","required":false,"description":"complaints (default), relief_pct, monetary_relief_pct, timely_pct, in_progress or name","schema":{"type":"string"},"example":"complaints"},{"name":"min_complaints","in":"query","required":false,"description":"Only rows with at least this many complaints","schema":{"type":"integer"},"example":100},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 25)","schema":{"type":"integer"},"example":25},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/consumer-complaints/companies":{"get":{"tags":["Consumer Complaints"],"summary":"Complaint Companies","description":"The companies named in complaints, with their complaints (all months and the 12 newest complete months), first and last month, newest complaint date, the ticker of the listed company and the bank_id of the bank with the same name. /consumer-complaints/companies/{id or page name} gives one company with its monthly series and its top products, issues and states. /consumer-complaints/products lists the product groups and the products in each.\n\nThe answer is {total, limit, offset, sort, order, as_of, rows, about}. One company answers {company, period, as_of, summary, series, product_groups, products, issues, states, about}.","operationId":"consumer_complaints_companies","parameters":[{"name":"q","in":"query","required":false,"description":"Words in the company name","schema":{"type":"string"},"example":"chase"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of the listed company","schema":{"type":"string"},"example":"JPM"},{"name":"bank_id","in":"query","required":false,"description":"Bank or credit union id(s)","schema":{"type":"string"},"example":"b3510"},{"name":"listed","in":"query","required":false,"description":"true: only names linked to a listed company","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"complaints_12m (default), complaints, name or last_complaint_date","schema":{"type":"string"},"example":"complaints_12m"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/recalls":{"get":{"tags":["Recalls"],"summary":"Recalls","description":"Recalls of vehicles (kind vehicle: cars, trucks, buses, motorcycles, RVs and trailers, plus tires, child car seats and vehicle equipment) since the late 1960s and of consumer products (kind consumer: toys, children's products, furniture, appliances, tools, bicycles and more) since the 1970s, from official public data, newest first. /recalls/{id} gives one recall (by id such as v24v123000 or c26123, or its page name) with its texts and the makes, models and model years it covers.\n\nThe answer is {filters, total, limit, offset, sort, order, as_of, rows, about}; as_of gives the newest recall date of each kind. /recalls/{id} answers {recall, vehicles, vehicles_total, about}. Until the first load is finished, lists answer with empty rows and note \"Data is being prepared\".","operationId":"recalls","parameters":[{"name":"kind","in":"query","required":false,"description":"vehicle or consumer (default both)","schema":{"type":"string"},"example":"vehicle"},{"name":"make","in":"query","required":false,"description":"Vehicle make(s), comma-separated","schema":{"type":"string"},"example":"FORD"},{"name":"model","in":"query","required":false,"description":"Vehicle model(s) as published, with make (several: separate with |)","schema":{"type":"string"},"example":"F-150"},{"name":"model_year","in":"query","required":false,"description":"Model year","schema":{"type":"integer"},"example":2021},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of the listed company","schema":{"type":"string"},"example":"TSLA"},{"name":"hazard","in":"query","required":false,"description":"Hazard group(s), comma-separated","schema":{"type":"string"},"example":"fire"},{"name":"q","in":"query","required":false,"description":"Words in the title, product name or component","schema":{"type":"string"},"example":"air bag"},{"name":"date_from","in":"query","required":false,"description":"First recall date: YYYY, YYYY-MM or YYYY-MM-DD","schema":{"type":"string"},"example":"2025"},{"name":"do_not_drive","in":"query","required":false,"description":"true: only recalls that tell owners not to drive the vehicle","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"date (default), units or title","schema":{"type":"string"},"example":"date"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 25)","schema":{"type":"integer"},"example":25},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/recalls/totals":{"get":{"tags":["Recalls"],"summary":"Recall Totals","description":"Recalls counted by one field, with the units affected: by year, month, kind, category, make, model, model_year, manufacturer, ticker, hazard, product_type or component, with the same filters as /recalls.\n\nThe answer is {by, filters, total, recalls, limit, offset, sort, order, as_of, rows, about}.","operationId":"recalls_totals","parameters":[{"name":"by","in":"query","required":true,"description":"year, month, kind, category, make, model, model_year, manufacturer, ticker, hazard, product_type or component","schema":{"type":"string"},"example":"make"},{"name":"kind","in":"query","required":false,"description":"vehicle or consumer","schema":{"type":"string"},"example":"vehicle"},{"name":"make","in":"query","required":false,"description":"Vehicle make(s)","schema":{"type":"string"},"example":"TOYOTA"},{"name":"date_from","in":"query","required":false,"description":"First recall date","schema":{"type":"string"},"example":"2025-10"},{"name":"sort","in":"query","required":false,"description":"recalls, units or name","schema":{"type":"string"},"example":"recalls"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":20}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/vehicle-ratings":{"get":{"tags":["Recalls"],"summary":"Vehicle Safety Ratings","description":"Crash test star ratings (1 to 5 stars; more is better) by make, model, model year, body style and drive train, from official public data: overall, frontal crash (driver and passenger), side crash (barrier and pole) and rollover, the chance of a rollover in a single-vehicle crash, and six safety features (standard, optional, standard_and_optional or no).\n\nThe answer is {filters, total, limit, offset, sort, order, rows, about}.","operationId":"vehicle_ratings","parameters":[{"name":"make","in":"query","required":false,"description":"Vehicle make(s)","schema":{"type":"string"},"example":"TOYOTA"},{"name":"model","in":"query","required":false,"description":"Vehicle model(s), with make","schema":{"type":"string"},"example":"CAMRY"},{"name":"model_year","in":"query","required":false,"description":"Model year","schema":{"type":"integer"},"example":2024},{"name":"min_overall","in":"query","required":false,"description":"At least this many overall stars","schema":{"type":"integer"},"example":5},{"name":"rated","in":"query","required":false,"description":"true: only vehicles with a star rating","schema":{"type":"boolean"},"example":true},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/vehicle-complaints":{"get":{"tags":["Recalls"],"summary":"Vehicle Owner Complaints","description":"Safety complaints vehicle owners filed since 1995, from official public data, counted by the month they were received: complaints, and the crashes, fires, injuries and deaths they report. Counts only, no complaint text. by gives the history (month or year) or a ranking (make, model, model_year or component).\n\nThe answer is {by, filters, totals, total, limit, offset, sort, order, as_of, rows, about}.","operationId":"vehicle_complaints","parameters":[{"name":"by","in":"query","required":false,"description":"month (default), year, make, model, model_year or component","schema":{"type":"string"},"example":"component"},{"name":"make","in":"query","required":false,"description":"Vehicle make(s)","schema":{"type":"string"},"example":"TESLA"},{"name":"model","in":"query","required":false,"description":"Vehicle model(s), with make","schema":{"type":"string"},"example":"MODEL 3"},{"name":"date_from","in":"query","required":false,"description":"First month received: YYYY or YYYY-MM","schema":{"type":"string"},"example":"2025-01"},{"name":"sort","in":"query","required":false,"description":"complaints (default), crashes, fires, injuries, deaths or name","schema":{"type":"string"},"example":"complaints"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 500)","schema":{"type":"integer"},"example":20}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/airlines":{"get":{"tags":["Transportation"],"summary":"Airlines","description":"US airline on-time performance and passenger traffic by month, from official public data. /airlines ranks the airlines for a period by on-time %, delays, cancellations, average arrival delay, passengers, seats or load factor, with the same period a year earlier. /airlines/series gives monthly numbers of one airline, several, a listed company (ticker) or all airlines. /airlines/{carrier} gives one airline with its newest month, last 12 months, busiest airports and routes.\n\nThe answer is {period, total, limit, offset, sort, order, rows, as_of, about}; as_of gives the first and newest month of the on-time and the traffic numbers. /airlines/series takes carrier, ticker, by (total or carrier), date_from and date_to (YYYY-MM). Until the first load is finished the lists answer with empty rows and note \"Data is being prepared\".","operationId":"airlines","parameters":[{"name":"period","in":"query","required":false,"description":"latest (default), ttm, a year or a month","schema":{"type":"string"},"example":"latest"},{"name":"sort","in":"query","required":false,"description":"on_time_pct (default), delayed_pct, cancelled_pct, avg_arrival_delay_min, flights, passengers, seats, departures, load_factor_pct, passengers_change_pct or carrier_name","schema":{"type":"string"},"example":"on_time_pct"},{"name":"carrier","in":"query","required":false,"description":"Carrier code(s), comma-separated","schema":{"type":"string"},"example":"DL,9E"},{"name":"ticker","in":"query","required":false,"description":"Ticker of a listed company: its airlines","schema":{"type":"string"},"example":"DAL"},{"name":"carrier_type","in":"query","required":false,"description":"us or foreign","schema":{"type":"string"},"example":"us"},{"name":"min_passengers","in":"query","required":false,"description":"Only airlines with at least this many passengers in the period","schema":{"type":"integer"},"example":100000},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":25}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/airports":{"get":{"tags":["Transportation"],"summary":"Airports and Air Routes","description":"Airports ranked for a period by departing passengers, flights, on-time %, delays or cancellations (/airports), one airport with its monthly series, airlines and top routes (/airports/{airport}), non-stop routes ranked by passengers (/air-routes) and passengers on flights within, to and from the US by month (/air-travelers), from official public data.\n\nAnswers are {period, total, limit, offset, sort, order, rows, as_of, about}. /air-travelers answers {total, rows: [{month, passengers, domestic_passengers, international_passengers, seats, departures, load_factor_pct, change_pct}]}.","operationId":"airports","parameters":[{"name":"period","in":"query","required":false,"description":"latest (default), ttm, a year or a month","schema":{"type":"string"},"example":"ttm"},{"name":"sort","in":"query","required":false,"description":"/airports: passengers (default), flights, on_time_pct, cancelled_pct; /air-routes: passengers (default), seats, departures, load_factor_pct, distance_miles","schema":{"type":"string"},"example":"passengers"},{"name":"state","in":"query","required":false,"description":"/airports: US state(s)","schema":{"type":"string"},"example":"TX"},{"name":"airport","in":"query","required":false,"description":"/air-routes: routes leaving or arriving at this airport","schema":{"type":"string"},"example":"ATL"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":20}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/trucking/carriers":{"get":{"tags":["Transportation"],"summary":"Trucking Carriers","description":"Active US trucking and bus carriers with 10 or more power units, from official public data, updated daily: fleet and drivers, operation, operating authority, safety rating, cargo, crashes over 24 months (fatal, injury, tow-away) with the crash rate per 100 power units, and roadside inspections with driver and vehicle out-of-service rates. /trucking/carriers/{carrier} gives one carrier (by carrier number or page name) with its fleet rank and the averages of all carriers, of its state and of all roadside inspections.\n\nThe answer is {total, limit, offset, sort, order, filters, data_date, rows, about}. Until the first load is finished it has empty rows and note \"Data is being prepared\".","operationId":"trucking_carriers","parameters":[{"name":"q","in":"query","required":false,"description":"Part of the carrier name, or a carrier number","schema":{"type":"string"},"example":"hunt"},{"name":"state","in":"query","required":false,"description":"State(s) where the carrier is based","schema":{"type":"string"},"example":"TX"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of listed companies","schema":{"type":"string"},"example":"JBHT"},{"name":"min_power_units","in":"query","required":false,"description":"At least this many power units","schema":{"type":"integer"},"example":100},{"name":"sort","in":"query","required":false,"description":"power_units (default), drivers, crashes, crash_rate, vehicle_oos_rate, ...","schema":{"type":"string"},"example":"power_units"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":25}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/trucking/stats":{"get":{"tags":["Transportation"],"summary":"Trucking by State and Month","description":"Trucking for all carriers (also the small ones) by state, month or year, from official public data: active carriers, power units, drivers and fleet size groups (monthly snapshot), new carriers, truck and bus crashes where they happened (fatal, injury, tow-away, deaths, injuries) and roadside inspections with driver, vehicle and hazmat out-of-service rates.\n\nThe answer is {group_by, period, snapshot_month, coverage, totals, rows, about}.","operationId":"trucking_stats","parameters":[{"name":"group_by","in":"query","required":false,"description":"state (default), month, year or none","schema":{"type":"string"},"example":"state"},{"name":"state","in":"query","required":false,"description":"State(s); default all (US)","schema":{"type":"string"},"example":"TX"},{"name":"date_from","in":"query","required":false,"description":"First month: YYYY-MM or YYYY","schema":{"type":"string"},"example":"2025-10"},{"name":"sort","in":"query","required":false,"description":"By state: state or a number such as crashes","schema":{"type":"string"},"example":"crashes"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/port-volumes":{"get":{"tags":["Transportation"],"summary":"Port Container Volumes","description":"Monthly container volumes of the seaports of Los Angeles (since 1995) and Long Beach (since 1987) in TEUs, from official public data: loaded imports, loaded exports, empty containers and totals, with the change from a year earlier and 12-month totals. /port-volumes ranks the ports for a period, /port-volumes/ports lists them and /port-volumes/{port} gives one port (USLAX, USLGB, a page name such as long-beach, or all for the ports combined) by month or year.\n\n/port-volumes answers {period, total, rows, combined, as_of, about}; /port-volumes/{port} answers {port, latest, last_12_months, frequency, total, rows, as_of, about}. Until the first load is finished they answer with note \"Data is being prepared\".","operationId":"port_volumes","parameters":[{"name":"period","in":"query","required":false,"description":"/port-volumes: latest (default), ttm, a year or a month","schema":{"type":"string"},"example":"latest"},{"name":"frequency","in":"query","required":false,"description":"/port-volumes/{port}: month (default) or year","schema":{"type":"string"},"example":"month"},{"name":"date_from","in":"query","required":false,"description":"/port-volumes/{port}: first month, YYYY-MM or YYYY","schema":{"type":"string"},"example":"2019-01"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 120 for one port)","schema":{"type":"integer"},"example":60}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/compliance/facilities":{"get":{"tags":["Facility Compliance & Emissions"],"summary":"Facilities","description":"US facilities with environmental compliance records (air, water and hazardous waste programs) or workplace safety inspections since 2010, or greenhouse gas reports, from official public data, with their totals for a period (default the last 5 years): inspections, violations, serious violations, penalties assessed, enforcement actions, and the newest year's emissions. /compliance/facilities/{facility_id} gives one facility with every year of each kind and of emissions.\n\nThe answer is {total, limit, offset, sort, order, period, filters, point, data_date, rows, about}; data_date gives the years covered by each kind. Until the first load is finished, lists answer with note \"Data is being prepared\". A record does not mean a site is unsafe today; penalties and violations vary a lot by industry and size.","operationId":"compliance_facilities","parameters":[{"name":"q","in":"query","required":false,"description":"Part of the facility name (at least 3 characters), or a facility_id","schema":{"type":"string"},"example":"refinery"},{"name":"state","in":"query","required":false,"description":"State(s): 2-letter code or name","schema":{"type":"string"},"example":"TX"},{"name":"county","in":"query","required":false,"description":"County name (add state)","schema":{"type":"string"},"example":"Harris"},{"name":"zip","in":"query","required":false,"description":"5-digit ZIP code(s)","schema":{"type":"string"},"example":"77506"},{"name":"city","in":"query","required":false,"description":"City name(s) (add state)","schema":{"type":"string"},"example":"Pasadena"},{"name":"lat","in":"query","required":false,"description":"Latitude of a point (with lon)","schema":{"type":"number"},"example":29.7},{"name":"lon","in":"query","required":false,"description":"Longitude of the point","schema":{"type":"number"},"example":-95.2},{"name":"radius_miles","in":"query","required":false,"description":"Radius around the point in miles (default 5, at most 25)","schema":{"type":"number"},"example":3},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of listed companies","schema":{"type":"string"},"example":"XOM"},{"name":"kind","in":"query","required":false,"description":"workplace_safety, environmental or emissions","schema":{"type":"string"},"example":"environmental"},{"name":"year_from","in":"query","required":false,"description":"First year of the totals (default: the last 5 years)","schema":{"type":"integer"},"example":2020},{"name":"sort","in":"query","required":false,"description":"penalties (default), violations, serious_violations, inspections, enforcement_actions, emissions, name or distance","schema":{"type":"string"},"example":"penalties"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":20},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/compliance/companies":{"get":{"tags":["Facility Compliance & Emissions"],"summary":"Listed Companies","description":"With ticker: one listed company's facilities by year and kind (inspections, violations, serious violations, penalties, enforcement actions) since 2010, its greenhouse gas emissions by year, its facilities by state, its 10 largest cases and its 10 largest emitters. Without ticker: listed companies ranked for a period.\n\nOne company answers {ticker, listed_company, period, facilities, facilities_by_state, workplace_safety, environmental, emissions, largest_cases, largest_emitters, data_date, about}, or 404 when no facility is linked. The ranking answers {total, limit, offset, sort, order, period, rows, about}.","operationId":"compliance_companies","parameters":[{"name":"ticker","in":"query","required":false,"description":"Ticker of one listed company; without it, companies are ranked","schema":{"type":"string"},"example":"XOM"},{"name":"state","in":"query","required":false,"description":"Only facilities in these states","schema":{"type":"string"},"example":"TX"},{"name":"year_from","in":"query","required":false,"description":"First year","schema":{"type":"integer"},"example":2015},{"name":"sort","in":"query","required":false,"description":"Ranking: penalties (default), violations, facilities, emissions and more","schema":{"type":"string"},"example":"penalties"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":20}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/emissions":{"get":{"tags":["Facility Compliance & Emissions"],"summary":"Greenhouse Gas Emissions","description":"Greenhouse gas emissions of large US facilities since 2010, from official public data, in metric tons of CO2 equivalent: ranked facilities (default), or totals by listed company, state, sector or year.\n\nThe answer is {group_by, year, total, limit, offset, sort, order, filters, totals, rows, data_date, about}.","operationId":"emissions","parameters":[{"name":"group_by","in":"query","required":false,"description":"facility (default), company, state, sector or year","schema":{"type":"string"},"example":"company"},{"name":"year","in":"query","required":false,"description":"Year (default the newest)","schema":{"type":"integer"},"example":2023},{"name":"state","in":"query","required":false,"description":"State(s)","schema":{"type":"string"},"example":"TX"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of listed companies","schema":{"type":"string"},"example":"DUK"},{"name":"sector","in":"query","required":false,"description":"Sector name","schema":{"type":"string"},"example":"Power Plants"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":20}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/employer-salaries/totals":{"get":{"tags":["Employer Salaries"],"summary":"Salary Totals","description":"Yearly pay that employers offered in certified work-visa filings, from official public data: H-1B temporary work visas (kind h1b, with H-1B1), E-3 work visas (e3) and PERM green card filings (perm), by fiscal year (October to September) since 2020. All employers together: by=year gives one row per fiscal year for the US, one area or one job group; by=state, metro, city or job ranks places or job groups for one fiscal year. Pay is the lower end of the offered pay range, made yearly, for full-time positions only. These are offered pay figures in work-visa filings, not the pay of all workers; a filing is an offer for a position, not a hire.\n\nThe answer is {by, kind, year, filters, total, rows, as_of, about}. Until the first load is finished, lists answer with empty rows and note \"Data is being prepared\".","operationId":"employer_salaries_totals","parameters":[{"name":"by","in":"query","required":false,"description":"year (default), state, metro, city or job","schema":{"type":"string"},"example":"year"},{"name":"kind","in":"query","required":false,"description":"h1b (default), e3 or perm","schema":{"type":"string"},"example":"h1b"},{"name":"year","in":"query","required":false,"description":"Fiscal year (default: the newest complete one)","schema":{"type":"integer"},"example":2025},{"name":"job","in":"query","required":false,"description":"Occupation code of the job group","schema":{"type":"string"},"example":"15-1252"},{"name":"area","in":"query","required":false,"description":"US, a state code, a metro area code or an area page name","schema":{"type":"string"},"example":"CA"},{"name":"state","in":"query","required":false,"description":"State(s) for by=metro or by=city","schema":{"type":"string"},"example":"TX"},{"name":"sort","in":"query","required":false,"description":"filings (default), median, p25, p75, mean, workers or name","schema":{"type":"string"},"example":"median"},{"name":"min_filings","in":"query","required":false,"description":"Only rows with at least this many filings","schema":{"type":"integer"},"example":100},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":20}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/employer-salaries/employers":{"get":{"tags":["Employer Salaries"],"summary":"Employers","description":"Employers ranked by filings (or pay) in one fiscal year and visa kind, in the whole US or for one job group. ticker gives every employer name linked to a listed company (units and subsidiaries as the filings name them). /employer-salaries/employers/{employer} gives one employer (by id or page name): pay in the US for every fiscal year and visa kind, and for one year its top job groups, worksite cities and job x city groups.\n\nThe answer is {kind, year, filters, total, limit, offset, sort, order, rows, as_of, about}. /employer-salaries/employers/{employer} answers {employer, kind, year, years, jobs, cities, details, as_of, about}.","operationId":"employer_salaries_employers","parameters":[{"name":"q","in":"query","required":false,"description":"Words in the employer name","schema":{"type":"string"},"example":"google"},{"name":"ticker","in":"query","required":false,"description":"Ticker(s) of the listed company","schema":{"type":"string"},"example":"GOOGL"},{"name":"job","in":"query","required":false,"description":"Rank employers by this job group","schema":{"type":"string"},"example":"15-1252"},{"name":"kind","in":"query","required":false,"description":"h1b (default), e3 or perm","schema":{"type":"string"},"example":"h1b"},{"name":"year","in":"query","required":false,"description":"Fiscal year (default: the newest complete one)","schema":{"type":"integer"},"example":2025},{"name":"listed","in":"query","required":false,"description":"true: only employers linked to a listed company","schema":{"type":"boolean"},"example":true},{"name":"sort","in":"query","required":false,"description":"filings (default), median, p25, p75, mean, workers or name","schema":{"type":"string"},"example":"filings"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":10}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/employer-salaries/jobs":{"get":{"tags":["Employer Salaries"],"summary":"Job Groups","description":"Job groups (official occupation codes) with filings and pay of all employers in one fiscal year, in the US or one area. /employer-salaries/jobs/{job} gives one job group: US pay for every fiscal year, and for one year its top employers, metro areas, cities and states.\n\nThe answer is {kind, year, filters, total, limit, offset, sort, order, rows, as_of, about}. /employer-salaries/jobs/{job} answers {job, kind, year, years, employers, metros, cities, states, as_of, about}.","operationId":"employer_salaries_jobs","parameters":[{"name":"q","in":"query","required":false,"description":"Words in the job group title","schema":{"type":"string"},"example":"software"},{"name":"major_group","in":"query","required":false,"description":"2-digit major group","schema":{"type":"string"},"example":"15"},{"name":"area","in":"query","required":false,"description":"US (default), a state code, a metro area code or an area page name","schema":{"type":"string"},"example":"41940"},{"name":"kind","in":"query","required":false,"description":"h1b (default), e3 or perm","schema":{"type":"string"},"example":"h1b"},{"name":"year","in":"query","required":false,"description":"Fiscal year","schema":{"type":"integer"},"example":2025}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/employer-salaries/areas":{"get":{"tags":["Employer Salaries"],"summary":"Areas","description":"States, metro areas or worksite cities with filings and pay of all employers in one fiscal year (or of one job group). /employer-salaries/areas/{area} gives one area (US, a state, a metro area or a city): pay of all employers for every fiscal year, and for one year its top job groups, top employers and, for a state or metro area, its top cities. Employers of a state or metro area are ranked by the filings of its cities added up (no pay figures); cities and the US have exact pay figures.\n\nThe answer is {area_type, kind, year, filters, total, limit, offset, sort, order, rows, as_of, about}. /employer-salaries/areas/{area} answers {area, kind, year, years, jobs, employers, cities, as_of, about}.","operationId":"employer_salaries_areas","parameters":[{"name":"area_type","in":"query","required":false,"description":"state, metro (default) or city","schema":{"type":"string"},"example":"metro"},{"name":"state","in":"query","required":false,"description":"State(s)","schema":{"type":"string"},"example":"CA"},{"name":"job","in":"query","required":false,"description":"Pay of this job group","schema":{"type":"string"},"example":"15-1252"},{"name":"kind","in":"query","required":false,"description":"h1b (default), e3 or perm","schema":{"type":"string"},"example":"h1b"},{"name":"sort","in":"query","required":false,"description":"filings (default), median, p25, p75, mean, workers or name","schema":{"type":"string"},"example":"median"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/mortgage-lending/summary":{"get":{"tags":["Mortgage Lending"],"summary":"Mortgage Lending Summary","description":"Home loan applications that US mortgage lenders report each year, from official public data, for one area and year since 2018: applications, loans made, approved but not taken, denied, withdrawn and incomplete, approval and denial rates, the amount lent, the median loan and median borrower income, the average interest rate, the number of lenders, the split by loan purpose, loan type and occupancy, the reasons for denials, the trend by year and the top lenders. Counts only: no single loan or applicant.\n\nThe answer is {area, filters, as_of, totals, by_purpose, by_loan_type, by_occupancy, denial_reasons, trend, top_lenders, other_lenders, about}. Before the first load it says \"Data is being prepared\".","operationId":"mortgage_lending_summary","parameters":[{"name":"state","in":"query","required":false,"description":"2-letter code or name","schema":{"type":"string"},"example":"TX"},{"name":"county","in":"query","required":false,"description":"County name (with state)","schema":{"type":"string"},"example":"Travis"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code","schema":{"type":"string"},"example":"48453"},{"name":"metro_code","in":"query","required":false,"description":"Metro area CBSA code","schema":{"type":"string"},"example":"12420"},{"name":"metro","in":"query","required":false,"description":"Part of a metro area name","schema":{"type":"string"},"example":"Austin"},{"name":"year","in":"query","required":false,"description":"A year (default: the newest)","schema":{"type":"string"},"example":"2024"},{"name":"purpose","in":"query","required":false,"description":"all, purchase, home_improvement, refinance, cash_out_refinance or other","schema":{"type":"string"},"example":"purchase"},{"name":"loan_type","in":"query","required":false,"description":"all, conventional, fha, va or usda","schema":{"type":"string"},"example":"conventional"},{"name":"occupancy","in":"query","required":false,"description":"all, primary, second_home or investment","schema":{"type":"string"},"example":"primary"},{"name":"top","in":"query","required":false,"description":"Top lenders to list, 0 to 50 (default 10)","schema":{"type":"integer"},"example":10}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/mortgage-lending/areas":{"get":{"tags":["Mortgage Lending"],"summary":"Mortgage Lending by Area","description":"States, metro areas or counties ranked for one year by home loan applications, loans made, amount lent, approval or denial rate, median loan, median borrower income, average interest rate or number of lenders, with the same purpose, loan type and occupancy filters.\n\nThe answer is {area_type, filters, total, limit, offset, sort, order, as_of, rows, about}. purpose, loan_type and occupancy work as on /mortgage-lending/summary.","operationId":"mortgage_lending_areas","parameters":[{"name":"area_type","in":"query","required":false,"description":"state (default), metro or county","schema":{"type":"string"},"example":"county"},{"name":"state","in":"query","required":false,"description":"2-letter code or name","schema":{"type":"string"},"example":"TX"},{"name":"metro_code","in":"query","required":false,"description":"With area_type=county: the counties of this CBSA code","schema":{"type":"string"},"example":"12420"},{"name":"year","in":"query","required":false,"description":"A year (default: the newest)","schema":{"type":"string"},"example":"2025"},{"name":"sort","in":"query","required":false,"description":"applications (default), originated, originated_amount, approval_rate, denial_rate, median_loan_amount, median_income, avg_interest_rate, avg_loan_amount, lenders or name","schema":{"type":"string"},"example":"denial_rate"},{"name":"order","in":"query","required":false,"description":"asc or desc","schema":{"type":"string"},"example":"desc"},{"name":"min_applications","in":"query","required":false,"description":"Only areas with at least this many applications","schema":{"type":"integer"},"example":500},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/mortgage-lending/lenders":{"get":{"tags":["Mortgage Lending"],"summary":"Mortgage Lenders","description":"Mortgage lenders with their home loan applications, loans made, amount lent, approval and denial rates and average interest rate for one year, nationwide or in a state, county or metro area (with their share of the area), found by name words, LEI, ticker or bank id. /mortgage-lending/lender gives one lender (or every lender of a ticker or bank) over the years, with its split by purpose, loan type and occupancy and its top states and counties.\n\nThe answer is {area, filters, total, applications, limit, offset, sort, order, as_of, rows, about}. County and metro lists include each lender's cells of at least 5 records; the rest counts in the area totals.","operationId":"mortgage_lending_lenders","parameters":[{"name":"q","in":"query","required":false,"description":"Words in the lender name","schema":{"type":"string"},"example":"rocket"},{"name":"ticker","in":"query","required":false,"description":"Ticker of a listed company","schema":{"type":"string"},"example":"RKT"},{"name":"state","in":"query","required":false,"description":"Rank the lenders of this state","schema":{"type":"string"},"example":"TX"},{"name":"county","in":"query","required":false,"description":"County name (with state)","schema":{"type":"string"},"example":"Travis"},{"name":"year","in":"query","required":false,"description":"A year (default: the newest)","schema":{"type":"string"},"example":"2025"},{"name":"sort","in":"query","required":false,"description":"applications (default), originated, originated_amount, approval_rate, denial_rate, avg_interest_rate, avg_loan_amount or name","schema":{"type":"string"},"example":"applications"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 50)","schema":{"type":"integer"},"example":50},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/properties":{"get":{"tags":["Real Estate"],"summary":"Properties (Search and Detail)","description":"One endpoint for US homes of every status: for sale, pending, for rent, sold in the last 12 months and off the market. Search a place with filters, or look up one home by property ID or by address.\n\nSearch mode: give at least one of zip, city, county or state. With no location at all the whole US is searched from a fixed sample, and the answer is marked approximate: true (counts are estimates). Very large areas are answered the same way. Detail mode: give property_id or address. All other parameters are optional filters. Not available with demo keys.","operationId":"properties","parameters":[{"name":"zip","in":"query","required":false,"description":"Search mode: ZIP code, or several separated by commas (up to 25)","schema":{"type":"string"},"example":"92602"},{"name":"city","in":"query","required":false,"description":"Search mode: city name. Add state when the name is used in more than one state","schema":{"type":"string"},"example":"Irvine"},{"name":"county","in":"query","required":false,"description":"Search mode: county name, with or without the word County","schema":{"type":"string"},"example":"Orange"},{"name":"state","in":"query","required":false,"description":"State as a 2-letter code or full name, for example CA or California. Alone, it searches the whole state","schema":{"type":"string"},"example":"CA"},{"name":"status","in":"query","required":false,"description":"for_sale (default), pending, rent, sold (last 12 months) or off_market. Use commas for several. In detail mode it picks which record of the home to show","schema":{"type":"string"},"example":"for_sale"},{"name":"price_min","in":"query","required":false,"description":"Minimum price (monthly rent for rentals, sold price for sold homes, estimated value for off-market homes)","schema":{"type":"number"},"example":500000},{"name":"price_max","in":"query","required":false,"description":"Maximum price","schema":{"type":"number"},"example":900000},{"name":"beds_min","in":"query","required":false,"description":"Minimum bedrooms","schema":{"type":"integer"},"example":3},{"name":"beds_max","in":"query","required":false,"description":"Maximum bedrooms","schema":{"type":"integer"},"example":5},{"name":"baths_min","in":"query","required":false,"description":"Minimum bathrooms (a half bath counts as 0.5)","schema":{"type":"number"},"example":2},{"name":"baths_max","in":"query","required":false,"description":"Maximum bathrooms","schema":{"type":"number"},"example":4},{"name":"sqft_min","in":"query","required":false,"description":"Minimum living area in square feet","schema":{"type":"integer"},"example":1500},{"name":"sqft_max","in":"query","required":false,"description":"Maximum living area in square feet","schema":{"type":"integer"},"example":3000},{"name":"lot_min","in":"query","required":false,"description":"Minimum lot size in square feet","schema":{"type":"integer"},"example":5000},{"name":"lot_max","in":"query","required":false,"description":"Maximum lot size in square feet","schema":{"type":"integer"},"example":20000},{"name":"year_built_min","in":"query","required":false,"description":"Built in this year or later","schema":{"type":"integer"},"example":2000},{"name":"year_built_max","in":"query","required":false,"description":"Built in this year or earlier","schema":{"type":"integer"},"example":2024},{"name":"style","in":"query","required":false,"description":"Home style, or several separated by commas: single_family, condos, townhomes, multi_family, land, mobile, farm, duplex_triplex, condo_townhome","schema":{"type":"string"},"example":"single_family"},{"name":"new_construction","in":"query","required":false,"description":"true for new construction only, false to leave it out","schema":{"type":"boolean"},"example":true},{"name":"hoa_max","in":"query","required":false,"description":"Maximum HOA fee per month (homes without an HOA count as 0)","schema":{"type":"number"},"example":300},{"name":"dom_min","in":"query","required":false,"description":"Minimum days on market of the current listing (the real listed date, not a date that resets on every relist)","schema":{"type":"integer"},"example":30},{"name":"dom_max","in":"query","required":false,"description":"Maximum days on market of the current listing","schema":{"type":"integer"},"example":60},{"name":"true_dom_min","in":"query","required":false,"description":"Minimum true days on market: the whole selling effort, earlier listings of the same home included and days off the market left out","schema":{"type":"integer"},"example":90},{"name":"true_dom_max","in":"query","required":false,"description":"Maximum true days on market","schema":{"type":"integer"},"example":180},{"name":"listed_within_days","in":"query","required":false,"description":"Only homes whose current listing started within this many days","schema":{"type":"integer"},"example":14},{"name":"price_cut","in":"query","required":false,"description":"true: only homes with a price cut. false: only homes without one","schema":{"type":"boolean"},"example":true},{"name":"price_cut_within_days","in":"query","required":false,"description":"Only homes whose latest price cut was within this many days","schema":{"type":"integer"},"example":7},{"name":"cut_min","in":"query","required":false,"description":"Total price cut since the home was first listed, at least this many dollars","schema":{"type":"number"},"example":20000},{"name":"cut_pct_min","in":"query","required":false,"description":"Total price cut since the home was first listed, at least this percent","schema":{"type":"number"},"example":5},{"name":"relisted","in":"query","required":false,"description":"true: only relisted homes. false: only homes that were not relisted in this selling effort","schema":{"type":"boolean"},"example":true},{"name":"sold_within_days","in":"query","required":false,"description":"Sold homes: sold within this many days","schema":{"type":"integer"},"example":30},{"name":"below_area_ppsf","in":"query","required":false,"description":"true: price per square foot is below the ZIP code median of the same status. false: at or above it","schema":{"type":"boolean"},"example":true},{"name":"below_area_ppsf_pct","in":"query","required":false,"description":"Price per square foot is at least this percent below the ZIP code median of the same status","schema":{"type":"number"},"example":10},{"name":"sort","in":"query","required":false,"description":"newest (default), oldest, price_asc, price_desc, ppsf_asc, ppsf_desc, dom_asc, dom_desc (true days on market), biggest_cut, recent_cut, best_value (lowest price per square foot compared with the ZIP code median), sqft_desc, beds_desc, lot_desc, year_built_desc","schema":{"type":"string"},"example":"recent_cut"},{"name":"limit","in":"query","required":false,"description":"Homes per page, 1 to 5000 (default 100)","schema":{"type":"integer"},"example":25},{"name":"offset","in":"query","required":false,"description":"Number of homes to skip, for the next page (default 0). The answer gives next_offset when there are more","schema":{"type":"integer"},"example":25},{"name":"fields","in":"query","required":false,"description":"standard (all search fields, default) or compact (fewer fields per home)","schema":{"type":"string"},"example":"standard"},{"name":"with_payment","in":"query","required":false,"description":"Search mode: add an estimated monthly payment to each home. Uses the payment inputs below, or the defaults","schema":{"type":"boolean"},"example":true},{"name":"property_id","in":"query","required":false,"description":"Detail mode: one home by its property ID (from a search answer)","schema":{"type":"string"},"example":"2559714761"},{"name":"address","in":"query","required":false,"description":"Detail mode: a street address in any common spelling, for example 41 Carpenteria, Irvine CA or just 41 Carpenteria. ZIP code, city and state are optional. If more than one home is a close match, the answer lists the best matches with a match score","schema":{"type":"string"},"example":"41 Carpenteria Irvine CA"},{"name":"address_matches_only","in":"query","required":false,"description":"With address: return only the best matching homes (useful for a search box), not the full detail","schema":{"type":"boolean"},"example":true},{"name":"radius_miles","in":"query","required":false,"description":"Detail mode: radius for the comparison with nearby homes, up to 50 miles (default 2)","schema":{"type":"number"},"example":1},{"name":"nearby_same_beds","in":"query","required":false,"description":"Detail mode: compare only with nearby homes that have the same number of bedrooms","schema":{"type":"boolean"},"example":true},{"name":"nearby_same_style","in":"query","required":false,"description":"Detail mode: compare only with nearby homes of the same style","schema":{"type":"boolean"},"example":true},{"name":"nearby_sqft_min","in":"query","required":false,"description":"Detail mode: compare only with nearby homes of at least this many square feet","schema":{"type":"integer"},"example":1800},{"name":"nearby_sqft_max","in":"query","required":false,"description":"Detail mode: compare only with nearby homes of at most this many square feet","schema":{"type":"integer"},"example":2800},{"name":"down_payment_pct","in":"query","required":false,"description":"Payment: down payment in percent (default 20)","schema":{"type":"number"},"example":10},{"name":"down_payment_amount","in":"query","required":false,"description":"Payment: down payment in dollars, instead of percent","schema":{"type":"number"},"example":100000},{"name":"interest_rate","in":"query","required":false,"description":"Payment: yearly interest rate in percent (default: the latest average 30-year fixed rate)","schema":{"type":"number"},"example":6},{"name":"loan_term_years","in":"query","required":false,"description":"Payment: loan term in years (default 30)","schema":{"type":"integer"},"example":30},{"name":"property_tax_rate","in":"query","required":false,"description":"Payment: yearly property tax in percent of the price (default: the rate from the last tax bill of the home when known, else the median rate of its ZIP code, city or county, else 1.25)","schema":{"type":"number"},"example":1.2},{"name":"insurance_per_year","in":"query","required":false,"description":"Payment: home insurance per year in dollars (default 0.35 percent of the price)","schema":{"type":"number"},"example":3000},{"name":"hoa_per_month","in":"query","required":false,"description":"Payment: HOA fee per month in dollars (default: the HOA fee of the home)","schema":{"type":"number"},"example":250},{"name":"pmi_rate_pct","in":"query","required":false,"description":"Payment: yearly mortgage insurance (PMI) in percent of the loan, used when the down payment is below 20 percent (default 0.7)","schema":{"type":"number"},"example":0.7},{"name":"maintenance_per_year","in":"query","required":false,"description":"Payment: maintenance per year in dollars. Added to the monthly payment only when you give it (default none)","schema":{"type":"number"},"example":4000}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/realestate-price-changes":{"get":{"tags":["Real Estate"],"summary":"Price Changes and Relists","description":"Price cuts, price increases and relists of the homes on the market now in one area, with true dates taken from each home's own listing history.\n\nRequired: at least one of zip_code, city or county. The answer lists only homes that have something to report, so it can be shorter than the number of homes on the market.","operationId":"realestate_price_changes","parameters":[{"name":"zip_code","in":"query","required":false,"description":"ZIP code","schema":{"type":"string"},"example":"92602"},{"name":"type","in":"query","required":false,"description":"Listing type: for-sale (default), rent or pending","schema":{"type":"string"},"example":"for-sale"},{"name":"city","in":"query","required":false,"description":"City name","schema":{"type":"string"},"example":"Irvine"},{"name":"county","in":"query","required":false,"description":"County name","schema":{"type":"string"},"example":"Orange"},{"name":"state","in":"query","required":false,"description":"State name or 2-letter code (recommended with city or county)","schema":{"type":"string"},"example":"CA"},{"name":"include_events","in":"query","required":false,"description":"true: also return the price steps of the current listing (price_events)","schema":{"type":"boolean"},"example":true}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/realestate-for-sale":{"get":{"tags":["Real Estate"],"summary":"Properties For Sale","description":"Residential real estate listings currently for sale, one ZIP code and a short date range at a time. For search with filters across a whole city, county or state, use /properties.\n\nRequired: zip_code AND one date filter. Available operators: list_date (exact), list_date_between, list_date_gte, list_date_gt, list_date_lte, list_date_lt. Max 3-day span for range operations.","operationId":"realestate_for_sale","parameters":[{"name":"zip_code","in":"query","required":true,"description":"ZIP/postal code","schema":{"type":"string"},"example":"77493"},{"name":"list_date","in":"query","required":false,"description":"Exact date match (YYYY-MM-DD)","schema":{"type":"string"},"example":"2025-01-03"},{"name":"list_date_between","in":"query","required":false,"description":"Date range (YYYY-MM-DD,YYYY-MM-DD, max 3-day span)","schema":{"type":"string"},"example":"2025-01-01,2025-01-03"},{"name":"list_date_gte","in":"query","required":false,"description":"Greater than or equal to date","schema":{"type":"string"},"example":"2025-01-01"},{"name":"list_date_gt","in":"query","required":false,"description":"Greater than date","schema":{"type":"string"},"example":"2025-01-01"},{"name":"list_date_lte","in":"query","required":false,"description":"Less than or equal to date","schema":{"type":"string"},"example":"2025-01-03"},{"name":"list_date_lt","in":"query","required":false,"description":"Less than date","schema":{"type":"string"},"example":"2025-01-03"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/realestate-sold":{"get":{"tags":["Real Estate"],"summary":"Properties Sold","description":"Recently sold residential properties with sale prices and dates, one ZIP code and a short date range at a time. For search with filters across a whole city, county or state, use /properties.\n\nRequired: zip_code AND one date filter. Available operators: last_sold_date (exact), last_sold_date_between, last_sold_date_gte, last_sold_date_gt, last_sold_date_lte, last_sold_date_lt. Max 3-day span for range operations.","operationId":"realestate_sold","parameters":[{"name":"zip_code","in":"query","required":true,"description":"ZIP/postal code","schema":{"type":"string"},"example":"77493"},{"name":"last_sold_date","in":"query","required":false,"description":"Exact date match (YYYY-MM-DD)","schema":{"type":"string"},"example":"2025-01-03"},{"name":"last_sold_date_between","in":"query","required":false,"description":"Date range (YYYY-MM-DD,YYYY-MM-DD, max 3-day span)","schema":{"type":"string"},"example":"2025-01-01,2025-01-03"},{"name":"last_sold_date_gte","in":"query","required":false,"description":"Greater than or equal to date","schema":{"type":"string"},"example":"2025-01-01"},{"name":"last_sold_date_gt","in":"query","required":false,"description":"Greater than date","schema":{"type":"string"},"example":"2025-01-01"},{"name":"last_sold_date_lte","in":"query","required":false,"description":"Less than or equal to date","schema":{"type":"string"},"example":"2025-01-03"},{"name":"last_sold_date_lt","in":"query","required":false,"description":"Less than date","schema":{"type":"string"},"example":"2025-01-03"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/realestate-pending":{"get":{"tags":["Real Estate"],"summary":"Pending Sales","description":"Properties with pending sales (under contract, contingent), one ZIP code and a short date range at a time. For search with filters across a whole city, county or state, use /properties.\n\nRequired: zip_code AND one date filter. Use EITHER pending_date operators OR list_date operators (not both). Available: pending_date, pending_date_between, pending_date_gte, pending_date_gt, pending_date_lte, pending_date_lt, list_date, list_date_between, list_date_gte, list_date_gt, list_date_lte, list_date_lt. Max 3-day span for range operations.","operationId":"realestate_pending","parameters":[{"name":"zip_code","in":"query","required":true,"description":"ZIP/postal code","schema":{"type":"string"},"example":"77493"},{"name":"pending_date","in":"query","required":false,"description":"Exact pending date match (YYYY-MM-DD)","schema":{"type":"string"},"example":"2025-10-28"},{"name":"pending_date_between","in":"query","required":false,"description":"Pending date range (max 3-day span)","schema":{"type":"string"},"example":"2025-10-26,2025-10-28"},{"name":"pending_date_gte","in":"query","required":false,"description":"Pending date greater than or equal","schema":{"type":"string"},"example":"2025-10-26"},{"name":"pending_date_gt","in":"query","required":false,"description":"Pending date greater than","schema":{"type":"string"},"example":"2025-10-26"},{"name":"pending_date_lte","in":"query","required":false,"description":"Pending date less than or equal","schema":{"type":"string"},"example":"2025-10-28"},{"name":"pending_date_lt","in":"query","required":false,"description":"Pending date less than","schema":{"type":"string"},"example":"2025-10-28"},{"name":"list_date","in":"query","required":false,"description":"Exact list date match (YYYY-MM-DD)","schema":{"type":"string"},"example":"2025-10-20"},{"name":"list_date_between","in":"query","required":false,"description":"List date range (max 3-day span)","schema":{"type":"string"},"example":"2025-10-18,2025-10-20"},{"name":"list_date_gte","in":"query","required":false,"description":"List date greater than or equal","schema":{"type":"string"},"example":"2025-10-18"},{"name":"list_date_gt","in":"query","required":false,"description":"List date greater than","schema":{"type":"string"},"example":"2025-10-18"},{"name":"list_date_lte","in":"query","required":false,"description":"List date less than or equal","schema":{"type":"string"},"example":"2025-10-20"},{"name":"list_date_lt","in":"query","required":false,"description":"List date less than","schema":{"type":"string"},"example":"2025-10-20"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/realestate-rent":{"get":{"tags":["Real Estate"],"summary":"Rental Properties","description":"Properties available for rent with rental prices and details, one ZIP code and a short date range at a time. For search with filters across a whole city, county or state, use /properties.\n\nRequired: zip_code AND one date filter. Available operators: list_date (exact), list_date_between, list_date_gte, list_date_gt, list_date_lte, list_date_lt. Max 3-day span for range operations.","operationId":"realestate_rent","parameters":[{"name":"zip_code","in":"query","required":true,"description":"ZIP/postal code","schema":{"type":"string"},"example":"77493"},{"name":"list_date","in":"query","required":false,"description":"Exact date match (YYYY-MM-DD)","schema":{"type":"string"},"example":"2025-01-03"},{"name":"list_date_between","in":"query","required":false,"description":"Date range (YYYY-MM-DD,YYYY-MM-DD, max 3-day span)","schema":{"type":"string"},"example":"2025-01-01,2025-01-03"},{"name":"list_date_gte","in":"query","required":false,"description":"Greater than or equal to date","schema":{"type":"string"},"example":"2025-01-01"},{"name":"list_date_gt","in":"query","required":false,"description":"Greater than date","schema":{"type":"string"},"example":"2025-01-01"},{"name":"list_date_lte","in":"query","required":false,"description":"Less than or equal to date","schema":{"type":"string"},"example":"2025-01-03"},{"name":"list_date_lt","in":"query","required":false,"description":"Less than date","schema":{"type":"string"},"example":"2025-01-03"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/property-tax":{"get":{"tags":["Real Estate"],"summary":"Property Tax","description":"Property tax information and rates by location.\n\nRequired: At least ONE of zip, city, or county. Optional: state can be added for more specific results.","operationId":"property_tax","parameters":[{"name":"zip","in":"query","required":false,"description":"ZIP code (at least ONE filter required)","schema":{"type":"string"},"example":"77493"},{"name":"city","in":"query","required":false,"description":"City name (at least ONE filter required)","schema":{"type":"string"},"example":"Katy"},{"name":"county","in":"query","required":false,"description":"County name (at least ONE filter required)","schema":{"type":"string"},"example":"Harris"},{"name":"state","in":"query","required":false,"description":"State abbreviation","schema":{"type":"string"},"example":"TX"}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/flood-insurance":{"get":{"tags":["Flood Claims & Disasters"],"summary":"Flood Insurance Claims","description":"Flood insurance claims, payouts, policies, coverage and premiums by area and year, from official public data: claims by the year of the flood since 1978 (claims filed, claims paid, building, contents and rebuild-to-code payments, total and average paid) and policies by the year a one-year policy starts since 2009 (policies, coverage, premium and average premium), for every ZIP code, county and state and the US.\n\nThe answer is {total, limit, offset, sort, order, years, rows, about}. /flood-insurance/ranking takes metric (claims, paid_claims, paid_total, avg_paid, policies, coverage_total, premium, avg_premium or claims_per_1000_policies), area_type (state, county or zip), state, county_fips, year or year_from/year_to, min_policies, order, limit and offset.","operationId":"flood_insurance","parameters":[{"name":"zip","in":"query","required":false,"description":"5-digit ZIP code(s), comma-separated","schema":{"type":"string"},"example":"77002"},{"name":"county","in":"query","required":false,"description":"County name (with state)","schema":{"type":"string"},"example":"Harris"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code(s); with area_type=zip the ZIP codes of these counties","schema":{"type":"string"},"example":"48201"},{"name":"state","in":"query","required":false,"description":"2-letter code or name","schema":{"type":"string"},"example":"TX"},{"name":"area_type","in":"query","required":false,"description":"country, state, county or zip (comma-separated)","schema":{"type":"string"},"example":"county"},{"name":"year","in":"query","required":false,"description":"A year, latest, current or all","schema":{"type":"string"},"example":"all"},{"name":"sort","in":"query","required":false,"description":"year, area_name, claims, paid_total, avg_paid, policies, premium, avg_premium and more","schema":{"type":"string"},"example":"paid_total"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}},"/disasters":{"get":{"tags":["Flood Claims & Disasters"],"summary":"Declared Disasters","description":"Disasters and emergencies declared by the federal government since 1953, from official public data: declaration id and number, type (major disaster, emergency, fire management), incident type (hurricane, flood, severe storm, fire and more), title, declaration and incident dates, the help programs declared, and the counties, places, tribal areas or whole states named.\n\nThe answer is {total, view, limit, offset, sort, order, rows, about}. /disasters/summary takes group_by (year, month, incident_type, state or declaration_type) and the same filters, and answers {group_by, total_declarations, rows, about}.","operationId":"disasters","parameters":[{"name":"county","in":"query","required":false,"description":"County name (with state)","schema":{"type":"string"},"example":"Harris"},{"name":"county_fips","in":"query","required":false,"description":"5-digit county FIPS code(s)","schema":{"type":"string"},"example":"48201"},{"name":"state","in":"query","required":false,"description":"2-letter code or name","schema":{"type":"string"},"example":"TX"},{"name":"incident_type","in":"query","required":false,"description":"Incident type(s), comma-separated","schema":{"type":"string"},"example":"Hurricane,Flood"},{"name":"declaration_type","in":"query","required":false,"description":"major_disaster, emergency or fire_management","schema":{"type":"string"},"example":"major_disaster"},{"name":"year","in":"query","required":false,"description":"Declarations of one year","schema":{"type":"string"},"example":"2024"},{"name":"view","in":"query","required":false,"description":"declarations or areas","schema":{"type":"string"},"example":"declarations"},{"name":"limit","in":"query","required":false,"description":"Rows per page, 1 to 1000 (default 100)","schema":{"type":"integer"},"example":100},{"name":"offset","in":"query","required":false,"description":"Rows to skip, for paging","schema":{"type":"integer"},"example":0}],"responses":{"200":{"description":"Successful response (JSON).","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"No API key in the request."},"403":{"description":"The API key is not valid or has expired."}}}}},"components":{"securitySchemes":{"apiKey":{"type":"apiKey","in":"query","name":"apikey","description":"Your DataPorium API key."}}}}