Documentation > API Program > Available Collections > IPUMS API for IPUMS CPS


IPUMS API for 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

Currently unsupported features include:

  • Hierarchical extracts for H/P records
  • Case Selection
  • Attached Characteristics
  • Custom sample sizes
  • Household-only extracts
  • Data Quality Flags
  • Longitudinal Extracts

For more details, please see the IPUMS CPS data extract workflows and the reference documentation.

Where is the CPS Metadata in the API?

At this time, there is no metadata support in the API for IPUMS CPS. While we hope to provide support in the future, it is possible to use the IPUMS CPS website to gather all of the necessary information to make a request to the IPUMS API. This includes information such as sample IDs and variable mnemonics.

In particular, we’d like to draw your attention to the IPUMS CPS sample IDs page. The other primary piece of required metadata – the variable mnemonics – are displayed when viewing variables in the IPUMS CPS extract building interface.