epidatpy

This package provides Python access to the Delphi Epidata API published by the Delphi research group at Carnegie Mellon University.

Useful links:

• Source code and bug tracker

• Listing on PyPI

• Epidata API key registration form

• Epidata API key documentation

See also the CMU Delphi Terms of Use, noting that the data is a research product and not warranted for a particular purpose.

Installation

Install from PyPI using pip:

pip install epidatpy

Documentation Contents

• Getting started
• Finding data of interest
• Accessing versioned data
• epidatpy Reference

Note

You should consider subscribing to the API mailing list to be notified of package updates, new data sources, corrections, and other updates.

API Keys

The Delphi Epidata API requires a (free) API key for full functionality. To generate your key, register for a pseudo-anonymous account here and see more discussion on the general API website. The epidatpy client will automatically look for this key in the environment variable DELPHI_EPIDATA_KEY. We recommend storing your key in a .env file, using python-dotenv to load it into your environment, and adding .env to your .gitignore file.

Note that for the time being, the private endpoints (i.e. those prefixed with pvt) will require additional permissions (contact us for more information).