ExpDev07 / coronavirus-tracker-api

🦠 A simple and fast (< 200ms) API for tracking the global coronavirus (COVID-19, SARS-CoV-2) outbreak. It's written in python using the 🔥 FastAPI framework. Supports multiple sources!
https://coronavirus-tracker-api.herokuapp.com
GNU General Public License v3.0
1.59k stars 323 forks source link

docs: methodology #216

Open Akuukis opened 4 years ago

Akuukis commented 4 years ago

Great stuff! I'm planning to use API for my dashboard Pandemic Estimator but I wish your API had a better documentation on methodology. I'm using JHU directly and I know what chaos it is, the most blatant example being that they provide "cumulative data" that's not cumulative quite often in practice. And the whole change of file formats, etc.

Can you please describe methodology how you deal with it? What's from JHU and what's from CSBS? What has been omitted, what has been "adjusted" and how? Thank you!

ExpDev07 commented 4 years ago

Hey, we don't mix and match the data. The data being retrieved is solely up to what data provider source you specify at the end of the URL through ?source=your_source. At the moment, jhu (as default if you don't provide one) or csbs are the only available ones.

As with JHU constantly changing their stuff, we try to deal with it as good as possible, but it's clearly reflected in the API sometimes (hotfixes needed to be pushed, indexes changing, recoveries suddenly gone, etc).