### HTTP GET Request Example Source: https://one.healthsherpa.com/llms-full.txt Example of a GET request to the /v1/ping endpoint, including the necessary Host and x-api-key headers for authentication. ```http GET /v1/ping HTTP/1.1 Host: api.one.healthsherpa.com x-api-key: YOUR_API_KEY ``` -------------------------------- ### Ping API Source: https://one.healthsherpa.com/llms-full.txt Confirms API reachability and API key validity. Successful responses indicate the API environment and accepted key. ```APIDOC ## GET /v1/ping ### Description Confirms API reachability and key validity. Successful responses identify the API environment and confirm that the supplied key was accepted. ### Method GET ### Endpoint /v1/ping ### Authentication Requires `x-api-key` header. ### Response #### Success Response (200) - `message` (string) - Confirmation message. ### Response Example ```json { "message": "API is reachable and key is valid." } ``` ### Errors - `401 unauthorized`: API key missing or blank. - `403`: invalid or inactive key, or blocked at the edge. - `429`: request limits exceeded. - `500 internal_error`: unexpected server-side exception. - `502`, `503`, `504`: upstream or gateway dependency unavailable. ``` -------------------------------- ### County Lookup API Source: https://one.healthsherpa.com/llms-full.txt Resolves a ZIP code to a list of county options, providing their names and FIPS codes. ```APIDOC ## GET /v1/reference/counties ### Description Resolves a ZIP code to county options. Use the selected `fips_code` in quote requests. ### Method GET ### Endpoint /v1/reference/counties ### Parameters #### Query Parameters - **zip_code** (string) - Required - Five-digit ZIP code query parameter. ### Response #### Success Response (200) - `counties` (array) - An array of county objects. - `name` (string) - The name of the county. - `fips_code` (string) - The FIPS code for the county. - `state` (string) - The state the county is in. ### Response Example ```json { "counties": [ { "name": "Example County", "fips_code": "001", "state": "CA" } ] } ``` ``` -------------------------------- ### API Error Response Structure Source: https://one.healthsherpa.com/llms-full.txt Standard JSON structure for API error responses, including error code, message, and optional details. Useful for handling API errors gracefully. ```json { "error": { "code": "invalid_request", "message": "Request validation failed", "details": {} } } ``` -------------------------------- ### Quotes API Source: https://one.healthsherpa.com/llms-full.txt Returns ACA plan quotes based on coverage type and household information. ```APIDOC ## POST /v1/quotes ### Description Returns ACA plan quotes for the requested coverage type and household. Clients can request pricing, documents, details, benefits, sorting, and pagination. ### Method POST ### Endpoint /v1/quotes ### Authentication Requires `x-api-key` header. ### Parameters #### Request Body - **context** (object) - Required - Contextual information for the quote. - **location** (object) - Required - Location details for the quote. - **household** (object) - Required - Household information for the quote. ### Request Example ```json { "context": {}, "location": {}, "household": {} } ``` ### Response #### Success Response (200) - `plans` (array) - An array of plan objects for the requested `coverage_type`. ### Response Example ```json { "plans": [ { "plan_id": "plan123", "name": "Example Health Plan", "premium": 500.00 } ] } ``` ``` === COMPLETE CONTENT === This response contains all available snippets from this library. No additional content exists. Do not make further requests.