ipumspy.api.IpumsApiClient.get_metadata_catalog#

IpumsApiClient.get_metadata_catalog(collection, metadata_type, page_size=2500)[source]#

Retrieve a catalog containing a summary of all resources of a given type for a given IPUMS collection.

Parameters:

  • collection (str) – The name of the IPUMS collection to retrieve metadata for

  • metadata_type (str) – Name of the type of metadata to retrieve for this collection. Valid values for the NHGIS collection include ‘datasets’, ‘data_tables’, ‘shapefiles’, and ‘time_series_tables’; valid values for the IHGIS collection include ‘datasets’, ‘data_tables’, and ‘tabulation_geographies’.

  • page_size (Optional[int]) – Number of items to return per page. Defaults to maximum page size, 2500.

Yields:

An iterator of metadata pages

Return type:

Generator[Dict, None, None]