{ "schema_version": 1, "generated_from": [ "portal/src/lib/catalogue.ts", "portal/src/lib/registry.ts", "portal/src/lib/plans.ts", "contracts/openapi/*.yaml" ], "hosts": { "api": "https://api.olympus.new-odyssey.com", "portal": "https://olympus.new-odyssey.com", "mcp": "https://mcp.olympus.new-odyssey.com/mcp" }, "auth": { "type": "api_key", "methods": [ "api_key", "oauth2" ], "header": "X-API-Key", "alternative": "Authorization: Bearer ", "obtain": "Sign up at /signup (free plan), then create a key at /console/keys.", "key_scope": "A key may be scoped to one product or allowed every product on the organization's plan; the plan must include the product.", "mcp": "The MCP server takes the same API key (X-API-Key or Authorization: Bearer), or an OAuth access token, and calls the REST API with it, so the same entitlements, quotas and metering apply.", "oauth": "OAuth 2.1 for remote MCP clients: the client discovers the authorization server from the MCP server's protected resource metadata, registers itself (RFC 7591), and the user approves an organization and product scopes on the consent screen (PKCE S256). Access tokens last 15 minutes, are bound to the MCP server and work only through it; refresh tokens rotate. Connected apps are listed and revocable in the console.", "oauth2": { "authorization_server": "https://api.olympus.new-odyssey.com", "metadata": "https://api.olympus.new-odyssey.com/.well-known/oauth-authorization-server", "protected_resource_metadata": "https://mcp.olympus.new-odyssey.com/.well-known/oauth-protected-resource/mcp", "registration": "https://api.olympus.new-odyssey.com/oauth/register", "scopes": [ "geo-demographics:read", "sales-tax:read", "sec:read", "usage:read" ] } }, "pricing": { "reference": "/pricing", "currency": "USD", "plans": [ { "code": "free", "name": "Free", "monthly_price_cents": 0, "public": true, "monthly_request_quota": 1000, "rate_limit_per_minute": 10, "historical_access": false, "bulk_access": false }, { "code": "developer", "name": "Developer", "monthly_price_cents": 7900, "public": true, "monthly_request_quota": 50000, "rate_limit_per_minute": 60, "historical_access": false, "bulk_access": false }, { "code": "growth", "name": "Growth", "monthly_price_cents": 29900, "public": true, "monthly_request_quota": 250000, "rate_limit_per_minute": 300, "historical_access": true, "bulk_access": false }, { "code": "business", "name": "Business", "monthly_price_cents": 99900, "public": true, "monthly_request_quota": 1000000, "rate_limit_per_minute": 1000, "historical_access": true, "bulk_access": true }, { "code": "enterprise", "name": "Enterprise", "monthly_price_cents": 250000, "public": false, "monthly_request_quota": null, "rate_limit_per_minute": 3000, "historical_access": true, "bulk_access": true } ], "free_tier": "The Free plan (no card) includes every live API with the Free plan's monthly quota per API and per-minute rate limit.", "quota_rules": [ "Quotas are per product, per monthly period starting on the subscription date.", "Requests answered with a 5xx are not counted; requests rejected before authentication are not counted.", "Repeating a request with the same Idempotency-Key within an hour is not counted again.", "MCP tool calls count exactly like the REST requests they make (one per endpoint called)." ], "pay_per_request": { "protocol": "x402", "status": "not_enabled", "facilitator": "Coinbase Developer Platform (CDP)", "network": "USDC on Base (testnet Base Sepolia first)", "note": "Pay-per-request without an account (x402 v2, USDC on Base through the Coinbase CDP facilitator) is built but not enabled yet. Use an API key or OAuth." } }, "rate_limits": "Per-minute limit per organization and product from the plan (X-RateLimit-* headers); monthly quota per product (X-Quota-* headers). 429 RATE_LIMIT_EXCEEDED or QUOTA_EXCEEDED with Retry-After.", "errors": "JSON {\"error\", \"code\", \"product\"?, \"details\"?}; every response has X-Request-Id.", "provenance": "Every record carries a provenance block (source URL, source version and date, publication time, validation status); every response lists the dataset publications it read in meta.datasets.", "products": [ { "number": 1, "slug": "business-verification", "name": "US Business Verification API", "category": "Business & Workforce", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 2, "slug": "professional-license-verification", "name": "US Professional License Verification API", "category": "Business & Workforce", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 3, "slug": "business-licenses", "name": "US Business License Data API", "category": "Business & Workforce", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 4, "slug": "form-5500", "name": "US Employee Benefits & Form 5500 API", "category": "Business & Workforce", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 5, "slug": "warn-notices", "name": "US WARN Layoff Notices API", "category": "Business & Workforce", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 6, "slug": "nonprofit-financials", "name": "US Nonprofit Financial Data API", "category": "Business & Workforce", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 7, "slug": "uk-premises-licensing", "name": "UK Premises Licensing API", "category": "Business & Workforce", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 8, "slug": "uk-animal-business-licensing", "name": "UK Animal Business Licensing API", "category": "Business & Workforce", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 9, "slug": "geo-demographics", "name": "US Geographic & Demographics API", "category": "Property, Land & Housing", "status": "live", "summary": "Census ACS 5-year demographics for ZCTAs and counties with margins of error, NCES public schools near a ZCTA, and comparison.", "api": { "base_path": "/v1/geo-demographics", "openapi": "/openapi/geo-demographics.yaml", "docs": "/docs/geo-demographics", "page": "/apis/geo-demographics", "endpoints": [ { "method": "GET", "path": "/v1/geo-demographics/locations/{zcta}", "operation_id": "getGeoDemographicsLocation", "summary": "ZCTA profile" }, { "method": "GET", "path": "/v1/geo-demographics/locations/{zcta}/demographics", "operation_id": "getGeoDemographicsLocationDemographics", "summary": "ZCTA demographics" }, { "method": "GET", "path": "/v1/geo-demographics/locations/{zcta}/schools", "operation_id": "listGeoDemographicsLocationSchools", "summary": "Public schools near a ZCTA" }, { "method": "POST", "path": "/v1/geo-demographics/locations/compare", "operation_id": "compareGeoDemographicsLocations", "summary": "Compare two ZCTAs" }, { "method": "GET", "path": "/v1/geo-demographics/counties/{fips}", "operation_id": "getGeoDemographicsCounty", "summary": "County profile" }, { "method": "GET", "path": "/v1/geo-demographics/coverage", "operation_id": "getGeoDemographicsCoverage", "summary": "Datasets, vintages and coverage" } ] }, "coverage": { "summary": "Census ACS 5-year demographic profiles for ZIP Code Tabulation Areas (ZCTAs) and counties, with 90% margins of error; NCES public schools near a ZCTA; two-ZCTA comparison.", "geography": "ACS 5-year ZCTAs and counties in the 50 states, DC and Puerto Rico.", "vintages": [ "ACS 5-year: the latest release loaded (e.g. 2020-2024), stated on every metric as vintage.period. Values describe that period, not today; dollars are inflation-adjusted to its final year.", "ZCTA-to-county relationships: Census 2020.", "Schools: the latest NCES CCD school year loaded (e.g. 2024-2025), stated as school_year." ], "refresh": "Annual (a publication is stale after 400 days).", "limits": [ "ZCTAs are not USPS ZIP codes: codes resolve only by exact ZCTA match; PO-box-only and single-building ZIPs have no ZCTA (404 ZCTA_NOT_FOUND).", "Values are survey estimates with margins of error (moe); suppressed values are null with null_reason.", "Connecticut planning regions (09110-09190) have no ZCTA overlaps in the 2020 relationship file." ], "not_included": [ "crime data or scores", "school ratings or rankings", "flood or other risk scores", "private schools", "predictive scores" ], "live_endpoint": "/v1/geo-demographics/coverage" }, "mcp_tools": [ "get_us_demographics", "get_product_coverage" ], "auth": { "product_id": "geo-demographics", "scopes": [ "geo-demographics:read" ] }, "pricing": { "reference": "/pricing", "included_in_plans": [ "free", "developer", "growth", "business", "enterprise" ] } }, { "number": 10, "slug": "building-permits", "name": "US Building Permits & Inspections API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 11, "slug": "code-enforcement", "name": "US Municipal Code Enforcement API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 12, "slug": "tax-delinquent-property", "name": "US Tax-Delinquent Property API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 13, "slug": "zoning", "name": "US Zoning & Development API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 14, "slug": "foreclosure-notices", "name": "US Foreclosure Notices API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 15, "slug": "uk-planning-enforcement", "name": "UK Planning Enforcement API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 16, "slug": "uk-rental-licensing", "name": "UK HMO & Rental Licensing API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 17, "slug": "uk-contaminated-land", "name": "UK Contaminated Land API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 18, "slug": "uk-developer-contributions", "name": "UK Section 106 & Developer Contributions API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 19, "slug": "uk-social-housing", "name": "UK Social Housing Data API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 20, "slug": "uk-commercial-property-valuation", "name": "UK Commercial Property Valuation API", "category": "Property, Land & Housing", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 21, "slug": "uk-council-spending", "name": "UK Council Spending API", "category": "Government Spending & Infrastructure", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 22, "slug": "uk-council-decisions", "name": "UK Council Decisions API", "category": "Government Spending & Infrastructure", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 23, "slug": "uk-council-capital-projects", "name": "UK Council Capital Projects API", "category": "Government Spending & Infrastructure", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 24, "slug": "municipal-capital-projects", "name": "US Municipal Capital Projects API", "category": "Government Spending & Infrastructure", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 25, "slug": "transportation-projects", "name": "US Transportation Infrastructure Projects API", "category": "Government Spending & Infrastructure", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 35, "slug": "federal-contractors", "name": "US Federal Contractor & Exclusions API", "category": "Government Spending & Infrastructure", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 26, "slug": "sales-tax", "name": "US Sales Tax Rates API", "category": "Financial & Tax", "status": "live", "summary": "Published sales and use tax rates by jurisdiction for Streamlined Sales Tax member states, by street address or ZIP+4, with the state, county, city and special district breakdown and effective dates.", "api": { "base_path": "/v1/sales-tax", "openapi": "/openapi/sales-tax.yaml", "docs": "/docs/sales-tax", "page": "/apis/sales-tax", "endpoints": [ { "method": "GET", "path": "/v1/sales-tax/rates/address", "operation_id": "getSalesTaxRatesByAddress", "summary": "Rates for a street address" }, { "method": "GET", "path": "/v1/sales-tax/rates/zip/{zip}", "operation_id": "getSalesTaxRatesByZip", "summary": "Rates for a ZIP+4 or 5-digit ZIP" }, { "method": "GET", "path": "/v1/sales-tax/states/{state}/jurisdictions", "operation_id": "listSalesTaxJurisdictions", "summary": "Every jurisdiction rate of a state on a date" }, { "method": "GET", "path": "/v1/sales-tax/coverage", "operation_id": "getSalesTaxCoverage", "summary": "States served, their files and the data vintage" } ] }, "coverage": { "summary": "Published sales and use tax rates by jurisdiction (state, county, city, special district) for Streamlined Sales Tax member states, by street address, ZIP+4 or 5-digit ZIP, with effective dates.", "geography": "Only the SST member states Olympus has published; GET /v1/sales-tax/coverage lists them and their dates. Every other state is answered as unsupported, with no rate.", "vintages": [ "The latest SST rate and boundary files of each state (e.g. 2026 Q4); the file name is returned with every rate.", "Dates from five years before a state's latest file quarter to its end; dates outside that range are unsupported." ], "refresh": "Checked on the 2nd and 16th of each month (stale after 100 days).", "limits": [ "Not a tax calculation or taxability determination: sourcing, nexus, exemptions and product taxability change what is owed.", "A 5-digit ZIP that spans several jurisdiction sets is answered as ambiguous with every candidate; no single rate is chosen.", "Lookups always answer 200 with status matched, ambiguous, unmatched or unsupported." ], "not_included": [ "transaction tax calculation", "states outside the published SST list (e.g. CA, TX, NY, FL)", "taxability rules", "filing or remittance" ], "live_endpoint": "/v1/sales-tax/coverage", "published_states": [ "NE", "ND", "SD", "VT", "WY" ] }, "mcp_tools": [ "lookup_us_sales_tax", "get_product_coverage" ], "auth": { "product_id": "sales-tax", "scopes": [ "sales-tax:read" ] }, "pricing": { "reference": "/pricing", "included_in_plans": [ "free", "developer", "growth", "business", "enterprise" ] } }, { "number": 27, "slug": "sec", "name": "US SEC Filings & Financial Data API", "category": "Financial & Tax", "status": "live", "summary": "SEC EDGAR companies by CIK or ticker, 10-K / 10-Q filing metadata and standardised XBRL financial metrics with history and comparison.", "api": { "base_path": "/v1/sec", "openapi": "/openapi/sec.yaml", "docs": "/docs/sec", "page": "/apis/sec", "endpoints": [ { "method": "GET", "path": "/v1/sec/companies/search", "operation_id": "searchSecCompanies", "summary": "Search companies by name or ticker, or resolve a ticker" }, { "method": "GET", "path": "/v1/sec/companies/{cik}", "operation_id": "getSecCompany", "summary": "Company profile" }, { "method": "GET", "path": "/v1/sec/companies/{cik}/filings", "operation_id": "listSecCompanyFilings", "summary": "10-K and 10-Q filings of a company" }, { "method": "GET", "path": "/v1/sec/companies/{cik}/financials", "operation_id": "getSecCompanyFinancials", "summary": "Financial metric history of a company" }, { "method": "GET", "path": "/v1/sec/financials/compare", "operation_id": "compareSecFinancials", "summary": "Compare one metric across companies" } ] }, "coverage": { "summary": "SEC EDGAR companies by CIK or ticker, 10-K / 10-Q filing metadata and eight standardised XBRL financial metrics with annual and quarterly history and comparison.", "geography": "SEC registrants in the EDGAR submissions archive, with tickers as mapped by the SEC.", "vintages": [ "As filed: the latest filed value, with the first reported value shown on restatement (is_restated).", "Annual values from 10-K / 10-K/A (FY); quarterly from 10-Q / 10-Q/A (Q1-Q3, no Q4). Fiscal years are each company's own." ], "refresh": "Nightly EDGAR bulk archives (stale after 3 days).", "limits": [ "Metrics: revenue, net_income, total_assets, total_liabilities, stockholders_equity, operating_cash_flow, eps_diluted, shares_outstanding.", "Quarterly operating cash flow is usually year-to-date (is_ytd: true).", "A ticker can map to more than one CIK during a reorganisation; ticker search returns every match." ], "not_included": [ "real-time streams", "full-text filing search", "insider trading", "ownership", "recommendations" ], "live_endpoint": null }, "mcp_tools": [ "get_sec_company_financials", "get_product_coverage" ], "auth": { "product_id": "sec", "scopes": [ "sec:read" ] }, "pricing": { "reference": "/pricing", "included_in_plans": [ "free", "developer", "growth", "business", "enterprise" ] } }, { "number": 28, "slug": "utility-regulatory-filings", "name": "US Utility Regulatory Filings API", "category": "Energy & Utilities", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 29, "slug": "interconnection-queue", "name": "US Electricity Interconnection Queue API", "category": "Energy & Utilities", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 30, "slug": "uk-rail-projects", "name": "UK Rail Infrastructure Projects API", "category": "Energy & Utilities", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 31, "slug": "health-insurance-rates", "name": "US Health Insurance Negotiated Rates API", "category": "Healthcare & Public Services", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 32, "slug": "hospital-prices", "name": "US Hospital Price Transparency API", "category": "Healthcare & Public Services", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 33, "slug": "uk-adult-social-care-fees", "name": "UK Adult Social Care Fees API", "category": "Healthcare & Public Services", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null }, { "number": 34, "slug": "uk-nhs-capital-investment", "name": "UK NHS Capital Investment API", "category": "Healthcare & Public Services", "status": "planned", "summary": null, "api": null, "coverage": null, "mcp_tools": [], "auth": null, "pricing": null } ], "mcp_tools": [ { "name": "get_us_demographics", "kind": "data", "product": "geo-demographics", "summary": "ACS 5-year demographics (with margins of error and vintage) for a US ZCTA or county.", "requires_api_key": true, "calls": [ "GET /v1/geo-demographics/locations/{zcta}/demographics", "GET /v1/geo-demographics/counties/{fips}" ], "scopes": [ "geo-demographics:read" ] }, { "name": "lookup_us_sales_tax", "kind": "data", "product": "sales-tax", "summary": "Published sales tax rates by jurisdiction for an address or ZIP in a published SST state (listed by get_product_coverage).", "requires_api_key": true, "calls": [ "GET /v1/sales-tax/rates/address", "GET /v1/sales-tax/rates/zip/{zip}" ], "scopes": [ "sales-tax:read" ] }, { "name": "get_sec_company_financials", "kind": "data", "product": "sec", "summary": "Standardised XBRL financial metric history of an SEC registrant, by CIK or ticker.", "requires_api_key": true, "calls": [ "GET /v1/sec/companies/search", "GET /v1/sec/companies/{cik}/financials" ], "scopes": [ "sec:read" ] }, { "name": "list_olympus_products", "kind": "catalogue", "product": null, "summary": "Every Olympus API (live and planned) with status, endpoints and MCP tools.", "requires_api_key": false, "calls": [], "scopes": [] }, { "name": "get_product_coverage", "kind": "catalogue", "product": null, "summary": "Coverage, vintages and limits of one API; optionally its live coverage endpoint.", "requires_api_key": false, "calls": [ "GET /v1/geo-demographics/coverage", "GET /v1/sales-tax/coverage" ], "scopes": [] }, { "name": "get_product_pricing", "kind": "catalogue", "product": null, "summary": "Plans, quotas, rate limits and the free tier.", "requires_api_key": false, "calls": [], "scopes": [] }, { "name": "get_remaining_usage", "kind": "account", "product": null, "summary": "The caller's plan and the monthly quota left per product.", "requires_api_key": true, "calls": [ "GET /v1/usage/remaining" ], "scopes": [ "usage:read" ] } ] }