Skip to content

search catalog

Mehmood Asghar edited this page Sep 8, 2020 · 1 revision

Catalog Search

Search parameters

sk - Keywords for searching study level metadata

from - Starting year for the data collection

to - End year for the data collection

country - Provide country name or ISO 3 code. For country names and codes, see endpoint /api/catalog/country_codes. For searching multiple countries, provide names separated by pipe(|) Example: Afghanistan|Indonesia or afg|ind or afghanistan|ind

collection - Filter results by one or more collections. For filtering multiples, use format collection1, collection2

dtype - Filter by data access types. valid values "open""direct""public""licensed""enclave""remote""other". For multiple values, use comma e.g. open, direct, remote

ps - (Page size) Number of results per page. Default is 15 records per page

page - Page to return for the search result

sort_by - Sort search results. - valid options are rank,title,year,nation

sort_order - Set results sort order. valid options - Ascending = asc, Descending= desc

format - Supported formats are json, xml

Function:

search_catalog(sk, from, to, country, ...)

search_catalog(sk="population census", from=2000, to=2005, country="afg|ind")
Clone this wiki locally