Documentation > IPUMS API Program > Available Collections > Household-Person Microdata Collections

IPUMS API for Household-Person Microdata Collections

We currently have partial API support for IPUMS household-person microdata collections, including IPUMS USA, IPUMS CPS and IPUMS International. Please see details for each collection below.

IPUMS API for IPUMS USA Data Extracts

The IPUMS API currently supports a subset of IPUMS USA extract system functionality. Supported features include:

Extracts rectangularized on person records
Pre-selected variables included by default
CSV or fixed-width data file output
Formatted data files for Stata, SPSS and SAS
Hierarchical extracts for H/P records
Case Selection
Attached Characteristics
Data Quality Flags

Currently unsupported features include:

Custom sample sizes
Household-only extracts
Adjustment of monetary values

IPUMS API for IPUMS CPS Data Extracts

The IPUMS API currently supports a subset of IPUMS CPS extract system functionality. Supported features include:

Extracts rectangularized on person records
Pre-selected variables included by default
CSV or fixed-width data file output
Formatted data files for Stata, SPSS and SAS
Hierarchical extracts for H/P records
Case Selection
Attached Characteristics
Data Quality Flags

Currently unsupported features include:

Custom sample sizes
Household-only extracts
Longitudinal extracts
Adjustment of monetary values

IPUMS API for IPUMS International Data Extracts

The IPUMS API currently supports a subset of IPUMS International extract system functionality. Supported features include:

Extracts rectangularized on person records
Pre-selected variables included by default
CSV or fixed-width data file output
Formatted data files for Stata, SPSS and SAS
Hierarchical extracts for H/P records
Case Selection
Attached Characteristics
Data Quality Flags

Currently unsupported features include:

Custom sample sizes
Household-only extracts

For more details, please see the IPUMS household-person microdata collection data extract workflow and the reference documentation.

How Do I Access Metadata for Household-Person Microdata Collections?

At this time, there is no metadata support in the API for IPUMS household-person microdata collections. While we hope to provide support in the future, it is possible to use the IPUMS website to gather all of the necessary information to make a data extract request to the API. This includes information such as sample IDs and variable mnemonics. Links to specific resources can be found on the Explore IPUMS Household-Person Microdata Collection Metadata page.