Skip to content

Latest commit

 

History

History
140 lines (124 loc) · 2.99 KB

meta.md

File metadata and controls

140 lines (124 loc) · 2.99 KB

About

This is the documentation of the API for accessing the API Metadata (meta) for fluview, twitter, wiki, and delphi data sources of the Delphi's epidemiological data.

General topics not specific to any particular data source are discussed in the API overview. Such topics include: contributing, citing, and data licensing.

API Metadata

...

The API

The base URL is: https://delphi.cmu.edu/epidata/api.php

See this documentation for details on specifying epiweeks, dates, and lists.

Parameters

None.

Response

Field Description Type
result result code: 1 = success, 2 = too many results, -2 = no results integer
epidata list of results array of objects
... ... ...
message success or error message string

Example URLs

https://delphi.cmu.edu/epidata/api.php?source=meta

{
  "result": 1,
  "epidata": [
    {
      "_api": {
        "minute": [
          {
            "num_hits": 0,
            "unique_ips": 0,
            "rows_returned": null
          }
        ],
        "hour": [
          {
            "num_hits": 63,
            "unique_ips": 4,
            "rows_returned": 7992
          }
        ],
        "day": [
          {
            "num_hits": 20513,
            "unique_ips": 71,
            "rows_returned": 2090111
          }
        ],
        "week": [
          {
            "num_hits": 47636,
            "unique_ips": 473,
            "rows_returned": 6484427
          }
        ],
        "month": [
          {
            "num_hits": 471494,
            "unique_ips": 5155,
            "rows_returned": 127706722
          }
        ]
      },
      "fluview": [
        {
          "latest_update": "2020-04-10",
          "latest_issue": 202014,
          "table_rows": 945920
        }
      ],
      "twitter": [
        {
          "latest_update": "2020-04-11",
          "num_states": 41,
          "table_rows": 132712
        }
      ],
      "wiki": [
        {
          "latest_update": "2020-04-12 07:00:00",
          "table_rows": 131585
        }
      ],
      "delphi": [
        {
          "system": "af",
          "first_week": 201541,
          "last_week": 201619,
          "num_weeks": 31
        },
        {
          "system": "eb",
          "first_week": 201441,
          "last_week": 201519,
          "num_weeks": 32
        },
        {
          "system": "ec",
          "first_week": 201441,
          "last_week": 202013,
          "num_weeks": 171
        },
        {
          "system": "sp",
          "first_week": 201441,
          "last_week": 201519,
          "num_weeks": 32
        },
        {
          "system": "st",
          "first_week": 201542,
          "last_week": 201949,
          "num_weeks": 123
        }
      ]
    }
  ],
  "message": "success"
}

Code Samples