Jump to Content

Covid-19 API Guide

A detailed descriptions of all the fields contained in the Covid-19 API

countries

Field	Format	Value
id	String, two-letter, capitalised	ISO 3166 country code
name	String	Country name
code	String, two-letter, capitalised	ISO 3166 country code
risk_level	String	`Low` `Moderate` `Medium` `High` `Extreme`; Country/territory overall Risk Level
covid_risk_level	String	`Low` `Moderate` `Medium` `High` `Extreme`; Country/territory Covid-19 Risk Level. See 'Covid-19 Methodology' for further details

infection

Field	Format	Value
rate	Number	Covid-19 infection rate; see 'Covid-19 Methodology' for further details
level	String	`Low`, `Moderate`, `Medium`, `High`, `Extreme`
as_of_date	String, YYYY-MM-DD	Date of the covid-19 infection data

cases

Field	Format	Value
active	Integer	Active covid-19 cases
deaths	Integer	Covid-19 deaths
confirmed	Integer	Confirmed covid-19 cases
recovered	Integer	Covid-19 recoveries; note that some countries/territories have stopped reporting recovered covid-19 patients
as_of_date	String, YYYY-MM-DD	Date of the covid-19 case data
vaccinated		National/territorial vaccination statistics
one_dose
percent	Number	Percent of population vaccinated with at least one dose
as_of_date	String, YYYY-MM-DD	Date of one-dose data
fully
percent	Number	Percent of population fully vaccinated
as_of_date	String, YYYY-MM-DD	Date of fully-vaccinated data
domestic_infection_map	String, URL	Dashboard and/or map that tracks covid-19 infection data domestically
hotspots	String	Covid-19 hotspots, separated by comma. Hotspots are locations that exhibit localised covid-19 situations worse than overall country/territory

summary

Field	Format	Value
summary	String	Text explanation of the covid-19 situation in the country/territory

policy

Field	Format	Value
current_status	String	`Lockdown` `Stay at home` `Curfew` `Closing` `Opening` `Open` `Partial Measures` `Distancing` `None`; indicates current national-level policy
start_date	String, YYYY-MM-DD	Date the current policy began
end_date	String, YYYY-MM-DD or `Indef`	Date the current policy is scheduled to end; `Indef` indicates there is no scheduled end date at this time
text	String	Text explanation of the current national/territorial covid-19 policy
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct
source_url	String, URL	Webpage for national Covid-19 policy

international_travel

international_flights

Field	Format	Value
is_banned	String	`Yes` `No` `Partial`
through_date	String, YYYY-MM-DD or `Indef`	Date the current travel ban is scheduled to end; `Indef` indicates there is no scheduled end date at this time
text	String	Explanation of international commercial flight situation
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

entry_and_borders

Field	Format	Value
entry_ban	String	`Yes` `No` `Partial`
through_date	String, YYYY-MM-DD	Date the current entry ban is scheduled to end; `Indef` indicates there is no scheduled end date at this time
text	String	Text explanation of entry rules and restrictions
entry_rules	String, URL	Webpage for entry rules
exemptions	String, URL	Webpage for entry exemptions
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct
banned_countries	Array of strings, two-letter, capitalised	Countries/territories from where travellers are generally banned from entry due to covid-19 rules. If no travellers are banned based on origin, this will be blank. Uses ISO 3166 country codes
land_border_ban	String	`Open` `Partially Open` `Closed`
maritime_border_ban	String	`Open` `Partially Open` `Closed`

testing

Field	Format	Value
need_test	String	`Yes` `No` `Yes, conditional`
when	String	`Before travel` `Upon arrival` `After arrival`; can be any combination of these three
requirement	String	`Mandatory` `Optional`
exemptions	String	Categories of travellers that do not require a pre-travel Covid test result on arrival: `Aircrew` Air crews `Transit` Transit less than 24 hours `Diplomatic` Diplomatic `Transport` Transport, logistics, hauliers `Medical` Medical treatment or health reasons `Short` Short-term trip, as defined by destination `Urgent` Urgent or compelling reason, as defined by destination `Family` Family or close relationship `Culture` Culture `Sports` Sports `Remote` Remote work `Commute` Cross-border commuters `Frequent` Frequent cross-border travellers `Citizen` Citizens `Resident` Residents `Military` Military personnel `Seamen` Seamen and other marine workers `Deported` Deportees and travellers refused entrance at their destination `Humanitarian` Those in need of international protection on humanitarian grounds `Healthcare` Medical, medivac and other emergency personnel `Disability` Those with disability, as defined by destination
test_type	String	The types of Covid-19 tests accepted; more than one type can be selected. `PCR` Polymerase chain reaction `Antigen` Rapid antigen test `NAAT` Nucleic Acid Amplification Test `LAMP` Loop-mediated isothermal amplification `TMA` Transcription mediated amplification `TRC` Transcription reverse-transcription concerted reaction `SDA` Strand displacement amplification `NEAR` Nicking enzyme amplification reaction `mPOCT` Molecular point of care test `LFT` Lateral flow test `SmartAMP` Smart amplification process `NGS` Next Generation Sequence `CLEIA` Quantitative antigen test `CRISPR` Clustered regularly interspaced short palindromic repeats `HAD` Helicase-dependent amplification `Antibody` Rapid antibody test
minimum_age	Integer	Minimum age, in years, that is required to take a Covid-19 test. Under this age, no test is required
test_validity
hours	Integer	The validity, in hours, for test results required before arrival
before	String	`Arrival` `Departure`; Test validity time is measured from arrival at destination or departure from origin. If blank, indicates this is not specified
arrival_test_days	String	If tests are required after arrival (not upon arrival), indicates on which day(s) a test is required. If a test is required within a window of time, indicates the first day ("test required on days 3-5" would result in `3`)
text	String	Explanation of testing requirements
rules	String, URL	Webpage of testing rules
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

health_travel_documentations

Field	Format	Value
need_documentations	String	`Yes` `No`
text	String	Explanation of required documentation; negative covid-19 test result requirements are handled in 'Testing' section
health_document	String, URL	Webpage of health document
travel_document	String, URL	Webpage of travel document
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

tracing_app

Field	Format	Value
need_app	String	`Yes` `No` `Recommended`
text	String	Explanation of tracing app rules
ios_urls	Array; URLs for iOS app stores	Link to app store page for tracing app; multiple URLs indicates multiple apps
android_urls	Array; URLs for Android app stores	Link to app store page for tracing app; multiple URLs indicates multiple apps
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

quarantine_on_arrival

Field	Format	Value
who_needs	String	`All travellers` `Some travellers` `None`
days	Integer	Number of days of quarantine required
type	String	`Self` `Gov` `Hybrid`; indicates self-quarantine at home or other suitable accommodation, at a government facility, or a hybrid system that includes both
text	String	Explanation of national/territorial quarantine rules
rules	String, URL	Webpage of quarantine rules
mandate_list	String, URL	Webpage of list of origin locations that require quarantine
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct
required_countries	Array; String, two-letter, capitalised	Countries/territories from where travellers are generally required to quarantine on arrival. If no travellers are required to quarantine, this will be blank. Uses ISO 3166 country codes

masks

Field	Format	Value
requirement	String	`Yes` `No` `Yes, conditional` `Partial` `Recommended`
text	String	Explanation of national/territorial mask requirements and recommendations
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

exit_country

Field	Format	Value
exit_ban	String	`Yes` `Recommended` `Partial` `No`; 'Yes' indicates all travellers are banned from leaving; 'Recommended' indicates that travellers should not leave, but are mostly free to do so; 'Partial' indicates that some travellers may leave, but others are prevented; 'No' indicates all travellers are free to leave
requirement	String	`Yes` `No` `Yes, conditional`; indicates whether there are special requirements to fulfill in order to leave the country/territory
text	String	Explanation of requirements to exit the country/territory
exit_requirements	String, URL	Webpage of exit requirements
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

vaccination

Field	Format	Value
requirement		`Yes` `No`; indicates whether vaccination is mandatory for entry
vaccinated_travellers
policy	String	`Yes` `No`; 'Yes' indicates fully vaccinated travellers are exempt from some requirements or restrictions
exemptions	String	`Entry Ban` `Testing` `Documents` `App` `Quarantine` `Masks` `Exit` `Domestic Restrictions`; indicates what exemptions fully vaccinated travellers qualify for. Details on the exemptions are found in the 'text' section.
text	String	Text explanation of the policies and exemptions for vaccinated travellers
source_url	String, URL	Webpage of vaccination regulations
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct
qualified_vaccines	String	Vaccine types recognised by the country/territory. Each entry contains the vaccine's short name and the number of days after the first/second dose for full vaccination, i.e. `AstraZeneca 14 days after second dose`
accepted_certificates	String	List of accepted certificates. `Not Specified` `Paper Certificate` and/or the name of the app

other_international_travel_restrictions

Field	Format	Value
text	String	Explanation of any other restrictions on international travel not covered in other sections
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

domestic_situation

areas_on_lockdown

Field	Format	Value
text	String	Explanation of areas on lockdown; `null` indicates no areas on lockdown
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

areas_under_curfew

Field	Format	Value
text	String	Explanation of areas under curfew; `null` indicates that no areas are under curfew
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

domestic_travel

Field	Format	Value
text	String	Explanation of domestic travel restrictions
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

other_domestic_restrictions

Field	Format	Value
text	String	Explanation of any other domestic restrictions related to covid not covered in other sections
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

additional_sections

Field	Format	Value
additional_sections	Array	One or more additional sections of covid-19 related security and safety issues.
title	String	Title of the covid-related security or safety issue
text	String	Explanation of the covid-related security or safety issue
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

resources

Field	Format	Value
government_covid_site	String, URL	Government covid-19 website
health_dept_covid_site	String, URL	Government health department covid-19 website
covid_dashboard	String, URL	Dashboard of national/territorial covid-19 data

Regions

Region sections contain data only when regional policy and rules differ from the national/territorial level. When they are the same, the regional section is left blank.

Field	Format	Value
id	String, format XX-XX or XX-XXX	ISO 3166-2 region code
name	String	Name of region
code	String, format XX-XX or XX-XXX	ISO 3166-2 region code
covid_risk_level	String	Covid-19 Domestic Travel Rating. `Low` `Moderate` `Medium` `High` `Extreme`; see 'Covid-19 Methodology' for further details

infection

Field	Format	Value
rate	String	Covid-19 infection rate; see 'Covid-19 Methodology' for further details
level	String	`Low`, `Moderate`, `Medium`, `High`, `Extreme`
as_of_date	String	Date of the covid-19 infection data

summary

Field	Format	Value
summary	String	Summary of the Covid-19 situation in region. Can be blank/`null`

policy

Field	Format	Value
current_status	String	`Lockdown` `Stay at home` `Curfew` `Closing` `Opening` `Open` `Partial Measures` `Distancing` `None`
text	String	Explanation of the region's covid-19 policy
end_date	String, YYYY-MM-DD or `Indef`	Date the current policy is scheduled to end; `Indef` indicates there is no scheduled end date at this time
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

entry_and_borders

Field	Format	Value
entry_ban	String	`Yes` `No` `Partial`
through_date	String, YYYY-MM-DD or `Indef`	Date the current entry restrictions are scheduled to end; `Indef` indicates there is no scheduled end date at this time
text	String	Explanation of the region's entry restrictions
entry_rules	String, URL	Website of entry restrictions
exemptions	String, URL	Website of exemptions to entry restrictions
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

testing

Field	Format	Value
need_test	String	`Yes` `No` `Yes, conditional`
when	String	`Before travel` `Upon arrival` `After arrival`; can be any combination of these three
requirement	String	`Mandatory` `Optional`
text	String	Explanation of region's testing rules
rules	String, URL	Website of region's testing rules
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

health_travel_documentations

Field	Format	Value
need_documentations		`Yes` `No`
text	String	Explanation of required documentation; negative covid-19 test result requirements are handled in 'Testing' section
health_document	String, URL	Webpage of health document
travel_document	String, URL	Webpage of travel document
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

tracing_app

Field	Format	Value
need_app	String	`Yes` `No` `Recommended`
text	String	Explanation of tracing app rules
ios_urls	Array; URLs for iOS app stores	Link to app store page for tracing app; multiple URLs indicates multiple apps
android_urls	Array; URLs for Android app stores	Link to app store page for tracing app; multiple URLs indicates multiple apps
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

domestic_quarantine_on_arrival

Field	Format	Value
who_needs	String	`All travellers` `Some travellers` `None`
days	Integer	Number of days of quarantine required for national/territorial rule
type	String	`Self` `Gov` `Hybrid`; indicates self-quarantine at home or other suitable accommodation, at a government facility, or a hybrid system that includes both
text	String	Explanation of national/territorial quarantine rules
rules	String, URL	Webpage of quarantine rules
mandate_list	String, URL	Webpage of list of origin locations that require quarantine
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

masks

Field	Format	Value
requirement	String	`Yes` `No` `Yes, conditional` `Partial` `Recommended`
text	String	Explanation of national/territorial mask requirements and recommendations
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

areas_on_lockdown

Field	Format	Value
text	String	Explanation of areas on lockdown; `null` indicates no areas on lockdown
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

areas_under_curfew

Field	Format	Value
text	String	Explanation of areas under curfew; `null` indicates that no areas are under curfew
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

internal_travel

Field	Format	Value
is_allowed	String	`Yes` `No` `Partial`; Indicates whether internal travel within the region is allowed
text	String	Text explanation about internal travel restrictions within the region
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

other_internal_restrictions

Field	Format	Value
text		Text explanation of any other internal restrictions within the region
last_update	String, YYYY-MM-DD	Date of last update or verification that the information in this section is correct

resources

Field	Format	Value
government_covid_site	String, URL	Regional government covid-19 website
health_dept_covid_site	String, URL	Regional government health department covid-19 website

Cities

Field	Format	Value
id	String, three letters, capitalised	Three-letter IATA city code
name	String	Name of the city
code	String, three letters, capitalised	Three-letter IATA city code
covid_risk_level	String	`Low` `Moderate` `Medium` `High` `Extreme`; see 'Methodology' for further details
summary	String	Summary of the covid-19 situation in the city. Blank unless the situation is substantially better or worse than the surrounding region and/or country/territory
lat	Number; between '-90' and '90'	Latitude of the city
lng	Number; between '-180' and '180'	Longitude of the city

Updated over 1 year ago