You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/covidcast.md
+36-15Lines changed: 36 additions & 15 deletions
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,8 @@ The COVIDcast API is based on HTTP GET queries and returns data in JSON form.
28
28
The base URL is https://delphi.cmu.edu/epidata/api.php.
29
29
30
30
Several [API clients are available](#api-clients) for common programming
31
-
languages, so you do not need to construct API calls yourself.
31
+
languages, so you do not need to construct API calls yourself. Alternately, [see
32
+
below](#example-urls) for example API URLs and query responses.
32
33
33
34
See [this documentation](README.md) for details on specifying epiweeks, dates, and lists.
34
35
@@ -45,8 +46,6 @@ select set of these data signals.
45
46
46
47
### Parameters
47
48
48
-
#### Required
49
-
50
49
| Parameter | Description | Type |
51
50
| --- | --- | --- |
52
51
|`data_source`| name of upstream data source (e.g., `doctor-visits` or `fb-survey`; [see full list](covidcast_signals.md)) | string |
@@ -57,7 +56,7 @@ select set of these data signals.
57
56
|`geo_value`| unique code for each location, depending on `geo_type` (county -> FIPS 6-4 code, HRR -> HRR number, MSA -> CBSA code, DMA -> DMA code, state -> two-letter [state](../../labels/states.txt) code), or `*` for all | string |
58
57
59
58
The current set of signals available for each data source is returned by the
60
-
[`covidcast_meta`](covidcast_meta.md) endpoint.
59
+
[`covidcast_meta`](covidcast_meta.md) endpoint.
61
60
62
61
### Response
63
62
@@ -84,24 +83,27 @@ requests for smaller time intervals.
84
83
## Geographic Coding
85
84
86
85
The `geo_value` field specifies the geographic location whose estimate is being
87
-
reported. County-level estimates are reported by the county FIPS code. All FIPS
88
-
codes are reported using pre-2015 FIPS code assignments, *except* for FIPS codes
89
-
used by the `jhu-csse` source. These are reported exactly as JHU reports their
90
-
data; see below.
91
-
92
-
Other possible `geo_type`s include:
86
+
reported. Estimates are available for several possible `geo_type`s:
93
87
88
+
*`county`: County-level estimates are reported by the county's five-digit [FIPS
89
+
code](https://en.wikipedia.org/wiki/FIPS_county_code). All FIPS codes are
90
+
reported using pre-2015 FIPS code assignments, *except* for FIPS codes used by
91
+
the `jhu-csse` source. These are reported exactly as JHU reports their data;
92
+
[see below](#fips-exceptions-in-jhu-data).
94
93
*`hrr`: Hospital Referral Region, units designed to represent regional health
95
94
care markets. There are roughly 300 HRRs in the United States. A map is
0 commit comments