ipumspy.api.IpumsApiClient.submit_extract

IpumsApiClient.submit_extract(extract, collection=None)[source]

Submit an extract request to the IPUMS API

Parameters

extract (Union[BaseExtract, Dict[str, Any]]) – The extract description to submit. May be either an IpumsExtract object, or the details of such an object, in which case it must include a key named collection

Return type

BaseExtract

Returns

The number of the extract for the passed user account