ipumspy.api.IpumsApiClient.__init__#

IpumsApiClient.__init__(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:

  • api_key (str) – User’s IPUMS API key

  • base_url (str) – IPUMS API url

  • num_retries (int) – number of times a request will be retried before raising TransientIpumsApiException

  • session (Optional[Session]) – requests session object