MCP 服务器

DataPorium

tech.dataporium/mcp
数据与分析 金融与投资 房地产 公开且可连接 MCP 2025-11-25

此 MCP 可以做什么

Provides market and company data covering stocks, ETFs, crypto, forex, commodities, economic indicators, housing, property listings, healthcare markets, and SEC filings.

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

DFX Real Estate Intelligence

io.github.Capital-W-Holdings/us-property-parcel-real-estate-debt

Provides US commercial real estate, parcel, debt maturity, bank CRE exposure, private capital, investor, ownership, occupancy, an…

Housing Intel

io.github.pipeworx-io/housing-intel

Analyzes housing markets, affordability, mortgage rates, rental yields, property data, employment, metro demand, and investment s…

Antevo Wealth

ch.antevo/wealth

Aggregates household wealth data across investments, liabilities, credit facilities, real assets, markets, risk, exposure, and fi…

Relendi — Commercial Real Estate Loan Tools

io.github.royamir1/relendi-cre

Calculates commercial real estate loan sizing, underwriting metrics, payments, stress tests, closing costs, and scenario comparis…

mtgmon Mortgage Analytics

io.github.lorenzopi/mtgmon

Provides U.S. mortgage market rates, HMDA lender analytics, GSE loan performance, servicer metrics, and mortgage-related SEC fili…

DealScanner

io.dealscanner/dealscanner

Searches real-estate investment properties, analyzes rental, flip, and BRRRR strategies, ranks areas, and retrieves sold comparab…

Dominick Prevete: DSCR Lender Data

com.dominickprevete/dscr-lender-data

Provides DSCR and investor-loan program information, indicative rates, terminology, methodology, and HMDA-based lender statistics…

TerraVue

app.terravue/terravue

Analyzes U.S. homes and ZIP codes for affordability, buy-versus-rent outcomes, appreciation, rents, and neighborhood signals.