{"openapi":"3.1.0","info":{"title":"Choice Arrangement Deck API","version":"1.0.0","description":"Individual-market (ACA) plans, age-rated premiums, silver benchmarks, formularies and in-network checks, subsidy-aware quotes (/subsidies: estimated premium tax credit, Medicaid indicator, cost-sharing reductions; estimates only), plus Medicare Advantage and Part D plans (/medicare). Free tier: per UTC day the first 100 calls at full speed, the next 500 at most one per 5 seconds, then 429 until 00:00 UTC. Every response carries X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-CAD-Usage-Band, X-CAD-Data-Version and X-Request-Id. Errors are RFC 9457 application/problem\u002Bjson. Enums are open: ignore values you do not know. Do not send consumer personal data.","termsOfService":"https://choicearrangementdeck.com/developer/terms","contact":{"name":"Choice Arrangement Deck developer support","email":"support@choicearrangementdeck.com"}},"servers":[{"url":"https://api.choicearrangementdeck.com/v1"}],"security":[{"oauth2":[]}],"tags":[{"name":"auth","description":"OAuth 2.0 client credentials"},{"name":"geo","description":"ZIP codes, counties, rating areas"},{"name":"plans","description":"Plans and issuers"},{"name":"prices","description":"Premiums, quotes, benchmarks"},{"name":"subsidies","description":"Estimated federal premium tax credit, Medicaid indicator and cost-sharing reductions, with the rules used, by plan year"},{"name":"providers","description":"In-network checks by NPI"},{"name":"drugs","description":"Drug search and formulary coverage"},{"name":"medicare","description":"Medicare Advantage and Part D plans, benefits and service areas, by plan year"},{"name":"networks","description":"Network sizes, comparison and disruption analysis (provider networks by NPI)"},{"name":"ichra","description":"ICHRA affordability (minimum employer contribution, FPL safe harbor)"},{"name":"exports","description":"Bulk exports (JSON Lines, CSV or XML) per plan year: plans, service areas, ZIP-to-county, plan-to-network"},{"name":"meta","description":"Usage and data versions"}],"paths":{"/oauth/token":{"post":{"tags":["auth"],"operationId":"getToken","summary":"Exchange client credentials for an access token","description":"OAuth 2.0 client_credentials. Send the client id and secret with HTTP Basic (preferred) or in the form body. Tokens last 60 minutes; there are no refresh tokens. Not counted against the daily limit. Max 30 tokens per client per hour.","security":[],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"type":"object","properties":{"grant_type":{"type":"string","enum":["client_credentials"]},"scope":{"type":"string","description":"Space-separated subset of: plans prices drugs providers"},"client_id":{"type":"string","description":"Only with client_secret_post"},"client_secret":{"type":"string","description":"Only with client_secret_post"}},"required":["grant_type"]}}}},"responses":{"200":{"description":"Token issued","content":{"application/json":{"schema":{"type":"object","properties":{"access_token":{"type":"string"},"token_type":{"type":"string","description":"Bearer"},"expires_in":{"type":"integer","description":"Seconds (3600)"},"scope":{"type":"string"}}}}}},"400":{"description":"unsupported_grant_type, invalid_scope, unauthorized_client (RFC 6749)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthError"}}}},"401":{"description":"invalid_client","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthError"}}}},"429":{"description":"Too many tokens or failed attempts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuthError"}}}}}}},"/.well-known/jwks.json":{"get":{"tags":["auth"],"operationId":"getJwks","summary":"Public token signing keys (JWKS)","parameters":[],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"security":[]}},"/openapi.json":{"get":{"tags":["meta"],"operationId":"getOpenApi","summary":"This OpenAPI document","parameters":[],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object"}}}}},"security":[]}},"/me/usage":{"get":{"tags":["meta"],"operationId":"getMyUsage","summary":"Your usage today against your limits (not counted)","parameters":[],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Usage"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/meta/data-versions":{"get":{"tags":["meta"],"operationId":"getDataVersions","summary":"Published data version, plan years and source load dates","parameters":[],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/DataVersions"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/geo/zip-codes/{zipCode}":{"get":{"tags":["geo"],"operationId":"getZipCode","summary":"Counties and rating areas of a ZIP code","parameters":[{"name":"zipCode","in":"path","required":true,"description":"5-digit ZIP code","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ZipCode"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/geo/counties/{countyFips}":{"get":{"tags":["geo"],"operationId":"getCounty","summary":"County detail and rating area per plan year","parameters":[{"name":"countyFips","in":"path","required":true,"description":"5-digit county FIPS code","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/County"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/issuers":{"get":{"tags":["plans"],"operationId":"listIssuers","summary":"Issuers (HIOS issuer IDs) offering individual-market plans","parameters":[{"name":"state","in":"query","required":false,"description":"2-letter state code","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"1-based page, default 1","schema":{"type":"string"}},{"name":"perPage","in":"query","required":false,"description":"Items per page, default 25, max 100","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Issuer"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/plans":{"get":{"tags":["plans"],"operationId":"listPlans","summary":"Individual-market medical plans sold at a ZIP code and county (no prices). With coverage=dental: stand-alone dental and pediatric dental plans instead (never mixed into the medical list), optionally priced for a household","parameters":[{"name":"zipCode","in":"query","required":true,"description":"5-digit ZIP code","schema":{"type":"string"}},{"name":"countyFips","in":"query","required":true,"description":"5-digit county FIPS; required because ZIPs cross counties","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}},{"name":"metalLevel","in":"query","required":false,"description":"bronze, expanded-bronze, silver, gold, platinum, catastrophic (comma-separated)","schema":{"type":"string"}},{"name":"issuerId","in":"query","required":false,"description":"HIOS issuer ID","schema":{"type":"string"}},{"name":"planType","in":"query","required":false,"description":"HMO, PPO, EPO, POS","schema":{"type":"string"}},{"name":"networkId","in":"query","required":false,"description":"CAD network ID","schema":{"type":"string"}},{"name":"coverage","in":"query","required":false,"description":"medical (default) or dental. dental returns stand-alone dental plans (CMS plan-attributes DentalOnlyPlan=Yes, federal and state exchanges) of the dental plan year; medical results never contain them","schema":{"type":"string"}},{"name":"ages","in":"query","required":false,"description":"dental only: comma-separated ages of the household (max 20); adds premium per plan (monthly dollars, by age or by family tier)","schema":{"type":"string"}},{"name":"level","in":"query","required":false,"description":"dental only: high or low (CMS dental level)","schema":{"type":"string"}},{"name":"audience","in":"query","required":false,"description":"dental only: child-only, adult-and-child or adult-only (comma-separated)","schema":{"type":"string"}},{"name":"pediatric","in":"query","required":false,"description":"dental only: true keeps plans that cover children (child-only and adult-and-child); false keeps adult-only plans","schema":{"type":"string"}},{"name":"market","in":"query","required":false,"description":"dental only: individual (default), shop or all. SHOP plans are small-group plans sold through an employer","schema":{"type":"string"}},{"name":"exchange","in":"query","required":false,"description":"dental only: on, off or both: sold on the exchange, only off it, or both","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"dental only: default (level, issuer, id) or premium (cheapest first; needs ages)","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"1-based page, default 1","schema":{"type":"string"}},{"name":"perPage","in":"query","required":false,"description":"Items per page, default 25, max 100","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/Plan"},{"$ref":"#/components/schemas/DentalPlan"}]}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/plans/batch":{"post":{"tags":["plans"],"operationId":"getPlansBatch","summary":"Up to 50 plans by ID","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planIds":{"type":"array","maxItems":50,"items":{"type":"string","description":"CMS plan ID, e.g. 12345MN0010001 or 12345MN0010001-01"}},"planYear":{"type":"integer"}},"required":["planIds"]}}}},"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PlanDetail"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/plans/{planId}":{"get":{"tags":["plans"],"operationId":"getPlan","summary":"Plan detail: deductible, maximum out-of-pocket, service area, network, links","parameters":[{"name":"planId","in":"path","required":true,"description":"CMS plan ID (14 characters, optional -NN variant). A stand-alone dental plan ID (for example 21989AK0030001) returns the dental detail when no medical plan has that ID","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}},{"name":"coverage","in":"query","required":false,"description":"dental: look the ID up among dental plans only","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/PlanDetail"},{"$ref":"#/components/schemas/DentalPlanDetail"}]},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/plans/{planId}/rates":{"get":{"tags":["prices"],"operationId":"getPlanRates","summary":"Monthly premium by age (0-14 to 64\u002B), tobacco and non-tobacco, in one county","parameters":[{"name":"planId","in":"path","required":true,"description":"CMS plan ID; a stand-alone dental plan ID returns dental rates (by age or by family tier) in dollars","schema":{"type":"string"}},{"name":"countyFips","in":"query","required":true,"description":"5-digit county FIPS","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"oneOf":[{"$ref":"#/components/schemas/PlanRates"},{"$ref":"#/components/schemas/DentalPlanRates"}]},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/plans/{planId}/benefits":{"get":{"tags":["plans"],"operationId":"getPlanBenefits","summary":"Every benefit and cost-sharing row stored for an individual-market plan (CMS Benefits and Cost Sharing PUF, standard variant), plan attributes (actuarial value, EHB %, riders...) and its CSR variants (deductible, MOOP, AV)","parameters":[{"name":"planId","in":"path","required":true,"description":"14-character CMS plan ID","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"planId":{"type":"string"},"planYear":{"type":"integer"},"name":{"type":"string"},"metalLevel":{"type":"string"},"variantId":{"type":"string","description":"Stored variant, e.g. 10091OR0770001-01"},"benefitCount":{"type":"integer"},"benefits":{"type":"array","items":{"type":"object","properties":{"benefit":{"type":"string","description":"snake_case benefit, e.g. primary_care_physician, individual_medical_deductible"},"inNetwork":{"type":"string"},"outOfNetwork":{"type":"string"},"limit":{"type":"string"}}}},"attributes":{"type":"object","additionalProperties":true,"description":"Plan-level attributes as stored (snake_case)"},"csrVariants":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"e.g. 10091OR0770001-06"},"values":{"type":"object","additionalProperties":true}}}},"notes":{"type":"array","items":{"type":"string"}}}},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/ichra/census":{"post":{"tags":["ichra"],"operationId":"uploadIchraCensus","summary":"Upload a group census for ICHRA quoting: an Excel workbook (.xlsx, first worksheet, same columns as CSV; legacy .xls is 415), CSV (Content-Type text/csv, one row per person; dependents repeat their employee\u0027s Employee ID with Relationship Spouse or Child) or JSON {employees: [{id, dateOfBirth|age, zipCode, countyFips, tobacco, lastUsedTobacco, hourlyRate, annualSalary, w2Wages, householdIncome, householdSize, dependents: [{id, relationship, dateOfBirth|age, tobacco}]}]}. CSV headers: Employee ID, Relationship, Date of Birth (or Age), Home ZIP, County FIPS, Tobacco (Y/N) or Last Used Tobacco, Hourly Rate, Annual Salary, W-2 Wages, Household Income, Household Size, and for classes Employment Type (full-time/part-time/seasonal), Pay Type (salaried/hourly; derived from Hourly Rate or Annual Salary when blank), Collective Bargaining, Waiting Period, Nonresident Alien (Y/N) (the website\u0027s census aliases are accepted). Up to 1,000 employees, 15 dependents each, 2 MB. Any row error is a 422 listing every row and field; nothing is stored. Names are not stored. Kept 7 days. Scope prices, counted","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"employees":{"type":"array","maxItems":1000,"items":{"type":"object","properties":{"id":{"type":"string","description":"Your employee id (not an SSN)"},"dateOfBirth":{"type":"string","description":"YYYY-MM-DD or M/D/YYYY"},"age":{"type":"integer","description":"When there is no date of birth"},"zipCode":{"type":"string"},"countyFips":{"type":"string","description":"Needed when the ZIP spans counties"},"tobacco":{"type":"boolean"},"lastUsedTobacco":{"type":"string","description":"Date; a smoker when within 6 months of the effective date"},"hourlyRate":{"type":"number"},"annualSalary":{"type":"number"},"w2Wages":{"type":"number"},"householdIncome":{"type":"number","description":"Annual, for the household premium tax credit estimate"},"householdSize":{"type":"integer"},"currentContribution":{"type":"number"},"employmentType":{"type":"string","description":"full-time, part-time or seasonal"},"payType":{"type":"string","description":"salaried or hourly"},"collectiveBargaining":{"type":"boolean"},"waitingPeriod":{"type":"boolean"},"nonresidentAlien":{"type":"boolean"},"dependents":{"type":"array","maxItems":15,"items":{"type":"object","properties":{"id":{"type":"string"},"relationship":{"type":"string","description":"spouse or child"},"dateOfBirth":{"type":"string"},"age":{"type":"integer"},"tobacco":{"type":"boolean"},"lastUsedTobacco":{"type":"string"}}}}}}}}}},"text/csv":{"schema":{"type":"string","description":"CSV with a header row"}},"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary","description":".xlsx workbook; the first worksheet is read"}}}},"responses":{"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"201":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IchraCensus"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"415":{"description":"Legacy .xls workbook: save as .xlsx or CSV","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"413":{"description":"Body over 2 MB","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/ichra/census/{censusId}":{"get":{"tags":["ichra"],"operationId":"getIchraCensus","summary":"A stored census: counts, notes and expiry (member details are not echoed). Not counted","parameters":[{"name":"censusId","in":"path","required":true,"description":"cen_... id","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IchraCensus"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"delete":{"tags":["ichra"],"operationId":"deleteIchraCensus","summary":"Delete a stored census now","parameters":[{"name":"censusId","in":"path","required":true,"description":"cen_... id","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}}},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/ichra/quote-jobs":{"post":{"tags":["ichra"],"operationId":"createIchraQuoteJob","summary":"Start an ICHRA group quote job (202, status queued; poll GET /ichra/quote-jobs/{jobId}). Body: censusId (or an inline census), planYear (2026 default; 2027 selectable), effectiveDate (default Jan 1), ratingAreaLocation home|work (\u002B workZipCode, workCountyFips), employerContribution (monthly allowance to test affordability), metalLevels, issuerIds, includePlans (default true); classes {by: permitted class types (employmentType, payType, collectiveBargaining, waitingPeriod, nonresidentAlien, ratingArea or state; age is not a class), groupPlanOfferedToOtherClasses (turns on the minimum class size rule), definitions: [{match, ageBands, maxAllowance}]}; ageBands [{fromAge, toAge, allowance}] for every class (allowance rises with age, oldest at most 3x youngest, else 422); optimizer {enabled (default true), safeHarbor auto|federalPovertyLine|rateOfPay|w2Wages, maxBands 1-10 (default 4), maxAllowance}; totalEmployeeCount (optional: the employer\u0027s whole headcount, used by the minimum class size rule instead of the census count when the census is partial; must be at least the number of census employees, else 422; the report says which count was used and why); familyTiers {by: coverage (employeeOnly, employeeSpouse, employeeChildren, family; default) or dependents (employeeOnly, employeePlus1, employeePlus2, employeePlus3OrMore), multipliers {tier: 1-10 x the employee-only allowance} or amounts {tier: [one amount per top-level age band]} (each tier must be one multiple of the employee-only bands, so the age variation is the same in every tier, else 422; a larger family may not get less; every tier the census uses needs an amount, else 422), or neither for the optimizer to choose (1x each, the cheapest, or the smallest multiples covering minimumShareOfHouseholdBenchmark of each household\u0027s benchmark)}; the household\u0027s tier comes from its census dependents and affordability always uses the employee-only allowance. Scope prices, counted","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"censusId":{"type":"string"},"census":{"type":"object","properties":{"employees":{"type":"array","items":{"type":"object"}}}},"planYear":{"type":"integer","description":"2026 (default) or 2027"},"effectiveDate":{"type":"string","description":"YYYY-MM-DD in the plan year"},"ratingAreaLocation":{"type":"string","description":"home (default) or work"},"workZipCode":{"type":"string"},"workCountyFips":{"type":"string"},"employerContribution":{"type":"number","description":"Monthly allowance per employee, dollars"},"metalLevels":{"type":"array","items":{"type":"string"}},"issuerIds":{"type":"array","items":{"type":"string"}},"includePlans":{"type":"boolean"},"totalEmployeeCount":{"type":"integer","description":"Optional employer total headcount (1-1,000,000, at least the census size, else 422) for the minimum class size rule; omitted = the census count"},"ageBands":{"type":"array","items":{"$ref":"#/components/schemas/IchraAgeBand"}},"familyTiers":{"$ref":"#/components/schemas/IchraFamilyTiers"},"classes":{"type":"object","properties":{"by":{"type":"array","items":{"type":"string","description":"employmentType, payType, collectiveBargaining, waitingPeriod, nonresidentAlien, ratingArea, state"}},"groupPlanOfferedToOtherClasses":{"type":"boolean"},"definitions":{"type":"array","items":{"type":"object","properties":{"match":{"type":"object","additionalProperties":{"type":"string"}},"ageBands":{"type":"array","items":{"$ref":"#/components/schemas/IchraAgeBand"}},"maxAllowance":{"type":"number"}}}}}},"optimizer":{"type":"object","properties":{"enabled":{"type":"boolean"},"safeHarbor":{"type":"string","description":"auto (default), federalPovertyLine, rateOfPay, w2Wages"},"maxBands":{"type":"integer","description":"1-10, default 4"},"maxAllowance":{"type":"number","description":"Monthly cap; no design above it"}}}}}}}},"responses":{"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"202":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IchraQuoteJob"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}}}}},"/ichra/quote-jobs/{jobId}":{"get":{"tags":["ichra"],"operationId":"getIchraQuoteJob","summary":"Job status (queued, running, complete, failed), progress and, when complete, the group summary per safe harbor (FPL, rate of pay, W-2): sum of minimums, flat (single-class) cost, compliant age-based schedule and cost, recommended safe harbor. Not counted","parameters":[{"name":"jobId","in":"path","required":true,"description":"iqj_... id","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/IchraQuoteJob"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}},"delete":{"tags":["ichra"],"operationId":"deleteIchraQuoteJob","summary":"Delete a job and its results now","parameters":[{"name":"jobId","in":"path","required":true,"description":"iqj_... id","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"deleted":{"type":"boolean"}}},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/ichra/quote-jobs/{jobId}/results":{"get":{"tags":["ichra"],"operationId":"getIchraQuoteResults","summary":"Households of a complete job: members (age on the effective date, tobacco), per-member and per-household monthly premiums for every plan sold at the home address (cheapest first), and affordability (self-only non-tobacco LCSP, each safe harbor\u0027s income, max employee cost and minimum employer contribution, household SLCSP benchmark, estimated household premium tax credit). 409 until complete. Not counted","parameters":[{"name":"jobId","in":"path","required":true,"description":"iqj_... id","schema":{"type":"string"}},{"name":"employeeId","in":"query","required":false,"description":"Only this employee","schema":{"type":"string"}},{"name":"format","in":"query","required":false,"description":"json (default) or json-report (the downloadable report, same as /report)","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"1-based page, default 1","schema":{"type":"string"}},{"name":"perPage","in":"query","required":false,"description":"Items per page, default 25, max 100","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IchraHousehold"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/ichra/quote-jobs/{jobId}/report":{"get":{"tags":["ichra"],"operationId":"getIchraQuoteReport","summary":"The explanation as a downloadable JSON document (Content-Disposition: attachment; ichra-report-{jobId}.json): inputs, ordered steps with notes, each household\u0027s benchmark plan and safe-harbor math, per class the minimum class size test, the employer\u0027s age bands and their checks, every band design the optimizer tried and why it was chosen or rejected, the compliance checks and the recommendation with its reasoning. 409 until complete. Not counted","parameters":[{"name":"jobId","in":"path","required":true,"description":"iqj_... id","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IchraReport"}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/ichra/affordability":{"post":{"tags":["ichra"],"operationId":"ichraAffordability","summary":"ICHRA affordability per employee: self-only lowest-cost silver plan (LCSP) at the employee\u0027s age in the home or work rating area, the most the employee can be required to pay (IRS required contribution %, 9.96% 2026 / 10.22% 2027) and the minimum employer contribution, plus the FPL safe harbor and an affordable flag. Scope prices, counted. An estimate","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"planYear":{"type":"integer"},"ratingAreaLocation":{"type":"string","description":"home (default) or work"},"members":{"type":"array","maxItems":200,"items":{"type":"object","properties":{"id":{"type":"string"},"age":{"type":"integer"},"zipCode":{"type":"string"},"countyFips":{"type":"string"},"workZipCode":{"type":"string"},"workCountyFips":{"type":"string"},"householdIncome":{"type":"number","description":"Annual household income (MAGI), dollars"},"householdSize":{"type":"integer"},"safeHarborIncome":{"type":"number","description":"Annual income under a safe harbor (W-2, rate of pay); used instead of householdIncome when sent"},"employerContribution":{"type":"number","description":"Monthly ICHRA allowance, dollars (optional)"}}}}}}}}},"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"planYear":{"type":"integer"},"estimate":{"type":"boolean"},"ratingAreaLocation":{"type":"string"},"requiredContributionPercent":{"type":"number"},"minimumEmployerContribution":{"type":"number","description":"Highest across members"},"fplMinimumEmployerContribution":{"type":"number"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"age":{"type":"integer"},"state":{"type":"string"},"ratingArea":{"type":"string"},"lcsp":{"type":"object","properties":{"planId":{"type":"string"},"name":{"type":"string"},"monthlyPremium":{"type":"number"}}},"slcsp":{"type":"object","properties":{"planId":{"type":"string"},"name":{"type":"string"},"monthlyPremium":{"type":"number"}}},"requiredContributionPercent":{"type":"number"},"maxEmployeeMonthlyCost":{"type":"number"},"minimumEmployerContribution":{"type":"number"},"fplMinimumEmployerContribution":{"type":"number"},"employerContribution":{"type":"number"},"affordable":{"type":"boolean"},"estimatedPremiumTaxCredit":{"type":"number"},"basis":{"type":"string","description":"householdIncome or safeHarborIncome"}}}},"method":{"type":"array","items":{"type":"string"}},"disclaimer":{"type":"string"}}},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/exports":{"get":{"tags":["exports"],"operationId":"listExports","summary":"Bulk export catalog: the four datasets (JSON Lines, CSV or XML) (plans, service-areas, zip-counties, plan-networks), plan years, page limits and the data version. Scope plans; not counted against the daily limit","parameters":[],"responses":{"200":{"description":"OK","headers":{},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ExportCatalog"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/exports/{dataset}":{"get":{"tags":["exports"],"operationId":"getExport","summary":"Bulk export of one dataset for one plan year as JSON Lines (default, one JSON object per line), CSV or XML (format=jsonl|csv|xml, or Accept: text/csv / application/xml; the format query parameter wins): plans, service-areas, zip-counties or plan-networks. Paged with an opaque cursor (follow X-CAD-Next-Cursor or the Link rel=next header until it is absent), cacheable (ETag, Cache-Control: private, max-age=3600, 304 on If-None-Match). Scope plans. Every page is one counted call against the daily limit (free tier: first 100 calls full speed, next 500 at one per 5 seconds, then 429 until 00:00 UTC); a page holds up to 20,000 lines, so each dataset takes a handful of calls. All ids are strings; money is dollars. The cursor is bound to the data version: if new data was published while paging, the next page is a 409 export_version_changed and the export starts again without a cursor","parameters":[{"name":"dataset","in":"path","required":true,"description":"plans, service-areas, zip-counties or plan-networks","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"Lines per page, 1 to 20000, default 5000","schema":{"type":"string"}},{"name":"cursor","in":"query","required":false,"description":"The X-CAD-Next-Cursor of the previous page; omit for the first page","schema":{"type":"string"}},{"name":"format","in":"query","required":false,"description":"Output format: jsonl (default, application/x-ndjson), csv (text/csv) or xml (application/xml). Without it, the Accept header chooses (text/csv, application/xml); otherwise JSON Lines","schema":{"type":"string","enum":["jsonl","csv","xml"],"default":"jsonl"}}],"responses":{"200":{"description":"One page in the requested format (JSON Lines, CSV with a header row, or XML)","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"},"X-CAD-Export-Format":{"description":"jsonl, csv or xml","schema":{"type":"string"}},"Vary":{"description":"Authorization, Accept","schema":{"type":"string"}},"ETag":{"description":"Validator of this page (differs per format); send it back in If-None-Match for a 304","schema":{"type":"string"}},"Cache-Control":{"description":"private, max-age=3600","schema":{"type":"string"}},"X-CAD-Export-Dataset":{"description":"The dataset","schema":{"type":"string"}},"X-CAD-Export-Plan-Year":{"description":"The plan year","schema":{"type":"string"}},"X-CAD-Export-Offset":{"description":"Index of the first line of this page","schema":{"type":"string"}},"X-CAD-Export-Count":{"description":"Lines in this page","schema":{"type":"string"}},"X-CAD-Export-Total":{"description":"Lines in the whole dataset for this plan year and data version","schema":{"type":"string"}},"X-CAD-Next-Cursor":{"description":"Cursor of the next page; absent on the last page","schema":{"type":"string"}},"Link":{"description":"URL of the next page with rel=\u0022next\u0022; absent on the last page","schema":{"type":"string"}}},"content":{"application/x-ndjson":{"schema":{"type":"string","description":"One JSON object per line, newline-terminated. Line schema by dataset: plans = ExportPlanLine, service-areas = ExportServiceAreaLine, zip-counties = ExportZipCountyLine, plan-networks = ExportPlanNetworkLine"},"examples":{"plans":{"value":"{\u0022planId\u0022:\u002210001MN0010001\u0022,\u0022planYear\u0022:2027,\u0022name\u0022:\u0022Sample Gold\u0022,\u0022issuerId\u0022:\u002210001\u0022,\u0022issuerName\u0022:\u0022Sample Health Plan\u0022,\u0022state\u0022:\u0022MN\u0022,\u0022metalLevel\u0022:\u0022gold\u0022,\u0022hsaEligible\u0022:false,\u0022countyCount\u0022:2}\n"}}},"text/csv":{"schema":{"type":"string","description":"RFC 4180 CSV, UTF-8, CRLF, header row on every page, columns in the field order of the dataset. Lists (countyFips, networkIssuerIds) are joined with ;. partialCountyZips is county:zip zip;county:zip. Null is an empty cell; booleans are true/false"},"examples":{"plans":{"value":"planId,planYear,name,issuerId,issuerName,state,metalLevel,planType,hsaEligible,deductible,maxOutOfPocket,networkId,countyCount\r\n10001MN0010001,2027,Sample Gold,10001,\u0022Sample Health Plan, Inc.\u0022,MN,gold,,false,,,,2\r\n"}}},"application/xml":{"schema":{"type":"string","description":"UTF-8 XML. Root element per dataset (plans, serviceAreas, zipCounties, planNetworks) with attributes dataset, planYear, dataVersion, offset, count, total; one record element per line (plan, serviceArea, zipCounty, planNetwork) with one child element per field. Lists are \u003Cvalue\u003E children; partialCountyZips is \u003Ccounty fips=...\u003E\u003CzipCode/\u003E...\u003C/county\u003E. Null fields are omitted"},"examples":{"plans":{"value":"\u003C?xml version=\u00221.0\u0022 encoding=\u0022utf-8\u0022?\u003E\u003Cplans dataset=\u0022plans\u0022 planYear=\u00222027\u0022 dataVersion=\u0022v1\u0022 offset=\u00220\u0022 count=\u00221\u0022 total=\u00221\u0022\u003E\u003Cplan\u003E\u003CplanId\u003E10001MN0010001\u003C/planId\u003E\u003CplanYear\u003E2027\u003C/planYear\u003E\u003Cname\u003ESample Gold\u003C/name\u003E\u003CissuerId\u003E10001\u003C/issuerId\u003E\u003CissuerName\u003ESample Health Plan\u003C/issuerName\u003E\u003Cstate\u003EMN\u003C/state\u003E\u003CmetalLevel\u003Egold\u003C/metalLevel\u003E\u003ChsaEligible\u003Efalse\u003C/hsaEligible\u003E\u003CcountyCount\u003E2\u003C/countyCount\u003E\u003C/plan\u003E\u003C/plans\u003E"}}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"304":{"description":"Not modified: the page you hold is current (counted)"},"409":{"description":"export_version_changed: new data was published while paging; start again without a cursor (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/subsidies/rules":{"get":{"tags":["subsidies"],"operationId":"getSubsidyRules","summary":"The subsidy rules used for a plan year: applicable percentage bands, poverty guidelines, thresholds, CSR tiers, Medicaid expansion states and sources (any valid token, counted)","parameters":[{"name":"planYear","in":"query","required":false,"description":"Plan year with rules; year is accepted too. Default: the current open-enrollment year. 422 lists the years with rules","schema":{"type":"string"}},{"name":"scenario","in":"query","required":false,"description":"currentLaw (default) or enhancedCredits. enhancedCredits is HYPOTHETICAL, not current law: the expired ARPA/IRA schedule with no income limit. 422 lists the scenarios","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SubsidyRules"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/subsidies/estimate":{"post":{"tags":["subsidies"],"operationId":"estimateSubsidy","summary":"Estimate the federal premium tax credit (APTC), Medicaid indicator and cost-sharing-reduction tier for a household. An estimate, not tax or eligibility advice","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubsidyEstimateRequest"}}}},"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SubsidyEstimate"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/quotes":{"post":{"tags":["prices"],"operationId":"createQuote","summary":"Price a household (ages and tobacco only, no names or birth dates) for every plan in an area, optionally with network and formulary status. Send householdIncome to also get per-plan subsidizedPremium, estimatedPremiumTaxCredit and csrTier/csrVariant plus a subsidy summary (an estimate; optional treatMedicaidLikelyAsIneligible and scenario); without it the response is unchanged","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteRequest"}}}},"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Quote"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"},"subsidy":{"$ref":"#/components/schemas/SubsidyEstimate"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/benchmarks/silver":{"get":{"tags":["prices"],"operationId":"getSilverBenchmark","summary":"Second-lowest-cost silver plan premium at a ZIP and county","parameters":[{"name":"zipCode","in":"query","required":true,"description":"5-digit ZIP code","schema":{"type":"string"}},{"name":"countyFips","in":"query","required":true,"description":"5-digit county FIPS","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}},{"name":"age","in":"query","required":false,"description":"0-120, default 40","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Benchmark"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/benchmarks/plans":{"get":{"tags":["prices"],"operationId":"getPlanBenchmarks","summary":"Competitive benchmarking: by metal level, the distribution (min, p25, median, p75, max, mean) of monthly premium at an age, deductible and maximum out-of-pocket across the individual-market plans at a ZIP and county, and every plan\u0027s rank (1 = lowest) and percentile (share of peers at or below; lower = cheaper)","parameters":[{"name":"zipCode","in":"query","required":true,"description":"5-digit ZIP code","schema":{"type":"string"}},{"name":"countyFips","in":"query","required":true,"description":"5-digit county FIPS","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}},{"name":"age","in":"query","required":false,"description":"0-120, default 40","schema":{"type":"string"}},{"name":"metalLevel","in":"query","required":false,"description":"Comma-separated metal levels","schema":{"type":"string"}},{"name":"market","in":"query","required":false,"description":"individual (the only market available)","schema":{"type":"string"}},{"name":"includePlans","in":"query","required":false,"description":"false = distributions only","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"BenchmarkDto: planYear, zipCode, countyFips, state, ratingArea, market, age, groups[{ metalLevel, planCount, issuerCount, premium|deductible|maxOutOfPocket { count, min, p25, median, p75, max, mean }, plans[{ planId, name, issuer, premium|deductible|maxOutOfPocket { value, rank, of, percentile } }] }], notes"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/plans/{planId}/benchmark":{"get":{"tags":["prices"],"operationId":"getPlanBenchmark","summary":"One plan against its county and metal-level peers: rank and percentile on premium, deductible and maximum out-of-pocket, plus the peer distribution","parameters":[{"name":"planId","in":"path","required":true,"description":"CMS plan ID","schema":{"type":"string"}},{"name":"zipCode","in":"query","required":true,"description":"5-digit ZIP code","schema":{"type":"string"}},{"name":"countyFips","in":"query","required":true,"description":"5-digit county FIPS","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}},{"name":"age","in":"query","required":false,"description":"0-120, default 40","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"PlanBenchmarkDetailDto: planYear, zipCode, countyFips, market, age, plan { planId, premium|deductible|maxOutOfPocket { value, rank, of, percentile } }, peers (distribution), notes"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/providers/{npi}/quality":{"get":{"tags":["providers"],"operationId":"getProviderQuality","summary":"Provider quality (CMS Care Compare): clinician MIPS final and category scores, and the overall star ratings of the hospitals the clinician is affiliated with","parameters":[{"name":"npi","in":"path","required":true,"description":"10-digit NPI","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"quality { npi, found, mips { finalScore, quality, promotingInteroperability, improvementActivities, cost, source, facilityCcn }, affiliatedHospitals[HospitalQuality], affiliatedHospitalAverageStars }, source { version, hospitalRatingsAsOf, mipsAsOf, mipsDataset, disclaimer }"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/hospitals/{ccn}/quality":{"get":{"tags":["providers"],"operationId":"getHospitalQuality","summary":"Hospital overall star rating (1-5, CMS Hospital General Information) by CMS Certification Number","parameters":[{"name":"ccn","in":"path","required":true,"description":"6-character CMS Certification Number","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","description":"hospital { ccn, name, city, state, zipCode, hospitalType, ownership, emergencyServices, overallStarRating, ratingFootnote }, source"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/quality/hospitals":{"get":{"tags":["providers"],"operationId":"listHospitalQuality","summary":"Hospitals in a state with their overall star rating, best first","parameters":[{"name":"state","in":"query","required":true,"description":"2-letter state code","schema":{"type":"string"}},{"name":"zipCode","in":"query","required":false,"description":"5-digit ZIP code","schema":{"type":"string"}},{"name":"minRating","in":"query","required":false,"description":"1-5","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"1-based page, default 1","schema":{"type":"string"}},{"name":"perPage","in":"query","required":false,"description":"Items per page, default 25, max 100","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","description":"HospitalQuality list"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/providers/{npi}/network-status":{"get":{"tags":["providers"],"operationId":"getProviderNetworkStatus","summary":"In-network yes / no / unknown per plan sold in an area, with source and as-of date","parameters":[{"name":"npi","in":"path","required":true,"description":"10-digit NPI","schema":{"type":"string"}},{"name":"zipCode","in":"query","required":true,"description":"5-digit ZIP code","schema":{"type":"string"}},{"name":"countyFips","in":"query","required":true,"description":"5-digit county FIPS","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkStatus"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/drugs":{"get":{"tags":["drugs"],"operationId":"searchDrugs","summary":"Drug search by name prefix or RxCUI","parameters":[{"name":"q","in":"query","required":true,"description":"Name (3\u002B characters) or RxCUI","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"1-based page, default 1","schema":{"type":"string"}},{"name":"perPage","in":"query","required":false,"description":"Items per page, default 25, max 100","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Drug"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/drugs/{rxcui}/coverage":{"get":{"tags":["drugs"],"operationId":"getDrugCoverage","summary":"Formulary tier, prior authorization, step therapy and quantity limits per plan","parameters":[{"name":"rxcui","in":"path","required":true,"description":"RxNorm concept ID","schema":{"type":"string"}},{"name":"planIds","in":"query","required":false,"description":"Comma-separated plan IDs (max 50); or use zipCode \u002B countyFips","schema":{"type":"string"}},{"name":"zipCode","in":"query","required":false,"description":"5-digit ZIP code","schema":{"type":"string"}},{"name":"countyFips","in":"query","required":false,"description":"5-digit county FIPS","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/DrugStatus"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/medicare/years":{"get":{"tags":["medicare"],"operationId":"listMedicareYears","summary":"Medicare plan years that are published, with data version, as-of date, plan counts and CMS source files","parameters":[],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MedicareYears"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/medicare/plans":{"get":{"tags":["medicare"],"operationId":"listMedicarePlans","summary":"Medicare Advantage (MA, MA-PD) and Part D (PDP) plans for one plan year, filtered by area, type, organization, premium, drug coverage and star rating","parameters":[{"name":"year","in":"query","required":false,"description":"Medicare plan year (planYear is accepted too). Default: the default plan year when Medicare has it, else the newest published year; see /medicare/years. Each year is separate","schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"2-letter state code: plans serving any county of the state","schema":{"type":"string"}},{"name":"zipCode","in":"query","required":false,"description":"5-digit ZIP code; with countyFips when the ZIP spans several counties","schema":{"type":"string"}},{"name":"countyFips","in":"query","required":false,"description":"5-digit county FIPS: plans serving that county (PDPs serve their whole region)","schema":{"type":"string"}},{"name":"planType","in":"query","required":false,"description":"HMO, HMO-POS, PPO, Regional PPO, PFFS, Cost, MSA, PDP, SNP, D-SNP, C-SNP, I-SNP or a full CMS type such as HMO D-SNP (comma-separated)","schema":{"type":"string"}},{"name":"kind","in":"query","required":false,"description":"MA (no drug coverage), MA-PD (with drug coverage) or PDP (stand-alone Part D), comma-separated","schema":{"type":"string"}},{"name":"contractId","in":"query","required":false,"description":"CMS contract id, e.g. H0028","schema":{"type":"string"}},{"name":"planIds","in":"query","required":false,"description":"Comma-separated plan IDs (max 50), e.g. H0028_007_0","schema":{"type":"string"}},{"name":"organization","in":"query","required":false,"description":"Parent organization or brand contains this text","schema":{"type":"string"}},{"name":"minPremium","in":"query","required":false,"description":"Lowest monthly premium in dollars","schema":{"type":"string"}},{"name":"maxPremium","in":"query","required":false,"description":"Highest monthly premium in dollars","schema":{"type":"string"}},{"name":"minStarRating","in":"query","required":false,"description":"Lowest overall Star Rating, 1 to 5","schema":{"type":"string"}},{"name":"includesDrugCoverage","in":"query","required":false,"description":"true or false","schema":{"type":"string"}},{"name":"snp","in":"query","required":false,"description":"true: special needs plans only; false: exclude them","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"1-based page, default 1","schema":{"type":"string"}},{"name":"perPage","in":"query","required":false,"description":"Items per page, default 25, max 100","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MedicarePlan"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/medicare/plans/{planId}":{"get":{"tags":["medicare"],"operationId":"getMedicarePlan","summary":"Medicare plan detail: premium, MOOP, copays, extra benefits, Part D deductible and tier cost sharing, Star Rating, service area, source file and year","parameters":[{"name":"planId","in":"path","required":true,"description":"CMS plan ID: contract_plan_segment (H0028_007_0); H0028-007-000 and H0028-007 are accepted","schema":{"type":"string"}},{"name":"year","in":"query","required":false,"description":"Medicare plan year (planYear is accepted too). Default: the default plan year when Medicare has it, else the newest published year; see /medicare/years. Each year is separate","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MedicarePlanDetail"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/medicare/plans/{planId}/service-area":{"get":{"tags":["medicare"],"operationId":"getMedicarePlanServiceArea","summary":"Counties (FIPS) a Medicare plan serves, by state, with the CMS county names that match no county","parameters":[{"name":"planId","in":"path","required":true,"description":"CMS plan ID (see /medicare/plans)","schema":{"type":"string"}},{"name":"year","in":"query","required":false,"description":"Medicare plan year (planYear is accepted too). Default: the default plan year when Medicare has it, else the newest published year; see /medicare/years. Each year is separate","schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"2-letter state code to narrow the list","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MedicareServiceArea"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/medicare/zip-codes/{zipCode}":{"get":{"tags":["medicare"],"operationId":"getMedicareZipCode","summary":"Counties of a ZIP code with the number of Medicare plans serving each, per plan year","parameters":[{"name":"zipCode","in":"path","required":true,"description":"5-digit ZIP code","schema":{"type":"string"}},{"name":"year","in":"query","required":false,"description":"Medicare plan year (planYear is accepted too). Default: the default plan year when Medicare has it, else the newest published year; see /medicare/years. Each year is separate","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MedicareZip"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/medicare/providers":{"get":{"tags":["medicare"],"operationId":"searchMedicareProviders","summary":"Doctor name search among providers listed in at least one loaded Medicare Advantage directory (state of the doctor\u0027s NPPES practice address)","parameters":[{"name":"year","in":"query","required":false,"description":"Medicare plan year (planYear is accepted too). Default: the default plan year when Medicare has it, else the newest published year; see /medicare/years. Each year is separate","schema":{"type":"string"}},{"name":"state","in":"query","required":true,"description":"2-letter state code of the doctor\u0027s practice","schema":{"type":"string"}},{"name":"q","in":"query","required":true,"description":"Name prefix, last name first, e.g. \u0027smith jo\u0027 (2\u002B characters)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MedicareProviderSearch"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/medicare/providers/{npi}/network-status":{"get":{"tags":["medicare"],"operationId":"getMedicareProviderNetworkStatus","summary":"In-network yes / no / unknown for a doctor (NPI) on each Medicare Advantage plan in an area, from the organization\u0027s public provider directory; estimated = derived plan-to-directory mapping","parameters":[{"name":"npi","in":"path","required":true,"description":"10-digit NPI","schema":{"type":"string"}},{"name":"year","in":"query","required":false,"description":"Medicare plan year (planYear is accepted too). Default: the default plan year when Medicare has it, else the newest published year; see /medicare/years. Each year is separate","schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"2-letter state code: MA and MA-PD plans serving any county of the state (500 plans at most)","schema":{"type":"string"}},{"name":"zipCode","in":"query","required":false,"description":"5-digit ZIP code; with countyFips when the ZIP spans several counties","schema":{"type":"string"}},{"name":"countyFips","in":"query","required":false,"description":"5-digit county FIPS","schema":{"type":"string"}},{"name":"kind","in":"query","required":false,"description":"MA or MA-PD, comma-separated","schema":{"type":"string"}},{"name":"planIds","in":"query","required":false,"description":"Comma-separated plan IDs (max 50), e.g. H0028_007_0","schema":{"type":"string"}},{"name":"organization","in":"query","required":false,"description":"Parent organization or brand contains this text","schema":{"type":"string"}},{"name":"status","in":"query","required":false,"description":"Only plans with this status: yes, no or unknown","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MedicareNetworkStatus"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/medicare/network-coverage":{"get":{"tags":["medicare"],"operationId":"getMedicareNetworkCoverage","summary":"How many MA and MA-PD plans of a year have provider-directory data, overall and by organization, and which organizations are loaded (exact or estimated mapping)","parameters":[{"name":"year","in":"query","required":false,"description":"Medicare plan year (planYear is accepted too). Default: the default plan year when Medicare has it, else the newest published year; see /medicare/years. Each year is separate","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MedicareNetworkCoverage"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/networks":{"get":{"tags":["networks"],"operationId":"listNetworks","summary":"Provider networks of the weekly build with their size (distinct NPIs), plans, issuers, states and whether the NPI list is estimated. Optional specialty count by NUCC taxonomy code. Network ids are fingerprints of an NPI list and change when the list changes: use plan ids as the stable key. meta.dataVersion is the provider build","parameters":[{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}},{"name":"state","in":"query","required":false,"description":"2-letter state code","schema":{"type":"string"}},{"name":"issuerId","in":"query","required":false,"description":"5-digit HIOS issuer id","schema":{"type":"string"}},{"name":"planId","in":"query","required":false,"description":"14-character plan id: the network of that plan","schema":{"type":"string"}},{"name":"estimated","in":"query","required":false,"description":"true: only estimated networks; false: only networks the insurer published","schema":{"type":"string"}},{"name":"taxonomy","in":"query","required":false,"description":"NUCC taxonomy code (see /specialties): adds specialtyNpiCount (individual NPIs with that taxonomy) and sorts by it","schema":{"type":"string"}},{"name":"sort","in":"query","required":false,"description":"size (default), id, or specialty (needs taxonomy)","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"1-based page, default 1","schema":{"type":"string"}},{"name":"perPage","in":"query","required":false,"description":"Items per page, default 25, max 100","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Network"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/networks/{networkId}":{"get":{"tags":["networks"],"operationId":"getNetwork","summary":"One network by network id or by 14-character plan id: size, plans, issuers, states, estimated flag and the top specialties","parameters":[{"name":"networkId","in":"path","required":true,"description":"Network id (from /networks) or a 14-character plan id","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions). 2021-2025 = ACA plan history (federal and state-based exchanges from the CMS QHP PUFs, historical=true; rateNote marks community-rated and estimated rates) on /plans, /plans/{planId}, /plans/{planId}/rates and the plans and service-areas exports (see /exports historyPlanYears)","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Network"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/networks/compare":{"post":{"tags":["networks"],"operationId":"compareNetworks","summary":"Compare 2 to 10 networks or plans: sizes, union, NPIs in all, only-in-each, and pairwise shared / only-in-A / only-in-B counts with Jaccard overlap. includeNpis lists the NPIs (up to npiLimit each)","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkCompareRequest"}}}},"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkCompare"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/networks/disruption":{"post":{"tags":["networks"],"operationId":"analyzeDisruption","summary":"Disruption analysis: given a list of provider NPIs (for example an employee census\u0027s doctors) return the share that is in each network and in each plan sold at a ZIP (or in the listed plans / networks). Plans without network data are reported as such, never as 0%","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NetworkDisruptionRequest"}}}},"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NetworkDisruption"},"meta":{"$ref":"#/components/schemas/ItemMeta"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}},"/specialties":{"get":{"tags":["networks"],"operationId":"listSpecialties","summary":"NUCC taxonomy codes and names known to the provider build (for /networks?taxonomy=)","parameters":[{"name":"q","in":"query","required":false,"description":"Code prefix or text in the name","schema":{"type":"string"}},{"name":"page","in":"query","required":false,"description":"1-based page, default 1","schema":{"type":"string"}},{"name":"perPage","in":"query","required":false,"description":"Items per page, default 25, max 100","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"},"X-CAD-Usage-Band":{"$ref":"#/components/headers/X-CAD-Usage-Band"},"X-CAD-Data-Version":{"$ref":"#/components/headers/X-CAD-Data-Version"},"X-Request-Id":{"$ref":"#/components/headers/X-Request-Id"}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Specialty"}},"meta":{"$ref":"#/components/schemas/ListMeta"},"links":{"$ref":"#/components/schemas/PageLinks"}},"required":["data","meta"]}}}},"401":{"description":"invalid_token","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"403":{"description":"insufficient_scope or client_disabled","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"404":{"description":"not_found (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"422":{"description":"validation_failed (counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"429":{"description":"rate_limited or daily_quota_exceeded, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}},"503":{"description":"data_unavailable, with Retry-After (not counted)","content":{"application/problem\u002Bjson":{"schema":{"$ref":"#/components/schemas/Problem"}}}}}}}},"components":{"securitySchemes":{"oauth2":{"type":"oauth2","description":"Client credentials. Create a client on your developer dashboard; the secret is shown once.","flows":{"clientCredentials":{"tokenUrl":"https://api.choicearrangementdeck.com/v1/oauth/token","scopes":{"plans":"Plans, issuers, geography","prices":"Rates, quotes, benchmarks","drugs":"Drugs and formularies","providers":"Provider network status"}}}}},"headers":{"X-RateLimit-Limit":{"description":"Calls allowed per UTC day","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"Calls left today","schema":{"type":"string"}},"X-RateLimit-Reset":{"description":"Seconds until 00:00 UTC","schema":{"type":"string"}},"X-CAD-Usage-Band":{"description":"full, throttled or blocked","schema":{"type":"string"}},"X-CAD-Data-Version":{"description":"Data snapshot that answered","schema":{"type":"string"}},"X-Request-Id":{"description":"Quote this when contacting support","schema":{"type":"string"}},"Retry-After":{"description":"Seconds to wait (429, 503)","schema":{"type":"string"}}},"schemas":{"Problem":{"type":"object","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"invalid_request, invalid_token, insufficient_scope, client_disabled, not_found, validation_failed, rate_limited, daily_quota_exceeded, internal_error, data_unavailable"},"detail":{"type":"string"},"traceId":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["type","title","status","code"]},"OAuthError":{"type":"object","properties":{"error":{"type":"string"},"error_description":{"type":"string"}}},"ListMeta":{"type":"object","properties":{"page":{"type":"integer"},"perPage":{"type":"integer"},"total":{"type":"integer"},"totalPages":{"type":"integer"},"dataVersion":{"type":"string"}}},"PageLinks":{"type":"object","properties":{"self":{"type":"string"},"next":{"type":"string"},"prev":{"type":"string"},"first":{"type":"string"},"last":{"type":"string"}}},"ItemMeta":{"type":"object","properties":{"dataVersion":{"type":"string"}}},"IssuerRef":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}}},"Plan":{"type":"object","properties":{"id":{"type":"string","description":"CMS standard component ID"},"name":{"type":"string"},"planYear":{"type":"integer"},"issuer":{"$ref":"#/components/schemas/IssuerRef"},"state":{"type":"string"},"metalLevel":{"type":"string","description":"bronze, expanded-bronze, silver, gold, platinum, catastrophic (open enum)"},"planType":{"type":"string"},"hsaEligible":{"type":"boolean"},"deductible":{"type":"number","description":"In-network individual deductible, dollars"},"maxOutOfPocket":{"type":"number","description":"In-network individual MOOP, dollars"},"networkId":{"type":"string"}}},"PlanDetail":{"type":"object","properties":{"id":{"type":"string","description":"CMS standard component ID"},"name":{"type":"string"},"planYear":{"type":"integer"},"issuer":{"$ref":"#/components/schemas/IssuerRef"},"state":{"type":"string"},"metalLevel":{"type":"string","description":"bronze, expanded-bronze, silver, gold, platinum, catastrophic (open enum)"},"planType":{"type":"string"},"hsaEligible":{"type":"boolean"},"deductible":{"type":"number","description":"In-network individual deductible, dollars"},"maxOutOfPocket":{"type":"number","description":"In-network individual MOOP, dollars"},"networkId":{"type":"string"},"serviceAreaCounties":{"type":"array","items":{"type":"string"}},"tobaccoRated":{"type":"boolean"},"links":{"type":"object","additionalProperties":{"type":"string"}},"benefits":{"type":"object"}}},"Issuer":{"type":"object","properties":{"issuerId":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"},"planCount":{"type":"integer"}}},"ZipCode":{"type":"object","properties":{"zipCode":{"type":"string"},"planYear":{"type":"integer"},"counties":{"type":"array","items":{"type":"object","properties":{"countyFips":{"type":"string"},"countyName":{"type":"string"},"state":{"type":"string"},"ratingArea":{"type":"string","description":"e.g. MN09"}}}}}},"County":{"type":"object","properties":{"countyFips":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"},"ratingAreas":{"type":"object","additionalProperties":{"type":"string"}}}},"PlanRates":{"type":"object","properties":{"planId":{"type":"string"},"planYear":{"type":"integer"},"countyFips":{"type":"string"},"ratingArea":{"type":"string"},"rates":{"type":"array","items":{"type":"object","properties":{"age":{"type":"string","description":"0-14, 15 ... 63, 64\u002B"},"premium":{"type":"number"},"tobaccoPremium":{"type":"number"}}}}}},"DentalPlan":{"type":"object","properties":{"id":{"type":"string","description":"CMS standard component ID (14 characters). On- and off-exchange variants are one plan"},"name":{"type":"string"},"planYear":{"type":"integer"},"coverage":{"type":"string","description":"Always dental"},"issuer":{"$ref":"#/components/schemas/IssuerRef"},"state":{"type":"string"},"market":{"type":"string","description":"individual or shop"},"exchange":{"type":"string","description":"on, off or both"},"planType":{"type":"string","description":"Dental plan type, e.g. DHMO, DPPO, Indemnity"},"level":{"type":"string","description":"high or low (CMS dental level)"},"audience":{"type":"string","description":"child-only, adult-and-child or adult-only"},"coversChildren":{"type":"boolean","description":"True for child-only and adult-and-child plans: the pediatric dental filter"},"networkId":{"type":"string"},"nationalNetwork":{"type":"boolean"},"deductible":{"type":"number","description":"Individual, dollars"},"deductibleFamily":{"type":"number"},"maxOutOfPocket":{"type":"number"},"maxOutOfPocketFamily":{"type":"number"},"annualMaximum":{"type":"number","description":"Annual benefit maximum in dollars, read from the benefit explanation text when stated"},"priced":{"type":"boolean","description":"False when the plan publishes no rate"},"rateNote":{"type":"string","description":"For example: SHOP plans publish quarterly rates; the first quarter is shown"},"premium":{"$ref":"#/components/schemas/DentalPremium"}},"required":["id","name","planYear","coverage","issuer","state"]},"DentalPremium":{"type":"object","properties":{"monthly":{"type":"number","description":"Household premium per month, dollars; null when no member is rated"},"basis":{"type":"string","description":"age (sum of member premiums) or family-tier (community-rated: household size sets the price)"},"familyTierMonthly":{"type":"number"},"coveredMembers":{"type":"integer","description":"Members this plan prices; child-only plans leave adults out"},"members":{"type":"array","items":{"type":"object","properties":{"age":{"type":"integer"},"premium":{"type":"number","description":"Null when this plan does not rate that member"}}}},"note":{"type":"string"},"ratingArea":{"type":"string"}}},"DentalPlanDetail":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"planYear":{"type":"integer"},"coverage":{"type":"string","description":"Always dental"},"issuer":{"$ref":"#/components/schemas/IssuerRef"},"state":{"type":"string"},"market":{"type":"string"},"exchange":{"type":"string"},"planType":{"type":"string"},"level":{"type":"string"},"audience":{"type":"string"},"coversChildren":{"type":"boolean"},"networkId":{"type":"string"},"nationalNetwork":{"type":"boolean"},"deductible":{"type":"number"},"deductibleFamily":{"type":"number"},"maxOutOfPocket":{"type":"number"},"maxOutOfPocketFamily":{"type":"number"},"annualMaximum":{"type":"number"},"annualMaximumNote":{"type":"string"},"priced":{"type":"boolean"},"rateNote":{"type":"string"},"effective":{"type":"string","description":"Date"},"expires":{"type":"string","description":"Date"},"links":{"type":"object","additionalProperties":{"type":"string"}},"variants":{"type":"array","items":{"type":"string","description":"CMS plan ID variants, e.g. 21989AK0030001-00"}},"pricing":{"type":"string","description":"age or family-tier"},"ratingAreas":{"type":"array","items":{"type":"integer"}},"serviceArea":{"type":"object","properties":{"statewide":{"type":"boolean"},"counties":{"type":"array","items":{"type":"string","description":"5-digit county FIPS"}},"partialCounties":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","description":"ZIP code"}}}}},"benefits":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"covered":{"type":"boolean"},"inNetwork":{"type":"string","description":"Cost sharing as published, e.g. $25 Copay"},"outOfNetwork":{"type":"string"},"limit":{"type":"string"},"exclusions":{"type":"string"},"explanation":{"type":"string"}}}},"source":{"type":"string","description":"The CMS PUF file the plan was read from"},"disclaimer":{"type":"string"}},"required":["id","name","planYear","coverage"]},"DentalPlanRates":{"type":"object","properties":{"planId":{"type":"string"},"planYear":{"type":"integer"},"countyFips":{"type":"string"},"ratingArea":{"type":"string"},"pricing":{"type":"string","description":"age or family-tier"},"rates":{"type":"array","items":{"type":"object","properties":{"age":{"type":"string","description":"0-14, 15 ... 63, 64\u002B"},"premium":{"type":"number","description":"Monthly dollars; absent where the plan does not rate that age"},"tobaccoPremium":{"type":"number"}}}},"familyTiers":{"type":"array","items":{"type":"object","properties":{"tier":{"type":"string","description":"i, c, p1, p2, p3, cp1, cp2 or cp3"},"description":{"type":"string"},"premium":{"type":"number"}}}},"rateNote":{"type":"string"}}},"ExportCatalog":{"type":"object","properties":{"format":{"type":"string","description":"jsonl"},"contentType":{"type":"string","description":"application/x-ndjson"},"planYears":{"type":"array","items":{"type":"integer"}},"defaultPlanYear":{"type":"integer"},"dataVersion":{"type":"string"},"defaultLimit":{"type":"integer","description":"5000"},"maxLimit":{"type":"integer","description":"20000"},"datasets":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"fields":{"type":"array","items":{"type":"string"}},"key":{"type":"string"},"url":{"type":"string"}}}},"notes":{"type":"array","items":{"type":"string"}}}},"ExportPlanLine":{"type":"object","properties":{"planId":{"type":"string","description":"CMS standard component ID"},"planYear":{"type":"integer"},"name":{"type":"string"},"issuerId":{"type":"string"},"issuerName":{"type":"string"},"state":{"type":"string"},"metalLevel":{"type":"string"},"planType":{"type":"string"},"hsaEligible":{"type":"boolean"},"deductible":{"type":"number","description":"In-network individual deductible, dollars"},"maxOutOfPocket":{"type":"number","description":"In-network individual MOOP, dollars"},"networkId":{"type":"string"},"countyCount":{"type":"integer","description":"Counties the plan is sold in"},"summaryOfBenefitsUrl":{"type":"string","description":"Summary of Benefits and Coverage URL (CMS PUF); absent when not filed"},"brochureUrl":{"type":"string","description":"Plan brochure URL; absent when not filed"},"formularyUrl":{"type":"string","description":"Drug formulary URL; absent when not filed"}},"required":["planId","planYear","name","issuerId","state"]},"ExportServiceAreaLine":{"type":"object","properties":{"planId":{"type":"string"},"planYear":{"type":"integer"},"state":{"type":"string"},"countyFips":{"type":"array","items":{"type":"string","description":"5-digit county FIPS, sorted"}},"partialCountyZips":{"type":"object","description":"Only for counties where the plan is sold in part of the county: county FIPS to the ZIP codes served","additionalProperties":{"type":"array","items":{"type":"string"}}}},"required":["planId","planYear","state","countyFips"]},"ExportZipCountyLine":{"type":"object","properties":{"zipCode":{"type":"string","description":"5-digit ZIP code"},"planYear":{"type":"integer"},"countyFips":{"type":"string"},"countyName":{"type":"string"},"state":{"type":"string"},"ratingArea":{"type":"string","description":"Rating area label, e.g. MN08"}},"required":["zipCode","planYear","countyFips","state","ratingArea"]},"ExportPlanNetworkLine":{"type":"object","properties":{"planId":{"type":"string"},"planYear":{"type":"integer"},"networkId":{"type":"string","description":"A fingerprint of the network\u0027s NPI list; it changes when the list changes, so key on planId"},"networkName":{"type":"string"},"estimated":{"type":"boolean","description":"True when the network was derived (price-transparency files, directory crosswalk, clinic expansion) rather than published by the insurer"},"networkIssuerIds":{"type":"array","items":{"type":"string"}}},"required":["planId","planYear"]},"QuoteRequest":{"type":"object","properties":{"zipCode":{"type":"string"},"countyFips":{"type":"string"},"planYear":{"type":"integer"},"members":{"type":"array","maxItems":20,"items":{"type":"object","properties":{"age":{"type":"integer"},"tobacco":{"type":"boolean"},"relationship":{"type":"string","description":"self, spouse, child (informational)"}},"required":["age"]}},"planIds":{"type":"array","maxItems":50,"items":{"type":"string"}},"npis":{"type":"array","maxItems":25,"items":{"type":"string"}},"rxcuis":{"type":"array","maxItems":25,"items":{"type":"string"}},"householdIncome":{"type":"number","description":"Optional. Annual household MAGI in dollars; switches on subsidy fields. Requires a plan year with subsidy rules"},"householdSize":{"type":"integer","description":"Optional with householdIncome: federal tax household size (default: number of members)"},"americanIndianAlaskaNative":{"type":"boolean","description":"Optional: selects the AI/AN cost-sharing variants"},"offeredAffordableEmployerCoverage":{"type":"boolean","description":"Optional: true makes the household ineligible for the credit"},"eligibleForMedicare":{"type":"boolean","description":"Optional: true makes the household ineligible for the credit"},"treatMedicaidLikelyAsIneligible":{"type":"boolean","description":"Optional, default false. By default a likely-Medicaid household still gets the computed credit plus a warning; true sets the credit to 0 in that case"},"scenario":{"type":"string","description":"Optional: currentLaw (default) or enhancedCredits. enhancedCredits is HYPOTHETICAL, not current law (the expired ARPA/IRA schedule with no income limit)"}},"required":["zipCode","countyFips","members"]},"IchraCensus":{"type":"object","properties":{"id":{"type":"string","description":"cen_..."},"format":{"type":"string","description":"csv or json"},"employees":{"type":"integer"},"dependents":{"type":"integer"},"members":{"type":"integer"},"createdUtc":{"type":"string"},"expiresUtc":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"links":{"type":"object","additionalProperties":{"type":"string"}}}},"IchraQuoteJob":{"type":"object","properties":{"id":{"type":"string","description":"iqj_..."},"status":{"type":"string","description":"queued, running, complete, failed"},"censusId":{"type":"string"},"planYear":{"type":"integer"},"effectiveDate":{"type":"string"},"ratingAreaLocation":{"type":"string"},"households":{"type":"integer"},"processed":{"type":"integer"},"createdUtc":{"type":"string"},"startedUtc":{"type":"string"},"completedUtc":{"type":"string"},"expiresUtc":{"type":"string"},"dataVersion":{"type":"string"},"error":{"type":"string"},"summary":{"type":"object","properties":{"employees":{"type":"integer"},"members":{"type":"integer"},"priced":{"type":"integer"},"notPriced":{"type":"integer"},"totalLcsp":{"type":"number"},"requiredContributionPercent":{"type":"number"},"recommendedSafeHarbor":{"type":"string"},"scenarios":{"type":"array","items":{"type":"object","properties":{"safeHarbor":{"type":"string","description":"federalPovertyLine, rateOfPay, w2Wages"},"available":{"type":"boolean"},"unavailableReason":{"type":"string"},"sumOfMinimums":{"type":"number"},"highestMinimum":{"type":"number"},"flatMonthlyCost":{"type":"number"},"ageBasedMonthlyCost":{"type":"number"},"affordableEmployees":{"type":"integer"},"ageBasedSchedule":{"type":"array","items":{"type":"object","properties":{"fromAge":{"type":"integer"},"toAge":{"type":"integer"},"allowance":{"type":"number"},"employees":{"type":"integer"}}}}}}},"classes":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"employees":{"type":"integer"},"priced":{"type":"integer"},"status":{"type":"string","description":"compliant, noCompliantDesign, notPriced"},"safeHarbor":{"type":"string"},"monthlyCost":{"type":"number"},"bands":{"type":"array","items":{"type":"object","properties":{"fromAge":{"type":"integer"},"toAge":{"type":"integer"},"allowance":{"type":"number"},"employees":{"type":"integer"}}}}}}},"recommendation":{"type":"object","properties":{"status":{"type":"string"},"monthlyCost":{"type":"number"},"annualCost":{"type":"number"},"reasoning":{"type":"array","items":{"type":"string"}}}}}},"links":{"type":"object","additionalProperties":{"type":"string"}},"disclaimer":{"type":"string"}}},"IchraFamilyTiers":{"type":"object","properties":{"by":{"type":"string","description":"coverage (default: employeeOnly, employeeSpouse, employeeChildren, family) or dependents (employeeOnly, employeePlus1, employeePlus2, employeePlus3OrMore)"},"multipliers":{"type":"object","description":"Tier name to a multiple (1-10) of the employee-only allowance; employeeOnly is 1","additionalProperties":{"type":"number"}},"amounts":{"type":"object","description":"Tier name to one monthly amount per top-level age band (age order); each tier must be one multiple of the bands","additionalProperties":{"type":"array","items":{"type":"number"}}},"minimumShareOfHouseholdBenchmark":{"type":"number","description":"Optimizer only (no multipliers or amounts): each tier covers at least this share (0-1] of every household\u0027s benchmark premium"}}},"IchraAgeBand":{"type":"object","properties":{"fromAge":{"type":"integer","description":"Age on the effective date"},"toAge":{"type":"integer"},"allowance":{"type":"number","description":"Monthly, dollars"}}},"IchraReport":{"type":"object","properties":{"reportVersion":{"type":"string"},"jobId":{"type":"string"},"censusId":{"type":"string"},"generatedUtc":{"type":"string"},"dataVersion":{"type":"string"},"inputs":{"type":"object"},"steps":{"type":"array","items":{"type":"object","properties":{"step":{"type":"integer"},"title":{"type":"string"},"detail":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}}},"households":{"type":"array","items":{"type":"object","description":"employeeId, className, age, ratingAge, location, benchmarkPlan, householdBenchmark, safeHarborMath [{safeHarbor, incomeBasis, monthlyIncome, requiredContributionPercent, maxEmployeeContribution, lcsp, minimumAllowance, formula}], problem, notes"}},"classes":{"type":"array","items":{"type":"object","description":"name, key, employees, priced, notPriced, minimumClassSize, safeHarbors, employerBands, tried [{safeHarbor, maxBands, design, status chosen|rejected|infeasible, reason}], complianceChecks [{rule, passed, detail}], recommendation {status, source, safeHarbor, design, reasoning}"}},"recommendation":{"type":"object","properties":{"status":{"type":"string","description":"compliant, noCompliantDesign, noEmployees"},"monthlyCost":{"type":"number"},"annualCost":{"type":"number"},"reasoning":{"type":"array","items":{"type":"string"}}}},"rulesApplied":{"type":"array","items":{"type":"string"}},"disclaimer":{"type":"string"}}},"IchraHousehold":{"type":"object","properties":{"employeeId":{"type":"string"},"zipCode":{"type":"string"},"countyFips":{"type":"string"},"countyName":{"type":"string"},"state":{"type":"string"},"ratingArea":{"type":"string"},"members":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"relationship":{"type":"string","description":"employee, spouse, child"},"age":{"type":"integer","description":"On the effective date"},"tobacco":{"type":"boolean"}}}},"affordability":{"type":"object","properties":{"requiredContributionPercent":{"type":"number"},"lcsp":{"type":"object","properties":{"planId":{"type":"string"},"name":{"type":"string"},"monthlyPremium":{"type":"number"},"source":{"type":"string","description":"affordability-table (the website\u0027s benchmark table) or read-model"},"ratingAge":{"type":"integer"},"ratingArea":{"type":"string"}}},"safeHarbors":{"type":"array","items":{"$ref":"#/components/schemas/IchraHarbor"}},"householdIncome":{"$ref":"#/components/schemas/IchraHarbor"},"employerContribution":{"type":"number"},"householdBenchmark":{"type":"number","description":"Household SLCSP, monthly"},"benchmarkSource":{"type":"string"},"estimatedHouseholdPremiumTaxCredit":{"type":"number","description":"When householdIncome is in the census"}}},"plans":{"type":"array","items":{"type":"object","properties":{"planId":{"type":"string"},"name":{"type":"string"},"issuerId":{"type":"string"},"issuerName":{"type":"string"},"metalLevel":{"type":"string"},"planType":{"type":"string"},"hsaEligible":{"type":"boolean"},"deductible":{"type":"number"},"maxOutOfPocket":{"type":"number"},"householdPremium":{"type":"number","description":"Monthly, the sum of the member premiums"},"employeeOnlyPremium":{"type":"number"},"members":{"type":"array","items":{"type":"object","properties":{"memberId":{"type":"string"},"premium":{"type":"number","description":"Monthly"},"rated":{"type":"boolean","description":"false = a fourth or later child under 21 (no charge)"}}}}}}},"planCount":{"type":"integer"},"notes":{"type":"array","items":{"type":"string"}},"problem":{"type":"string","description":"Why the household could not be priced"}}},"IchraHarbor":{"type":"object","properties":{"safeHarbor":{"type":"string"},"monthlyIncome":{"type":"number"},"maxEmployeeContribution":{"type":"number"},"minimumEmployerContribution":{"type":"number"},"affordable":{"type":"boolean","description":"When employerContribution was sent"}}},"SubsidyEstimateRequest":{"type":"object","properties":{"zipCode":{"type":"string"},"countyFips":{"type":"string"},"planYear":{"type":"integer","description":"Default: current open-enrollment year; 422 lists the supported years"},"householdIncome":{"type":"number","description":"Annual household modified adjusted gross income in dollars"},"householdSize":{"type":"integer","description":"Federal tax household size, at least the number of members (default: number of members)"},"members":{"type":"array","maxItems":20,"items":{"type":"object","properties":{"age":{"type":"integer"},"tobacco":{"type":"boolean","description":"Accepted; tobacco use does not change the benchmark or the credit"},"relationship":{"type":"string"}},"required":["age"]}},"americanIndianAlaskaNative":{"type":"boolean"},"offeredAffordableEmployerCoverage":{"type":"boolean","description":"Caller-supplied: an offer of affordable employer coverage makes the household ineligible"},"eligibleForMedicare":{"type":"boolean","description":"Caller-supplied: Medicare eligibility makes the household ineligible"},"treatMedicaidLikelyAsIneligible":{"type":"boolean","description":"Optional, default false. By default a likely-Medicaid household still gets the computed credit plus a warning (people eligible for Medicaid generally cannot receive the credit); true sets the credit to 0 in that case"},"scenario":{"type":"string","description":"Optional: currentLaw (default) or enhancedCredits. enhancedCredits is HYPOTHETICAL, not current law: the expired ARPA/IRA schedule (0% to 8.5% of income, no 400% limit) applied to the plan year"}},"required":["zipCode","countyFips","householdIncome","members"]},"SubsidyEstimate":{"type":"object","properties":{"planYear":{"type":"integer"},"estimate":{"type":"boolean","description":"Always true"},"location":{"type":"object","properties":{"zipCode":{"type":"string"},"countyFips":{"type":"string"},"state":{"type":"string"},"ratingArea":{"type":"string"}}},"household":{"type":"object","properties":{"income":{"type":"number"},"size":{"type":"integer"},"sizeDefaulted":{"type":"boolean"},"members":{"type":"array","items":{"type":"object","properties":{"age":{"type":"integer"},"tobacco":{"type":"boolean"},"rated":{"type":"boolean"},"benchmarkPremium":{"type":"number"},"benchmarkPlanId":{"type":"string"},"benchmarkSource":{"type":"string","description":"affordability-table or read-model"}}}}}},"federalPovertyLevel":{"type":"object","properties":{"guidelineYear":{"type":"integer"},"region":{"type":"string"},"guideline":{"type":"number","description":"Dollars for this household size"},"percent":{"type":"number","description":"Household income as a percent of the guideline"}}},"applicablePercentage":{"type":"object","properties":{"percent":{"type":"number","description":"Share of income expected toward the benchmark; absent above the income limit"},"band":{"type":"string"},"basis":{"type":"string"}}},"expectedContribution":{"type":"object","properties":{"annual":{"type":"number"},"monthly":{"type":"number"}}},"benchmark":{"type":"object","properties":{"slcspMonthly":{"type":"number","description":"Household second-lowest-cost silver premium"},"source":{"type":"string"},"method":{"type":"string"}}},"premiumTaxCredit":{"type":"object","properties":{"eligible":{"type":"boolean"},"ineligibleReasons":{"type":"array","items":{"type":"string","description":"Open enum, e.g. income-below-100-percent-fpl, income-above-fpl-limit, medicaid-likely"}},"estimatedMonthly":{"type":"number"},"estimatedAnnual":{"type":"number"},"monthlyIfOtherCoverageNotAvailable":{"type":"number","description":"Credit that would apply if the household were not excluded (for example when treatMedicaidLikelyAsIneligible zeroed it)"},"formula":{"type":"string"},"creditNote":{"type":"string","description":"Present when adults are likely Medicaid eligible: people eligible for Medicaid generally cannot receive the credit"}}},"medicaidChip":{"type":"object","properties":{"indicatorOnly":{"type":"boolean","description":"Always true: not an eligibility determination"},"state":{"type":"string"},"expansionState":{"type":"boolean"},"guidelineYear":{"type":"integer"},"fplPercent":{"type":"number"},"adultThresholdFplPercent":{"type":"number"},"adultStatus":{"type":"string","description":"likely-eligible, above-threshold, expansion-not-adopted, no-adult-members, not-assessed"},"coverageGapPossible":{"type":"boolean"},"likelyMedicaidEligible":{"type":"boolean","description":"True when adults look likely to be eligible for Medicaid (an indicator, not a determination)"},"childrenStatus":{"type":"string","description":"likely-eligible, above-threshold, no-child-members, not-assessed (states outside the CMS state-medicaid file)"},"childrenThresholdFplPercent":{"type":"number","description":"Highest children\u0027s Medicaid/CHIP limit for the members\u0027 ages, including the 5-point MAGI disregard"},"childrenLikelyEligible":{"type":"integer","description":"Members under 19 at or below their limit"},"childrenSource":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}}}},"costSharingReductions":{"type":"object","properties":{"eligible":{"type":"boolean"},"actuarialValuePercent":{"type":"integer","description":"94, 87 or 73 by income; 100 for AI/AN zero cost sharing"},"type":{"type":"string","description":"income-tier, zero-cost-sharing, limited-cost-sharing"},"variantSuffix":{"type":"string","description":"Plan ID variant suffix, e.g. 06 for the 94% variant"},"standardVariantSuffix":{"type":"string","description":"01"},"notes":{"type":"array","items":{"type":"string"}}}},"statePrograms":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"type":{"type":"string","description":"basic-health-program or state-funded-coverage"},"state":{"type":"string"},"note":{"type":"string"},"status":{"type":"string","description":"may-apply"},"affectsCredit":{"type":"boolean","description":"Always false: informational only"},"asOf":{"type":"string"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SourceRef"}}}}},"statePremiumSubsidy":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"state":{"type":"string","description":"CA, NM, VT or NJ"},"status":{"type":"string","description":"estimated or may-apply (flag only, no amount)"},"estimatedMonthly":{"type":"number","description":"Household amount per month (estimated status only)"},"estimatedAnnual":{"type":"number"},"method":{"type":"string","description":"reducedApplicablePercent, backfillToScenario, percentOfIncome or flagOnly"},"approximation":{"type":"string","description":"What is approximated"},"asOf":{"type":"string"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SourceRef"}}}},"eligibility":{"type":"object","properties":{"status":{"type":"string","description":"credit-estimated, credit-estimated-medicaid-likely, medicaid-likely-credit-withheld, not-eligible-for-credit"},"premiumTaxCreditEligible":{"type":"boolean"},"likelyMedicaidEligible":{"type":"boolean"},"treatMedicaidLikelyAsIneligible":{"type":"boolean"},"reasons":{"type":"array","items":{"type":"string"}},"summary":{"type":"string"},"warnings":{"type":"array","items":{"type":"string"}}}},"scenario":{"type":"object","properties":{"name":{"type":"string","description":"currentLaw or enhancedCredits"},"hypothetical":{"type":"boolean","description":"True when the scenario is not current law"},"note":{"type":"string"}}},"rules":{"type":"object","properties":{"planYear":{"type":"integer"},"ruleSet":{"type":"string"},"enhancedCredits":{"type":"boolean"},"cliffFplPercent":{"type":"number"},"fplGuidelineYear":{"type":"integer"},"scenario":{"type":"string"},"rulesUrl":{"type":"string"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SourceRef"}}}},"assumptions":{"type":"array","items":{"type":"string"}},"disclaimer":{"type":"string"}}},"SourceRef":{"type":"object","properties":{"title":{"type":"string"},"url":{"type":"string"}}},"SubsidyRules":{"type":"object","properties":{"planYear":{"type":"integer"},"ruleSet":{"type":"string"},"enhancedCredits":{"type":"boolean"},"cliffFplPercent":{"type":"number"},"applicablePercentageBands":{"type":"array","items":{"type":"object","properties":{"fromFplPercent":{"type":"number"},"toFplPercent":{"type":"number"},"initialPercent":{"type":"number"},"finalPercent":{"type":"number"},"applies":{"type":"string"}}}},"requiredContributionPercent":{"type":"number","description":"Employer-coverage affordability percentage for the plan year (informational)"},"povertyGuidelines":{"$ref":"#/components/schemas/PovertyGuidelines"},"costSharingReductions":{"type":"object","properties":{"standardVariantSuffix":{"type":"string"},"tiers":{"type":"array","items":{"type":"object","properties":{"fromFplPercent":{"type":"number"},"toFplPercent":{"type":"number"},"fromInclusive":{"type":"boolean"},"actuarialValuePercent":{"type":"integer"},"variantSuffix":{"type":"string"}}}},"aianZeroCostSharingMaxFplPercent":{"type":"number"},"aianZeroCostSharingVariantSuffix":{"type":"string"},"aianLimitedCostSharingVariantSuffix":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SourceRef"}}}},"medicaid":{"type":"object","properties":{"asOf":{"type":"string"},"adultExpansionFplPercent":{"type":"number"},"medicaidGuidelineYear":{"type":"integer"},"medicaidGuideline":{"$ref":"#/components/schemas/PovertyGuidelines"},"expansionJurisdictions":{"type":"array","items":{"type":"string"}},"nonExpansionStates":{"type":"array","items":{"type":"string"}},"childrenAndChip":{"type":"string"},"notes":{"type":"array","items":{"type":"string"}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SourceRef"}}}},"statePrograms":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"name":{"type":"string"},"type":{"type":"string"},"minFplPercentExclusive":{"type":"number"},"minFplPercentInclusive":{"type":"number"},"maxFplPercent":{"type":"number"},"fplBasis":{"type":"string","description":"planYearGuideline or currentYearGuideline"},"minAge":{"type":"integer"},"maxAge":{"type":"integer"},"status":{"type":"string"},"asOf":{"type":"string"},"note":{"type":"string"},"source":{"$ref":"#/components/schemas/SourceRef"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SourceRef"}}}}},"calculation":{"type":"array","items":{"type":"string"}},"legislativeStatus":{"type":"object","properties":{"asOf":{"type":"string"},"summary":{"type":"string"},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SourceRef"}}}},"sources":{"type":"array","items":{"$ref":"#/components/schemas/SourceRef"}},"notes":{"type":"array","items":{"type":"string"}},"scenario":{"type":"string","description":"currentLaw or enhancedCredits"},"hypothetical":{"type":"boolean","description":"True for scenarios that are not current law"},"scenarioNote":{"type":"string"},"availableScenarios":{"type":"array","items":{"type":"string"}},"stateProgramsAsOf":{"type":"string"},"availableYears":{"type":"array","items":{"type":"integer"}},"planDataLoadedYears":{"type":"array","items":{"type":"integer"}},"disclaimer":{"type":"string"}}},"PovertyGuidelines":{"type":"object","properties":{"guidelineYear":{"type":"integer"},"source":{"$ref":"#/components/schemas/SourceRef"},"contiguousStatesAndDc":{"$ref":"#/components/schemas/PovertyRegion"},"alaska":{"$ref":"#/components/schemas/PovertyRegion"},"hawaii":{"$ref":"#/components/schemas/PovertyRegion"}}},"PovertyRegion":{"type":"object","properties":{"firstPerson":{"type":"number"},"eachAdditionalPerson":{"type":"number"},"bySize":{"type":"object","additionalProperties":{"type":"number","description":"Dollars by household size 1 to 8"}}}},"Quote":{"type":"object","properties":{"planId":{"type":"string"},"planName":{"type":"string"},"metalLevel":{"type":"string"},"issuer":{"$ref":"#/components/schemas/IssuerRef"},"monthlyPremium":{"type":"number"},"members":{"type":"array","items":{"type":"object","properties":{"age":{"type":"integer"},"tobacco":{"type":"boolean"},"premium":{"type":"number"},"rated":{"type":"boolean","description":"false for the 4th\u002B child under 21"}}}},"providers":{"type":"array","items":{"$ref":"#/components/schemas/ProviderStatus"}},"drugs":{"type":"array","items":{"$ref":"#/components/schemas/DrugStatus"}},"subsidizedPremium":{"type":"number","description":"Only with householdIncome: premium minus the credit applied, never below 0"},"estimatedPremiumTaxCredit":{"type":"number","description":"Only with householdIncome: min(estimated monthly credit, plan premium before any tobacco surcharge)"},"estimatedStateSubsidy":{"type":"number","description":"Only with householdIncome where a state premium subsidy is estimated (CA, NM, VT for 2026): the state amount applied to this plan, at most the premium left after the federal credit"},"netPremium":{"type":"number","description":"Only with householdIncome: premium after the federal credit and any estimated state premium subsidy, never below 0 (an estimate)"},"csrTier":{"type":"integer","description":"Silver plans only, when cost-sharing-reduction eligible: 94, 87, 73 (100 for AI/AN zero cost sharing)"},"csrVariant":{"type":"object","properties":{"id":{"type":"string","description":"e.g. 57129MN0090001-06"},"name":{"type":"string"},"type":{"type":"string"},"actuarialValue":{"type":"number"},"individualDeductible":{"type":"string"},"individualMoop":{"type":"string"}}}}},"Benchmark":{"type":"object","properties":{"zipCode":{"type":"string"},"countyFips":{"type":"string"},"planYear":{"type":"integer"},"age":{"type":"integer"},"secondLowestSilverPremium":{"type":"number"},"planId":{"type":"string"},"silverPlanCount":{"type":"integer"},"method":{"type":"string"}}},"ProviderStatus":{"type":"object","properties":{"npi":{"type":"string"},"planId":{"type":"string"},"status":{"type":"string","description":"yes, no, unknown"},"networkId":{"type":"string"},"source":{"type":"string"},"asOfUtc":{"type":"string","description":"date-time"}}},"NetworkStatus":{"type":"object","properties":{"npi":{"type":"string"},"name":{"type":"string"},"planYear":{"type":"integer"},"plans":{"type":"array","items":{"$ref":"#/components/schemas/ProviderStatus"}}}},"Drug":{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"brands":{"type":"string"},"rxcuis":{"type":"array","items":{"type":"string"}}}},"DrugStatus":{"type":"object","properties":{"rxcui":{"type":"string"},"planId":{"type":"string"},"status":{"type":"string","description":"covered, not-covered, unknown"},"tier":{"type":"string"},"priorAuthorization":{"type":"boolean"},"stepTherapy":{"type":"boolean"},"quantityLimit":{"type":"boolean"}}},"Usage":{"type":"object","properties":{"clientId":{"type":"string"},"tier":{"type":"string"},"day":{"type":"string","description":"yyyyMMdd (UTC)"},"served":{"type":"integer"},"fullSpeedLimit":{"type":"integer"},"throttledLimit":{"type":"integer"},"dailyLimit":{"type":"integer"},"remaining":{"type":"integer"},"band":{"type":"string"},"resetSeconds":{"type":"integer"},"resetUtc":{"type":"string","description":"date-time"}}},"MedicareYears":{"type":"object","properties":{"defaultYear":{"type":"integer"},"years":{"type":"array","items":{"type":"object","properties":{"year":{"type":"integer"},"dataVersion":{"type":"string"},"asOfUtc":{"type":"string","description":"date-time"},"planCounts":{"$ref":"#/components/schemas/MedicareKindCounts"},"files":{"type":"object","additionalProperties":{"type":"string"}}}}}}},"MedicareKindCounts":{"type":"object","properties":{"ma":{"type":"integer"},"maPd":{"type":"integer"},"pdp":{"type":"integer"},"total":{"type":"integer"}}},"MedicareStarRating":{"type":"object","properties":{"overall":{"type":"number","description":"1 to 5 in half steps; absent for new or low-enrollment plans"},"health":{"type":"number"},"drug":{"type":"number"}}},"MedicarePlan":{"type":"object","properties":{"id":{"type":"string","description":"contract_plan_segment, e.g. H0028_007_0"},"year":{"type":"integer"},"kind":{"type":"string","description":"MA, MA-PD or PDP"},"planType":{"type":"string","description":"HMO, HMO-POS, PPO, Regional PPO, PFFS, Cost, MSA, PDP, with a C-SNP, D-SNP or I-SNP suffix for special needs plans"},"snpType":{"type":"string","description":"Dual-Eligible, Chronic or Disabling Condition, Institutional"},"name":{"type":"string"},"organization":{"type":"string","description":"Parent organization"},"brand":{"type":"string"},"monthlyPremium":{"type":"number","description":"Total monthly premium in dollars"},"partCPremium":{"type":"number"},"partDPremium":{"type":"number"},"drugDeductible":{"type":"number"},"maxOutOfPocket":{"type":"number","description":"In-network medical MOOP, dollars"},"drugMaxOutOfPocket":{"type":"number"},"starRating":{"$ref":"#/components/schemas/MedicareStarRating"},"includesDrugCoverage":{"type":"boolean"},"states":{"type":"array","items":{"type":"string"}},"detailUrl":{"type":"string"}}},"MedicareCostShare":{"type":"object","properties":{"type":{"type":"string","description":"copay or coinsurance"},"amount":{"type":"number","description":"Dollars (copay)"},"percent":{"type":"number","description":"Percent of the drug cost (coinsurance)"},"minimum":{"type":"number"},"maximum":{"type":"number"}}},"MedicareTier":{"type":"object","properties":{"tier":{"type":"string","description":"Part D tier number"},"deductibleApplies":{"type":"boolean"},"preferredPharmacyPricing":{"type":"boolean"},"beforeDeductible":{"$ref":"#/components/schemas/MedicareCostShare"},"initialCoverage":{"$ref":"#/components/schemas/MedicareCostShare"},"catastrophic":{"$ref":"#/components/schemas/MedicareCostShare"}}},"MedicarePlanDetail":{"type":"object","properties":{"id":{"type":"string"},"year":{"type":"integer"},"contractId":{"type":"string"},"planNumber":{"type":"string"},"segmentId":{"type":"string"},"kind":{"type":"string"},"planType":{"type":"string"},"snpType":{"type":"string"},"name":{"type":"string"},"organization":{"type":"string"},"brand":{"type":"string"},"premium":{"type":"object","properties":{"monthlyTotal":{"type":"number"},"partC":{"type":"number"},"partD":{"type":"number"},"priorYearMonthlyTotal":{"type":"number","description":"Same plan id in the prior plan year, when published"}}},"maxOutOfPocket":{"type":"number","description":"In-network medical MOOP, dollars"},"copays":{"type":"object","properties":{"primaryCare":{"type":"number"},"specialist":{"type":"number"},"emergencyRoom":{"type":"number"},"urgentCare":{"type":"number"}}},"extraBenefits":{"type":"object","properties":{"dental":{"type":"boolean"},"vision":{"type":"boolean"},"hearing":{"type":"boolean"}}},"drugCoverage":{"type":"object","properties":{"included":{"type":"boolean"},"benefitType":{"type":"string","description":"e.g. Enhanced Alternative, Basic Alternative, Defined Standard"},"formularyId":{"type":"string"},"formularyLoaded":{"type":"boolean"},"deductible":{"type":"number"},"maxOutOfPocket":{"type":"number"},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/MedicareTier"}},"note":{"type":"string"}}},"starRating":{"$ref":"#/components/schemas/MedicareStarRating"},"network":{"type":"object","properties":{"providerDataLoaded":{"type":"boolean"},"providerCount":{"type":"integer"}}},"serviceArea":{"type":"object","properties":{"states":{"type":"array","items":{"type":"string"}},"allCountiesStates":{"type":"array","items":{"type":"string"}},"countiesResolved":{"type":"boolean"},"countyFips":{"type":"array","items":{"type":"string"}},"unmatchedCountyNames":{"type":"integer"},"serviceAreaUrl":{"type":"string"}}},"website":{"type":"string"},"source":{"$ref":"#/components/schemas/MedicareSource"}}},"ProviderData":{"type":"object","properties":{"version":{"type":"string","description":"Provider build version"},"planYear":{"type":"integer"},"asOfUtc":{"type":"string","description":"date-time"},"note":{"type":"string","description":"What estimated means"}}},"Specialty":{"type":"object","properties":{"taxonomy":{"type":"string","description":"NUCC taxonomy code"},"name":{"type":"string"}}},"SpecialtyCount":{"type":"object","properties":{"taxonomy":{"type":"string"},"name":{"type":"string"},"npiCount":{"type":"integer"}}},"Network":{"type":"object","properties":{"id":{"type":"string","description":"Network id (string; a fingerprint of the NPI list)"},"planYear":{"type":"integer"},"npiCount":{"type":"integer","description":"Distinct NPIs in the network"},"planCount":{"type":"integer"},"issuerIds":{"type":"array","items":{"type":"string"}},"states":{"type":"array","items":{"type":"string"}},"estimated":{"type":"boolean","description":"true: the NPI list was derived (price-transparency files, crosswalk, clinic expansion), not published as a network by the insurer"},"derivation":{"type":"string","description":"How an estimated list was built"},"specialtyNpiCount":{"type":"integer","description":"Only with the taxonomy filter"},"plans":{"type":"array","items":{"type":"string"}},"providerData":{"$ref":"#/components/schemas/ProviderData"},"specialties":{"type":"object","properties":{"buildVersion":{"type":"string"},"individualNpis":{"type":"integer","description":"Individual (type 1) NPIs with a taxonomy in the build"},"coveredNpis":{"type":"integer","description":"NPIs of the network found in the per-state provider files"},"top":{"type":"array","items":{"$ref":"#/components/schemas/SpecialtyCount"}}}}}},"NetworkCompareRequest":{"type":"object","properties":{"networks":{"type":"array","minItems":2,"maxItems":10,"items":{"type":"string","description":"Network id or 14-character plan id"}},"planYear":{"type":"integer"},"includeNpis":{"type":"boolean","description":"List NPIs (default false: counts only)"},"npiLimit":{"type":"integer","description":"NPIs listed per list, 1 to 1000, default 100"}},"required":["networks"]},"NpiList":{"type":"object","properties":{"count":{"type":"integer"},"npis":{"type":"array","items":{"type":"string"}},"truncated":{"type":"boolean"}}},"NetworkCompare":{"type":"object","properties":{"planYear":{"type":"integer"},"networks":{"type":"array","items":{"type":"object","properties":{"networkId":{"type":"string"},"npiCount":{"type":"integer"},"estimated":{"type":"boolean"},"derivation":{"type":"string"},"refs":{"type":"array","items":{"type":"string","description":"What the caller sent"}}}}},"unionCount":{"type":"integer","description":"NPIs in at least one network"},"inAll":{"$ref":"#/components/schemas/NpiList"},"onlyIn":{"type":"array","items":{"type":"object","properties":{"networkId":{"type":"string"},"count":{"type":"integer","description":"NPIs in this network and none of the others"},"npis":{"type":"array","items":{"type":"string"}},"truncated":{"type":"boolean"}}}},"pairs":{"type":"array","items":{"type":"object","properties":{"a":{"type":"string"},"b":{"type":"string"},"shared":{"type":"integer"},"onlyInA":{"type":"integer"},"onlyInB":{"type":"integer"},"jaccard":{"type":"number","description":"shared / union, 0 to 1"},"sharedPctOfA":{"type":"number"},"sharedPctOfB":{"type":"number"}}}},"anyEstimated":{"type":"boolean"},"disclaimer":{"type":"string"},"providerData":{"$ref":"#/components/schemas/ProviderData"}}},"NetworkDisruptionRequest":{"type":"object","properties":{"npis":{"type":"array","minItems":1,"maxItems":2000,"items":{"type":"string","description":"10-digit NPI. Invalid NPIs are reported in the response, not rejected"}},"zipCode":{"type":"string","description":"Evaluate every plan sold at this ZIP (all its counties, or countyFips)"},"countyFips":{"type":"string","description":"Narrow a ZIP to one county"},"planIds":{"type":"array","maxItems":50,"items":{"type":"string","description":"14-character plan id (with zipCode: only these plans)"}},"networks":{"type":"array","maxItems":60,"items":{"type":"string","description":"Network id or plan id evaluated without ZIP"}},"issuerIds":{"type":"array","items":{"type":"string","description":"With zipCode: only plans of these HIOS issuers"}},"planYear":{"type":"integer"},"includeNpis":{"type":"boolean","description":"List the out-of-network NPIs of each network (default false)"}},"required":["npis"]},"NetworkDisruption":{"type":"object","properties":{"planYear":{"type":"integer"},"zipCode":{"type":"string"},"npiCount":{"type":"integer","description":"Valid distinct NPIs analysed"},"npisInAnyNetwork":{"type":"integer","description":"Of those, in at least one evaluated network"},"invalidNpiCount":{"type":"integer"},"invalidNpis":{"type":"array","items":{"type":"string","description":"First 25"}},"networks":{"type":"array","items":{"type":"object","properties":{"networkId":{"type":"string"},"planIds":{"type":"array","items":{"type":"string"}},"estimated":{"type":"boolean"},"derivation":{"type":"string"},"inNetwork":{"type":"integer"},"outOfNetwork":{"type":"integer"},"percentInNetwork":{"type":"number","description":"0 to 100, one decimal"},"outOfNetworkNpis":{"type":"array","items":{"type":"string"}}}}},"plans":{"type":"array","items":{"type":"object","properties":{"planId":{"type":"string"},"name":{"type":"string"},"issuerId":{"type":"string"},"issuerName":{"type":"string"},"metalLevel":{"type":"string"},"status":{"type":"string","description":"ok, or no-network-data: the plan has no network in the build, so nothing is claimed"},"networkId":{"type":"string"},"estimated":{"type":"boolean"},"derivation":{"type":"string"},"inNetwork":{"type":"integer"},"outOfNetwork":{"type":"integer"},"percentInNetwork":{"type":"number"}}}},"anyEstimated":{"type":"boolean"},"disclaimer":{"type":"string"},"providerData":{"$ref":"#/components/schemas/ProviderData"}}},"MedicareSource":{"type":"object","properties":{"year":{"type":"integer"},"dataVersion":{"type":"string"},"asOfUtc":{"type":"string","description":"date-time"},"files":{"type":"object","additionalProperties":{"type":"string"}},"disclaimer":{"type":"string"}}},"MedicareServiceArea":{"type":"object","properties":{"planId":{"type":"string"},"year":{"type":"integer"},"states":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string"},"allCounties":{"type":"boolean"},"counties":{"type":"integer"}}}},"countiesResolved":{"type":"boolean"},"counties":{"type":"array","items":{"type":"object","properties":{"countyFips":{"type":"string"},"name":{"type":"string"},"state":{"type":"string"}}}},"unmatchedCountyNames":{"type":"array","items":{"type":"string","description":"State: CMS county name"}},"source":{"$ref":"#/components/schemas/MedicareSource"}}},"MedicareZip":{"type":"object","properties":{"zipCode":{"type":"string"},"year":{"type":"integer"},"counties":{"type":"array","items":{"type":"object","properties":{"countyFips":{"type":"string"},"countyName":{"type":"string"},"state":{"type":"string"},"planCounts":{"$ref":"#/components/schemas/MedicareKindCounts"}}}}}},"MedicareProviderSearch":{"type":"object","properties":{"year":{"type":"integer"},"state":{"type":"string"},"disclaimer":{"type":"string"},"providers":{"type":"array","items":{"type":"object","properties":{"npi":{"type":"string"},"name":{"type":"string"},"credential":{"type":"string"},"specialty":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zipCode":{"type":"string"}}}}}},"MedicareNetworkStatus":{"type":"object","properties":{"provider":{"type":"object","properties":{"npi":{"type":"string"},"name":{"type":"string"},"credential":{"type":"string"},"state":{"type":"string"}}},"year":{"type":"integer"},"doctorInAnyDirectory":{"type":"boolean","description":"true when the NPI is listed in at least one loaded directory network"},"summary":{"type":"object","properties":{"yes":{"type":"integer"},"no":{"type":"integer"},"unknown":{"type":"integer"},"estimated":{"type":"integer"}}},"plans":{"type":"array","items":{"type":"object","properties":{"planId":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string"},"organization":{"type":"string"},"status":{"type":"string","description":"yes, no, unknown"},"estimated":{"type":"boolean","description":"true when the plan-to-directory mapping is derived, not exact"},"note":{"type":"string"}}}},"directoriesAsOfUtc":{"type":"string","description":"date-time"},"disclaimer":{"type":"string"}}},"MedicareNetworkCoverage":{"type":"object","properties":{"year":{"type":"integer"},"dataVersion":{"type":"string"},"asOfUtc":{"type":"string","description":"date-time"},"maPlans":{"type":"integer"},"maPlansWithNetwork":{"type":"integer"},"percent":{"type":"number"},"disclaimer":{"type":"string"},"organizations":{"type":"array","items":{"type":"object","properties":{"organization":{"type":"string"},"mapping":{"type":"string"},"estimated":{"type":"boolean"},"plans":{"type":"integer"},"directoryCrawledUtc":{"type":"string","description":"date-time"}}}},"byOrganization":{"type":"array","items":{"type":"object","properties":{"organization":{"type":"string"},"plans":{"type":"integer"},"plansWithNetwork":{"type":"integer"},"percent":{"type":"number"}}}}}},"DataVersions":{"type":"object","properties":{"dataVersion":{"type":"string"},"publishedUtc":{"type":"string","description":"date-time"},"planYears":{"type":"array","items":{"type":"integer"}},"defaultPlanYear":{"type":"integer"},"sources":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string"},"version":{"type":"string"},"asOfUtc":{"type":"string","description":"date-time"}}}}}}}}}