ipumspy.api.OtherExtract

class ipumspy.api.OtherExtract(collection, details)[source]

A generic extract object for working with collections that are not yet officially supported by this API library

Attributes

collection

Name of an IPUMS data collection

extract_id

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

extract_info

The API response recieved by the IpumsApiClient

details

dictionary containing variable names and sample IDs

Methods

__init__

A generic extract object for working with collections that are not yet officially supported by this API library

build

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