Bulk Exports in the API

Export plan, service area, and zip-county datasets through Ideon's API

The "Create Bulk Export" endpoint (API docs) can be used to asynchronously generate dataset files, allowing users to cache data locally to optimize real-time quoting integrations. Through this endpoint, datasets for plan benefits, service areas, and zip-counties can accessed in JSONL format. This page includes general information on using Bulk Exports; the following sub-pages details information specific to each of the supported datasets.

• Plans - available plans and their associated benefits. This file replaces the "Plans in Bulk" endpoint as the recommended workflow to cache plan benefits to optimize real-time quoting integrations.

• Service Areas - the service areas associated with each plan detailing their geographical availability, as defined by ZIP and FIPS codes. This file supports visibility for users into zip-county level plan availability prior to quoting, if desired.

• Zip-Counties - the full set of ZIP and FIPS codes as well as their core metadata supported in Ideon's API.

General Information

• The download_url's are presigned for authentication. If the URL expires, users can hit the Show Bulk Export endpoint for the export_id to generate a new presigned download_url for the same export file.

• Requests to the "Create Bulk Export" endpoint are subject to additional rate limits in Ideon's API. Users are limited to generating 15 bulk exports per day; this is significantly more than would be required for any data caching workflow. These limitations do not apply to the "Show Bulk Export" endpoint.

• The processing time to generate a bulk export file can vary significantly based on the amount of data being returned. Zip Counties exports will typically complete within 15 seconds. Plan and Service Area exports can take a similar amount of time for very small exports, up to 15 minutes for larger ones. For the latter two export types, we recommend polling every couple of minutes for a complete status.

• An empty plans or service areas dataset indicates that the user does not have permissioned access to any plans given the requested filter parameters.