VaccinateCA API

VaccinateCA API Docs

Welcome to the VaccinateCA API Docs. These APIs provide data on COVID-19 vaccine availability in California. Visit VaccinateCA.com to learn more about VacicnateCA.

Get Started    

Getting Started

General information on the API use and structure.

The VaccinateCA API is a globally-versioned, JSON API.

Endpoints are of the form api.vaccinateca.com/v$version/$resource.json

Example: api.vaccinateca.com/v1/counties.json

Versioning

We will add new endpoints, add fields, and change "minor" semantics of fields without changing the API version. We will create a new API version when removing an endpoint, removing a field, or changing field semantics in a substantial way.

When we create a new API version, we will move all still-maintained endpoints to the new version, even if they did not experience a breaking change. For example, if we need to make a breaking change in the Locations API and move from v1 to v2, we will also create a Counties v2, even if Counties did not change.

We provide historical versions of the API on a best-effort basis, but may stop providing them if the technical challenges become significant. If you plan to rely on these APIs, please contact us so we can inform you about future additions and updates. Our email address is listed in API responses in the Contact object, documented below. At the time of writing these docs, it is api at VaccinateCA.com.

Response Structure

Responses are JSON, with two top-level keys: "usage" and "content".

{
  "usage": Usage,
  "content": Content
}

The Usage schema is as follows:

Key

Type

Description

notice

String

Request for responsible use.

contact

Contact

Contact information for VaccinateCA.

The Contact schema is as follows:

Key

Type

Description

partnersEmail

String

A contact email for users of the API. This is not a contact email for general vaccine questions.

Content is a list of objects, each of which is documented in the corresponding API page. For example, the Locations API returns a list of Location objects as Content.

Updated 9 months ago

Getting Started


General information on the API use and structure.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.