ipumspy.api.IpumsApiClient#
- class ipumspy.api.IpumsApiClient(api_key, base_url='https://api.ipums.org/extracts', api_version=2, num_retries=3, session=None)[source]#
Class for creating and retrieving IPUMS extracts via API
- Parameters:
Methods
Class for creating and retrieving IPUMS extracts via API
Download the extract with id
extract_number
todownload_dir
(default location is current directory)Returns True if the IPUMS extract's files have been expired from the cache.
Check on the status of an extract request.
GET a request from the IPUMS API
Retrieve sample descriptions and ids for all samples in an IPUMS collection.
Convenience method to get a specific previously-submitted IPUMS extract.
Retrieve extract history for a specific collection.
Returns details about a past IPUMS extract
Return details about the past
limit
requestsPOST a request from the IPUMS API
Submit a request to the IPUMS API
Submit an extract request to the IPUMS API
Convenience function to wait for an extract to complete.