ipumspy.api.IpumsApiClient.get_extract_info#

IpumsApiClient.get_extract_info(extract, collection=None)[source]#

Returns details about a past IPUMS extract

Parameters:

  • extract (Union[BaseExtract, int]) – The extract to download. This extract must have been submitted. Alternatively, can be an extract id. If an extract id is provided, you must supply the collection name

  • collection (Optional[str]) – The name of the collection to pull the extract from. If None, then extract must be a BaseExtract

Return type:

Dict[str, Any]

Returns:

An IPUMS extract definition