The IPUMS API for CPS

IPUMS Data Extract API for CPS

The IPUMS Data Extract API for CPS is currently in beta status and 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

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

Where is the Metadata API?

At this time, there is not a publicly available metadata API for IPUMS CPS. While we hope to provide one 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 CPS Data Extract 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.