ipumspy.api.BaseExtract

class ipumspy.api.BaseExtract[source]

A wrapper around an IPUMS extract. In most cases, you probably want to use a subclass, but if a particular collection does not have an Extract currently built, you can use this wrapper directly.

Attributes

extract_id

The extract id associated with this extract, assigned by the IpumsApiClient

extract_info

The API response recieved by the IpumsApiClient

Methods

__init__

A wrapper around an IPUMS extract.

build

Convert the object into a dictionary to be passed to the IPUMS API as a JSON string