# API Reference

 Learn the conventions and patterns used across the Turquoise Consumer Pricing API, plus the
 details, example requests, and responses for each endpoint. All endpoints are under base URL
 `https://api.turquoise.health` and use JSON request and response bodies.
 

#### Conventions

Auth
Bearer token on every request
Pagination
`page_size` \+ `cursor` → `page.next_cursor`
Money
objects: integer `minor_units` (cents), `amount`, `currency`
Search
`search` \+ `min_score` on list endpoints

#### Errors

`400`
Malformed parameters
`401`
Missing or expired token
`404`
Resource not found
`422`
Validation error
`429`
Rate limit; back off and retry
`500`
Server error

## Endpoints

Click below to jump to the associated section

### V3

* [GET
/v3/providers/types

Get Provider Types](#cp/tag/consumer-pricing/v3_get_provider_types)
* [GET
/v3/providers

List Providers](#cp/tag/consumer-pricing/v3_list_providers)
* [GET
/v3/providers/{provider\_id}

Get Provider Details](#cp/tag/consumer-pricing/v3_get_provider)
* [GET
/v3/payers

List Payers](#cp/tag/consumer-pricing/v3_list_payers)
* [GET
/v3/payers/{payer\_id}

Get Payer Details](#cp/tag/consumer-pricing/v3_get_payer)
* [GET
/v3/networks

List Networks](#cp/tag/consumer-pricing/v3_list_networks)
* [GET
/v3/networks/{network\_id}

Get Network Details](#cp/tag/consumer-pricing/v3_get_network)
* [GET
/v3/packages

List Packages](#cp/tag/consumer-pricing/v3_list_packages)
* [GET
/v3/packages/{package\_id}

Get Package Details](#cp/tag/consumer-pricing/v3_get_package)
* [GET
/v3/packages/{package\_id}/line\_items

List a Package's Contents](#cp/tag/consumer-pricing/v3_list_package_line_items)
* [POST
/v3/prices/query

List Prices](#cp/tag/consumer-pricing/v3_query_prices)
* [POST
/v3/prices/compare

Get Price Statistics](#cp/tag/consumer-pricing/v3_compare_prices)
* [GET
/v3/prices/{price\_id}

Get a Price](#cp/tag/consumer-pricing/v3_get_price)
* [POST
/v3/personalized\-estimates

List personalized prices](#cp/tag/consumer-pricing/v3_list_personalized_estimates)
* [POST
/v3/personalized\-estimates/compare

Compare personalized prices across providers for a package](#cp/tag/consumer-pricing/v3_compare_personalized_estimates)

The full machine-readable OpenAPI schema is available at `/api/docs/openapi.json`.