Get Active Outbreaks V2

curl --request GET \
  --url https://api.example.com/v2/active-outbreaks/outbreak-summaries \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "event": "<string>",
      "event_guid": "<string>",
      "pathogen": "<string>",
      "event_start_location": "Belgium",
      "event_description": "Liver inflammation in children",
      "location_granularity": "<string>",
      "country_code": "CN",
      "country": "China",
      "admin_l1": "Inner Mongolia",
      "al1_code": "CN-IM",
      "longitude": 0,
      "latitude": 0,
      "first_score_date": "2024-01-01",
      "latest_score_date": "2024-01-10",
      "first_report_date": "2024-01-01",
      "latest_report_date": "2024-01-10",
      "first_occurrence_date": "2024-01-01",
      "latest_occurrence_date": "2024-01-10",
      "cuml_cases": 1000,
      "cuml_deaths": 100,
      "event_cuml_cases": 500,
      "event_cuml_deaths": 50,
      "event_active_cases": 200,
      "event_active_deaths": 10,
      "event_warning_score": 7.5,
      "event_warning_score_bin_value": 1.1,
      "event_warning_previous_score": 7.1,
      "event_warning_data_origin": "HED",
      "event_warning_score_trend": "Stable",
      "primary_transmission_route": "Airborne",
      "primary_transmission_route_score": 0.5,
      "human_to_human_transmission": "Yes",
      "human_to_human_transmission_score": 0,
      "vector_to_human_transmission": "No",
      "vector_to_human_transmission_score": 1,
      "treatment_availability": "No",
      "treatment_availability_score": 0.3,
      "vaccine_availability": "Yes",
      "vaccine_availability_score": 0.5,
      "cfr": "0-.01%]",
      "cfr_score": 0.5,
      "human_animal_interface": "Domestic animals",
      "human_animal_interface_score": 0.5,
      "frequency_of_outbreaks": "Extremely frequent",
      "frequency_of_outbreaks_score": 0.7,
      "select_agent_status": "Yes",
      "select_agent_status_score": 0,
      "pathogen_prioritization": "[14, 16)",
      "pathogen_prioritization_score": 0.4,
      "epidemiology": "Endemic: transition to epidemic (2x 5yr avg)",
      "epidemiology_score": 0.1,
      "geographic_scale": "Local",
      "geographic_scale_score": 0.5,
      "region_trend": "Trend1",
      "region_trend_score": 4.5,
      "al0_trend": "0",
      "al0_trend_score": 0.5,
      "al1_trend": "0",
      "al1_trend_score": 4,
      "geo_trend": "(0 - 1]",
      "geo_trend_score": 0,
      "event_case_scale": "< 10 cases",
      "event_case_scale_score": 3.5,
      "new_case_trend": "0",
      "new_case_trend_score": 0,
      "countries_impacted": "100",
      "top_countries": "Comoros, Mayotte, Tanzania",
      "mapbox_version": "v4_4",
      "mapbox_layer_name": "adm1",
      "mapbox_id": "dXJuOm1ieGJuZDpBUklOOnY0",
      "output_version": "v2.0.0",
      "run_timestamp": "2024-05-23T22:16:13Z",
      "file_date": "2024-01-01"
    }
  ],
  "has_more": true,
  "next_page": "<string>"
}

Active Outbreaks v2

Get Active Outbreaks V2

Get active outbreak summaries using cursor-based pagination (v2).

This endpoint provides cursor-based pagination for active outbreak data. Unlike the v1 endpoint, this version:

Uses cursor-based pagination instead of offset-based pagination
Removes sortby and order parameters (results are always ordered by ID)
Returns a PaginatedListEnvelope object with data, has_more, and next_page fields

Parameters: page: Cursor for pagination (omit for first page) num: Maximum number of records to return (1-1000) … (all other filtering parameters same as v1)

Returns: PaginatedListEnvelope containing:

data: List of ActiveOutbreak records
has_more: Boolean indicating if more records are available
next_page: Cursor for the next page (if has_more is true)

GET

active-outbreaks

outbreak-summaries

Get Active Outbreaks V2

curl --request GET \
  --url https://api.example.com/v2/active-outbreaks/outbreak-summaries \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "event": "<string>",
      "event_guid": "<string>",
      "pathogen": "<string>",
      "event_start_location": "Belgium",
      "event_description": "Liver inflammation in children",
      "location_granularity": "<string>",
      "country_code": "CN",
      "country": "China",
      "admin_l1": "Inner Mongolia",
      "al1_code": "CN-IM",
      "longitude": 0,
      "latitude": 0,
      "first_score_date": "2024-01-01",
      "latest_score_date": "2024-01-10",
      "first_report_date": "2024-01-01",
      "latest_report_date": "2024-01-10",
      "first_occurrence_date": "2024-01-01",
      "latest_occurrence_date": "2024-01-10",
      "cuml_cases": 1000,
      "cuml_deaths": 100,
      "event_cuml_cases": 500,
      "event_cuml_deaths": 50,
      "event_active_cases": 200,
      "event_active_deaths": 10,
      "event_warning_score": 7.5,
      "event_warning_score_bin_value": 1.1,
      "event_warning_previous_score": 7.1,
      "event_warning_data_origin": "HED",
      "event_warning_score_trend": "Stable",
      "primary_transmission_route": "Airborne",
      "primary_transmission_route_score": 0.5,
      "human_to_human_transmission": "Yes",
      "human_to_human_transmission_score": 0,
      "vector_to_human_transmission": "No",
      "vector_to_human_transmission_score": 1,
      "treatment_availability": "No",
      "treatment_availability_score": 0.3,
      "vaccine_availability": "Yes",
      "vaccine_availability_score": 0.5,
      "cfr": "0-.01%]",
      "cfr_score": 0.5,
      "human_animal_interface": "Domestic animals",
      "human_animal_interface_score": 0.5,
      "frequency_of_outbreaks": "Extremely frequent",
      "frequency_of_outbreaks_score": 0.7,
      "select_agent_status": "Yes",
      "select_agent_status_score": 0,
      "pathogen_prioritization": "[14, 16)",
      "pathogen_prioritization_score": 0.4,
      "epidemiology": "Endemic: transition to epidemic (2x 5yr avg)",
      "epidemiology_score": 0.1,
      "geographic_scale": "Local",
      "geographic_scale_score": 0.5,
      "region_trend": "Trend1",
      "region_trend_score": 4.5,
      "al0_trend": "0",
      "al0_trend_score": 0.5,
      "al1_trend": "0",
      "al1_trend_score": 4,
      "geo_trend": "(0 - 1]",
      "geo_trend_score": 0,
      "event_case_scale": "< 10 cases",
      "event_case_scale_score": 3.5,
      "new_case_trend": "0",
      "new_case_trend_score": 0,
      "countries_impacted": "100",
      "top_countries": "Comoros, Mayotte, Tanzania",
      "mapbox_version": "v4_4",
      "mapbox_layer_name": "adm1",
      "mapbox_id": "dXJuOm1ieGJuZDpBUklOOnY0",
      "output_version": "v2.0.0",
      "run_timestamp": "2024-05-23T22:16:13Z",
      "file_date": "2024-01-01"
    }
  ],
  "has_more": true,
  "next_page": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

page

string | null

A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.

num

integer

default:100

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

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

Response

Successful Response

data

ActiveOutbreak · object[]

required

Show child attributes

has_more

boolean

required

next_page

string | null

Get Events Of Active Outbreaks Get Pathogen Names

⌘I

API Reference

Endpoints

Get Active Outbreaks V2

Authorizations

Query Parameters

Response