{"openapi":"3.1.0","info":{"title":"Choice Arrangement Deck API","version":"1.0.0","description":"Individual-market plans, age-rated premiums, silver benchmarks, formularies and in-network checks. 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":"providers","description":"In-network checks by NPI"},{"name":"drugs","description":"Drug search and formulary coverage"},{"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)","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)","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)","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)","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":"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/Plan"}},"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)","schema":{"type":"string"}},{"name":"planYear","in":"query","required":false,"description":"Plan year; default = the current open-enrollment year (see /meta/data-versions)","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/PlanDetail"},"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","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)","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/PlanRates"},"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","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"}},"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)","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"}}}}}}},"/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)","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)","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"}}}}}}}},"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"}}}}}},"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"}}},"required":["zipCode","countyFips","members"]},"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"}}}},"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"}}},"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"}}}}}}}}}