The IPUMS API for International

IPUMS API for IPUMS International Data Extracts

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

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

Currently unsupported features include:

  • Custom sample sizes
  • Household-only extracts
  • Longitudinal Extracts

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

Where is the IPUMS International Metadata in the API?

At this time, there is no metadata support in the API for IPUMS International. While we hope to provide support in the future, it is possible to use the IPUMS International 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.

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