About the IPUMS API category

[grover]

The IPUMS API program is a new way to get access to IPUMS data programmatically without needing to manually interact with our websites. The IPUMS API is still in active development, with new features and data collection support being released on a regular basis.

Read more about our current API capabilities at developer.ipums.org

Not sure what the IPUMS API is? See this brief explanation:

What is an IPUMS API?

The IPUMS API will provide programmatic access to IPUMS metadata and data without having to interact directly with one of the IPUMS websites. Previously, data could only be retrieved from IPUMS by logging into a website and selecting variables/datasets/tables from a filterable list. Nothing! Our website will remain available for users who prefer this method of browsing and retrieving data. We agree it is a great way for humans to explore what is available, but it is not so great for computers.…

[Whitney_Webber]

I’d like to use the API to access the IPUMS USA 2018-2022, ACS 5-year sample. I ran get_sample_info(“usa”) and didn’t see it in the list of available samples, but it looks like it is available for download on the website. Can you advise?

[Isabel_Pastoor]

Please try the command get_sample_info(collection = “usa”) and let me know if you continue to have issues.

[Whitney_Webber]

@Isabel_Pastoor

get_sample_info(collection = “usa”)

Thanks! I tried it and I’m still only seeing 152 observations through us2022b. Another question as well…I used SAS to run the 2017-2021 ACS 5-Year Estimates using an IPUMS file created in July 2023. Now, I’m testing out the API extract in R created today. I’m noticing a difference in the distribution for the POVERTY variable. Same sample, just different ways of extracting the data on different dates. Do you know what might account for the difference?

[Isabel_Pastoor]

Thank you for your patience in awaiting a response.

We looked into what you describe with the ipumsr package, and determined that the correct, most updated list of available samples was not displaying. We have fixed the issue and you should now see all the currently available samples when you use the command get_sample_info(collection = “usa”).

Regarding your question about POVERTY, in February of this year, IPUMS made updates to the variables POVERTY and FAMUNIT to address a problem with how POVERTY was calculated individually and within families. Thus, estimates derived using POVERTY will differ between data extracted before and after February 6, 2024. You can read more about the changes that were made in the revision history.

[Whitney_Webber]

@Isabel_Pastoor

Regarding your question about POVERTY, in February of this year, IPUMS made updates to the variables POVERTY and FAMUNIT to address a problem with how POVERTY was calculated individually and within families. Thus, estimates derived using POVERTY will differ between data extracted before and after February 6, 2024. You can read more about the changes that were made in the revision history.

Thank you very much for your response! I greatly appreciate the fix to the ipumsr package and clarification on the POVERTY calculation.