ipumspy.api.IpumsApiClient¶
- class ipumspy.api.IpumsApiClient(api_key, base_url='https://api.ipums.org/extracts', api_version='beta', 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)Check on the status of an extract request.
Returns True if the IPUMS extract's files have been purged from the cache.
GET a request from the IPUMS API
Returns details about a past IPUMS extract
POST a request from the IPUMS API
Submit a request to the IPUMS API
Re-submits an IPUMS extract for which the data and ddi files have been purged from the IPUMS extract system cache.
Return details about the past
limit
requestsSubmit an extract request to the IPUMS API
Convenience function to wait for an extract to complete.