Get Active Outbreaks

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

offset

integer

default:0

It is used for offset-based pagination, usually works together with num parameter.

num

integer

default:100

Maximum number of records will be returned by the API call. The maximum acceptable value is {MAX_NUMBER_OF_RECORDS_PER_PAGE}

pathogen

string | null

If not empty, only the records with this pathogen will be return.

event

string | null

If not empty, only the records with this event will be returned.

country_code

string | null

If not empty, only the records with this country code will be returned.

Required string length: 2

first_score_date_min

string<date> | null

Filter to return events with a first score date on or after the given date. Date format (yyyy-mm-dd)

latest_score_date_min

string<date> | null

Filter to return events with a latest score date on or after the given date. Date format (yyyy-mm-dd)

first_occurence_date_min

string<date> | null

Filter to return events with a first occurence date on or after the given date. Date format (yyyy-mm-dd)

first_occurence_date_max

string<date> | null

Filter to return events with a first occurence date on or before the given date. Date format (yyyy-mm-dd)

latest_occurence_date_min

string<date> | null

Filter to return events with a latest occurence date on or after the given date. Date format (yyyy-mm-dd)

latest_occurence_date_max

string<date> | null

Filter to return events with a latest occurence date on or before the given date. Date format (yyyy-mm-dd)

primary_transmission_route

enum<string>

If not empty, only the records with this transmission route will be returned.

Available options:

Airborne,

Zoonotic,

Vectorborne,

Foodborne,

Fomite,

Direct Contact,

Fecal-Oral,

Waterborne,

Bloodborne,

Ingestion,

Environmental

human_to_human_transmission

enum<string>

If not empty, only the records with this level of human to human transmission will be returned.

Available options:

Yes,

No,

Limited

vector_to_human_transmission

enum<string>

If not empty, only the records with this primary vector will be returned.

Available options:

No,

Not zoonotic or vectorborne,

Ticks,

Vectorborne,

Mosquitoes,

Biting flies,

Fleas

treatment_availability

enum<string>

If not empty, only the records with this level of treatment availability will be returned.

Available options:

No,

Post-exposure prophylaxis only,

Theraputic,

Curative

vaccine_availability

enum<string>

If not empty, only the records with this level of vaccine availability will be returned.

Available options:

Yes,

No,

Limited,

Pre-exposure prophylaxis only

case_fatality_rate

enum<string>

If not empty, only the records with this case fatality rate will be returned.

Available options:

0-.01%],

(0.01-0.1%],

(0.1-1.0%],

(1.0-5.0%],

(5.0-20%],

>20%

human_animal_interface

enum<string>

If not empty, only the records with this human to animal interface type will be returned.

Available options:

Domestic animals,

Not zoonotic or vector-borne,

Vector-borne,

Wild animals,

Companion animals

frequency_of_outbreaks

enum<string>

If not empty, only the records with this outbreak frequency will be returned.

Available options:

Extremely frequent,

Moderate,

Rare

select_agent_status

enum<string>

If not empty, only the records with this US Federal Select Agent status will be returned.

Available options:

Yes,

No

al1_code

string | null

ISO 3166-2 administrative division 1 code for reported cases and deaths

countries_impacted_min

integer | null

minimum number of countries impacted. All results will have equal to or greater than this value of impacted countries

countries_impacted_max

integer | null

maximum number of countries impacted. All results will have equal to or less than this value of impacted countries

event_warning_score_min

integer | null

minimum warning score. All results will have equal to or greater than this score

event_warning_score_max

integer | null

maximum warning score. All results will have equal to or less than this score

cuml_cases_min

integer | null

minimum cumulative cases. All results will have equal to or greater than this value

cuml_cases_max

integer | null

maximum cumulative cases. All results will have equal to or less than this value

cuml_deaths_min

integer | null

minimum cumulative deaths. All results will have equal to or greater than this value

cuml_deaths_max

integer | null

maximum cumulative deaths. All results will have equal to or less than this value

event_cuml_cases_min

integer | null

minimum cumulative cases globally for the event. All results will have equal to or greater than this value

event_cuml_cases_max

integer | null

maximum cumulative cases globally for the event. All results will have equal to or less than this value

event_cuml_deaths_min

integer | null

minimum cumulative deaths globally for the event. All results will have equal to or greater than this value

event_cuml_deaths_max

integer | null

maximum cumulative deaths globally for the event. All results will have equal to or less than this value

sortby

enum<string>

If not empty, the records will be sorted in ascending order of this soryby value. The acceptable sort by values are event, event_id, disease, syndrome, pathogen, pathogen_detail, pathogen_detail_2, date_occurred_low_end, date_occurred_high_end, date_reported, date_type, country, cc, latitude, longitude, administrative_area_level_1, administrative_area_level_2, locality, location_granularity, location_type, cases, confirmed_cases, suspected_cases, probable_cases, deaths, confirmed_deaths, suspected_deaths, probable_deaths, cuml_cases, cuml_confirmed_cases, cuml_suspected_cases, cuml_prob_cases, cuml_deaths, cuml_confirmed_deaths, cuml_suspected_deaths, cuml_probable_deaths, source and is_primary_source

Available options:

event,

event_guid,

pathogen,

event_start_location,

event_description,

location_gran,

country_code,

country,

admin_l1,

al1_code,

longitude,

latitude,

first_score_date,

latest_score_date,

first_report_date,

latest_report_date,

first_occurrence_date,

latest_occurrence_date,

cuml_cases,

cuml_deaths,

event_cuml_cases,

event_cuml_deaths,

event_active_cases,

event_active_deaths,

event_warning_score,

event_warning_score_bin_value,

event_warning_previous_score,

event_warning_data_origin,

event_warning_score_trend,

primary_transmission_route,

primary_transmission_route_score,

human_to_human_transmission,

human_to_human_transmission_score,

vector_to_human_transmission,

vector_to_human_transmission_score,

treatment_availability,

treatment_availability_score,

vaccine_availability,

vaccine_availability_score,

cfr,

cfr_score,

human_animal_interface,

human_animal_interface_score,

frequency_of_outbreaks,

frequency_of_outbreaks_score,

select_agent_status,

select_agent_status_score,

pathogen_prioritization,

pathogen_prioritization_score,

epidemiology,

epidemiology_score,

geographic_scale,

geographic_scale_score,

region_trend,

region_trend_score,

al0_trend,

al0_trend_score,

al1_trend,

al1_trend_score,

geo_trend,

geo_trend_score,

event_case_scale,

event_case_scale_score,

new_case_trend,

new_case_trend_score,

countries_impacted,

top_countries

order

enum<string>

If not empty, the records will be sorted in ascending order. The acceptable order values are asc and desc

Available options:

asc,

desc

Response

Successful Response

event

string

required

Name of event in format _<Event description (if relevant)>

Example:

"Alongshan virus_China_2017"

event_guid

string

required

An alphanumeric ID assigned to each event

Example:

"fb0d2b60-2a27-4532-8e4a-815884e3a4a1"

pathogen

string

required

Name of the etiological agent in the event

Example:

"Alongshan virus"

event_start_location

string | null

required

Country / territory where the event started

Example:

"Belgium"

event_description

string | null

required

Distinguishing feature of the event (if relevant)

Example:

"Liver inflammation in children"

location_granularity

string

required

Spatial granularity of location associated with data

Example:

"administrative_area_level_1"

country_code

string | null

required

ISO 3166-1 alpha-2 country / territory code for reported cases and deaths

Example:

"CN"

country

string | null

required

Country / territory name for reported cases and deaths

Example:

"China"

admin_l1

string | null

required

Administrative division 1 name for reported cases and deaths

Example:

"Inner Mongolia"

al1_code

string | null

required

ISO 3166-2 administrative division 1 code for reported cases and deaths

Example:

"CN-IM"

longitude

number | null

required

Coordinate of location centroid at specified location

Required range: -180 <= x <= 180

latitude

number | null

required

Coordinate of location centroid at specified location

Required range: -90 <= x <= 90

first_score_date

string<date> | null

required

First date the event was scored by Ginkgo Biosecurity

Example:

"2024-01-01"

latest_score_date

string<date> | null

required

Latest date the event was scored by Ginkgo Biosecurity

Example:

"2024-01-10"

first_report_date

string<date> | null

required

First date the reporting source reported cases or deaths at location

Example:

"2024-01-01"

latest_report_date

string<date> | null

required

Latest date the reporting source reported cases or deaths at location

Example:

"2024-01-10"

first_occurrence_date

string<date> | null

required

First date of cases or deaths at location

Example:

"2024-01-01"

latest_occurrence_date

string<date> | null

required

Latest date of cases or deaths at location

Example:

"2024-01-10"

cuml_cases

integer | null

required

By location, cumulative number of cases, including confirmed, suspected, and probable cases where confirmation status is reported

Example:

1000

cuml_deaths

integer | null

required

By location, cumulative number of deaths, including confirmed, suspected, and probable deaths where confirmation status is reported

Example:

100

event_cuml_cases

integer | null

required

Cumulative number of cases specific to this event, (global)

Example:

500

event_cuml_deaths

integer | null

required

Event-level cumulative deaths (global)

Example:

50

event_active_cases

integer | null

required

Event-level rolling new cases in the last 28 days (derived). This field can have negative values. This happens if there are corrections to data reported by the reporting source resulting in negative values.

Example:

200

event_active_deaths

integer | null

required

Event-level rolling new deaths in the last 28 days (derived). This field can have negative values. This happens if there are corrections to data reported by the reporting source resulting in negative values.

Example:

10

event_warning_score

number | null

required

Event threat score

Example:

7.5

event_warning_score_bin_value

number | null

required

Threat bin assigned to the threat score

Example:

1.1

event_warning_previous_score

number | null

required

Warning score 7 days ago

Example:

7.1

event_warning_data_origin

string | null

required

Data origin for the event (HED or TRACKER). Events with HED data origins have structured epidemiological data available.

Example:

"HED"

event_warning_score_trend

string | null

required

Indicates if warning score has increased, decreased, remained stable, or is new within the previous week

Example:

"Stable"

primary_transmission_route

string | null

required

A categorical variable indicating the primary transmission route for the pathogen

Example:

"Airborne"

primary_transmission_route_score

number | null

required

A numeric value associated with the primary transmission route for the pathogen

Example:

0.5

human_to_human_transmission

string | null

required

A categorical variable indicating the level of human-to-human transmission for the pathogen

Example:

"Yes"

human_to_human_transmission_score

number | null

required

A numeric value associated with the level of human-to-human transmission for the pathogen

Example:

0

vector_to_human_transmission

string | null

required

A categorical variable indicating the primary vector of the pathogen

Example:

"No"

vector_to_human_transmission_score

number | null

required

A numeric value associated with the primary vector of the pathogen

Example:

1

treatment_availability

string | null

required

A categorical variable indicating the treatment options for infections caused by the pathogen or post-exposure vaccination

Example:

"No"

treatment_availability_score

number | null

required

A numeric value associated with the treatment options for infections caused by the pathogen or post-exposure vaccination

Example:

0.3

vaccine_availability

string | null

required

A categorical variable indicating pre-exposure vaccine or prophylaxis availability for the pathogen

Example:

"Yes"

vaccine_availability_score

number | null

required

A numeric value associated with pre-exposure vaccine or prophylaxis availability for the pathogen

Example:

0.5

cfr

string | null

required

Case fatality rate specific to this event

Example:

"0-.01%]"

cfr_score

number | null

required

A numeric value associated with the case fatality rate of the pathogen

Example:

0.5

human_animal_interface

string | null

required

A categorical variable indicating the types of reservoir species for zoonotic pathogens; if multiple categories are present for a pathogen, the highest scoring is selected

Example:

"Domestic animals"

human_animal_interface_score

number | null

required

A numeric value associated with the types of reservoir species for zoonotic pathogens

Example:

0.5

frequency_of_outbreaks

string | null

required

A categorical variable indicating how frequently outbreaks caused by the pathogen occur

Example:

"Extremely frequent"

frequency_of_outbreaks_score

number | null

required

A numeric value associated with how frequently outbreaks caused by the pathogen occur

Example:

0.7

select_agent_status

string | null

required

A categorical variable indicating if the pathogen is on the US Federal Select Agent program list

Example:

"Yes"

select_agent_status_score

number | null

required

A numeric value associated with if the pathogen is on the US Federal Select Agent program list

Example:

0

pathogen_prioritization

string | null

required

A categorical variable that bins the pathogen subcomponent scores

Example:

"[14, 16)"

pathogen_prioritization_score

number | null

required

A numeric value associated with the pathogen subcomponent scores

Example:

0.4

epidemiology

string | null

required

A categorical variable describing the early epidemiology of the outbreak at the start location

Example:

"Endemic: transition to epidemic (2x 5yr avg)"

epidemiology_score

number | null

required

A numeric value associated with the early epidemiology of the outbreak

Example:

0.1

geographic_scale

string | null

required

A categorical variable describing the geographic scale of the event

Example:

"Local"

geographic_scale_score

number | null

required

A numeric value associated with the geographic scale of the event

Example:

0.5

region_trend

string | null

required

Region trend specific to this event

Example:

"Trend1"

region_trend_score

number | null

required

Score of the region trend specific to this event

Example:

4.5

al0_trend

string | null

required

AL0 trend specific to this event

Example:

"0"

al0_trend_score

number | null

required

Score of the AL0 trend specific to this event

Example:

0.5

al1_trend

string | null

required

AL1 trend specific to this event

Example:

"0"

al1_trend_score

number | null

required

Score of the AL1 trend specific to this event

Example:

4

geo_trend

string | null

required

A categorical variable describing the geographic scale of the event

Example:

"(0 - 1]"

geo_trend_score

number | null

required

A numeric value associated with the geographic scale of the event

Example:

0

event_case_scale

string | null

required

A categorical variable that bins the event-level cumulative cases

Example:

"< 10 cases"

event_case_scale_score

number | null

required

A numeric value associated with the event-level cumulative cases

Example:

3.5

new_case_trend

string | null

required

A categorical variable that bins the event-level number of new cases in a period equal to 4 times the pathogen's incubation period

Example:

"0"

new_case_trend_score

number | null

required

A numeric value associated with the event-level number of new cases in a period equal to 4 times the pathogen's incubation period

Example:

0

countries_impacted

integer | null

required

The number of countries reporting cases for the event

Example:

"100"

top_countries

string | null

required

The top 5 countries impacted by the event (cuml_cases * [1 + cuml_deaths])

Example:

"Comoros, Mayotte, Tanzania"

mapbox_version

string | null

required

Mapbox version

Example:

"v4_4"

mapbox_layer_name

string | null

required

Mapbox layer name

Example:

"adm1"

mapbox_id

string | null

required

Mapbox boundary ID

Example:

"dXJuOm1ieGJuZDpBUklOOnY0"

output_version

string | null

required

Semantic version of HED output (release notes available in changelog)

Example:

"v2.0.0"

run_timestamp

string<date-time> | null

required

Timestamp the Active Outbreaks file was computed (YYYY-MM-DDTHH:MM:SSZ)

Example:

"2024-05-23T22:16:13Z"

file_date

string<date> | null

required

Date the Active Outbreaks file was computed

Example:

"2024-01-01"

API Reference

Endpoints

Authorizations

Query Parameters

Response