The IPUMS API for IPUMS USA

IPUMS API for IPUMS USA Data Extracts

The IPUMS API 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*

*not yet supported by the ipumspy or ipumsr client SDK libraries

Currently unsupported features include:

  • Custom sample sizes
  • Household-only extracts

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

Where is the IPUMS USA Metadata in the API?

At this time, there is no metadata support in the API for IPUMS USA. While we hope to provide support in the future, it is possible to use the IPUMS USA website to gather all of the necessary information to make an extract 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 USA sample IDs page. The other primary piece of required metadata – the variable mnemonics – are displayed when viewing variables in the IPUMS USA extract building interface. ß