MIDAS Catalog API

Documentation

Introduction

The MIDAS Catalog is a curated collection of resources (e.g. datasets, software) pertinent to the field of infectious disease modeling. The MIDAS Catalog web interface is available at: https://catalog.midasnetwork.us.

All of the metadata for the catalog entries in the MIDAS Catalog are accessible via the MIDAS Catalog API. This REST API is intended for use by developers that want to use the catalog entry metadata in their own software.

Note: API use is restricted to members of the MIDAS Research Network. All members are assigned a personal token, which we call an API key, which is required to be sent with API requests.

A brief explanation of searching for metadata via the API is as follows:

API location:

The API is hosted at members.midasnetwork.us/midascontacts. All requests should prepend https://members.midasnetwork.us/midascontacts/ to the URLs described below.

Search:

The most important function of the API is search. API users search the catalog by issuing one or more field-value pairs as query parameters in the url. The API will then return the JSON metadata of the matching catalog entries.

For example, a request to retrieve datasets about COVID-19:

/catalog/search?disease=covid_19&type_or_record=data_set&apiKey={key}

Building a field-value pair:

A listing of metadata fields (e.g. “disease”, “location”) are obtained using the: /catalog/entries/fields endpoint.

A listing of metadata values for a given field (e.g. for disease: “covid_19”, “mpox”) are obtained using the /catalog/entries/fields/values?field=<field> endpoint.

For the official documentation of the API, please see below.

Important: All Catalog API endpoints use the HTTP GET method.

Developer Documentation

Endpoint Used to Retrieve an API Key

The API Key is emailed to the specified email address used in the request. The provided email address must match the address used on the membership application. Use this link to apply to become a member of MIDAS.

API users retrieve their API Key by issuing the following request:

Endpoint Definition

				
					/catalog/apiKey/request?emailAddress={member_email_address}

HTTP

				
					https://members.midasnetwork.us/midascontacts/catalog/apikey/request?emailAddress=<member_email_address>

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/apikey/request?emailAddress=" + "member_email_address"
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/apikey/request?emailAddress=" + "member_email_address" -H "accept: application/json;charset=UTF-8"

Endpoints Used to Search for Catalog Metadata Entries

Search for JSON Endpoint

Endpoint Definition

				
					/catalog/search?apiKey={apiKey}

Calling the endpoint with no query parameters will return all JSON metadata for all entries in the catalog.

Retrieving the JSON metadata for all entries at once

HTTP

				
					https://members.midasnetwork.us/midascontacts/catalog/search?apikey=<member_api_key>

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key"
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" -H "accept: application/json;charset=UTF-8"

Search Fields and Values

Note: An extensive listing of available search fields and values as of 5/15/2023 is available in Appendix A.

Retrieving all available search fields

Endpoint Definition

				
					/catalog/search/fields?apiKey={apiKey}

HTTP

				
					https://members.midasnetwork.us/midascontacts/catalog/search/fields?apikey=<member_api_key>

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/search/fields?apiKey=" + "member_api_key"
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/search/fields?apiKey=" + "member_api_key" -H "accept: application/json;charset=UTF-8"

Retrieving all available values for a search field

Endpoint Definition

				
					/catalog/search/fields/value?apiKey={apiKey}&field={field_name}

HTTP

				
					https://members.midasnetwork.us/midascontacts/catalog/search/fields/value?apikey=<member_api_key>&field=<field_name>

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/search/fields/values?apiKey=" + "member_api_key" + “&field=<field_name>”
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/search/fields?apiKey=" + "member_api_key" + “&field=<field_name>” -H "accept: application/json;charset=UTF-8"

Example API Requests

Retrieve a JSON array of entry metadata for entries about a disease (COVID-19)

HTTP

				
					https://members.midasnetwork.us/midascontacts/catalog/search?apikey=<member_api_key>&disease=covid_19

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&disease=covid_19"
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&disease=covid_19" -H "accept: application/json;charset=UTF-8"

Retrieve a JSON array of entry metadata for entries about a location (the United States) including sublocations

Note: The GeonamesID for the United States is 6252001.

HTTP

				
					https://members.midasnetwork.us/midascontacts/catalog/search?apikey=<member_api_key>&locationOption=include_sub_locations&location=6252001

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&locationOption=include_sub_locations&location=6252001"
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&locationOption=include_sub_locations&location=6252001" -H "accept: application/json;charset=UTF-8"

Retrieve a JSON array of entry metadata for Mpox Datasets in North America

Important: This is the first query that specifies a geographical location. Instead of the query using the name of a location, which will vary between languages, the API queries locations using numerical IDs from the Geonames Database.

HTTP

				
					https://members.midasnetwork.us/midascontacts
/catalog/search?apikey=<member_api_key>&disease=mpox&type_or_record=data_set&location=6255149&location_option=include_sub_locations

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&disease=mpox&type_or_record=data_set&location=6255149&location_option=include_sub_locations"
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" -H "accept: application/json;charset=UTF-8"

Retrieve a JSON array of entry metadata for entries about any location in a list of locations (Connecticut or New York)

Note: The GeonamesIds for Connecticut and New York, are 4831725 and 5128638, respectively.

HTTP

				
					https://members.midasnetwork.us/midascontacts/catalog/search?apikey=<member_api_key>&location=4831725&location=5128638

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&location=4831725&location=5128638"
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&location=4831725&location=5128638" -H "accept: application/json;charset=UTF-8"

Retrieve a JSON array of entry metadata for entries of data type (dataset) about a topic (case counts)

HTTP

				
					https://members.midasnetwork.us/midascontacts/catalog/search?apikey=<member_api_key>&type_or_record=data_set&topic=case_counts

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&type_or_record=data_set&topic=case_counts"
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&type_or_record=data_set&topic=case_counts" -H "accept: application/json;charset=UTF-8"

Retrieve a JSON array of entry metadata for entries that are a part of a collection (the MIDAS Curated Archive of Global Public Health Data)

Note: The MIDAS Curated Archive of Global Public Health Data is a centralized worldwide archive of official COVID-19 data from public health agencies, ministries of health, and other governmental websites.

HTTP

				
					https://members.midasnetwork.us/midascontacts/catalog/search?apikey=<member_api_key>&collection=curated_archive_of_global_public_health_data

Python

				
					import requests
url = "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&collection=curated_archive_of_global_public_health_data"
response = requests.get(url)
print(response.text)

Shell / cUrl

				
					curl -X GET "https://members.midascontacts.com/catalog/search?apiKey=" + "member_api_key" + "&collection=curated_archive_of_global_public_health_data" -H "accept: application/json;charset=UTF-8"

Appendix A: Search Fields and Values

Simple Fields

Field	Accepted Values
biological_scale	`population`, `molecular`
collection	`include_non_collection_specific_results`, `curated_archive_of_global_public_health_data`
disease	`include_non_disease_specific_results`, `covid_19`, `mpox`
host_species	`homo_sapiens`, `non_specific_host`
pathogen_species	`severe_acute_respiratory_syndrome_coronavirus_2`, `monkeypox_virus`, `non_specific_pathogen`
language	`albanian`, `arabic`, `armenian`, `azerbaijani`, `basque`, `bengali`, `bhojpuri`, `bosnian`, `bulgarian`, `burmese`, `central_khmer`, `chinese`, `croatian`, `czech`, `danish`, `dutch_flemish`, `english`, `estonian`, `finnish`, `french`, `georgian`, `german`, `greek_modern`, `gujarati`, `hausa`, `hebrew`, `hindi`, `hungarian`, `icelandic`, `igbo`, `indonesian`, `italian`, `japanese`, `javanese`, `kannada`, `kirghiz_kyrgyz`, `korean`, `lao`, `latvian`, `lithuanian`, `maithili`, `malay`, `malayalam`, `marathi`, `mongolian`, `montenegrin`, `norwegian`, `panjabi_punjabi`, `papiamento`, `persian`, `polish`, `portuguese`, `romanian_moldavian_moldovan`, `russian`, `serbian`, `sindhi`, `slovak`, `slovenian`, `somali`, `spanish_castilian`, `swedish`, `tajik`, `tamil`, `telugu`, `thai`, `turkish`, `ukrainian`, `urdu`, `uzbek`, `vietnamese`, `yoruba`
location	geonames identifiers
location_option	`include_non_location_specific_results`, `include_sub_locations`, `multi_continental`
temporal_scope_begin_date	begin date in format `yyyy/MM/dd`
temporal_scope_end_date	end date in format `yyyy/MM/dd`

type_or_record

Hierarchical. Values with children include all sub-values.

type_or_record

software Software
- executable_file Executable File
- package Package
- web_application Web Application
data_set Data Set
catalog Catalog
- literature Literature
  - modeling_studies Modeling Studies
  - disease_specific_collection Disease-Specific Collection
dashboard Dashboard
repository Repository
educational_resource Educational Resource

digital_object_type

Sub-types for software records.

digital_object_type

executable_file Executable File
package Package
web_application Web Application

file_format

file_format Flat list

csv
pdf
tsv
xlsx
html
js
json
txt
zip
jpg
png
xls
twb
twbx
dbf
prj
shp
shx
geo_json
topo_json
md
rmd
r
rdata
rds
rproj
tif
nc
pyp
sas
dta
google_sheet
google_docs
google_slides
google_forms
xml
tsv_for_excel
rss
csv_for_excel
csv_for_excel__europe_
tar_gz
ndjson
fasta
doc
docx
rda
xlsm
svg
nwk
nexus
cpp
yaml
ppt
pptx
rdf
sav
kml
kmz
dat
gdp
ris
do_sata
eps
m
mat
gdb
acc
pqt
jsonl
parquet
ods
hwp
seven_zip
rar

license

license Flat list

academic_free_license_version_3
alfred_copyright
apache_license_version_2_0
artistic_license_1_0
artistic_license_2_0
cc_by_2_0
cc_by_2_0_uk
cc_by_2_1_jp
cc_by_2_5
cc_by_3_0
cc_by_3_0_au
cc_by_3_0_us
cc_by_4_0
cc_by_igo
cc_by_nc_3_0
cc_by_nc_3_0_igo
cc_by_nc_4_0
cc_by_nc_nd_2_5
cc_by_nc_nd_2_5_ch
cc_by_nc_nd_3_0
cc_by_nc_nd_4_0
cc_by_nc_sa_2_5
cc_by_nc_sa_2_5_in
cc_by_nc_sa_3_0
cc_by_nc_sa_3_0_igo
cc_by_nc_sa_3_0_us
cc_by_nc_sa_4_0
cc_by_nd_3_0
cc_by_nd_4_0
cc_by_sa_2_0
cc_by_sa_2_1_jp
cc_by_sa_3_0
cc_by_sa_3_0_us
cc_by_sa_4_0
cc0
cc0_1_0
dbcl_v1_0
design_science_license
epl_v1
etalab_open_license_2_0
flowrepository_open_access_terms_of_use
free_to_use_license
freebsd
gnu_agpl_v3
gnu_gpl_v2
gnu_gpl_v3
gnu_lgpl_v2_1
gnu_lgpl_v3
iupac_inchi_trust_inchi_licence_no__1_0
lppl_v1_2
lppl_v1_3c
miaca_full_copyright
mit_license
modified_bsd
mpl_v1_1
mpl_v2_0
nlm_open_license_with_attribution
odbl_v1_0
odc_by_v1_0
ome_software_conditons_of_use
open_government_licence_v3_0
opl_v1_0
orcid_mit_style_license_mit
pdm_1_0_deed
pddl_v1_0
prodom_commercial_license
proprietary_commercial_software_license
public_domain_u_s__government
saas
sbgn_open_license_with_attribution
terms_of_use_for_embl_ebi_services
ucsc_genome_browser_commercial_software_license

geographical_resolution

geographical_resolution Flat list

address
borough
canton
census_tract
city
commune
continent
country
county
department
dependent_political_entity
district
emirate
first_order_administrative_division
fourth_order_administrative_division
freely_associated_state
governorate
health_region
independent_political_entity
indian_reservation
kingdom
municipality
parish
political_entity
populated_place
postal_code
prefecture
principality
province
region
second_order_administrative_division
section_of_independent_political_entity
semi_independent_political_entity
special_region
state
territory
third_order_administrative_division
town
village
ward
who_african_region
who_eastern_mediterranean_region
who_european_region
who_region_of_the_americas_region
who_south_east_asia_region
who_western_pacific_region

software_language

software_language Flat list

c
clojure
cplusplus
fortran
go
java
javascript
julia
matlab
ocaml
python
r
rust
scala
typescript

operating_system

operating_system Flat list

android
centos
debian
freebsd
ios
linux
macos
red_hat_enterprise_linux
ubuntu
windows

topic / teaches

Hierarchical. The teaches field accepts the same values as topic.

topic Expand categories to see sub-values

behavior Behavior
- conspiracy_theories Conspiracy Theories
- contact_rates Contact Rates
- human_daily_movement_data_set Human Movement
- policy_adherence Policy Adherence
- vaccination_intent Vaccination Intent
  - intent_to_be_vaccinated Intent to Be Vaccinated
  - intent_to_have_a_ward_vaccinated Intent to Have a Ward Vaccinated
    
    intent_to_have_a_child_vaccinated Intent to Have a Child Vaccinated
  - intent_to_vaccinate Intent to Vaccinate
- vaccine_hesitancy Vaccine Hesitancy
clinical_trial Clinical Trial
control_strategy_census Control Strategy
- drug_treatment Drug Treatment
- event_cancellations Event Cancellations
- laboratory_testing_capacity Laboratory Testing Capacity
- laboratory_testing_facility_census Laboratory Testing Facility
- regulatory_complaints Regulatory Complaints
- risk_factors Risk Factors
- school_closure_control_strategy_census School Closure
- vaccination Vaccination
  - census_of_vaccination_supplies Vaccination Supplies
  - vaccination_administration_capacity Vaccination Capacity
  - vaccination_administration_census Vaccination Administration
    
    cumulative_vaccination_count Cumulative Vaccination
    
    incident_vaccination_count Incident Vaccination
  - vaccination_with_nirsevimab Nirsevimab Vaccination
- wildlife_health_interventions Wildlife Health Interventions
data_preparation Data Preparation
data_service Data Service
decision_support_systems Decision Support Systems
disease Disease
- antimicrobial_resistance Antimicrobial Resistance
  - antibiotic_resistance Antibiotic Resistance
    
    methicillin_resistant_staphylococcus_aureus_infectious_disease MRSA
- digestive_system_disorder Digestive System Disorder
  - diarrheal_disease Diarrhea
    
    shigellosis Shigellosis
  - foodborne_illness Foodborne Illness
    
    escherichia_coli_infection E. coli
    
    hepatitis_a_virus_infection Hepatitis A
    
    listeriosis Listeria
    
    salmonellosis Salmonella
    
    typhoid_fever Typhoid Fever
    
    shigellosis Shigellosis
  - hepatitis Hepatitis
    
    hepatitis_a_virus_infection Hepatitis A
    
    hepatitis_b_virus_infection Hepatitis B
    
    hepatitis_c_virus_infection Hepatitis C
  - intestinal_infectious_disease Intestinal Infectious Disease
    
    cholera Cholera
    
    shigellosis Shigellosis
- infectious_disease Infectious Disease
  - bacterial_infectious_disease Bacterial Infection
    
    anthrax_infection Anthrax
    
    chlamydia_trachomatis_infectious_disease Chlamydial
    
    cholera Cholera
    
    diphtheria Diphtheria
    
    escherichia_coli_infection E. coli
    
    gonorrhea Gonorrhea
    
    legionellosis Legionella
    
    listeriosis Listeria
    
    lyme_disease Lyme Disease
    
    meningococcal_infection N. meningitidis
    
    methicillin_resistant_staphylococcus_aureus_infectious_disease MRSA
    
    pertussis Pertussis
    
    pneumococcal_infection S. pneumoniae
    
    pneumonia Pneumonia
    
    salmonellosis Salmonella
    
    typhoid_fever Typhoid Fever
    
    shigellosis Shigellosis
    
    spotted_fever Spotted Fever
    
    syphilis Syphilis
    
    tetanus Tetanus
    
    tuberculosis Tuberculosis
  - fungal_infectious_disease Fungi Infection
    
    coccidioidomycosis Valley Fever
    
    pneumonia Pneumonia
  - neglected_tropical_disease Neglected Tropical Disease
    
    chikungunya Chikungunya
    
    dengue_disease Dengue
  - nosocomial_infection Healthcare-associated Infection
    
    methicillin_resistant_staphylococcus_aureus_infectious_disease MRSA
  - parasitic_infectious_disease Parasitic Infection
    
    coccidioidomycosis Valley Fever
    
    malaria Malaria
  - sexually_transmitted_disease Sexually Transmitted Disease
    
    aids AIDS
    
    chlamydia_trachomatis_infectious_disease Chlamydial
    
    gonorrhea Gonorrhea
    
    syphilis Syphilis
  - vaccine_preventable_disease Vaccine-Preventable Disease
    
    chickenpox Varicella
    
    cholera
    
    covid_19 COVID-19
    
    dengue_disease Dengue
    
    diphtheria
    
    ebola_hemorrhagic_fever Ebola
    
    hepatitis_a_virus_infection
    
    hepatitis_b_virus_infection
    
    influenza
    
    malaria
    
    measles
    
    mumps_infectious_disease Mumps
    
    pertussis
    
    pneumococcal_infection
    
    poliomyelitis
    
    rubella
    
    tetanus
    
    tuberculosis
    
    typhoid_fever
    
    yellow_fever
  - vector_borne_disease Vector-borne Infection
    
    chikungunya
    
    dengue_disease
    
    listeriosis
    
    malaria
    
    tick_borne_infectious_disease Tick-borne
    
    lyme_disease
    
    spotted_fever
    
    west_nile_fever
    
    yellow_fever
    
    zika_virus_infectious_disease Zika
  - viral_infectious_disease Viruses Infection
    
    aids
    
    chickenpox
    
    chikungunya
    
    dengue_disease
    
    hand_foot_and_mouth_disease
    
    hepatitis_a_virus_infection
    
    hepatitis_b_virus_infection
    
    hepatitis_c_virus_infection
    
    measles
    
    mpox
    
    mumps_infectious_disease
    
    poliomyelitis
    
    rubella
    
    smallpox
    
    viral_hemorrhagic_fever
    
    ebola_hemorrhagic_fever
    
    viral_respiratory_tract_infection
    
    covid_19
    
    influenza
    
    pneumonia
    
    respiratory_syncytial_virus_infectious_disease RSV
    
    west_nile_fever
    
    yellow_fever
    
    zika_virus_infectious_disease
  - zoonotic_infection Zoonotic Infection
    
    anthrax_infection
    
    ebola_hemorrhagic_fever
    
    escherichia_coli_infection
    
    influenza
    
    listeriosis
    
    malaria
    
    mpox
    
    salmonellosis
    
    typhoid_fever
    
    tick_borne_infectious_disease
    
    lyme_disease
    
    spotted_fever
    
    west_nile_fever
    
    yellow_fever
    
    zika_virus_infectious_disease
- substance_related_disorder Substance-Related Disorder
disease_vector Disease Vector
- culicidae Mosquitos
- ixodida Ticks
educational_activity Educational Activity
ensemble_specification Ensemble Specification
environment_information Environment Information
- air_quality
- climate_data_set Climate
- land_cover_land_use
- natural_disasters
- weather_data_set Weather
evaluation Evaluation
graphics_visualization Graphics Visualization
health_heterogeneity Health Heterogeneity
- socio_economic_impacts Socio-economic Impacts
  - aid_responses Aid / Responses
health_system_capacity Health System Capacity
- treatment_facility_census Treatment Facility
host_organism Host
- homo_sapiens
immunology Immunology
- infectious_agent_seroprevalence Seroprevalence
media Media
- social_media
modeling Modeling
- modeling_method Modeling Method
  - agent_based_models
  - compartmental_models
  - dynamic_models
  - expert_assessment_opinion
  - machine_learning
  - mathematical_model
  - statistical_model
    
    bayesian_model
    
    geospatial_models
    
    simulation_time_series Time Series
- modeling_output Modeling Output
- modeling_purpose Modeling Purpose
  - decision_models
  - disease_transmission_model Disease Transmission
  - forecasting
  - health_risk_assessment
  - intra_host_modeling
  - network_modeling
  - parameter_estimation
  - phylogenetic_analysis
  - scenario_analysis
  - uncertainty_quantification
pathogen Pathogen
- bacteria Bacteria
  - bacillus_anthracis
  - bordetella_pertussis
  - borrelia
  - chlamydia
  - clostridium_tetani
  - corynebacterium_diphtheriae
  - escherichia_coli
  - legionella
  - listeria_monocytogenes
  - mycobacterium_tuberculosis
  - neisseria_gonorrhoeae
  - neisseria_meningitidis
  - rickettsia
  - salmonella
  - shigella
  - staphylococcus_aureus
  - streptococcus_pneumoniae
  - treponema_pallidum
  - vibrio_cholerae
- fungi Fungi
  - coccidioides
- plasmodium
- viruses Viruses
  - chikungunya_virus
  - dengue_virus
  - ebolavirus
  - enterovirus
    
    enterovirus_c Poliovirus
  - hepacivirus_hominis Hepatitis C virus
  - hepatitis_b_virus
  - human_alphaherpesvirus_3 Varicella-zoster
  - human_hepatitis_a_virus
  - human_immunodeficiency_virus
  - human_respiratory_syncytial_virus
  - influenza_a_virus
  - influenza_b_virus
  - measles_morbillivirus
  - monkeypox_virus Mpox virus
  - mumps_orthorubulavirus
  - rubella_virus
  - severe_acute_respiratory_syndrome_coronavirus_2 SARS-CoV-2
  - unidentified_influenza_virus
  - variola_virus
  - west_nile_virus
  - yellow_fever_virus
  - zika_virus
population_count Population Count
- count_of_disease_cases Case Count
  - cumulative_case_count
  - incident_case_count
- count_of_infections_in_a_population Infection Count
  - cumulative_infection_count
  - incident_infection_count
- count_of_outpatient_visit Outpatient Visit
  - cumulative_outpatient_visit
  - incident_outpatient_visit
- count_of_recovered_in_a_population Recovery Count
  - cumulative_recovered_count
  - incident_recovered_count
- diagnostic_tests Tests
- emergency_department_visit_dataset Emergency Department Visit
  - cumulative_emergency_department_visit_count
  - incident_emergency_department_visit_count
- hospital_stay_dataset Hospitalization
  - cumulative_hospitalization_count
  - incident_hospitalization_count
  - peak_hospitalization_count Peak Size
  - peak_hospitalization_time_cumulative_distribution Peak Time
- infection_case_list
- mortality_data Mortality
  - cumulative_death_count
  - excess_mortality_dataset Excess Mortality
  - incident_death_count
- organism_strain Organism Strain
population_demographic_census Population Demographic
- age_stratified
- ethnic_identity_information_content_entity Ethnicity
- gender_identity_information_content_entity Gender
- phenotypic_sex Sex
- racial_identity_information_content_entity Race
sequence_collection Sequence Collection
- phylogenetics
synthetic_populations Synthetic Populations
wastewater_surveillance_data_set Wastewater

Educational Resource Fields

These fields apply to records of type educational_resource.

Field	Accepted Values
educational_level	`Graduate`, `professional`, `general_public`
educational_use	`classroom_instruction`, `lecture_support`, `self_paced_learning`, `workshop_activity`, `simulation_exercise`, `case_study_analysis`, `data_analysis_activity`, `guided_practice`, `independent_practice`, `assessment`, `discussion_prompt`, `reference_material`
educational_audience	`researchers`, `students`, `public_health_professionals`, `general_public`
educational_objective	`understanding_sir_models`, `understanding_seir_models`, `interpreting_epidemic_curves`, `Understanding_r0_and_re`, `scenario_analysis`, `data_literacy`, `model_comparison`, `uncertainty_interpretation`, `public_health_decision_support`, `ethical considerations`
educational_prerequisite	`calculus`, `basic_statistics`, `programming_basics`, `python_fundamentals`, `r_fundamentals`, `basic_epidemiology`, `modeling_fundamentals`, `public_health_foundations`
educational_format	`online`, `interactive`, `slides`, `in_person`, `mooc`, `notebooks`, `textbook`, `lecture_notes`, `datasets`, `software`, `video`
educational_data_requirements	`synthetic_data`, `real_world_datasets`, `none`

Introduction

Table of Contents (click section for more detail)

Developer Documentation

Endpoint Used to Retrieve an API Key

Endpoint Definition

HTTP

Python

Shell / cUrl

Endpoints Used to Search for Catalog Metadata Entries

Search for JSON Endpoint

Endpoint Definition

Retrieving the JSON metadata for all entries at once

HTTP

Python

Shell / cUrl

Search Fields and Values

Retrieving all available search fields

Endpoint Definition

HTTP

Python

Shell / cUrl

Retrieving all available values for a search field

Endpoint Definition

HTTP

Python

Shell / cUrl

Example API Requests

Retrieve a JSON array of entry metadata for entries about a disease (COVID-19)

HTTP

Python

Shell / cUrl

Retrieve a JSON array of entry metadata for entries about a location (the United States) including sublocations

HTTP

Python

Shell / cUrl

Retrieve a JSON array of entry metadata for Mpox Datasets in North America

HTTP

Python

Shell / cUrl

Retrieve a JSON array of entry metadata for entries about any location in a list of locations (Connecticut or New York)

HTTP

Python

Shell / cUrl

Retrieve a JSON array of entry metadata for entries of data type (dataset) about a topic (case counts)

HTTP

Python

Shell / cUrl

Retrieve a JSON array of entry metadata for entries that are a part of a collection (the MIDAS Curated Archive of Global Public Health Data)

HTTP

Python

Shell / cUrl

Appendix A: Search Fields and Values

Simple Fields

type_or_record

digital_object_type

file_format

license

geographical_resolution

software_language

operating_system

topic / teaches

Educational Resource Fields