Welcome to the Ribbon Health API!

Welcome to the Ribbon API, we're excited to have you here!

We built Ribbon to simplify healthcare decisions. Ribbon Health is an API data platform for comprehensive and real-time information on providers, networks, cost, and quality of care.

Our goal is to provide you with an API infrastructure that makes it easy and simple to build healthcare solutions for your users.

See below to review our documentation structure, check out examples of use-cases and solutions, and dive right into the documentation!

To get your API key, please sign up at https://go.ribbonhealth.com/try-now

Example Use-cases

Ribbon supports many use-cases for developing healthcare solutions. Our existing customers & users leverage our API in a variety of ways, including:

• Find a provider: Power a comprehensive provider search that allows users to find specific specialists in their neighborhood who accept their insurance

• Buy the right insurance: Allow users to search for insurances during open enrollment to limit to plans who accept the user's existing provider and provide the lowest cost inclusive of all annual medical care and insurance costs

• Shop for care: Provide your users with personalized out-of-pocket costs of care for anyone looking to use their Health Savings Account dollars and price-shop across different treatment options for an existing condition

Structure of this API readme

Our documentation is structured to support the solutions we offer. We've created 6 sections with specific use-cases listed underneath each one. The sections are:

1) Provider Endpoints:
These endpoints allow you to build new applications leveraging Ribbon Health provider information to find providers, to learn more about a specific provider, and even to book online appointments.

2) Custom Provider Index:
With a custom provider index you get all the functionality of the provider endpoints as well as the ability to edit or add to Ribbon Health's provider data.

3) Locations Endpoints:
Here you can compare treatments and prices across points of care and help your users find specific locations to get care, including a doctor's office, urgent care, or emergency care settings.

4) Insurance Endpoints:
These features were designed to allow you to compare and recommend plans as well as to evaluate plans based on the expected cost of care and the doctors in the insurance networks.

5) Cost Estimate Endpoints:
These endpoints were built to estimate costs and compare medical options based on their expected out-of-pocket cost estimates.

Layout of each documentation page

Within each section, we've included individual documentation pages to support each solution. Every documentation page, where applicable, includes:

1) Endpoint overview
2) Diving In
3) Example Request
4) Example JSON Output
5) Parameters