Documentation Convention

The API Reference has all the end points that Covindia.com provides. All end points begin with covindia and are followed by hyphens (-). There are two types of data that Covindia provides with one exception.

  • covindia-history-* - Data from the past until now
  • covindia-present-* - Data at this moment in time

The exception is covindia-raw-data which provides all the data from the database.

Each end point has tables which give the key and the description of what the end point returns.

The data type of the is written in parantheses ( and ). The data type corresponds to that cell of the table and not the value to which the key points.

There are end points that have keys that point to objects (analogous to dictionary of dictionaries in Python3). For making it easy, the description for these end points is across multiple tables. When one key points to an object, the description of the key leads to the Description Table of the object.

Keys can like `key` or key. The difference:

  • `key` is the exact characters you can expect to find in the JSON that the end-point returns
  • key is a placeholder for a general key that holds data.

Below is an example of the tables for easy understanding:

Table Example.1
Key
 Description
district-name (str)
 Each district-name (as defined in Resources) is the key to an object of type as described by Table Example.2


Table Example.2
Key
 Description
`state` (str)
 (str) The state (as defined in Resources) the district is in.
`infectedCount` (str)
 (int) The number of infected cases in this district until now.


This would map to a JSON that looks like this:

{
    "Mumbai" : {
        "state" : "Maharastra",
        "infectedCount" : 100
    },
    "Bangalore" : {
        "state" : "Karnataka",
        "infectedCount" : 42
    },
    "Chennai" : {
        "state" : "Tamil Nadu",
        "infectedCount" : 55
    },
    ...
}