Server definition
- Hash
- sha256:9a782636e6ab63f004734012308f72190d6b6b7d4c64c5d45fafbb30bb9bf664
- What it is
- What a remote MCP server returned when asked what it offers: 41 tools
The blob, as servednamed by its sha256
{
"instructions": "Dataporium financial and real-estate data (dataporium.tech).\nTips:\n- Most tools need one main filter, usually a ticker `symbol` (e.g. AAPL) or `company_name`. If you only know a name,\n call search_symbols first.\n- If the API answers with an error that says which filter is required, call the tool again with that filter.\n- Every tool accepts `filters`: extra API parameters as a dictionary. Call list_filters(dataset) to see them.\n- Results are capped at 100 rows per call; use `limit`/`page` (when the plan allows) or narrower filters for more.\n- Dates are YYYY-MM-DD. Money values are in the currency the data states (usually USD).\n\nBroad research (the user names no specific company or place, e.g. \"which stocks look undervalued?\",\n\"which cities are good for rental investment?\"):\n1. Screen first. screen_stocks and search_housing_areas rank the whole universe in ONE call (the database does the\n work); screen_ma_deals does the same for M&A. Call describe_screen_fields first to see the fields, units and\n typical ranges, then choose realistic thresholds (e.g. near the 10th/90th percentile) instead of guessing.\n2. Look from 2-3 angles with separate screens (for stocks e.g. value, growth, quality; for places e.g. rent yield,\n price growth, safety). Names that appear in several screens are the strongest candidates.\n3. Shortlist 3-5, then use detail tools only for those (get_company_profile, get_financial_statements,\n get_stock_news, get_housing_area_insights, search_properties).\n4. Keep a research question to about 15-20 tool calls. Never loop over hundreds of symbols or ZIP codes one by one.\n5. In the answer, state the filters used and the data date, and say it is research, not financial advice.\n\nHomes (US): search_properties finds homes in a ZIP, city, county or state (for sale, pending, for rent, sold in the\nlast 12 months, off market) with clean facts: real listed date and days on market, relists, price cuts, the whole\nselling effort, and comparisons with nearby homes and the area. get_property gives everything about one home, by\nproperty_id or by an address in any spelling. Both answers include website_link: share it with the user so they\ncan see the homes on the map at dataporium.tech.\n\nAreas (US): get_housing_area_insights gives the full picture of ONE area (a ZIP, city, county, metro or state):\nhousing market, property tax, crime, demographics, climate and environmental risk, air quality, the\nneighborhood profile, local jobs and pay, new home permits, people moving in and out, and gas prices; add\ninclude=[\"market_history\"] for the long monthly time series. search_housing_areas finds\nand ranks many areas at once. Crime figures come from the police agency named in source_note, which is not always\nthe place's own department: always quote source_note when you show crime numbers.\n\nRates, inflation and trade (US): get_economic_metrics also gives the Treasury yield curve (economic_metrics\n\"yield_curve\" or \"treasury_yields\"), Federal Reserve rate decisions with the current target range and the next FOMC\nmeeting (\"fed_decisions\"), inflation by category (\"inflation_by_category\"), high-grade corporate bond yields\n(\"corporate_bond_yields\") and US imports, exports and trade balance by country and product (\"us_trade\",\n\"us_trade_top\"). Share website_link.\n\nRegulatory pathways: get_healthcare_market also explains how medicines and medical devices get approved in the largest markets (datasets \"regulatory_markets\", \"regulatory_pathways\" with jurisdiction and segment, \"regulatory_pathway\" with pathway_id for the steps, requirements, time targets, fees and reliance, \"regulatory_compare\" for two to eight markets side by side) and gives approvals across markets (\"regulatory_approvals\", \"regulatory_approval_stats\", \"regulatory_review_times\", \"regulatory_first_approvals\", \"regulatory_companies\"), fees (\"regulatory_fees\") and rule changes (\"regulatory_changes\"). Always say it is not legal or regulatory advice and give the last_verified date. Share website_link.\n\nDrug pipeline and short interest: get_healthcare_market also gives US drug approvals (dataset \"drug_approvals\",\n\"drug_approval_summary\", \"drug_approval_companies\"; novel_drug marks the first approval of a new active ingredient)\nand every registered clinical trial (dataset \"clinical_trials\" to search by symbol, query, phase and status,\n\"clinical_trial_summary\" for counts by phase, status, condition or sponsor, and \"clinical_trial\" with trial_id for\nthe full record: eligibility, outcomes and every site). get_short_interest gives the shares sold short twice a month\nsince 2017 for one symbol (view \"history\") or the most shorted stocks (view \"most_shorted\"). Share website_link.\n\nHealthcare providers (US): search_healthcare_providers finds hospitals (default), health systems, any provider with\nan NPI (doctors, nurse practitioners, clinics, pharmacies), Medicare group practices, yearly hospital financials and\nhospital quality measures, with counts for maps and rankings. get_healthcare_provider gives the full profile of one\nNPI, hospital (CCN), health system or group practice with every mapped link (all by keys, with match method and\nconfidence): hospital financials by year, quality with national medians, the system's hospitals and the listed owner\n(ticker, e.g. HCA, THC, CYH, UHS). The same two tools cover Medicare use and money: search_healthcare_providers kinds\nprocedures / procedure_codes / procedure_providers (services and payments per doctor and code), lab_tests,\nhospital_procedures (stays per DRG, outpatient services per APC), prescriptions / drugs / prescribers / drug_profile\n(Medicare drug claims and cost per prescriber and drug), drug_spending, medicaid_drugs (per state and NDC), payments /\npayment_companies / payment_recipients (company payments to doctors and teaching hospitals) and company_summary (a\nlisted company's Medicare drug spending and payments to doctors); get_healthcare_provider adds the parts procedures,\nlab_tests, prescriptions and payments. Labs and devices (same two tools): kinds labs, lab_counts, lab_companies,\nlab_test_segments (Medicare tests by lab segment and test category), device_procedures (Medicare procedures by device\ncategory, code and place), device_hospital_procedures, medical_equipment, device_approvals, device_recalls,\ndevice_adverse_events, device_companies (device makers by ticker, e.g. MDT, ABT, BSX), and device_procedures_icd\n(California only, all payers; always show its \"attribution\" source line with those numbers). Procedure codes are\nshown as numbers with public categories. Share website_link.\n\nCongress trades: get_politician_trades gives the stock trades that members of the US Congress report in their\nofficial House and Senate financial disclosure filings (view trades, summary, members or symbols). Amounts are\nranges, not exact values, and a trade can be filed up to 45 days after it happens (sometimes later). Share website_link.",
"tools": [
{
"description": "Fields you can filter and rank on in screen_stocks (dataset \"stocks\") and search_housing_areas (dataset\n \"areas\"), with unit, description and typical range (10th, 50th, 90th percentile). Call this before screening to\n choose realistic thresholds. For areas pass the level you will search (ranges differ between states, cities and\n ZIPs).",
"inputSchema": {
"properties": {
"dataset": {
"description": "'stocks' for screen_stocks fields or 'areas' for search_housing_areas fields.",
"enum": [
"stocks",
"areas"
],
"title": "Dataset",
"type": "string"
},
"level": {
"anyOf": [
{
"enum": [
"zip",
"city",
"county",
"metro",
"state"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "For areas: the level you will search ('state', 'county', 'metro', 'city' or 'zip').",
"title": "Level"
}
},
"required": [
"dataset"
],
"title": "describe_screen_fieldsArguments",
"type": "object"
},
"name": "describe_screen_fields",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Revenue by business segment, product and geography, from company filings.\n period=\"annual\" (default): yearly breakdown. period=\"quarter\": revenue per fiscal quarter (needs symbol) by\n perspective: segment, product, region, country, end_market, channel, customer or subsegment (comma-separated;\n default all), or perspective=\"views\" to list which views the company has and how many quarters each covers.\n Quarter rows: fiscal_period (e.g. 2025Q4), period_end, period_weeks (12 to 16), revenue, total_revenue,\n share_of_total_revenue, member_role (operating, corporate, elimination), is_leaf (never add a parent row to its\n children), is_derived (Q4 calculated as full year minus Q1 to Q3) and quality_flags. Filter with fiscal_year\n and fiscal_yearqtr (e.g. 2025Q2), or filters such as from_date, to_date, fiscal_quarter, leaf_only,\n include_derived, latest_only, limit. Without a year the newest 12 quarters are returned.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"fiscal_year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Fiscal year, e.g. 2025.",
"title": "Fiscal Year"
},
"fiscal_yearqtr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Fiscal year and quarter together, e.g. '2025Q2'.",
"title": "Fiscal Yearqtr"
},
"period": {
"default": "annual",
"description": "Time period, e.g. '2024' or '2024-06'.",
"enum": [
"annual",
"quarter"
],
"title": "Period",
"type": "string"
},
"perspective": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Perspective"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"title": "get_business_segmentsArguments",
"type": "object"
},
"name": "get_business_segments",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Market calendars: 'earnings_splits' (earnings dates and stock splits, filter by symbol), 'ipo' (upcoming and\n recent IPOs), 'economic' (economic events like CPI or Fed decisions, filter by event_name/country).",
"inputSchema": {
"properties": {
"calendar_month": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Calendar month number, 1 to 12.",
"title": "Calendar Month"
},
"calendar_year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Calendar year, e.g. 2026.",
"title": "Calendar Year"
},
"country": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Country name, e.g. 'United States'.",
"title": "Country"
},
"event_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name of an economic event, e.g. 'CPI' or 'Fed Interest Rate Decision'.",
"title": "Event Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"kind": {
"description": "'earnings_splits' for earnings dates and stock splits, 'ipo' for IPOs, 'economic' for economic events.",
"enum": [
"earnings_splits",
"ipo",
"economic"
],
"title": "Kind",
"type": "string"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"required": [
"kind"
],
"title": "get_calendarArguments",
"type": "object"
},
"name": "get_calendar",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Commodity futures prices, e.g. GC=F gold, SI=F silver, CL=F crude oil, NG=F natural gas. interval '1d' or '5m';\n points = how many of the newest bars to return (default 250).",
"inputSchema": {
"properties": {
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"interval": {
"default": "1d",
"description": "'1d' for daily bars or '5m' for 5-minute bars.",
"enum": [
"1d",
"5m"
],
"title": "Interval",
"type": "string"
},
"points": {
"default": 250,
"description": "How many of the newest bars to return (default 250, about one trading year of daily bars).",
"title": "Points",
"type": "integer"
},
"symbol": {
"description": "Commodity futures symbol, e.g. 'GC=F' (gold), 'SI=F' (silver), 'CL=F' (crude oil), 'NG=F' (natural gas).",
"title": "Symbol",
"type": "string"
}
},
"required": [
"symbol"
],
"title": "get_commodity_pricesArguments",
"type": "object"
},
"name": "get_commodity_prices",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Investor presentations (slide decks with links) or press releases of a company.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"kind": {
"description": "'presentations' for investor slide decks, 'press_releases' for company press releases.",
"enum": [
"presentations",
"press_releases"
],
"title": "Kind",
"type": "string"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"required": [
"kind"
],
"title": "get_company_documentsArguments",
"type": "object"
},
"name": "get_company_documents",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Logo image URL of a company.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"title": "get_company_logoArguments",
"type": "object"
},
"name": "get_company_logo",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Company profile and fundamentals: sector, industry, description, address, employees, market cap, valuation\n ratios, dividends, analyst targets and more (also used by the stock screener).",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"limit": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum number of rows to return.",
"title": "Limit"
},
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Page number for paging through long results, starting at 1.",
"title": "Page"
},
"sort_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Field to sort the results by.",
"title": "Sort By"
},
"sort_order": {
"anyOf": [
{
"enum": [
"asc",
"desc"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Sort direction: 'asc' (ascending) or 'desc' (descending).",
"title": "Sort Order"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"title": "get_company_profileArguments",
"type": "object"
},
"name": "get_company_profile",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Earnings call transcripts. Filter by fiscal_year and fiscal_qtr (e.g. Q3) to get one call; transcripts are long.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"fiscal_qtr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Fiscal quarter, e.g. 'Q2'.",
"title": "Fiscal Qtr"
},
"fiscal_year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Fiscal year, e.g. 2025.",
"title": "Fiscal Year"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"title": "get_earnings_transcriptsArguments",
"type": "object"
},
"name": "get_earnings_transcripts",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "US economic data. economic_metrics is either a time series name: GDP, real_GDP, real_GDP_Per_Capita,\n nominal_Potential_GDP, CPI, inflation, inflation_Rate, federal_Funds, unemployment_Rate, total_Non_farm_Payroll,\n initial_Claims, retail_Sales, consumer_Sentiment, durable_Goods, industrial_Production_Total_Index,\n new_Privately_Owned_HousingUnits_Started_Total_Units, total_Vehicle_Sales, retail_Money_Funds,\n smoothed_US_Recession_Probabilities, 30Year_Fixed_Rate_Mortgage_Average, 15Year_Fixed_Rate_Mortgage_Average,\n commercial_Bank_Interest_Rate_On_Credit_Card_Plans__All_Accounts,\n 3Month_Or_90Day_Rates_And_Yields_Certificates_Of_Deposit;\n or one of these data sets (put their options in filters):\n - \"yield_curve\": the US Treasury yield curve (1 month to 30 years, percent) on the newest day, compared with 1\n month and 1 year earlier, with the 10y-2y and 10y-3m spreads. date = another day; filters {\"compare\": \"1w,1m,1y\"}.\n - \"treasury_yields\": daily Treasury yields from 1990. filters {\"maturity\": \"2y,10y\", \"date_from\": \"2024-01-01\",\n \"date_to\": ..., \"frequency\": \"daily|weekly|monthly\", \"limit\": 100}.\n - \"fed_decisions\": Federal Reserve (FOMC) rate decisions since 1994 with the target range, the change in basis\n points, the current target range and the NEXT MEETING date. filters {\"decision\": \"hike|cut|hold\", \"year\": 2024,\n \"status\": \"upcoming\"}.\n - \"inflation_by_category\": consumer prices for 25 categories (core, food, food at home, energy, gasoline,\n electricity, shelter, rent, new and used vehicles, car insurance, airline fares, apparel, medical care,\n services ...): yoy_pct (12-month change) and mom_pct (1-month change, seasonally adjusted). filters\n {\"latest\": true, \"sort\": \"yoy_pct\"} ranks the categories rising fastest; {\"category\": \"gasoline,shelter\",\n \"month_from\": \"2024-01\"} gives history.\n - \"corporate_bond_yields\": yields of high-grade (AAA to A) corporate bonds for 2, 5, 10 and 30 years, monthly\n from 1984, with the spread over Treasury yields.\n - \"us_trade\": US goods exports, imports and trade balance by month from 2015 (US dollars, not seasonally\n adjusted). filters {\"dimension\": \"total\"} or {\"dimension\": \"country\", \"code\": \"5700\"} (China; 1220 Canada,\n 2010 Mexico) or {\"dimension\": \"product\", \"q\": \"vehicles\"} (2-digit HS chapters).\n - \"us_trade_top\": top trading partners or product groups over a period. filters {\"dimension\": \"country|product\",\n \"period\": \"last_12_months|ytd|year|month\", \"year\": 2025, \"sort\": \"total_trade|exports|imports|balance\",\n \"order\": \"asc\"} (balance asc = largest deficits).\n Data sets answer with website_link: share it.",
"inputSchema": {
"properties": {
"date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Date filter in YYYY-MM-DD format, e.g. '2026-06-30'.",
"title": "Date"
},
"economic_metrics": {
"description": "Name of the US economic series, e.g. 'CPI', 'unemployment_Rate', 'federal_Funds' or '30Year_Fixed_Rate_Mortgage_Average' (the full list is in the tool description), or a data set: 'yield_curve', 'treasury_yields', 'fed_decisions', 'inflation_by_category', 'corporate_bond_yields', 'us_trade' or 'us_trade_top'.",
"title": "Economic Metrics",
"type": "string"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
}
},
"required": [
"economic_metrics"
],
"title": "get_economic_metricsArguments",
"type": "object"
},
"name": "get_economic_metrics",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "US election results with margins, swing, turnout and partisan lean. Coverage: president and US Senate by state\n for every election 1976 to 2024, US House by district 1976 to 2024 and county results of the presidential race 2000 to 2024;\n county, city or town, congressional district and precinct results, governors, other statewide offices, state legislature\n seats and statewide ballot measures for 2016, 2018, 2020, 2022 and 2024. Results\n are certified; election-night rows (status live) are unofficial counts and a race is only called when called_at\n is set. party_margin/rd_margin_pct = Republican share minus Democratic share in points (positive = Republican\n lead, R+3.2 means Republicans led by 3.2 points); swing_pct is the change of that margin against the previous\n comparable race in the same area (positive = toward Republicans); flipped = the winning party changed.\n view \"races\" (default): races with winner or leader, runner-up, votes and shares, margin, swing, flip; filter by\n year, office (president, us_senate, us_house, governor, lt_governor, attorney_general, secretary_of_state,\n treasurer, other_statewide, state_senate, state_house, ballot_measure, judicial; several with commas), state\n (two-letter code), name (race or candidate text) and filters such as {\"margin_max\": 5} (close races), {\"flipped\":\n true}, {\"winner_party\": \"R\"}, {\"status\": \"live\"}. Each row has race_id: use it as `race` in view \"results\".\n view \"results\": one race (race = race_id such as \"2024-president\", \"2024-us-senate-tx\", \"2022-governor-az\") with\n every candidate (votes and share) and the result by area: level state, county, cousub (city or town), cd\n (district) or precinct (precinct needs county = 5-digit code); state limits to a state; name searches area names;\n sort total_votes, rd_margin, swing, dem_pct, rep_pct, turnout or name.\n view \"candidates\": people who ran: name, state, office, year, filters {\"party\": \"D\", \"won\": true, \"in_congress\":\n true}; with slug (from a candidate row) one candidate with every race.\n view \"geography\": one area with its races, partisan lean, bellwether record, split tickets, turnout and\n demographics: level state, county, cousub, cd or national and area_code (state: 2-digit code such as 48; county:\n 5-digit code such as 48453), or for a county give state and county name instead of area_code.\n view \"area\": the latest elections for a state, county (name) and/or city in one call (state, county, city).\n view \"summary\": analysis = trend (national presidential vote by year), seats (seats won by party and change),\n legislatures (control of state legislature chambers), flips and swing (areas that changed party or moved most;\n year, office, level state or county), bellwethers, split_tickets, lean (partisan lean index), demographics\n (county results next to income, education, age and race) or coverage (what is loaded).\n view \"turnout\": turnout by state or county and year (share of citizen voting-age adults, registered voters where\n reported); level state or county, state, name, filters {\"min_turnout\": 60}.\n On election night the answer also has election_night_note (\"Election night: unofficial, still counting, last\n update HH:MM UTC\"): share it; live rows are only ever \"Leading\" (leader_label), never a winner.\n The answer has website_link: share it so the user can see the pages on dataporium.tech.",
"inputSchema": {
"properties": {
"analysis": {
"anyOf": [
{
"enum": [
"trend",
"seats",
"legislatures",
"flips",
"swing",
"bellwethers",
"split_tickets",
"lean",
"demographics",
"coverage"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "For view 'summary': trend, seats, legislatures, flips, swing, bellwethers, split_tickets, lean, demographics or coverage.",
"title": "Analysis"
},
"area_code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Area code: 2-digit state code (48), 5-digit county code (48453) or 10-digit city or town code.",
"title": "Area Code"
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "City or town name (with state), for view 'area'.",
"title": "City"
},
"county": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "County name, e.g. 'Travis' (with state), or for precinct results the 5-digit county code.",
"title": "County"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Extra API filters, e.g. {\"margin_max\": 5, \"flipped\": true}. list_filters('get_election_results') shows all.",
"title": "Filters"
},
"level": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Area level: state, county, cousub (city or town), cd (congressional district), precinct or national; for turnout state or county.",
"title": "Level"
},
"limit": {
"default": 25,
"description": "Rows to return, 1 to 100 (default 25).",
"title": "Limit",
"type": "integer"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Text to search: a race or candidate name, or an area name.",
"title": "Name"
},
"office": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Office: president, us_senate, us_house, governor, lt_governor, attorney_general, secretary_of_state, treasurer, other_statewide, state_senate, state_house, ballot_measure or judicial; several separated by commas.",
"title": "Office"
},
"offset": {
"default": 0,
"description": "Rows to skip, for the next page.",
"title": "Offset",
"type": "integer"
},
"order": {
"anyOf": [
{
"enum": [
"asc",
"desc"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Order"
},
"race": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A race_id from view 'races', e.g. '2024-president', '2024-us-senate-tx' or '2022-governor-az'.",
"title": "Race"
},
"slug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Candidate slug from a candidates row, for one candidate with every race.",
"title": "Slug"
},
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Sort field (depends on the view, e.g. year, margin, total_votes, rd_margin, swing, turnout, name).",
"title": "Sort"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Two-letter state code, e.g. 'TX'.",
"title": "State"
},
"view": {
"default": "races",
"description": "'races' (list races), 'results' (one race by area), 'candidates', 'geography' (one area in full), 'area' (latest elections of a state, county or city), 'summary' (analysis, see analysis) or 'turnout'.",
"enum": [
"races",
"results",
"candidates",
"geography",
"area",
"summary",
"turnout"
],
"title": "View",
"type": "string"
},
"year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Election year, e.g. 2024.",
"title": "Year"
}
},
"title": "get_election_resultsArguments",
"type": "object"
},
"name": "get_election_results",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "US energy data from official US government sources. category e.g. petroleum, natural-gas, electricity, coal,\n co2-emissions, total-energy; location e.g. a state code (TX); period e.g. 2024; period_type annual/monthly.\n category \"gas_prices\" gives weekly retail pump prices (US dollars per gallon, taxes included) for the US, its fuel\n regions, 9 states and 10 cities: dataset = product (regular, midgrade, premium, all_grades, diesel; default all),\n location = US, a state code (CA, CO, FL, MA, MN, NY, OH, TX, WA), a region code (R1 East Coast, R1A New England,\n R1B Central Atlantic, R1C Lower Atlantic, R2 Midwest, R3 Gulf Coast, R4 Rocky Mountain, R5 West Coast, R5X West\n Coast except California) or a city (Boston, Chicago, Cleveland, Denver, Houston, Los Angeles, Miami, New York City,\n San Francisco, Seattle); period = a year (2024) or month (2024-06) for history; without period you get the newest\n week with the change from 1, 4 and 52 weeks earlier. Website: https://dataporium.tech/energy?tab=gas-prices.",
"inputSchema": {
"properties": {
"category": {
"description": "Energy data category, e.g. 'petroleum', 'natural-gas', 'electricity', 'coal', 'co2-emissions', 'total-energy', or 'gas_prices' for weekly retail pump prices.",
"title": "Category",
"type": "string"
},
"dataset": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional dataset within the category. Leave empty to see what is available.",
"title": "Dataset"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"location": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Location code, e.g. a US state code such as 'TX'.",
"title": "Location"
},
"period": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Time period, e.g. '2024' or '2024-06'.",
"title": "Period"
},
"period_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Reporting period, e.g. 'annual' or 'quarterly'.",
"title": "Period Type"
}
},
"required": [
"category"
],
"title": "get_energy_dataArguments",
"type": "object"
},
"name": "get_energy_data",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Stock exchange trading hours or holidays. exchange e.g. NYSE, NASDAQ, LSE.",
"inputSchema": {
"properties": {
"exchange": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Stock exchange, e.g. 'NYSE', 'NASDAQ' or 'LSE'.",
"title": "Exchange"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"kind": {
"description": "'hours' for trading hours or 'holidays' for market holidays.",
"enum": [
"hours",
"holidays"
],
"title": "Kind",
"type": "string"
}
},
"required": [
"kind"
],
"title": "get_exchange_scheduleArguments",
"type": "object"
},
"name": "get_exchange_schedule",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Financial statements (income statement, balance sheet, cash flow). summary=True returns the compact\n summary version with the key lines. Filter by fiscal_year (e.g. 2025), fiscal_qtr (e.g. Q2) or\n fiscal_year_qtr (e.g. 2025Q2); period_type e.g. annual or quarterly. Each period has data_status: \"final\", or\n \"temporary\" for a quarter the company has just reported that is shown early with only the lines already\n confirmed; the final numbers replace it later.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"fiscal_qtr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Fiscal quarter, e.g. 'Q2'.",
"title": "Fiscal Qtr"
},
"fiscal_year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Fiscal year, e.g. 2025.",
"title": "Fiscal Year"
},
"fiscal_year_qtr": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Fiscal year and quarter together, e.g. '2025Q2'.",
"title": "Fiscal Year Qtr"
},
"period_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Reporting period, e.g. 'annual' or 'quarterly'.",
"title": "Period Type"
},
"statement": {
"description": "Which financial statement: 'income', 'balance_sheet' or 'cash_flow'.",
"enum": [
"income",
"balance_sheet",
"cash_flow"
],
"title": "Statement",
"type": "string"
},
"summary": {
"default": false,
"description": "True returns the compact version with only the key lines; False returns every line item.",
"title": "Summary",
"type": "boolean"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"required": [
"statement"
],
"title": "get_financial_statementsArguments",
"type": "object"
},
"name": "get_financial_statements",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Currency exchange rates. currency_conversion like 'USD-EUR'. interval picks the bar size\n (5m and 1h cover recent days, 1d/1w/1mo cover years).",
"inputSchema": {
"properties": {
"currency_conversion": {
"description": "Currency pair as FROM-TO, e.g. 'USD-EUR', 'EUR-JPY' or 'GBP-USD'.",
"title": "Currency Conversion",
"type": "string"
},
"date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Date filter in YYYY-MM-DD format, e.g. '2026-06-30'.",
"title": "Date"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"interval": {
"default": "1d",
"description": "Bar size: '5m' and '1h' cover recent days; '1d', '1w' and '1mo' cover years.",
"enum": [
"5m",
"1h",
"1d",
"1w",
"1mo"
],
"title": "Interval",
"type": "string"
}
},
"required": [
"currency_conversion"
],
"title": "get_fx_ratesArguments",
"type": "object"
},
"name": "get_fx_rates",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "US federal government business of listed companies: federal contracts they win and the lobbying they pay for\n (official US government data). Contract totals include the units a company owns today, for all years (also years\n before it owned them); group_by \"unit\" with a symbol lists those units and their share.\n view \"contract_totals\" (default): contract obligations in US dollars (contracts of every size), group_by\n fiscal_year (default with a symbol), quarter (fiscal quarters), agency, unit or symbol (companies ranked, default\n without a symbol); filters e.g. {\"fiscal_year_from\": 2020, \"fiscal_year_to\": 2025}. US fiscal years run October to\n September. Groups have complete=false while late defense contracts can still come in (90 days).\n view \"contracts\": contract awards of $1 million or more, newest first: award_id, agency, sub_agency, amount (total\n obligated so far), award_date, start_date, end_date, description, product_category, industry, place of\n performance. Filter by symbol, q (words, e.g. \"F-35\"), agency (e.g. \"Department of Defense\"), fiscal_year,\n date_from/date_to; sort award_date or amount; filters e.g. {\"min_amount\": 100000000, \"state\": \"TX\",\n \"active_only\": true}.\n view \"lobbying_totals\": lobbying spending, group_by quarter, year (default with a symbol), symbol (companies\n ranked, default without a symbol), issue (general issue codes such as TAX, DEF, HCR, TRD with plain names),\n entity (government entities contacted) or registrant (outside lobbying firms). A quarter's total is the\n company's in-house expenses when it filed its own report (these include outside firms), else the outside\n firms' income.\n view \"lobbying\": the quarterly lobbying reports, newest first: lobbying firm or in-house, amount, issues with\n their descriptions, government entities contacted. Filter by symbol, q (words in the issues, e.g. \"tariffs\"),\n issue (codes, e.g. \"TAX,TRD\"), year; filters e.g. {\"in_house\": false, \"registrant\": \"Akin\", \"quarter\": 2}.\n Lobbying covers 2015 to today (reports are due 20 days after each quarter); contracts cover fiscal year 2015 to\n today. The answer has website_link: share it with the user.",
"inputSchema": {
"properties": {
"agency": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Agency"
},
"date_from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date in YYYY-MM-DD format.",
"title": "Date From"
},
"date_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date in YYYY-MM-DD format.",
"title": "Date To"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"fiscal_year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Fiscal year, e.g. 2025.",
"title": "Fiscal Year"
},
"group_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Group By"
},
"issue": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Issue"
},
"limit": {
"default": 25,
"description": "Maximum number of rows to return.",
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Number of rows to skip, for the next page of results (e.g. 20 after a first call with limit 20).",
"title": "Offset",
"type": "integer"
},
"q": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q"
},
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Sort order: newest, oldest, price_asc, price_desc, ppsf_asc, ppsf_desc (price per square foot), dom_asc, dom_desc (true days on market), biggest_cut, recent_cut, best_value (lowest price per sqft vs the ZIP median), sqft_desc, beds_desc, lot_desc or year_built_desc.",
"title": "Sort"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
},
"view": {
"default": "contract_totals",
"enum": [
"contracts",
"contract_totals",
"lobbying",
"lobbying_totals"
],
"title": "View",
"type": "string"
},
"year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Year"
}
},
"title": "get_government_activityArguments",
"type": "object"
},
"name": "get_government_activity",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Healthcare market data: drug/brand revenue by quarter (brand_revenue, filter symbol), company revenue by\n healthcare industry, market size by country/region, company market share, industry market size and therapy-area\n market size. industry values: Pharmaceutical, Medical Device, Diagnostic Life Science, Consumer Healthcare,\n Health Insurance, Healthcare, Distributor, Veterinary, and others.\n Drug pipeline (official US government data, updated daily):\n \"drug_approvals\": US drug approvals, newest first: original approvals of new drugs (NDA), biologics (BLA) and\n generics (ANDA), tentative approvals, and new uses (efficacy supplements); novel_drug = first approval of a new\n active ingredient. Filter by symbol (the listed company that holds the drug today), query (drug or company name),\n date_from/date_to; filters e.g. {\"novel_only\": true, \"application_type\": \"NDA,BLA\", \"approval_kind\": \"original\"}.\n \"drug_approval_summary\": counts by group_by (year, month, application_type, category, approval_kind or symbol).\n \"drug_approval_companies\": listed companies with their approval and novel drug counts (sort=\"novel_drugs\").\n \"clinical_trials\": registered clinical studies worldwide; filter by symbol (listed lead sponsor), query (words in\n title, conditions and drugs, e.g. \"obesity semaglutide\"), phase (early1, 1, 1/2, 2, 2/3, 3, 4, na), status\n (active, recruiting, completed, stopped, ...), date_from/date_to (start date); filters e.g. {\"condition\":\n \"Alzheimer\", \"sponsor\": \"Mayo Clinic\", \"country\": \"Germany\", \"has_results\": true}.\n \"clinical_trial_summary\": counts by group_by (phase, status, start_year, study_type, sponsor, symbol, condition or\n country) with active, recruiting, completed, stopped and phase 3 counts.\n \"clinical_trial\": the full record of one study by trial_id (e.g. \"NCT04184622\"): design, dates, enrollment,\n eligibility criteria, primary and secondary outcomes and every site.\n Regulatory pathways (how medicines and devices get approved; reviewed content, each with last_verified and a\n confidence level; not legal or regulatory advice):\n \"regulatory_markets\": the covered markets (codes like US, EU, GB, JP, CN, DE, CA, CH), segments and the shared\n pathway types. \"regulatory_pathways\": pathway cards; filter jurisdiction (e.g. \"US\" or \"DE\"; EU members include\n the EU-wide routes) and segment (drug, biologic, biosimilar, generic, otc, vaccine, atmp, combination, device,\n ivd, samd); filters e.g. {\"pathway_type\": \"conditional\", \"device_class\": \"II\", \"expedited_only\": true}.\n \"regulatory_pathway\": one pathway by pathway_id (from regulatory_pathways): steps with official day targets and\n clock stops, requirements, time targets, fees, reliance on other regulators, device classes, approvals per year;\n where published also scenarios (paths through decision points), the document checklist per step and the\n after-approval duties (lifecycle).\n \"regulatory_compare\": jurisdiction = 2 to 8 codes separated by commas (e.g. \"US,EU,JP\"), optional segment; routes\n lined up by pathway type with target days and fees.\n \"regulatory_approvals\": approvals from official regulator data across markets (filter jurisdiction, segment,\n symbol, query, date_from/date_to; filters e.g. {\"pathway_type\": \"biosimilar\", \"new_active_only\": true,\n \"expedited\": \"conditional\"}). \"regulatory_approval_stats\": counts with group_by (year, jurisdiction, segment,\n pathway_type, product_class, expedited, therapeutic_area; two with a comma, e.g. \"year,pathway_type\").\n \"regulatory_review_times\": actual review times per year, only where the official data has both dates.\n \"regulatory_first_approvals\": first approval date of a substance in each market (query = substance name).\n \"regulatory_companies\": listed companies ranked by approvals (jurisdiction or ALL). \"regulatory_fees\" and\n \"regulatory_changes\": official fees and rule changes or pending reforms.\n The drug pipeline and regulatory answers have website_link: share it with the user.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"dataset": {
"description": "Which dataset, e.g. 'brand_revenue', 'company_revenue', 'market_share', 'therapy_market_size', 'drug_approvals', 'clinical_trials' or 'clinical_trial' (one full study record).",
"enum": [
"brand_revenue",
"company_revenue",
"geo_market_size",
"market_share",
"industry_market_size",
"therapy_market_size",
"drug_approvals",
"drug_approval_summary",
"drug_approval_companies",
"clinical_trials",
"clinical_trial_summary",
"clinical_trial",
"regulatory_markets",
"regulatory_pathways",
"regulatory_pathway",
"regulatory_compare",
"regulatory_approvals",
"regulatory_approval_stats",
"regulatory_review_times",
"regulatory_fees",
"regulatory_changes",
"regulatory_first_approvals",
"regulatory_companies"
],
"title": "Dataset",
"type": "string"
},
"date_from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Drug approvals: approved on or after; clinical trials: started on or after (YYYY-MM-DD).",
"title": "Date From"
},
"date_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Drug approvals: approved on or before; clinical trials: started on or before (YYYY-MM-DD).",
"title": "Date To"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"group_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Only for the summary datasets. drug_approval_summary: year, month, application_type, category, approval_kind or symbol. clinical_trial_summary: phase, status, start_year, study_type, sponsor, symbol, condition or country.",
"title": "Group By"
},
"industry": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Healthcare industry, e.g. 'Pharmaceutical', 'Medical Device' or 'Health Insurance'.",
"title": "Industry"
},
"jurisdiction": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Regulatory datasets: market code(s), e.g. 'US', 'EU', 'GB', 'JP', 'DE'; for regulatory_compare 2 to 8 codes separated by commas, e.g. 'US,EU,JP'.",
"title": "Jurisdiction"
},
"limit": {
"default": 25,
"description": "Rows to return for the drug pipeline datasets, 1 to 100 (default 25).",
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Rows to skip, for the next page of the drug pipeline datasets.",
"title": "Offset",
"type": "integer"
},
"pathway_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Only for dataset 'regulatory_pathway': the pathway ID from regulatory_pathways, e.g. 'us-device-510k'.",
"title": "Pathway Id"
},
"phase": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Only for clinical trials: early1, 1, 1/2, 2, 2/3, 3, 4, na or none; several separated by commas.",
"title": "Phase"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Drug pipeline datasets: words to search, e.g. a drug ('semaglutide'), a condition ('obesity') or a company name.",
"title": "Query"
},
"segment": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Regulatory datasets: drug, biologic, biosimilar, generic, otc, vaccine, atmp (cell and gene therapy), combination, device, ivd or samd (software).",
"title": "Segment"
},
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Drug approvals: approval_date (default), brand_name or symbol. Clinical trials: last_update_posted (default), start_date, primary_completion_date, enrollment or phase. Summaries: e.g. trials, active_trials, novel_drugs.",
"title": "Sort"
},
"status": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Only for clinical trials: active, recruiting, not_yet_recruiting, active_not_recruiting, completed, stopped, terminated, withdrawn, suspended; several separated by commas.",
"title": "Status"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker. For brand_revenue the drug maker; for the drug pipeline datasets the listed company that holds the drug or leads the trial, e.g. 'LLY'.",
"title": "Symbol"
},
"trial_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Only for dataset 'clinical_trial': the trial ID (NCT number), e.g. 'NCT04184622'.",
"title": "Trial Id"
}
},
"required": [
"dataset"
],
"title": "get_healthcare_marketArguments",
"type": "object"
},
"name": "get_healthcare_market",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "The full profile of ONE healthcare entity, with every mapped link (all by keys, each with match_method and\n confidence). Give exactly one of:\n npi: a provider (10 digits): registry record with all specialties and the practice address, Medicare enrollment\n (specialty, medical school, graduation year, telehealth), group practices with their health system, and hospital\n affiliations; for an organization NPI the hospital (CCN) or group practice it belongs to.\n ccn: a hospital (6 characters, e.g. \"240010\"): profile, beds, star rating, organization NPIs, health system and\n listed owner, yearly financials (net patient revenue, operating and net income and margins, discharges, occupancy,\n uncompensated care) for every loaded fiscal year, quality measures with national medians, affiliated clinicians.\n system: a health system ID or slug (e.g. \"hca-healthcare\"; find it with search_healthcare_providers\n kind=\"health_systems\"): member hospitals, financial roll-up by year, linked group practices and the 2023 profile.\n group_pac_id: a Medicare group practice (10 digits): organization NPIs and its clinicians.\n Medicare parts (newest year in detail plus totals per year): for an npi \"procedures\" (top codes, payments),\n \"lab_tests\", \"prescriptions\" (top drugs, cost, opioid claims) and \"payments\" (money from drug and device companies:\n by year, company, nature and product); for a ccn \"procedures\" (stays per DRG and outpatient services per APC with\n the national average payment) and \"payments\" (teaching hospitals); for a system \"procedures\" and \"payments\".\n Labs and devices: \"labs\" (certified labs linked to the NPI, to the hospital, or the system's hospital labs) and for a\n ccn \"device_procedures\" (device-heavy stays by DRG and outpatient services by APC, per year).\n include: optional list of parts, e.g. [\"financials\", \"quality\"] for a hospital or [\"groups\", \"hospitals\"] for a\n provider, [\"prescriptions\"] for what a doctor prescribes (default: all parts). The answer has website_link: share\n it with the user.",
"inputSchema": {
"properties": {
"ccn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A hospital's 6-character certification number, e.g. '240010'.",
"title": "Ccn"
},
"group_pac_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A Medicare group practice ID (10 digits).",
"title": "Group Pac Id"
},
"include": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Parts to return, e.g. [\"financials\", \"quality\"] for a hospital, [\"groups\", \"hospitals\"] for a provider, [\"hospitals\", \"financials\"] for a system; Medicare parts: procedures, lab_tests, prescriptions, payments. Default: all.",
"title": "Include"
},
"npi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A 10-digit NPI of a clinician or an organization.",
"title": "Npi"
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A health system ID or slug, e.g. 'hca-healthcare'.",
"title": "System"
}
},
"title": "get_healthcare_providerArguments",
"type": "object"
},
"name": "get_healthcare_provider",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Full details of ONE US area in one call: the housing market, property tax, crime, demographics, climate and\n environmental risk, air quality and the neighborhood profile (schools, amenities, walkability, noise). Name the\n area with zip, or city + state, or county + state, or metro (e.g. 'Los Angeles, CA'), or just state; a state can\n be 'CA' or 'California'. Pick the parts with include: market (home value and rent levels, 1-year changes,\n forecast, homes for sale, and for metro areas also inventory, days to pending, price cuts and affordability),\n market_history (the long monthly time series of values and rents: only added when you ask for it, newest 24\n months by default, use months or date_from/date_to for other periods), tax, crime, demographics,\n environmental_hazards, climate_risk, air_quality, neighborhood_profile, elections (how the area voted in the latest\n presidential elections, Senate and governor races, partisan lean and turnout: \"how does X vote?\"), jobs (unemployment rate by month and\n average weekly pay: \"what is the unemployment rate in X?\"), permits (new homes approved by building permits: \"how\n many new homes are being built in X?\"), migration (people moving in and out, net, top origins and destinations:\n \"are people moving to X?\") and gas_prices (weekly pump prices of the closest area the survey covers). Jobs,\n permits and migration of a ZIP or city use its county (jobs use the city itself when it has 25,000+ people).\n Without include you get market, tax, crime, demographics, climate_risk, neighborhood_profile and jobs as a\n compact summary. A part with no data for that\n area says available false with the reason (crime and demographics for a ZIP use the ZIP's city). When you present\n crime data, quote the source_note that comes with it: it says whose figures these are (the place's own police\n department, a county sheriff, or a neighboring city when the place has none) and, for a ZIP code, that the figures\n are for the city. The answer has\n website_link to see the homes of the area on the map at dataporium.tech: share it. To compare or rank many\n areas use search_housing_areas; to list the homes of an area use search_properties.",
"inputSchema": {
"properties": {
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "City name, e.g. 'Irvine'. Add state (the same city name exists in several states).",
"title": "City"
},
"county": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "County name, e.g. 'Orange' (the word County is optional). Add state.",
"title": "County"
},
"date_from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Only for market_history: first date to return, YYYY-MM-DD (use instead of months).",
"title": "Date From"
},
"date_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Only for market_history: last date to return, YYYY-MM-DD.",
"title": "Date To"
},
"include": {
"anyOf": [
{
"items": {
"enum": [
"market",
"market_history",
"tax",
"crime",
"demographics",
"environmental_hazards",
"climate_risk",
"air_quality",
"neighborhood_profile",
"jobs",
"permits",
"migration",
"gas_prices",
"elections"
],
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Which parts to return: 'market', 'market_history', 'tax', 'crime', 'demographics', 'environmental_hazards', 'climate_risk', 'air_quality', 'neighborhood_profile', 'jobs', 'permits', 'migration', 'gas_prices'. Default: market, tax, crime, demographics, climate_risk, neighborhood_profile and jobs (a compact summary, no long history).",
"title": "Include"
},
"level": {
"anyOf": [
{
"enum": [
"zip",
"city",
"county",
"metro",
"state"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional: 'zip', 'city', 'county', 'metro' or 'state'. Normally not needed, it is worked out from what you give.",
"title": "Level"
},
"metro": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Metro area name as listed, e.g. 'Los Angeles, CA' or 'Dallas, TX'. Metro areas have market data only (no tax, crime or other parts).",
"title": "Metro"
},
"months": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Only for market_history: how many of the newest months to return for each series (default 24, up to 240).",
"title": "Months"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "US state as a 2-letter code or a name, e.g. 'CA' or 'California'. With city or county it says which state; alone it means the whole state.",
"title": "State"
},
"zip": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "5-digit US ZIP code of the area, e.g. '92618'. Use this OR city, county, metro or state.",
"title": "Zip"
}
},
"title": "get_housing_area_insightsArguments",
"type": "object"
},
"name": "get_housing_area_insights",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Industry and sector classification of a company (revenue-based sector/industry, NAICS sector, SIC category).",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"title": "get_industry_classificationArguments",
"type": "object"
},
"name": "get_industry_classification",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Insider trading: recent 'transactions', insiders' 'holdings_summary', or full 'transaction_history'.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"kind": {
"description": "'transactions' (recent trades), 'holdings_summary' or 'transaction_history'.",
"enum": [
"transactions",
"holdings_summary",
"transaction_history"
],
"title": "Kind",
"type": "string"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"required": [
"kind"
],
"title": "get_insider_activityArguments",
"type": "object"
},
"name": "get_insider_activity",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Mergers, acquisitions and investments. 'deals' = full deal records for a company (symbol/company_name),\n 'summary' = shorter records, 'flat' = one row per deal with filters like ticker_buyer, ticker_target,\n txn_stage, date_announced, 'reports' = aggregated counts by level/level_values, 'filters' = searchable deal list.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
},
"view": {
"default": "deals",
"description": "'deals' (full records for a company), 'summary', 'flat' (one row per deal), 'reports' (aggregated counts) or 'filters' (searchable deal list).",
"enum": [
"deals",
"summary",
"flat",
"reports",
"filters"
],
"title": "View",
"type": "string"
}
},
"title": "get_ma_transactionsArguments",
"type": "object"
},
"name": "get_ma_transactions",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Today's biggest stock gainers, losers or most active stocks.",
"inputSchema": {
"properties": {
"exchange": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Stock exchange, e.g. 'NYSE', 'NASDAQ' or 'LSE'.",
"title": "Exchange"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"status": {
"default": "gainer",
"description": "'gainer' for top gainers, 'loser' for top losers, 'active' for most traded stocks.",
"enum": [
"gainer",
"loser",
"active"
],
"title": "Status",
"type": "string"
}
},
"title": "get_market_moversArguments",
"type": "object"
},
"name": "get_market_movers",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Latest market-wide news by topic (general, stock, forex, crypto).",
"inputSchema": {
"properties": {
"page": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Page number for paging through long results, starting at 1.",
"title": "Page"
},
"topic": {
"default": "general",
"description": "News topic: 'general', 'stock', 'forex' or 'crypto'.",
"enum": [
"general",
"stock",
"forex",
"crypto"
],
"title": "Topic",
"type": "string"
}
},
"title": "get_market_newsArguments",
"type": "object"
},
"name": "get_market_news",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Option chain (calls and puts with strikes, expirations, prices, volume, open interest) for a stock.",
"inputSchema": {
"properties": {
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"symbol": {
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol",
"type": "string"
}
},
"required": [
"symbol"
],
"title": "get_options_chainArguments",
"type": "object"
},
"name": "get_options_chain",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "US patents granted to listed companies since 2015 (official US government data), listed under the company that\n owned the patent when it was granted.\n view \"totals\" (default): patent counts, group_by year (grant year, default with a symbol), section (technology\n section A to H or Y, plus design patents), cpc_class (technology class such as G06F computing or H01M batteries)\n or symbol (companies ranked by patents, default without a symbol). Each group: patents, claims, cited_by\n (citations from later US patents) and share.\n view \"patents\": the patents, newest first: patent_number, title, grant_date, filing_date, patent_type, cpc_main\n (main technology class) and section_name, claims, inventors, citations_made and cited_by. Filter by symbol,\n q (words in the title, e.g. \"battery\"), section, cpc_class, year_from/year_to; sort grant_date or cited_by (the\n most cited patents); filters e.g. {\"patent_type\": \"utility\", \"min_cited_by\": 10}.\n New patents are granted every Tuesday. The answer has website_link: share it with the user.",
"inputSchema": {
"properties": {
"cpc_class": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Cpc Class"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"group_by": {
"anyOf": [
{
"enum": [
"year",
"section",
"cpc_class",
"symbol"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Group By"
},
"limit": {
"default": 25,
"description": "Maximum number of rows to return.",
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Number of rows to skip, for the next page of results (e.g. 20 after a first call with limit 20).",
"title": "Offset",
"type": "integer"
},
"q": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Q"
},
"section": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Section"
},
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Sort order: newest, oldest, price_asc, price_desc, ppsf_asc, ppsf_desc (price per square foot), dom_asc, dom_desc (true days on market), biggest_cut, recent_cut, best_value (lowest price per sqft vs the ZIP median), sqft_desc, beds_desc, lot_desc or year_built_desc.",
"title": "Sort"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
},
"view": {
"default": "totals",
"enum": [
"patents",
"totals"
],
"title": "View",
"type": "string"
},
"year_from": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Year From"
},
"year_to": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Year To"
}
},
"title": "get_patentsArguments",
"type": "object"
},
"name": "get_patents",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Stock trades reported by members of the US Congress in their official financial disclosure filings: who\n traded, party, chamber, trade and filing dates, buy or sell, amount range. Data is delayed by law (filed up to\n 45 days after the trade).\n view \"trades\" (default): the trades, newest first; filter by symbol (e.g. NVDA, or several: \"AAPL,MSFT\"),\n member_name (part of a name, e.g. \"Pelosi\"), member_id, party (D, R or I), chamber, trade_type (buy or sell),\n date_from/date_to (trade dates, YYYY-MM-DD) or days (last N days). Each trade has the member, party on the trade\n date, state, ticker and company, asset_name and asset_class, buy or sell, the amount range as filed, held_by\n (Self, Spouse, Joint or Child), trade_date, filed_date, filing delay and filing_url (the official filing).\n view \"summary\": totals grouped by group_by (party, member, symbol, month, year, chamber, trade_type, asset_class,\n held_by, state, amount_bucket or delay_bucket): trades, buys, sells, estimated buy and sell value, net, members,\n symbols, average filing delay and late filings.\n view \"members\": members with trade counts, buys, sells, last trade, their most traded symbols and the family\n split (self_trades, spouse_trades, joint_trades, child_trades, family_trades, family_value_estimate,\n family_share_pct); sort=\"family_trades\", \"spouse_trades\", \"family_value\" or \"family_share\" ranks by it.\n One member's history: member_id with symbol (e.g. member_id=\"P000197\", symbol=\"NVDA\") returns all of that member's\n trades in that one symbol, including trades by the spouse, joint and children (field held_by). With\n view=\"summary\" and group_by=\"held_by\" the same filters give the family split: Self, Spouse, Joint and Child.\n view \"symbols\": tickers with trade counts, buys, sells, members and the split by party (use days=90 and\n sort=\"buys\" for the most bought stocks).\n view \"net_worth\": net worth from the yearly financial disclosure reports, as reported (assets and liabilities\n are filed as ranges, so net_worth_min, net_worth_max and the middle net_worth_mid; the personal home and some\n accounts are left out). Without member_id: each member's latest year ranked by net worth (the richest members);\n filter by party, chamber, year, filters {\"state\": \"CA\", \"in_office\": true}; sort net_worth, assets, liabilities\n or name; group_by party, chamber, state or year gives the median, average and total net worth per group\n (party comparison). With member_id or member_name: that member's history, one row per report year. Rows have the number of\n assets, the share held by the member, spouse, jointly and by children, and the five largest assets.\n view \"assets\": what a member owns: every asset of one report (member_id or member_name, year = report year,\n default the latest) with asset class, ticker, held_by, value range and income, plus the report's net worth,\n its liabilities and the years available; filters e.g. {\"asset_class\": \"Stock\", \"held_by\": \"Spouse\"}. With\n symbol and no member: the members whose latest report lists that stock.\n branch: \"congress\" (default), \"executive\" (senior executive branch officials such as the President, Vice\n President and cabinet secretaries: their trades, net worth and assets) or \"all\".\n Amounts are ranges (for example $15,001 - $50,000); value fields are estimates from the middle of each range,\n never exact. Filings can come up to 45 days after the trade, or later when filed late (late_filing). sort: for\n trades trade_date, filed_date, amount_mid, member_name or symbol; for the other views trades, buys,\n sells, buy_value, sell_value, net_value or last_trade_date. Extra filters (list_filters shows all), e.g.\n {\"late_filing\": true, \"held_by\": \"Spouse\", \"asset_class\": \"Stock\", \"amount_min\": 100000, \"state\": \"TX\"}.\n country: \"US\" (default) or another country's parliament: \"DE\" (German Bundestag, members from 2013) or \"NL\"\n (Dutch House of Representatives). These countries publish no stock trades, so with DE or NL the views are:\n \"members\" (members ranked by outside income; sort income, side_jobs, interests or name; year limits the income\n to one calendar year), \"interests\" (side jobs with role and organization, outside income with exact amounts or\n ranges, company stakes, donations and benefits (DE), gifts and paid travel (NL); filters e.g.\n {\"interest_type\": \"stake\"}, {\"interest_type\": \"income\"}, {\"org_type\": \"Private company\"}, {\"q\": \"Aufsichtsrat\"},\n {\"has_amount\": true}; sort year, yearly_value or amount), \"summary\" (group_by party, member, year, interest_type,\n category, org_type, organization or ticker: record counts and outside income in euros; e.g. top earners:\n group_by=\"member\", sort=\"income\") and \"holdings\" (company stakes, Germany; {\"listed_only\": true} for stakes in\n listed companies with our ticker). member_id looks like DE-78869 or NL-1057; member_name finds members by name.\n Amounts are in euros as reported (Germany: exact since 2021, ranges before; business owners report gross receipts).\n Dutch answers built on the official register of side activities carry source_credit (\"Source: Tweede Kamer\"):\n show it with that data.\n The answer has website_link: share it so the user can see the trades on dataporium.tech.",
"inputSchema": {
"properties": {
"branch": {
"anyOf": [
{
"enum": [
"congress",
"executive",
"all"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Branch"
},
"chamber": {
"anyOf": [
{
"enum": [
"house",
"senate"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "'house' or 'senate'.",
"title": "Chamber"
},
"country": {
"anyOf": [
{
"enum": [
"US",
"DE",
"NL"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Country name, e.g. 'United States'.",
"title": "Country"
},
"date_from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "First trade date, YYYY-MM-DD.",
"title": "Date From"
},
"date_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Last trade date, YYYY-MM-DD.",
"title": "Date To"
},
"days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Only trades from the last N days, e.g. 30, 90 or 365.",
"title": "Days"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Extra API filters, e.g. {\"late_filing\": true, \"held_by\": \"Spouse\", \"asset_class\": \"Stock\", \"amount_min\": 100000, \"state\": \"TX\"}. list_filters('get_politician_trades') shows all.",
"title": "Filters"
},
"group_by": {
"anyOf": [
{
"enum": [
"party",
"member",
"symbol",
"month",
"year",
"chamber",
"trade_type",
"asset_class",
"held_by",
"state",
"amount_bucket",
"delay_bucket",
"interest_type",
"category",
"org_type",
"organization",
"ticker"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Only for view 'summary': party, member, symbol, month, year, chamber, trade_type, asset_class, held_by, state, amount_bucket or delay_bucket (default party).",
"title": "Group By"
},
"limit": {
"default": 25,
"description": "Rows to return, 1 to 100 (default 25).",
"title": "Limit",
"type": "integer"
},
"member_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Official member ID (Bioguide), e.g. 'P000197'; several separated by commas.",
"title": "Member Id"
},
"member_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Part of a member's name, e.g. 'Pelosi' or 'Tuberville'.",
"title": "Member Name"
},
"offset": {
"default": 0,
"description": "Rows to skip, for the next page (e.g. 25 after a first call with limit 25).",
"title": "Offset",
"type": "integer"
},
"party": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Party on the trade date: 'D', 'R' or 'I' (or Democrat, Republican, Independent). For view 'members' it is the member's current party.",
"title": "Party"
},
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "For trades: trade_date (default), filed_date, amount_mid, member_name or symbol. For the other views: trades, buys, sells, buy_value, sell_value, net_value or last_trade_date. For members also family_trades, spouse_trades, family_value or family_share.",
"title": "Sort"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker, e.g. 'NVDA', or several separated by commas, e.g. 'AAPL,MSFT'.",
"title": "Symbol"
},
"trade_type": {
"anyOf": [
{
"enum": [
"buy",
"sell",
"purchase",
"sale",
"sale_partial",
"sale_full",
"exchange"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "'buy' or 'sell' (or purchase, sale, sale_partial, sale_full, exchange).",
"title": "Trade Type"
},
"view": {
"default": "trades",
"description": "'trades' (the trades, newest first), 'summary' (totals by group_by), 'members' (members with trade counts and most traded symbols) or 'symbols' (tickers with counts and the split by party).",
"enum": [
"trades",
"summary",
"members",
"symbols",
"net_worth",
"assets",
"interests",
"holdings"
],
"title": "View",
"type": "string"
},
"year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"title": "Year"
}
},
"title": "get_politician_tradesArguments",
"type": "object"
},
"name": "get_politician_trades",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Everything about one US home, by property_id (from search_properties) or by address in any spelling\n (e.g. \"110 Coastal Garden, Irvine CA\" or \"125 Shell\"; ZIP, city and state are optional). Returns the address\n and location, status, price, estimate, HOA, beds, baths, sqft, lot, year built, description, photos, the\n listing facts (real listed date, days on market, relisted and when, the whole selling effort with first price\n and days off the market, every price cut), the clean timeline (listed, price changed, pending, removed,\n relisted, sold, listed for rent), last sale, tax history, schools, agent and office contacts, comparisons with\n nearby homes (2 miles) and with the ZIP and city, the area market numbers and an estimated monthly payment.\n To recalculate, call get_property again with new payment inputs (down payment, interest rate, term, tax rate,\n insurance, HOA, PMI, maintenance) or a new radius_miles and nearby filters. If several homes match an address,\n the answer lists them with a match score: ask the user which one, then call again with its property_id. The\n answer has website_link: share it so the user can open this home on the map at dataporium.tech. For the full\n details of the area (market history, property tax, crime, demographics, climate, air quality, neighborhood\n profile) call get_housing_area_insights (the answer has more_area_data with the exact call); to compare or rank\n areas call search_housing_areas.",
"inputSchema": {
"properties": {
"address": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Street address in any spelling, e.g. '110 Coastal Garden, Irvine CA' or '125 Shell'. ZIP, city and state are optional.",
"title": "Address"
},
"down_payment_amount": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Down payment in dollars (use instead of down_payment_pct).",
"title": "Down Payment Amount"
},
"down_payment_pct": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Down payment in percent of the price (default 20).",
"title": "Down Payment Pct"
},
"hoa_per_month": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "HOA fee per month in dollars (default: the home's HOA fee).",
"title": "Hoa Per Month"
},
"insurance_per_year": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Home insurance per year in dollars (default 0.35% of the price).",
"title": "Insurance Per Year"
},
"interest_rate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Yearly mortgage interest rate in percent, e.g. 6.25 (default: latest 30-year fixed average).",
"title": "Interest Rate"
},
"loan_term_years": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Loan term in years (default 30).",
"title": "Loan Term Years"
},
"maintenance_per_year": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Maintenance per year in dollars, added to the monthly payment when given (default none).",
"title": "Maintenance Per Year"
},
"nearby_same_beds": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "True compares only with nearby homes that have the same number of bedrooms.",
"title": "Nearby Same Beds"
},
"nearby_same_style": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "True compares only with nearby homes of the same style.",
"title": "Nearby Same Style"
},
"nearby_sqft_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Compare only with nearby homes of at most this many square feet.",
"title": "Nearby Sqft Max"
},
"nearby_sqft_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Compare only with nearby homes of at least this many square feet.",
"title": "Nearby Sqft Min"
},
"pmi_rate_pct": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Mortgage insurance per year in percent of the loan, used below 20% down (default 0.7).",
"title": "Pmi Rate Pct"
},
"property_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Property id of one home, from search_properties.",
"title": "Property Id"
},
"property_tax_rate": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Property tax in percent of the price per year, e.g. 1.1 (default: the home's own rate from its last tax bill when known, else the median rate of its ZIP, city or county).",
"title": "Property Tax Rate"
},
"radius_miles": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Radius in miles for the nearby comparison (default 2, up to 50).",
"title": "Radius Miles"
},
"status": {
"anyOf": [
{
"enum": [
"for_sale",
"pending",
"rent",
"sold",
"off_market"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Which record of the home to show when it has several (e.g. 'sold' for its last sale while it is for sale again). Default: the current one.",
"title": "Status"
}
},
"title": "get_propertyArguments",
"type": "object"
},
"name": "get_property",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "SEC filings of a company (10-K, 10-Q, 8-K, ...) with links. form_type filters by form.",
"inputSchema": {
"properties": {
"accessionnumber": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "SEC accession number of one filing, e.g. '0000320193-25-000079'.",
"title": "Accessionnumber"
},
"cik": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "SEC Central Index Key of the company, e.g. 320193 for Apple.",
"title": "Cik"
},
"form_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "SEC form type, e.g. '10-K', '10-Q' or '8-K'.",
"title": "Form Type"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"title": "get_sec_filingsArguments",
"type": "object"
},
"name": "get_sec_filings",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Daily performance or P/E history of market sectors or industries (e.g. sector 'Technology', exchange 'NASDAQ').",
"inputSchema": {
"properties": {
"date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Date filter in YYYY-MM-DD format, e.g. '2026-06-30'.",
"title": "Date"
},
"exchange": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Stock exchange, e.g. 'NYSE', 'NASDAQ' or 'LSE'.",
"title": "Exchange"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"industry": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Industry name, e.g. 'Semiconductors'.",
"title": "Industry"
},
"kind": {
"description": "'sector_performance', 'sector_pe', 'industry_performance' or 'industry_pe'.",
"enum": [
"sector_performance",
"sector_pe",
"industry_performance",
"industry_pe"
],
"title": "Kind",
"type": "string"
},
"sector": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Market sector, e.g. 'Technology' or 'Health Care'.",
"title": "Sector"
}
},
"required": [
"kind"
],
"title": "get_sector_industry_performanceArguments",
"type": "object"
},
"name": "get_sector_industry_performance",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Institutional ownership: 'major' holders, 'quarterly' 13F holdings (filters year, qtr, period),\n 'quarterly_summary', ownership 'by_type', share 'class', and holders by country 'geo'.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"kind": {
"description": "'major', 'quarterly' (13F holdings), 'quarterly_summary', 'by_type', 'class' or 'geo'.",
"enum": [
"major",
"quarterly",
"quarterly_summary",
"by_type",
"class",
"geo"
],
"title": "Kind",
"type": "string"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"required": [
"kind"
],
"title": "get_shareholdersArguments",
"type": "object"
},
"name": "get_shareholders",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Short interest of US stocks and ETFs: the shares sold short and not yet bought back, reported twice a month\n (settlement dates around the 15th and the month end, published about a week later), history from 2017.\n view \"history\" (default): one or more symbols (e.g. \"GME\" or \"AAPL,TSLA\"), newest first: short_interest,\n previous_short_interest, change_shares, change_pct, avg_daily_volume, days_to_cover; for one symbol also\n `latest` with shares_outstanding and short_pct_shares_outstanding. date_from/date_to limit the dates. Without a\n symbol, settlement_date (\"latest\" or a date) lists every symbol on that date (sort short_interest, change_pct or\n days_to_cover).\n view \"most_shorted\": stocks ranked on the newest (or a given) settlement date by sort: short_pct (percent of\n shares outstanding, default), days_to_cover, short_interest, short_value, change_pct or change_shares; market\n nyse, nasdaq, nyse_american, otc or listed (all exchanges, default); filters e.g. {\"min_market_cap\": 300000000,\n \"min_avg_volume\": 100000, \"sector\": \"Healthcare\", \"min_price\": 5}.\n view \"dates\": the settlement dates with data.\n The percent of shares outstanding uses today's share count (a float figure is not available). The answer has\n website_link: share it with the user.",
"inputSchema": {
"properties": {
"date_from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "First settlement date for view 'history', YYYY-MM-DD.",
"title": "Date From"
},
"date_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Last settlement date for view 'history', YYYY-MM-DD.",
"title": "Date To"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Extra API filters, e.g. {\"min_market_cap\": 300000000, \"sector\": \"Healthcare\"}; list_filters('get_short_interest') shows all.",
"title": "Filters"
},
"limit": {
"default": 25,
"description": "Rows to return, 1 to 100 (default 25).",
"title": "Limit",
"type": "integer"
},
"market": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "nyse, nasdaq, nasdaq_global, nasdaq_capital, nyse_american, nyse_arca, bzx, otc or listed (every exchange, not OTC).",
"title": "Market"
},
"offset": {
"default": 0,
"description": "Rows to skip, for the next page.",
"title": "Offset",
"type": "integer"
},
"settlement_date": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A settlement date (YYYY-MM-DD) or 'latest'. With view 'history' and no symbol it lists every symbol on that date; with 'most_shorted' it ranks that date.",
"title": "Settlement Date"
},
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "most_shorted: short_pct (default), days_to_cover, short_interest, short_value, change_pct or change_shares. history: settlement_date (default), short_interest, change_pct or days_to_cover.",
"title": "Sort"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker, e.g. 'GME', or several separated by commas for view 'history'.",
"title": "Symbol"
},
"view": {
"default": "history",
"description": "'history' (one symbol over time, default), 'most_shorted' (ranking of all stocks) or 'dates'.",
"enum": [
"history",
"most_shorted",
"dates"
],
"title": "View",
"type": "string"
}
},
"title": "get_short_interestArguments",
"type": "object"
},
"name": "get_short_interest",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "A company's social media and employer data: X (Twitter) profile/posts/follower history, LinkedIn\n profile/posts/followers and employees, Glassdoor profile and ratings.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"dataset": {
"description": "Which dataset, e.g. 'x_profile', 'x_posts', 'linkedin_profile' or 'glassdoor_ratings'.",
"enum": [
"x_profile",
"x_posts",
"x_followers",
"linkedin_profile",
"linkedin_posts",
"linkedin_followers_employees",
"glassdoor_profile",
"glassdoor_ratings"
],
"title": "Dataset",
"type": "string"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"required": [
"dataset"
],
"title": "get_social_mediaArguments",
"type": "object"
},
"name": "get_social_media",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Recent news articles about one company or crypto coin (full text, sentiment, tags). ticker e.g. AAPL or BTC-USD.",
"inputSchema": {
"properties": {
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"stock_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Asset type of the ticker, e.g. 'stock' or 'crypto'.",
"title": "Stock Type"
},
"ticker": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, SPY or BTC-USD (crypto uses the -USD suffix).",
"title": "Ticker"
}
},
"title": "get_stock_newsArguments",
"type": "object"
},
"name": "get_stock_news",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Price history (open, high, low, close, volume) plus dividends of a stock, ETF or index. interval '1d' = daily\n bars (full history available), '5m' = 5-minute bars of about the last month. points = how many of the newest\n bars to return (default 250, about one trading year of daily bars; up to about 500 fit in one answer).",
"inputSchema": {
"properties": {
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"interval": {
"default": "1d",
"description": "'1d' for daily bars (full history) or '5m' for 5-minute bars (about the last month).",
"enum": [
"1d",
"5m"
],
"title": "Interval",
"type": "string"
},
"points": {
"default": 250,
"description": "How many of the newest bars to return (default 250, about one trading year of daily bars).",
"title": "Points",
"type": "integer"
},
"ticker": {
"description": "Ticker symbol, e.g. AAPL, SPY or BTC-USD (crypto uses the -USD suffix).",
"title": "Ticker",
"type": "string"
}
},
"required": [
"ticker"
],
"title": "get_stock_pricesArguments",
"type": "object"
},
"name": "get_stock_prices",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "List every filter (API parameter) a tool accepts, with descriptions, for use in its `filters` argument.\n tool is a tool name such as 'search_properties' or 'get_financial_statements'.",
"inputSchema": {
"properties": {
"tool": {
"description": "Name of a DataPorium tool, e.g. 'search_properties' or 'get_financial_statements'.",
"title": "Tool",
"type": "string"
}
},
"required": [
"tool"
],
"title": "list_filtersArguments",
"type": "object"
},
"name": "list_filters",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of list_filters: the filters each endpoint of a tool accepts.",
"properties": {
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the tool name is unknown.",
"title": "Error"
},
"filters_by_endpoint": {
"anyOf": [
{
"additionalProperties": {
"additionalProperties": {
"type": "string"
},
"type": "object"
},
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "For each API endpoint of the tool: filter name -> description.",
"title": "Filters By Endpoint"
},
"tool": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Tool the filters belong to.",
"title": "Tool"
},
"tools": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown tool name: the valid tool names.",
"title": "Tools"
}
},
"title": "FilterList",
"type": "object"
}
},
{
"description": "Find M&A deals across the market (default: the 12 months up to the newest deal). stage e.g.\n [\"Completed\"] or [\"Announced/Pending\"]; sectors and countries are partial matches (e.g. target_sector\n [\"Health Care\"], target_country [\"United States\"]); values in USD millions. Compact rows (date, buyer,\n target, tickers, value, stage, sectors, countries); use get_ma_transactions for full details of one deal.",
"inputSchema": {
"properties": {
"buyer": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Buyer company name or ticker (partial match).",
"title": "Buyer"
},
"buyer_country": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Country of the buyer, e.g. [\"United States\"] (partial match).",
"title": "Buyer Country"
},
"buyer_sector": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Sector of the buyer, e.g. [\"Technology\"] (partial match).",
"title": "Buyer Sector"
},
"date_from": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Start date in YYYY-MM-DD format.",
"title": "Date From"
},
"date_to": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "End date in YYYY-MM-DD format.",
"title": "Date To"
},
"limit": {
"default": 20,
"description": "Rows to return, 1 to 50.",
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Number of rows to skip, for the next page of results (e.g. 20 after a first call with limit 20).",
"title": "Offset",
"type": "integer"
},
"sort_by": {
"default": "date",
"description": "'date' (newest first by default) or 'value'.",
"enum": [
"date",
"value"
],
"title": "Sort By",
"type": "string"
},
"sort_order": {
"anyOf": [
{
"enum": [
"asc",
"desc"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "desc",
"description": "Sort direction: 'asc' (ascending) or 'desc' (descending).",
"title": "Sort Order"
},
"stage": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Deal stage list, e.g. [\"Completed\"] or [\"Announced/Pending\"].",
"title": "Stage"
},
"target": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Acquired company name or ticker (partial match).",
"title": "Target"
},
"target_country": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Country of the acquired company, e.g. [\"United States\"] (partial match).",
"title": "Target Country"
},
"target_sector": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Sector of the acquired company, e.g. [\"Health Care\"] (partial match).",
"title": "Target Sector"
},
"value_max_usd_mm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum deal value in US dollars, millions.",
"title": "Value Max Usd Mm"
},
"value_min_usd_mm": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum deal value in US dollars, millions (e.g. 1000 = $1 billion).",
"title": "Value Min Usd Mm"
}
},
"title": "screen_ma_dealsArguments",
"type": "object"
},
"name": "screen_ma_deals",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "START HERE for broad stock questions (no specific company named). Ranks ~45,000 companies in one call.\n filters: {\"field\": [min, max]} using fields from describe_screen_fields(\"stocks\"), e.g.\n {\"market_cap\": [2e9, null], \"forward_pe\": [5, 15], \"revenue_growth_pct\": [10, null], \"debt_to_equity\": [null, 1]}.\n Percent fields are in percent (10 = 10%). sector/industry/country/exchange: lists, partial match\n (e.g. sector [\"Technology\"], country [\"United States\"]). sort_by any field, e.g. \"fcf_yield_pct\".\n Returns at most 50 rows plus total_matches; use offset for the next page.",
"inputSchema": {
"properties": {
"country": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Countries to keep, e.g. [\"United States\"].",
"title": "Country"
},
"exchange": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Exchanges to keep, e.g. [\"NASDAQ\", \"NYSE\"].",
"title": "Exchange"
},
"fields": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Extra fields to include in each result row, from describe_screen_fields.",
"title": "Fields"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Ranges as {\"field\": [min, max]} using fields from describe_screen_fields(\"stocks\"); use null for an open end, e.g. {\"forward_pe\": [5, 15], \"revenue_growth_pct\": [10, null]}.",
"title": "Filters"
},
"industry": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Industries to keep (partial match), e.g. [\"Semiconductors\"].",
"title": "Industry"
},
"limit": {
"default": 20,
"description": "Rows to return, 1 to 50.",
"title": "Limit",
"type": "integer"
},
"offset": {
"default": 0,
"description": "Number of rows to skip, for the next page of results (e.g. 20 after a first call with limit 20).",
"title": "Offset",
"type": "integer"
},
"pending_target": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "True keeps only companies that are targets of a pending M&A deal.",
"title": "Pending Target"
},
"query": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Free-text search on company name or ticker.",
"title": "Query"
},
"sector": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Sectors to keep (partial match), e.g. [\"Technology\"].",
"title": "Sector"
},
"sort_by": {
"default": "market_cap",
"description": "Field to rank by, e.g. 'market_cap', 'forward_pe' or 'fcf_yield_pct'.",
"title": "Sort By",
"type": "string"
},
"sort_order": {
"anyOf": [
{
"enum": [
"asc",
"desc"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "desc",
"description": "Sort direction: 'asc' (ascending) or 'desc' (descending).",
"title": "Sort Order"
}
},
"title": "screen_stocksArguments",
"type": "object"
},
"name": "screen_stocks",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "US healthcare providers, hospitals and health systems from official US government data, linked by keys\n (NPI for providers, CCN for hospitals, PAC ID for group practices, a system ID for health systems).\n kind \"hospitals\" (default): every active Medicare hospital with type, ownership, beds, star rating (1 to 5),\n health system, listed owner (ticker) and the latest yearly financials; filter by q (name or city), state, city,\n zip, hospital_type (e.g. \"Short-term acute care\", \"Critical access\", \"Psychiatric\", \"Children's\"), ownership,\n system (ID or slug), ticker (e.g. HCA, THC, CYH, UHS); sort e.g. \"net_patient_revenue\" (default), \"beds\",\n \"star_rating\", \"net_income\", \"operating_margin_pct\".\n kind \"health_systems\": systems with hospitals, beds, clinicians, revenue roll-ups and listed owner; q, state, ticker.\n kind \"providers\": every provider with an NPI (doctors, nurse practitioners, clinics, pharmacies and more): q (name\n or NPI), specialty (e.g. \"cardiology\"), entity_type, state, city, zip, medicare=true for Medicare clinicians.\n kind \"groups\": Medicare group practices with their organization NPI and linked health system.\n kind \"hospital_financials\": yearly cost report financials per hospital (fiscal_year, state, system, ticker).\n kind \"hospital_quality\": quality measures (measure e.g. \"mortality_heart_attack\", \"readmission_heart_failure\",\n \"would_recommend\", \"infection_c_diff\", \"ed_time_minutes\") with national medians; best first by default.\n kind \"provider_counts\" / \"hospital_counts\": totals grouped by group_by (providers: state, specialty,\n medicare_specialty, entity_type; hospitals: state, hospital_type, ownership, star_rating, system, teaching).\n kind \"specialties\": specialty names and codes with provider counts.\n Medicare use and money (newest data year by default; year= for another):\n kind \"procedures\": Medicare services per provider and procedure code: give npi (a doctor's codes) or code (e.g.\n \"99213\", \"G0439\"; the providers billing it, with state). kind \"procedure_codes\": codes ranked by Medicare payments\n nationally or in a state (q = code or category words). kind \"code_profile\": one code (code=) by year and state.\n kind \"procedure_providers\": providers ranked by Medicare payments (state, specialty = provider type).\n kind \"lab_tests\" / \"lab_test_providers\": lab test codes with the lab fee schedule rate / labs ranked.\n kind \"hospital_procedures\": hospital stays per DRG (inpatient) and outpatient services per APC per hospital (ccn,\n code, state, system, ticker; filters {\"setting\": \"outpatient\"}); \"hospital_procedure_codes\": DRG/APC national totals.\n kind \"prescriptions\": Medicare drug claims and cost per prescriber and drug (npi or drug, e.g. \"eliquis\").\n kind \"drugs\": drugs ranked by cost nationally or in a state (q, ticker). kind \"drug_profile\": one drug (drug=):\n totals by year and state, spending by manufacturer, top prescribers, Medicaid use, listed company.\n kind \"prescribers\": prescribers ranked. kind \"drug_spending\": spending by drug, manufacturer or listed company\n (group_by drug|manufacturer|company|year; ticker). kind \"medicaid_drugs\": Medicaid prescriptions and amount per drug\n product in a state (default national) and year (filters {\"quarter\": 1}).\n kind \"payments\": company payments to doctors and teaching hospitals (npi, ccn, ticker or filters {\"payer\": id});\n \"payment_companies\": paying companies ranked (q, ticker); \"payment_company\": one company (q = name or ID);\n \"payment_recipients\": doctors and hospitals ranked by payments received. kind \"company_summary\": a listed\n company's (ticker=) Medicare drug spending and payments to doctors, its certified labs and its device approvals,\n recalls and adverse events.\n Diagnostics and labs: kind \"labs\": every certified US lab (about 300,000, all payers) with lab type, segment\n (independent_reference, pol = physician office, hospital, other), certificate, accreditations, yearly test volume,\n listed company (ticker, e.g. DGX, LH) and NPI/CCN links; q (name or lab number), state, city, zip, ticker,\n filters {\"segment\": \"pol\", \"certificate_type\": \"accreditation\", \"accreditation\": \"CAP\", \"lab_type\": \"Pharmacy\"}.\n kind \"lab_counts\": lab counts and test volumes by group_by segment, lab_type, certificate_type, state, volume_band,\n accreditation, company, segment_state, year or segment_year (trend). kind \"lab_companies\": lab companies with labs,\n states, volumes and Medicare lab payments. kind \"lab_profile\": one lab (q = 10-character lab number).\n kind \"lab_test_segments\": Medicare lab tests by group_by segment (independent_lab, pathology_practice,\n physician_office, hospital_setting, other), category (chemistry, hematology, immunology, microbiology,\n molecular_infectious, molecular_genetic, pla, pathology, toxicology, ...), year, place, segment_year,\n category_year, segment_category or code (with fee schedule rate and private insurer median). kind\n \"lab_private_prices\": private insurer lab prices (2016 reporting) next to the Medicare rate (code, q).\n Medical devices: kind \"device_procedures\": Medicare procedures that use devices by group_by category (e.g.\n joint, spine, cardiac_rhythm, structural_heart, coronary, neurostim, ophthalmic, imaging), subcategory, code,\n place (office, asc, hospital_outpatient, hospital_inpatient, ...), provider, year, category_year or category_place\n (code, year, filters {\"category\": \"joint\", \"place\": \"asc\"}). \"How many knee replacements\": kind\n \"device_procedures\", group_by \"code\", q \"27447\". kind \"device_procedure_states\": the same by state (code or\n filters {\"category\": ...}). kind \"device_hospital_procedures\": device-heavy hospital stays (DRG) and outpatient\n services (APC) by group_by category, code, state, hospital or year (ccn, state, system, ticker, filters\n {\"setting\": \"inpatient\"}). kind \"device_procedures_icd\": CALIFORNIA ONLY, all payers: inpatient procedure counts\n by ICD-10-PCS code with official descriptions, category and device category (group_by code, category,\n device_category, year; q = words or code prefix); its answer carries a required source line in \"attribution\":\n always show that line with these numbers. kind \"medical_equipment\": Medicare equipment and supplies (glucose\n monitors, sleep apnea machines, wheelchairs, braces) by group_by code, category, state or year; kind\n \"equipment_referrers\": doctors ordering the most. kind \"devices\": device product codes with class and counts.\n kind \"device_approvals\": 510(k) clearances, De Novo grants and PMA approvals (ticker, q, year, filters\n {\"pathway\": \"pma\"}; group_by year, pathway, company, year_pathway). kind \"device_recalls\": recalls (ticker,\n filters {\"recall_class\": \"I\"}; group_by year, class, root_cause, company). kind \"device_adverse_events\": adverse\n event reports by group_by year, product_code or company (ticker, filters {\"event_type\": \"death\"}). kind\n \"device_companies\": listed device makers with approval, recall and event totals; \"device_company\": one maker\n (ticker=, e.g. MDT, ABT, BSX).\n For one provider, hospital, system or group in full, use get_healthcare_provider. Extra filters: list_filters.\n The answer has website_link: share it so the user can see the data on dataporium.tech.",
"inputSchema": {
"properties": {
"ccn": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A hospital's 6-character CCN (kinds hospital_procedures, payments, payment_recipients).",
"title": "Ccn"
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "City name, e.g. 'Austin'.",
"title": "City"
},
"code": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Procedure code(s): CPT/HCPCS for procedures (e.g. '99213', 'G0439'), DRG (3 digits, e.g. '470') or APC (4 digits) for hospital_procedures.",
"title": "Code"
},
"drug": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Drug brand or generic name or slug, e.g. 'eliquis', 'atorvastatin' (kinds prescriptions, drug_profile, drug_spending, medicaid_drugs).",
"title": "Drug"
},
"entity_type": {
"anyOf": [
{
"enum": [
"individual",
"organization"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Entity Type"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"fiscal_year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Hospital fiscal year (the year it ends), e.g. 2024 (kind 'hospital_financials').",
"title": "Fiscal Year"
},
"group_by": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "For 'provider_counts': state, specialty, medicare_specialty or entity_type. For 'hospital_counts': state, hospital_type, ownership, star_rating, system or teaching.",
"title": "Group By"
},
"hospital_type": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "E.g. 'Short-term acute care' (or 'acute'), 'Critical access', 'Psychiatric', 'Rehabilitation', 'Long-term care', \"Children's\".",
"title": "Hospital Type"
},
"kind": {
"default": "hospitals",
"description": "'hospitals' (default), 'health_systems', 'providers' (any NPI), 'groups' (Medicare group practices), 'hospital_financials', 'hospital_quality', 'provider_counts', 'hospital_counts', 'specialties'; Medicare use and money: 'procedures', 'procedure_codes', 'procedure_providers', 'code_profile', 'lab_tests', 'lab_test_providers', 'hospital_procedures', 'hospital_procedure_codes', 'prescriptions', 'drugs', 'prescribers', 'drug_profile', 'drug_spending', 'medicaid_drugs', 'payments', 'payment_companies', 'payment_recipients', 'payment_company', 'company_summary'; labs and devices: 'labs', 'lab_counts', 'lab_companies', 'lab_profile', 'lab_test_segments', 'lab_private_prices', 'device_procedures', 'device_procedure_states', 'device_hospital_procedures', 'device_procedures_icd' (California only, with a required source line), 'medical_equipment', 'equipment_referrers', 'devices', 'device_approvals', 'device_recalls', 'device_adverse_events', 'device_companies', 'device_company'.",
"enum": [
"hospitals",
"health_systems",
"providers",
"groups",
"hospital_financials",
"hospital_quality",
"provider_counts",
"hospital_counts",
"specialties",
"procedures",
"procedure_codes",
"procedure_providers",
"code_profile",
"lab_tests",
"lab_test_providers",
"hospital_procedures",
"hospital_procedure_codes",
"prescriptions",
"drugs",
"prescribers",
"drug_profile",
"drug_spending",
"medicaid_drugs",
"payments",
"payment_companies",
"payment_recipients",
"payment_company",
"company_summary",
"labs",
"lab_counts",
"lab_companies",
"lab_profile",
"lab_test_segments",
"lab_private_prices",
"device_procedures",
"device_procedure_states",
"device_hospital_procedures",
"device_procedures_icd",
"medical_equipment",
"equipment_referrers",
"devices",
"device_approvals",
"device_recalls",
"device_adverse_events",
"device_companies",
"device_company"
],
"title": "Kind",
"type": "string"
},
"limit": {
"default": 25,
"description": "Rows to return, 1 to 100 (default 25).",
"title": "Limit",
"type": "integer"
},
"measure": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Quality measure ID(s), e.g. 'mortality_heart_attack', 'would_recommend', 'readmission_heart_failure' (kind 'hospital_quality').",
"title": "Measure"
},
"medicare": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "True = only clinicians enrolled in Medicare (kind 'providers').",
"title": "Medicare"
},
"npi": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "A provider's 10-digit NPI (kinds procedures, prescriptions, payments, procedure_providers, prescribers, payment_recipients).",
"title": "Npi"
},
"offset": {
"default": 0,
"description": "Number of rows to skip, for the next page of results (e.g. 20 after a first call with limit 20).",
"title": "Offset",
"type": "integer"
},
"order": {
"anyOf": [
{
"enum": [
"asc",
"desc"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Order"
},
"ownership": {
"anyOf": [
{
"enum": [
"nonprofit",
"for-profit",
"government"
],
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"title": "Ownership"
},
"q": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Name (any part) or city; for providers also a 10-digit NPI. E.g. 'mayo clinic'.",
"title": "Q"
},
"sort": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Hospitals: net_patient_revenue (default), beds, star_rating, net_income, operating_margin_pct, discharges, name. Systems: hospital_count, total_beds, net_patient_revenue, clinician_count. Providers: name, npi, enumeration_date.",
"title": "Sort"
},
"specialty": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Specialty name or part of it, e.g. 'cardiology', 'family medicine'.",
"title": "Specialty"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Two-letter state code, e.g. 'TX'; several separated by commas.",
"title": "State"
},
"system": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Health system ID or slug, e.g. 'hca-healthcare'.",
"title": "System"
},
"ticker": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Listed owner of the hospital's system, e.g. 'HCA', 'THC', 'CYH', 'UHS'.",
"title": "Ticker"
},
"year": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Data year (Medicare) or program year (payments), e.g. 2024. Default: newest.",
"title": "Year"
},
"zip": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "5-digit ZIP code(s), comma-separated.",
"title": "Zip"
}
},
"title": "search_healthcare_providersArguments",
"type": "object"
},
"name": "search_healthcare_providers",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Find and rank many areas at once (states, counties, metros, cities or ZIP codes) from a ready-made scorecard\n of market, price, rent, crime, income and affordability numbers. START HERE for broad real-estate questions\n such as where to buy, rent out or live. One level per call, ranked on home value and its 1-year change, rent\n and rent yield, price forecast, market speed (metros), homes for sale, crime, population and income,\n unemployment, air quality, flood and earthquake risk, weather and property tax, and the local economy:\n local_unemployment_rate_pct (newest month), avg_weekly_wage, new_homes_permitted_12m and net_migration_per_1000\n (people moving in minus out per 1,000 residents; county level for ZIPs and cities). filters: {\"field\": [min, max]},\n e.g. {\"gross_rent_yield_pct\": [7, null], \"population\": [50000, null], \"crime_rate_per_1000\": [null, 30]}.\n states: [\"TX\", \"FL\"]. flood_risk: [\"Low\"]. Call describe_screen_fields(\"areas\") first to learn the fields, units\n and typical ranges. For the full detail of ONE area use get_housing_area_insights; to list the homes of an area\n you picked use search_properties. The crime rate of a place is that of the police agency that serves it, which\n can be a neighboring city or the county sheriff: get_housing_area_insights names the agency in source_note.",
"inputSchema": {
"properties": {
"city": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Cities to keep, e.g. [\"Austin\"].",
"title": "City"
},
"county": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Counties to keep, e.g. [\"Travis\"].",
"title": "County"
},
"fields": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Extra fields to include in each result row, from describe_screen_fields.",
"title": "Fields"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Ranges as {\"field\": [min, max]} using fields from describe_screen_fields(\"areas\"), e.g. {\"gross_rent_yield_pct\": [7, null], \"population\": [50000, null]}.",
"title": "Filters"
},
"flood_risk": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of flood risk levels to keep, e.g. [\"Low\"].",
"title": "Flood Risk"
},
"level": {
"description": "Which places to rank: 'state', 'county', 'metro', 'city' or 'zip'.",
"enum": [
"state",
"county",
"metro",
"city",
"zip"
],
"title": "Level",
"type": "string"
},
"limit": {
"default": 20,
"description": "Rows to return, 1 to 50.",
"title": "Limit",
"type": "integer"
},
"metro": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of metro area names, e.g. [\"Dallas\"].",
"title": "Metro"
},
"offset": {
"default": 0,
"description": "Number of rows to skip, for the next page of results (e.g. 20 after a first call with limit 20).",
"title": "Offset",
"type": "integer"
},
"sort_by": {
"default": "population",
"description": "Field to rank by, e.g. 'population', 'gross_rent_yield_pct' or 'home_value_change_1y_pct'.",
"title": "Sort By",
"type": "string"
},
"sort_order": {
"anyOf": [
{
"enum": [
"asc",
"desc"
],
"type": "string"
},
{
"type": "null"
}
],
"default": "desc",
"description": "Sort direction: 'asc' (ascending) or 'desc' (descending).",
"title": "Sort Order"
},
"states": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of US state codes, e.g. [\"TX\", \"FL\"].",
"title": "States"
}
},
"required": [
"level"
],
"title": "search_housing_areasArguments",
"type": "object"
},
"name": "search_housing_areas",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Find US homes in a place: give zips, or city (+ state), or county (+ state), or a state. With no location\n it searches the whole US using a fixed sample, and the counts are approximate (marked approximate in the\n answer). status: for_sale (default),\n pending, rent, sold (last 12 months) or off_market. Returns total_matches, a summary of ALL matches\n (count, median price, median price per sqft, median true days on market, share with a price cut, share\n relisted), the market numbers of the area (inventory, median prices, days to pending, sales, sale vs list\n price, months of supply, home value index and forecast), and up to 50 homes per call with short facts: price,\n price per sqft, beds, baths, sqft, real listed date and days on market (not the date that resets on every\n relist), true days on market for the whole selling effort, relisted or not, last and total price cut, sold\n price vs the last list price, and price per sqft vs the ZIP median. Use offset for the next page. Each home has\n a property_id for get_property, and the answer has website_link: share it so the user sees these homes on the\n map. Duplicate homes are already removed. For the full details of the area (market history, property tax,\n crime, demographics, climate, air quality, neighborhood profile) call get_housing_area_insights; to compare or\n rank areas call search_housing_areas.",
"inputSchema": {
"properties": {
"baths_min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum number of bathrooms.",
"title": "Baths Min"
},
"beds_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum number of bedrooms.",
"title": "Beds Max"
},
"beds_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum number of bedrooms.",
"title": "Beds Min"
},
"below_area_ppsf": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "True: price per sqft below the ZIP median of the same status. False: at or above it.",
"title": "Below Area Ppsf"
},
"below_area_ppsf_pct": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Price per sqft at least this percent below the ZIP median, e.g. 10.",
"title": "Below Area Ppsf Pct"
},
"city": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "City name, e.g. 'Irvine'. Add state when the name is used in several states.",
"title": "City"
},
"county": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "County name, e.g. 'Orange' (the word County is optional). Add state.",
"title": "County"
},
"cut_pct_min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Only homes whose total price cut since first listed is at least this percent, e.g. 5.",
"title": "Cut Pct Min"
},
"dom_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum days on market of the current listing (real listed date, not the date that resets on relist).",
"title": "Dom Max"
},
"hoa_max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum HOA fee per month (homes without HOA count as 0).",
"title": "Hoa Max"
},
"limit": {
"default": 50,
"description": "Homes to return, 1 to 50 (default 50).",
"title": "Limit",
"type": "integer"
},
"listed_within_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Only homes whose current listing started within this many days.",
"title": "Listed Within Days"
},
"lot_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum lot size in square feet.",
"title": "Lot Max"
},
"lot_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum lot size in square feet.",
"title": "Lot Min"
},
"new_construction": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "True for new construction only; False to exclude it.",
"title": "New Construction"
},
"offset": {
"default": 0,
"description": "Homes to skip, for the next page (e.g. 50 after the first call).",
"title": "Offset",
"type": "integer"
},
"price_cut": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "True: only homes with a price cut. False: only homes without one.",
"title": "Price Cut"
},
"price_cut_within_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Only homes whose latest price cut was within this many days, e.g. 30.",
"title": "Price Cut Within Days"
},
"price_max": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum price in dollars (monthly rent for rentals, sold price for sold homes).",
"title": "Price Max"
},
"price_min": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum price in dollars (monthly rent for rentals, sold price for sold homes).",
"title": "Price Min"
},
"relisted": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null,
"description": "True: only relisted homes. False: only homes not relisted in this selling effort.",
"title": "Relisted"
},
"sold_within_days": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Sold homes only: sold within this many days, e.g. 90.",
"title": "Sold Within Days"
},
"sort": {
"default": "newest",
"description": "Sort order: newest, oldest, price_asc, price_desc, ppsf_asc, ppsf_desc (price per square foot), dom_asc, dom_desc (true days on market), biggest_cut, recent_cut, best_value (lowest price per sqft vs the ZIP median), sqft_desc, beds_desc, lot_desc or year_built_desc.",
"enum": [
"newest",
"oldest",
"price_asc",
"price_desc",
"ppsf_asc",
"ppsf_desc",
"dom_asc",
"dom_desc",
"biggest_cut",
"recent_cut",
"best_value",
"sqft_desc",
"beds_desc",
"lot_desc",
"year_built_desc"
],
"title": "Sort",
"type": "string"
},
"sqft_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum living area in square feet.",
"title": "Sqft Max"
},
"sqft_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Minimum living area in square feet.",
"title": "Sqft Min"
},
"state": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "US state as a 2-letter code or name, e.g. 'TX'. Add it with city or county; alone it searches the whole state.",
"title": "State"
},
"status": {
"anyOf": [
{
"items": {
"enum": [
"for_sale",
"pending",
"rent",
"sold",
"off_market"
],
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Which homes: [\"for_sale\"] (default), \"pending\", \"rent\", \"sold\" (last 12 months) or \"off_market\"; several are allowed.",
"title": "Status"
},
"style": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "Home styles, e.g. [\"single_family\", \"condos\", \"townhomes\", \"multi_family\", \"land\"].",
"title": "Style"
},
"true_dom_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Maximum true days on market: the whole selling effort, earlier listings of the same home included and days off the market left out.",
"title": "True Dom Max"
},
"with_payment": {
"default": false,
"description": "True adds an estimated monthly payment to each home (20% down, latest 30-year rate).",
"title": "With Payment",
"type": "boolean"
},
"year_built_max": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Newest acceptable year built, e.g. 1990.",
"title": "Year Built Max"
},
"year_built_min": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Oldest acceptable year built, e.g. 2000.",
"title": "Year Built Min"
},
"zips": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "List of US ZIP codes, e.g. [\"92618\", \"92602\"].",
"title": "Zips"
}
},
"title": "search_propertiesArguments",
"type": "object"
},
"name": "search_properties",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
},
{
"description": "Find a company's tickers across exchanges (main ticker, all listed symbols, CIK). Use this first when you only\n know a company name. Give symbol OR company_name (exact name, e.g. 'Apple Inc.').",
"inputSchema": {
"properties": {
"cik": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "SEC Central Index Key of the company, e.g. 320193 for Apple.",
"title": "Cik"
},
"company_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Exact company name as listed, e.g. 'Apple Inc.'. Use search_symbols to find it.",
"title": "Company Name"
},
"filters": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Optional extra filters as a JSON object of API parameter names and values, e.g. {\"fiscal_year\": 2025}. Call list_filters with this tool's name to see every accepted filter.",
"title": "Filters"
},
"main_ticker": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Primary ticker of the company, e.g. GOOGL.",
"title": "Main Ticker"
},
"symbol": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Ticker symbol, e.g. AAPL, MSFT or NVDA. Use search_symbols if you only know the company name.",
"title": "Symbol"
}
},
"title": "search_symbolsArguments",
"type": "object"
},
"name": "search_symbols",
"outputSchema": {
"additionalProperties": true,
"description": "Answer of a DataPorium data tool: the records plus how they were requested, or an error.",
"properties": {
"allowed_filters": {
"anyOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"default": null,
"description": "On an unknown-filter error: the filters this endpoint accepts.",
"title": "Allowed Filters"
},
"data": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "The records: a list of objects (or one object) with the requested data.",
"title": "Data"
},
"detail": {
"anyOf": [
{},
{
"type": "null"
}
],
"default": null,
"description": "Extra error detail from the API, e.g. which filter is required.",
"title": "Detail"
},
"endpoint": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "DataPorium API endpoint that answered, e.g. /company-info.",
"title": "Endpoint"
},
"error": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the call failed, with the reason.",
"title": "Error"
},
"filters_sent": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"default": null,
"description": "Filters sent to the API for this answer.",
"title": "Filters Sent"
},
"note": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Present when the answer was shortened, with how to get the rest.",
"title": "Note"
},
"rows": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null,
"description": "Number of records the API returned (before any shortening).",
"title": "Rows"
}
},
"title": "DataResult",
"type": "object"
}
}
]
}Verify it yourself
curl -s https://api.teppi.xyz/v1/evidence/sha256:9a782636e6ab63f004734012308f72190d6b6b7d4c64c5d45fafbb30bb9bf664 | sha256sum