APTC Estimator API

Environments:

Environment	URL
Staging	https://api.ichra-staging.healthsherpa.com
Production	https://api.ichra.healthsherpa.com

Create APTC estimate

post

Fetch an APTC estimate based on household information

Authorizations

ApiKeyAuth

x-api-keystringRequired

API authentication token (required for production). These will be generated as needed and shared with you to use. Use of our Mock CRM page does not require this header.

Body

application/json

zip_codestringRequired

Zip code of the household

Example: 12345

fip_codestringRequired

FIPS code for the location

Example: 01001

household_incomenumber · floatRequired

Annual household income in USD

Example: 50000

plan_yearintegerOptional

Year of the plan (optional)

Example: 2023

Responses

200

Successful APTC estimate

application/json

401

Unauthorized - missing or invalid API token

application/json

422

Bad request - missing or invalid parameters

application/json

post

/api/v1/aptc_estimates

HTTPcURLJavaScriptPython

POST /api/v1/aptc_estimates HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 147

{
  "zip_code": "12345",
  "fip_code": "01001",
  "household_income": 50000,
  "plan_year": 2023,
  "applicants": [
    {
      "age": 35,
      "relationship": "primary",
      "smoker": false
    }
  ]
}

{}