Skip to content

Latest commit

 

History

History
344 lines (334 loc) · 32.4 KB

endpoint-coverage.md

File metadata and controls

344 lines (334 loc) · 32.4 KB

Endpoint coverage

Generated by scripts/gen-endpoint-coverage.py from crates/fmp-py-gen/registry/. Do not edit by hand.

This table records the coverage the libfmp crate and the fmp-py-sdk wheel ship for every endpoint entry in the captured FMP documentation oracle (artifacts/documentations/outer.md). It is the release deliverable planned for v0.2.0 (#41); that version was superseded before the table landed, and the coverage below has shipped in every release since 0.2.0 (crates.io libfmp and PyPI fmp-py-sdk share the Cargo workspace version, and the Go module sdk/go shares it too, tagged sdk/go/vX.Y.Z at each release commit).

  • Documented oracle entries: 276
  • Rust Client methods: 271 (cargo run -p fmp-py-gen --bin registry_check verifies each one)
  • Python methods: 271 across 30 namespaces
  • Go methods: 271 across 30 namespaces (python3 scripts/check_go_coverage.py audits each one)
  • States: supported 255, raw 1, gated 13, deferred 2
State Meaning
supported typed request and typed response rows in Rust and Python
raw the documented response is open-ended, so rows stay dynamic JSON
gated reachable only within the documented entitlement or a fixed query variant
deferred a documented ambiguity is mirrored as written; the upstream contract gap is tracked in #40

Domains

Domain Documented section Documented entries Rust methods Python methods Go methods States
search Search 7 (includes screener) 6 6 6 supported 6
directory Directory 11 11 11 11 supported 11
company Company 17 17 17 17 supported 17
screener Search counted under Search 1 1 1 supported 1
quote Quote 16 16 16 16 gated 6, supported 10
statements Statements 27 27 27 27 supported 27
chart Chart 10 10 10 10 supported 10
economics Economics 4 4 4 4 deferred 1, supported 3
calendar Calendar 9 9 9 9 supported 9
transcripts Earnings Transcript 4 3 3 3 supported 3
news News 10 10 10 10 supported 10
institutional_ownership Form 13F 8 8 8 8 supported 8
analyst Analyst 8 8 8 8 supported 8
market Market Performance 11 11 11 11 supported 11
technical_indicators Technical Indicators 9 9 9 9 supported 9
funds ETF & Mutual Funds 9 9 9 9 supported 9
sec_filings SEC Filings 12 12 12 12 raw 1, supported 11
insider_trading Insider Trades 6 6 6 6 supported 6
indexes Indexes 15 14 14 14 supported 14
market_hours Market Hours 3 3 3 3 supported 3
commodities Commodity 9 8 8 8 supported 8
dcf Discounted Cash Flow 4 4 4 4 supported 4
forex Forex 9 8 8 8 supported 8
crypto Crypto 9 8 8 8 supported 8
congressional Senate 12 12 12 12 supported 12
esg ESG 3 3 3 3 supported 3
commitment_of_traders Commitment Of Traders 3 3 3 3 supported 3
fundraising Fundraisers 6 6 6 6 supported 6
bulk Bulk 18 18 18 18 deferred 1, supported 17
tipranks TipRanks 7 7 7 7 gated 7

The oracle lists 276 entries while the registry names 271 methods because the Search section holds the screener entry (screener.companies) and five entries are documented twice. Each duplicate is served by the single method that owns the path:

  • Crypto / All Cryptocurrencies Quotes: quote.cryptocurrencies
  • Forex / Batch Forex Quotes: quote.forex
  • Commodity / All Commodities Quotes: quote.commodities
  • Indexes / All Index Quotes: quote.indexes
  • Earnings Transcript / Available Transcript Symbols: directory.earnings_transcript_list

Endpoints

Domain Python method Rust Client method State Go Notes
search search.symbol search_symbol supported supported
search search.name search_name supported supported
search search.cik search_cik supported supported
search search.cusip search_cusip supported supported
search search.isin search_isin supported supported
search search.exchange_variants search_exchange_variants supported supported
directory directory.company_symbols company_symbols supported supported
directory directory.financial_statement_symbols financial_statement_symbols supported supported
directory directory.cik_list cik_list supported supported
directory directory.symbol_changes symbol_changes supported supported
directory directory.etf_symbols etf_symbols supported supported
directory directory.actively_trading actively_trading supported supported
directory directory.earnings_transcript_list earnings_transcript_list supported supported
directory directory.available_exchanges available_exchanges supported supported
directory directory.available_sectors available_sectors supported supported
directory directory.available_industries available_industries supported supported
directory directory.available_countries available_countries supported supported
company company.profile profile supported supported
company company.profile_by_cik profile_by_cik supported supported
company company.notes company_notes supported supported
company company.stock_peers stock_peers supported supported
company company.delisted_companies delisted_companies supported supported
company company.employee_count employee_count supported supported
company company.historical_employee_count historical_employee_count supported supported
company company.market_capitalization market_capitalization supported supported
company company.batch_market_capitalization batch_market_capitalization supported supported
company company.historical_market_capitalization historical_market_capitalization supported supported
company company.shares_float shares_float supported supported
company company.all_shares_float all_shares_float supported supported
company company.latest_mergers_acquisitions latest_mergers_acquisitions supported supported
company company.search_mergers_acquisitions search_mergers_acquisitions supported supported
company company.key_executives key_executives supported supported
company company.executive_compensation executive_compensation supported supported
company company.executive_compensation_benchmark executive_compensation_benchmark supported supported
screener screener.companies company_screener supported supported
quote quote.full quote supported supported Nasdaq data is 15-minute delayed unless the real-time user declaration is on file
quote quote.short quote_short supported supported Nasdaq data is 15-minute delayed unless the real-time user declaration is on file
quote quote.mutual_funds mutual_fund_quotes gated supported fixed short=true; the undocumented short=false universe is not exposed
quote quote.aftermarket_trade aftermarket_trade supported supported Nasdaq data is 15-minute delayed unless the real-time user declaration is on file
quote quote.aftermarket_quote aftermarket_quote supported supported Nasdaq data is 15-minute delayed unless the real-time user declaration is on file
quote quote.stock_price_change stock_price_change supported supported
quote quote.batch batch_quote supported supported Nasdaq data is 15-minute delayed unless the real-time user declaration is on file
quote quote.batch_short batch_quote_short supported supported Nasdaq data is 15-minute delayed unless the real-time user declaration is on file
quote quote.batch_aftermarket_trade batch_aftermarket_trade supported supported Nasdaq data is 15-minute delayed unless the real-time user declaration is on file
quote quote.batch_aftermarket_quote batch_aftermarket_quote supported supported Nasdaq data is 15-minute delayed unless the real-time user declaration is on file
quote quote.exchange exchange_quotes supported supported Nasdaq data is 15-minute delayed unless the real-time user declaration is on file
quote quote.etfs etf_quotes gated supported fixed short=true; the undocumented short=false universe is not exposed
quote quote.commodities commodity_quotes gated supported fixed short=true; the undocumented short=false universe is not exposed
quote quote.cryptocurrencies cryptocurrency_quotes gated supported fixed short=true; the undocumented short=false universe is not exposed
quote quote.forex forex_quotes gated supported fixed short=true; the undocumented short=false universe is not exposed
quote quote.indexes index_quotes gated supported fixed short=true; the undocumented short=false universe is not exposed
statements statements.income.statement income_statement supported supported
statements statements.income.statement_ttm income_statement_ttm supported supported
statements statements.balance.statement balance_sheet_statement supported supported
statements statements.balance.statement_ttm balance_sheet_statement_ttm supported supported
statements statements.cash_flow.statement cash_flow_statement supported supported
statements statements.cash_flow.statement_ttm cash_flow_statement_ttm supported supported
statements statements.metrics.key_metrics key_metrics supported supported
statements statements.metrics.key_metrics_ttm key_metrics_ttm supported supported
statements statements.ratios.financial_ratios financial_ratios supported supported
statements statements.ratios.financial_ratios_ttm financial_ratios_ttm supported supported
statements statements.growth.income income_statement_growth supported supported
statements statements.growth.balance_sheet balance_sheet_statement_growth supported supported
statements statements.growth.cash_flow cash_flow_statement_growth supported supported
statements statements.growth.financial financial_statement_growth supported supported
statements statements.as_reported.income income_statement_as_reported supported supported
statements statements.as_reported.balance_sheet balance_sheet_statement_as_reported supported supported
statements statements.as_reported.cash_flow cash_flow_statement_as_reported supported supported
statements statements.as_reported.full financial_statement_full_as_reported supported supported
statements statements.reports.dates financial_reports_dates supported supported rows carry secret download links; redacted in Python repr
statements statements.reports.json financial_reports_json supported supported one typed object (not a list) whose sections are dynamic JSON
statements statements.reports.xlsx financial_reports_xlsx supported supported binary payload (BinaryResponse / fmp.BinaryPayload)
statements statements.segmentation.revenue_product revenue_product_segmentation supported supported
statements statements.segmentation.revenue_geographic revenue_geographic_segmentation supported supported
statements statements.summaries.latest_financial_statements latest_financial_statements supported supported
statements statements.summaries.financial_scores financial_scores supported supported
statements statements.summaries.owner_earnings owner_earnings supported supported
statements statements.summaries.enterprise_values enterprise_values supported supported
chart chart.light stock_chart_light supported supported
chart chart.full stock_chart_full supported supported
chart chart.non_split_adjusted stock_chart_non_split_adjusted supported supported
chart chart.dividend_adjusted stock_chart_dividend_adjusted supported supported
chart chart.one_minute stock_chart_one_minute supported supported
chart chart.five_minutes stock_chart_five_minutes supported supported
chart chart.fifteen_minutes stock_chart_fifteen_minutes supported supported
chart chart.thirty_minutes stock_chart_thirty_minutes supported supported
chart chart.one_hour stock_chart_one_hour supported supported
chart chart.four_hours stock_chart_four_hours supported supported
economics economics.treasury_rates treasury_rates supported supported
economics economics.indicators economic_indicators supported supported
economics economics.calendar economic_calendar deferred supported previous/estimate/actual are documented non-null f64; live nulls tracked in #40
economics economics.market_risk_premium market_risk_premium supported supported
calendar calendar.dividends dividends supported supported
calendar calendar.dividends_calendar dividends_calendar supported supported
calendar calendar.earnings earnings supported supported
calendar calendar.earnings_calendar earnings_calendar supported supported
calendar calendar.ipos_calendar ipos_calendar supported supported
calendar calendar.ipos_disclosure ipos_disclosure supported supported
calendar calendar.ipos_prospectus ipos_prospectus supported supported
calendar calendar.stock_splits stock_splits supported supported
calendar calendar.stock_splits_calendar stock_splits_calendar supported supported
transcripts transcripts.latest latest_earnings_transcripts supported supported
transcripts transcripts.by_quarter earnings_transcript supported supported
transcripts transcripts.dates earnings_transcript_dates supported supported
news news.articles articles supported supported
news news.latest_general_news latest_general_news supported supported
news news.latest_press_releases latest_press_releases supported supported
news news.latest_stock_news latest_stock_news supported supported
news news.latest_crypto_news latest_crypto_news supported supported
news news.latest_forex_news latest_forex_news supported supported
news news.search_press_releases search_press_releases supported supported
news news.search_stock_news search_stock_news supported supported
news news.search_crypto_news search_crypto_news supported supported
news news.search_forex_news search_forex_news supported supported
institutional_ownership institutional_ownership.latest_filings latest_institutional_ownership_filings supported supported
institutional_ownership institutional_ownership.extract institutional_ownership_extract supported supported
institutional_ownership institutional_ownership.form_13f_filing_dates form_13f_filing_dates supported supported
institutional_ownership institutional_ownership.holder_analytics institutional_holder_analytics supported supported
institutional_ownership institutional_ownership.holder_performance_summary holder_performance_summary supported supported
institutional_ownership institutional_ownership.holder_industry_breakdown holder_industry_breakdown supported supported
institutional_ownership institutional_ownership.positions_summary institutional_positions_summary supported supported
institutional_ownership institutional_ownership.industry_summary institutional_industry_summary supported supported
analyst analyst.financial_estimates financial_estimates supported supported
analyst analyst.ratings_snapshot ratings_snapshot supported supported
analyst analyst.historical_ratings historical_ratings supported supported
analyst analyst.price_target_summary price_target_summary supported supported
analyst analyst.price_target_consensus price_target_consensus supported supported
analyst analyst.stock_grades stock_grades supported supported
analyst analyst.historical_stock_grades historical_stock_grades supported supported
analyst analyst.stock_grades_summary stock_grades_summary supported supported
market market.sector_performance_snapshot sector_performance_snapshot supported supported
market market.industry_performance_snapshot industry_performance_snapshot supported supported
market market.sector_pe_snapshot sector_pe_snapshot supported supported
market market.industry_pe_snapshot industry_pe_snapshot supported supported
market market.historical_sector_performance historical_sector_performance supported supported
market market.historical_industry_performance historical_industry_performance supported supported
market market.historical_sector_pe historical_sector_pe supported supported
market market.historical_industry_pe historical_industry_pe supported supported
market market.biggest_gainers biggest_gainers supported supported
market market.biggest_losers biggest_losers supported supported
market market.most_actives most_actives supported supported
technical_indicators technical_indicators.simple_moving_average simple_moving_average supported supported
technical_indicators technical_indicators.exponential_moving_average exponential_moving_average supported supported
technical_indicators technical_indicators.weighted_moving_average weighted_moving_average supported supported
technical_indicators technical_indicators.double_exponential_moving_average double_exponential_moving_average supported supported
technical_indicators technical_indicators.triple_exponential_moving_average triple_exponential_moving_average supported supported
technical_indicators technical_indicators.relative_strength_index relative_strength_index supported supported
technical_indicators technical_indicators.standard_deviation standard_deviation supported supported
technical_indicators technical_indicators.williams williams supported supported
technical_indicators technical_indicators.average_directional_index average_directional_index supported supported
funds funds.etf_holdings etf_holdings supported supported
funds funds.etf_info etf_info supported supported
funds funds.etf_country_weightings etf_country_weightings supported supported
funds funds.etf_asset_exposure etf_asset_exposure supported supported
funds funds.etf_sector_weightings etf_sector_weightings supported supported
funds funds.latest_disclosure_holders latest_fund_disclosure_holders supported supported
funds funds.disclosures fund_disclosures supported supported
funds funds.search_disclosure_holders search_fund_disclosure_holders supported supported
funds funds.disclosure_dates fund_disclosure_dates supported supported
sec_filings sec_filings.latest_8k latest_8k_sec_filings supported supported
sec_filings sec_filings.latest latest_sec_filings supported supported
sec_filings sec_filings.by_form_type sec_filings_by_form_type supported supported
sec_filings sec_filings.by_symbol sec_filings_by_symbol supported supported
sec_filings sec_filings.by_cik sec_filings_by_cik supported supported
sec_filings sec_filings.search_companies_by_name search_sec_companies_by_name supported supported
sec_filings sec_filings.search_companies_by_symbol search_sec_companies_by_symbol supported supported
sec_filings sec_filings.search_companies_by_cik search_sec_companies_by_cik supported supported
sec_filings sec_filings.company_profile sec_company_profile supported supported
sec_filings sec_filings.industry_classifications industry_classifications supported supported
sec_filings sec_filings.all_industry_classifications all_industry_classifications supported supported
sec_filings sec_filings.search_industry_classifications search_industry_classifications raw supported documented as [{}]; Rust Vec<DynamicObject>, Python list[dict]
insider_trading insider_trading.latest_trades latest_insider_trades supported supported
insider_trading insider_trading.search_trades search_insider_trades supported supported
insider_trading insider_trading.search_reporting_names search_insider_reporting_names supported supported
insider_trading insider_trading.transaction_types insider_transaction_types supported supported
insider_trading insider_trading.trade_statistics insider_trade_statistics supported supported
insider_trading insider_trading.beneficial_ownership_acquisitions beneficial_ownership_acquisitions supported supported
indexes indexes.list index_list supported supported
indexes indexes.quote index_quote supported supported
indexes indexes.quote_short index_quote_short supported supported
indexes indexes.chart_light index_chart_light supported supported
indexes indexes.chart_full index_chart_full supported supported
indexes indexes.chart_one_minute index_chart_one_minute supported supported
indexes indexes.chart_five_minutes index_chart_five_minutes supported supported
indexes indexes.chart_one_hour index_chart_one_hour supported supported
indexes indexes.sp500_constituents sp500_constituents supported supported
indexes indexes.nasdaq_constituents nasdaq_constituents supported supported
indexes indexes.dow_jones_constituents dow_jones_constituents supported supported
indexes indexes.historical_sp500_constituents historical_sp500_constituents supported supported
indexes indexes.historical_nasdaq_constituents historical_nasdaq_constituents supported supported
indexes indexes.historical_dow_jones_constituents historical_dow_jones_constituents supported supported
market_hours market_hours.exchange exchange_market_hours supported supported
market_hours market_hours.holidays holidays_by_exchange supported supported
market_hours market_hours.all_exchanges all_exchange_market_hours supported supported
commodities commodities.list commodities_list supported supported
commodities commodities.quote commodity_quote supported supported
commodities commodities.quote_short commodity_quote_short supported supported
commodities commodities.chart_light commodity_chart_light supported supported
commodities commodities.chart_full commodity_chart_full supported supported
commodities commodities.chart_one_minute commodity_chart_one_minute supported supported
commodities commodities.chart_five_minutes commodity_chart_five_minutes supported supported
commodities commodities.chart_one_hour commodity_chart_one_hour supported supported
dcf dcf.standard discounted_cash_flow supported supported
dcf dcf.levered levered_discounted_cash_flow supported supported
dcf dcf.custom custom_discounted_cash_flow supported supported
dcf dcf.custom_levered custom_levered_discounted_cash_flow supported supported
forex forex.list forex_list supported supported
forex forex.quote forex_quote supported supported
forex forex.quote_short forex_quote_short supported supported
forex forex.chart_light forex_chart_light supported supported
forex forex.chart_full forex_chart_full supported supported
forex forex.chart_one_minute forex_chart_one_minute supported supported
forex forex.chart_five_minutes forex_chart_five_minutes supported supported
forex forex.chart_one_hour forex_chart_one_hour supported supported
crypto crypto.list cryptocurrency_list supported supported
crypto crypto.quote cryptocurrency_quote supported supported
crypto crypto.quote_short cryptocurrency_quote_short supported supported
crypto crypto.chart_light cryptocurrency_chart_light supported supported
crypto crypto.chart_full cryptocurrency_chart_full supported supported
crypto crypto.chart_one_minute cryptocurrency_chart_one_minute supported supported
crypto crypto.chart_five_minutes cryptocurrency_chart_five_minutes supported supported
crypto crypto.chart_one_hour cryptocurrency_chart_one_hour supported supported
congressional congressional.latest_senate_disclosures latest_senate_disclosures supported supported
congressional congressional.latest_house_disclosures latest_house_disclosures supported supported
congressional congressional.senate_trades senate_trades supported supported
congressional congressional.senate_trades_by_name senate_trades_by_name supported supported
congressional congressional.senate_trades_by_member_id senate_trades_by_member_id supported supported
congressional congressional.house_trades house_trades supported supported
congressional congressional.house_trades_by_name house_trades_by_name supported supported
congressional congressional.house_trades_by_member_id house_trades_by_member_id supported supported
congressional congressional.profiles congressional_profiles supported supported
congressional congressional.positions congressional_positions supported supported
congressional congressional.net_worth congressional_net_worth supported supported
congressional congressional.net_worth_aggregated congressional_net_worth_aggregated supported supported
esg esg.disclosures esg_disclosures supported supported
esg esg.ratings esg_ratings supported supported
esg esg.benchmark esg_benchmark supported supported
commitment_of_traders commitment_of_traders.report cot_report supported supported
commitment_of_traders commitment_of_traders.analysis cot_analysis supported supported
commitment_of_traders commitment_of_traders.report_list cot_report_list supported supported
fundraising fundraising.latest_crowdfunding_offerings latest_crowdfunding_offerings supported supported
fundraising fundraising.crowdfunding_offerings_by_cik crowdfunding_offerings_by_cik supported supported
fundraising fundraising.search_crowdfunding_offerings search_crowdfunding_offerings supported supported
fundraising fundraising.search_regulation_d_offerings search_regulation_d_offerings supported supported
fundraising fundraising.latest_regulation_d_offerings latest_regulation_d_offerings supported supported
fundraising fundraising.regulation_d_offerings_by_cik regulation_d_offerings_by_cik supported supported
bulk bulk.company_profiles bulk_company_profiles supported supported
bulk bulk.stock_ratings bulk_stock_ratings supported supported
bulk bulk.dcf_valuations bulk_dcf_valuations supported supported
bulk bulk.financial_scores bulk_financial_scores supported supported
bulk bulk.price_target_summaries bulk_price_target_summaries supported supported
bulk bulk.etf_holdings bulk_etf_holdings deferred supported documented key lastUpdated" is mirrored verbatim; upstream fix tracked in #40
bulk bulk.upgrades_downgrades_consensus bulk_upgrades_downgrades_consensus supported supported
bulk bulk.key_metrics_ttm bulk_key_metrics_ttm supported supported
bulk bulk.financial_ratios_ttm bulk_financial_ratios_ttm supported supported
bulk bulk.stock_peers bulk_stock_peers supported supported
bulk bulk.earnings_surprises bulk_earnings_surprises supported supported
bulk bulk.income_statements bulk_income_statements supported supported
bulk bulk.income_statement_growth bulk_income_statement_growth supported supported
bulk bulk.balance_sheet_statements bulk_balance_sheet_statements supported supported
bulk bulk.balance_sheet_statement_growth bulk_balance_sheet_statement_growth supported supported
bulk bulk.cash_flow_statements bulk_cash_flow_statements supported supported
bulk bulk.cash_flow_statement_growth bulk_cash_flow_statement_growth supported supported
bulk bulk.eod bulk_eod supported supported
tipranks tipranks.search_ratings search_tipranks_ratings gated supported requires the TipRanks add-on (AccessRequirement::NamedAddOn); Enterprise plan for history older than 3 years
tipranks tipranks.point_in_time_ratings_by_symbol tipranks_point_in_time_ratings_by_symbol gated supported requires the TipRanks add-on (AccessRequirement::NamedAddOn)
tipranks tipranks.point_in_time_ratings_by_analyst tipranks_point_in_time_ratings_by_analyst gated supported requires the TipRanks add-on (AccessRequirement::NamedAddOn)
tipranks tipranks.symbol_summary tipranks_symbol_summary gated supported requires the TipRanks add-on (AccessRequirement::NamedAddOn)
tipranks tipranks.analyst_summary tipranks_analyst_summary gated supported requires the TipRanks add-on (AccessRequirement::NamedAddOn)
tipranks tipranks.firm_summary tipranks_firm_summary gated supported requires the TipRanks add-on (AccessRequirement::NamedAddOn)
tipranks tipranks.analysts tipranks_analysts gated supported requires the TipRanks add-on (AccessRequirement::NamedAddOn)