ipumspy.api.IpumsApiClient#

class ipumspy.api.IpumsApiClient(api_key, base_url='https://api.ipums.org', api_version=2, num_retries=3, session=None)[source]#

Class for creating and retrieving IPUMS extracts via API

Parameters:

api_key (str) – User’s IPUMS API key
base_url (str) – IPUMS API url
api_version (str) – IPUMS API version
num_retries (int) – number of times a request will be retried before raising TransientIpumsApiException
session (Optional[Session]) – requests session object

Methods

`__init__`	Class for creating and retrieving IPUMS extracts via API
`download_extract`	Download the extract with id `extract_number` to `download_dir` (default location is current directory)
`extract_is_expired`	Returns `True` if the IPUMS extract's files have been expired from the cache.
`extract_status`	Check on the status of an extract request.
`get`	GET a request from the IPUMS API
`get_all_sample_info`	Retrieve sample descriptions and ids for all samples in an IPUMS collection.
`get_extract_by_id`	Convenience method to get a specific previously-submitted IPUMS extract.
`get_extract_history`	Retrieve extract history for a specific collection.
`get_extract_info`	Returns details about a past IPUMS extract
`get_metadata`	Retrieve detailed metadata for a specific IPUMS resource.
`get_metadata_catalog`	Retrieve a catalog containing a summary of all resources of a given type for a given IPUMS collection.
`get_previous_extracts`	Return details about the past `limit` requests
`post`	POST a request from the IPUMS API
`request`	Submit a request to the IPUMS API
`submit_extract`	Submit an extract request to the IPUMS API
`wait_for_extract`	Convenience function to wait for an extract to complete.