IPUMS API for IPUMS Microdata Collections
We currently have partial API support for IPUMS microdata collections, including:
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
- Household-only extracts
- Case Selection
- Attached Characteristics
- Data Quality Flags
Currently unsupported features include:
- Custom sample sizes
- 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
- Case Selection
- Attached Characteristics
- Data Quality Flags
Currently unsupported features include:
- Custom sample sizes
- 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
- Case Selection
- Attached Characteristics
- Data Quality Flags
Currently unsupported features include:
- Custom sample sizes
IPUMS API for IPUMS ATUS Data Extracts
The IPUMS API currently supports a subset of IPUMS ATUS extract system functionality. Supported features include:
- Extracts rectangularized on person records
- Extracts rectangularized on activity records
- Pre-selected variables included by default
- Inclusion of IPUMS-constructed and user-constructed Time Use Variables
- CSV or fixed-width data file output
- Formatted data files for Stata, SPSS, and SAS
- Hierarchical extracts
- Attached Characteristics
- Data Quality Flags
- Specification of Sample Members
- Inclusion of Elder Care Records
Currently unsupported features include:
- Creation of user-constructed Time Use Variables
IPUMS API for IPUMS AHTUS Data Extracts
The IPUMS API currently supports a subset of IPUMS AHTUS extract system functionality. Supported features include:
- Extracts rectangularized on person records
- Extracts rectangularized on activity records
- Pre-selected variables included by default
- Inclusion of IPUMS-constructed and user-constructed Time Use Variables
- CSV or fixed-width data file output
- Formatted data files for Stata, SPSS, and SAS
- Hierarchical extracts
- Data Quality Flags
Currently unsupported features include:
- Creation of user-constructed Time Use Variables
IPUMS API for IPUMS MTUS Data Extracts
The IPUMS API currently supports a subset of IPUMS MTUS extract system functionality. Supported features include:
- Extracts rectangularized on person records
- Extracts rectangularized on activity records
- Pre-selected variables included by default
- Inclusion of IPUMS-constructed and user-constructed Time Use Variables
- CSV or fixed-width data file output
- Formatted data files for Stata, SPSS, and SAS
- Hierarchical extracts
- Data Quality Flags
Currently unsupported features include:
- Creation of user-constructed Time Use Variables
IPUMS API for IPUMS MEPS Data Extracts
The IPUMS API currently supports a subset of IPUMS MEPS extract system functionality. Supported features include:
- Extracts rectangularized on person records
- Extracts rectangularized on round records
- Pre-selected variables included by default
- CSV or fixed-width data file output
- Formatted data files for Stata, SPSS, and SAS
- Hierarchical extracts
- Data Quality Flags
Currently unsupported features include:
- Wide format extracts
- Creation of user-constructed Event Summary Variables
IPUMS API for IPUMS NHIS Data Extracts
The IPUMS API currently supports a subset of IPUMS NHIS extract system functionality. Supported features include:
- Extracts rectangularized on person records
- Extracts rectangularized on injury records
- Pre-selected variables included by default
- CSV or fixed-width data file output
- Formatted data files for Stata, SPSS, and SAS
- Hierarchical extracts
- Attached Characteristics
For more details, please see the IPUMS microdata collection data extract workflow and the reference documentation.
How Do I Access Metadata for IPUMS Microdata Collections?
At this time, there is no metadata support in the API for IPUMS 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 Microdata Collection Metadata page.