Look up state, county, and rating area for a ZIP code
GET /v1/health/zips/{zip}
Resolves a ZIP code to its state, county FIPS, county name, and ACA rating area. Some ZIPs span multiple rating areas — the response includes all matching locations.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”5-digit ZIP code
Example
10001Query Parameters
Section titled “Query Parameters ”Plan year. Defaults to 2026. Available: 2026
Responses
Section titled “ Responses ”ZIP code geography details with HAL _links
ZIP code geography resolution with HAL _links
object
object
A HAL link object (draft-kelly-json-hal-11 §5)
object
Target URI or URI Template
True when href is an RFC 6570 URI Template
Media type hint for the target resource
Human-readable link title
A HAL link object (draft-kelly-json-hal-11 §5)
object
Target URI or URI Template
True when href is an RFC 6570 URI Template
Media type hint for the target resource
Human-readable link title
object
Headers
Section titled “Headers ”Unique request identifier for tracing
RFC 8288 Web Linking (pagination and resource discovery)
Weak ETag for conditional request support (If-None-Match)
Validation error
RFC 9457 Problem Details for HTTP APIs (application/problem+json)
object
URI identifying the problem type. about:blank for standard HTTP status semantics.
Short human-readable summary of the problem type
HTTP status code
Human-readable explanation specific to this occurrence
URI reference identifying the specific occurrence (request path)
Validation errors (extension member, present on 400 responses)
object
Dot-delimited path to the invalid field
Validation error message
Minimum subscription tier required (extension member, present on 402 responses)
URL to upgrade subscription (extension member, present on 402/429 responses)
Example
{ "type": "https://api.opelyx.com/problems/not-found", "title": "Not Found", "status": 404, "detail": "Plan 99999XX0000000-00 not found.", "instance": "/v1/health/plans/99999XX0000000-00"}Missing or invalid API key
RFC 9457 Problem Details for HTTP APIs (application/problem+json)
object
URI identifying the problem type. about:blank for standard HTTP status semantics.
Short human-readable summary of the problem type
HTTP status code
Human-readable explanation specific to this occurrence
URI reference identifying the specific occurrence (request path)
Validation errors (extension member, present on 400 responses)
object
Dot-delimited path to the invalid field
Validation error message
Minimum subscription tier required (extension member, present on 402 responses)
URL to upgrade subscription (extension member, present on 402/429 responses)
Example
{ "type": "https://api.opelyx.com/problems/not-found", "title": "Not Found", "status": 404, "detail": "Plan 99999XX0000000-00 not found.", "instance": "/v1/health/plans/99999XX0000000-00"}Headers
Section titled “Headers ”Bearer authentication challenge
Resource not found
RFC 9457 Problem Details for HTTP APIs (application/problem+json)
object
URI identifying the problem type. about:blank for standard HTTP status semantics.
Short human-readable summary of the problem type
HTTP status code
Human-readable explanation specific to this occurrence
URI reference identifying the specific occurrence (request path)
Validation errors (extension member, present on 400 responses)
object
Dot-delimited path to the invalid field
Validation error message
Minimum subscription tier required (extension member, present on 402 responses)
URL to upgrade subscription (extension member, present on 402/429 responses)
Example
{ "type": "https://api.opelyx.com/problems/not-found", "title": "Not Found", "status": 404, "detail": "Plan 99999XX0000000-00 not found.", "instance": "/v1/health/plans/99999XX0000000-00"}Rate limit exceeded
RFC 9457 Problem Details for HTTP APIs (application/problem+json)
object
URI identifying the problem type. about:blank for standard HTTP status semantics.
Short human-readable summary of the problem type
HTTP status code
Human-readable explanation specific to this occurrence
URI reference identifying the specific occurrence (request path)
Validation errors (extension member, present on 400 responses)
object
Dot-delimited path to the invalid field
Validation error message
Minimum subscription tier required (extension member, present on 402 responses)
URL to upgrade subscription (extension member, present on 402/429 responses)
Example
{ "type": "https://api.opelyx.com/problems/not-found", "title": "Not Found", "status": 404, "detail": "Plan 99999XX0000000-00 not found.", "instance": "/v1/health/plans/99999XX0000000-00"}Headers
Section titled “Headers ”Seconds until the rate limit resets
Maximum requests per day for this tier
Remaining requests today
Unix timestamp when the limit resets (midnight UTC)