Generate and reveal
No API key has been revealed in this browser session yet.
Generate an API key or reveal one when it is ready.
Portal access
Use a one-time login link
Use the email link we send you to sign in, manage your API key, and test the public API.
Step 1
Complete registration and confirm your email.
Step 2
Watch for the email with your login link.
Step 3
Open that link to sign in and manage your API key.
Portal sign in
Request a login link
Use the same email address you registered with. If a login link is available for that email, we will send one shortly.
Loading portal configuration before enabling sign in.
Developer portal
Manage your API key
Request an API key only when you are ready to copy and store the secret immediately.
Actions
Link Your HealthSherpa Marketplace
Connect your developer account to HealthSherpa Marketplace to interact with your linked agent account.
Click the button above to start the HealthSherpa Marketplace authorization flow.
Approval-gated access
Request enrollment workflows
On-Exchange Direct-to-Consumer Enrollment API
Submit a review request for on-exchange enrollment workflows where consumers enroll themselves. Review is required so we can confirm the experience meets on-exchange regulatory requirements before access is enabled.
Request received
This request has already been submitted.
Submit a short explanation for your on-exchange direct-to-consumer enrollment request.
Off-Exchange Enrollment API
Submit a review request for off-exchange enrollment workflows.
Request received
This request has already been submitted.
Submit a short explanation for your off-exchange enrollment request.
Explore the public API
Use your API key to send live requests against the currently available endpoints.
Public API base URL
Loading...
OpenAPI JSON
openapi.json
If you just generated a new key, confirm it above and retry after a few seconds if it is still becoming available.
GET
/v1/ping
Health check endpoint for confirming API reachability and key validity.
Use this endpoint to verify that your request reaches the public API and that the supplied API key is accepted.
Authentication
x-api-key header
Expected success
200 OK with a simple JSON payload
Common responses
200Request accepted and routed correctly.
403API Gateway rejected the key as missing, invalid, not active yet, or not authorized for this API, or the request was blocked at the API edge.
429Rate limit exceeded; retry with backoff.
Ready to send a health check request.
request.http
Loading request preview...
response.json
Not sent
Send a request to inspect the response here.
GET
/v1/reference/counties
Resolve one or more counties for a ZIP code before sending a quote request.
Use this reference endpoint when a ZIP code may span multiple counties. The response lists
each matching county with its fips_code, name, and state so you can reuse the
selected county in quote requests.
Authentication
x-api-key header
Query param
zip_code (5 digits)
Response shape
{ counties: [{ fips_code, name, state }] }
Common responses
200One or more counties returned for the ZIP code.
400 invalid_requestZIP is missing or malformed.
403API Gateway rejected the key as missing, invalid, not active yet, or not authorized for this API, or the request was blocked at the API edge.
404 not_foundNo counties found for the ZIP code.
429Rate limit exceeded; retry with backoff.
503County lookup upstream unavailable.
Some ZIP codes overlap multiple counties or even multiple states. Use the returned
fips_code from the county you want before calling /v1/quotes.
Ready to look up counties for a ZIP code.
request.http
Loading request preview...
response.json
Not sent
Send a request to inspect the response here.
GET
/v1/reference/issuers
List the QHP issuers active in a state for a plan year, including the canonical 5-digit HIOS issuer ID for downstream quote filters.
Use this reference endpoint to populate issuer filters or to validate that an inbound quote
request targets a known issuer in the requested state. The response is sorted by display
name then hios_issuer_id for a stable, deterministic order.
Authentication
x-api-key header
Required query param
state (two-letter US code)
Optional query param
plan_year (integer 2020..2099, defaults to the current ACA plan year)
Response shape
{ issuers: [{ name, hios_issuer_id }] }
Common responses
200One or more issuers returned for the state and plan year.
400 invalid_requeststate is missing or is not a US state code, or plan_year is not an integer in 2020..2099.403API Gateway rejected the key as missing, invalid, not active yet, or not authorized for this API, or the request was blocked at the API edge.
404 not_foundNo active issuers found for the state in the requested plan year.
429Rate limit exceeded; retry with backoff.
Leave plan_year blank to default to the current ACA plan year. Specify an
explicit year during open enrollment rollover or when reconciling a prior-year enrollment.
Ready to look up issuers for a state.
request.http
Loading request preview...
response.json
Not sent
Send a request to inspect the response here.
POST
/v1/quotes
Search for plan quotes using a prefilled medical request with household and applicant screening inputs.
This endpoint accepts a quote request body and returns matching plan results for a single coverage type. The sample fields below prefill a valid medical quote request with explicit household sizing, optional state-specific applicant flags, and the default sort and page values shown in the preview.
Authentication
x-api-key header
Content type
application/json
Request shape
Context, location, household, plus optional filters, sort, and page inputs
Legacy include
Deprecated and ignored. Quotes always return the canonical payload and emit a deprecation warning in
meta.warnings when present.
Medical filter enums
filters.medical.metal_levels[] and filters.medical.plan_types[] use lowercase values like silver and ppo
Common responses
200Quotes returned successfully. No matches still return
200 with an empty plans[] array and meta.result_count: 0.400 invalid_requestRequest validation failed, including bad ZIP or FIPS values, wrong JSON types, applicant issues, or unsupported enum values.
403API Gateway rejected the key as missing, invalid, not active yet, or not authorized for this API, or the request was blocked at the API edge.
404Quote context could not be resolved.
429Rate limit exceeded; retry with backoff.
503Catalog or upstream source unavailable.
Advanced applicant options
Use these only when a state-specific marketplace flow needs extra screening fields for the applicant in this sample request.
The request preview derives a matching date_of_birth from the applicant age
and effective date so the sample quote request stays runnable. Set
household_size to the full tax household, even when fewer applicants are
listed here.
Ready to send a quote request.
request.http
Loading request preview...
response.json
Not sent
Send a request to inspect the response here.
Support
Contact support
Ask a support question. We include your portal name and email.
Send one support question per hour.