# IPUMS API **URL:** https://forum.ipums.org/c/ipums-api/16.md [Latest](https://forum.ipums.org/latest.md) · [Categories](https://forum.ipums.org/categories.md) --- ## [About the IPUMS API category](https://forum.ipums.org/t/about-the-ipums-api-category/49)
**Author:** [@grover](https://forum.ipums.org/u/grover)\ **Replies:** 5\ **Last updated:** [April 12, 2024, 6:03pm UTC](https://forum.ipums.org/t/about-the-ipums-api-category/49 "2024-04-12T18:03:51Z")
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 … --- ## [Timeout error on relatively small data extracts](https://forum.ipums.org/t/timeout-error-on-relatively-small-data-extracts/7080)
**Author:** [@i\_chen](https://forum.ipums.org/u/i_chen)\ **Replies:** 1\ **Last updated:** [May 21, 2026, 5:54pm UTC](https://forum.ipums.org/t/timeout-error-on-relatively-small-data-extracts/7080 "2026-05-21T17:54:51Z")
Hi, I’m having some trouble downloading extracts using the R API. I already submitted 16 extracts and am trying to download them using the following code: samples ← get\_sample\_info(“usa”) acs\_5y\_samples ← samples %\>% … --- ## [IPUMSR API Key issue](https://forum.ipums.org/t/ipumsr-api-key-issue/6550)
**Author:** [@MMiller](https://forum.ipums.org/u/MMiller)\ **Replies:** 2\ **Last updated:** [May 28, 2025, 1:11am UTC](https://forum.ipums.org/t/ipumsr-api-key-issue/6550 "2025-05-28T01:11:11Z")
I am trying to retrieve data using the ipumsr package. I have set my key using: set\_ipums\_api\_key("ENTER\_API\_KEY\_HERE",save=TRUE,overwrite=TRUE) I then try to submit an extract request as follows: submitted\_extract \<-… --- ## [IPUMS API - NHIS metadata](https://forum.ipums.org/t/ipums-api-nhis-metadata/6499)
**Author:** [@Alexandra\_Ruth](https://forum.ipums.org/u/Alexandra_Ruth)\ **Replies:** 4\ **Last updated:** [April 24, 2025, 3:50pm UTC](https://forum.ipums.org/t/ipums-api-nhis-metadata/6499 "2025-04-24T15:50:33Z")
Hi! I love the example vignette that enables the ddi codebook to be downloaded for a cps extract. Do you know if/when it will be possible to do this same thing for health survey extracts? I tried using the vignette here… --- ## [Invalid API Key error](https://forum.ipums.org/t/invalid-api-key-error/6451)
**Author:** [@S\_D](https://forum.ipums.org/u/S_D)\ **Replies:** 4\ **Last updated:** [April 23, 2025, 9:03pm UTC](https://forum.ipums.org/t/invalid-api-key-error/6451 "2025-04-23T21:03:51Z")
Hi, I’m a first-time user of IPUMS API and I keep getting an “Invalid API key” error while making a request. I double-checked the key I’m using and also revoked an existing one and created a new one but the issue persi… --- ## [This is my first time using IPUMS API, I only use CENSUS API before](https://forum.ipums.org/t/this-is-my-first-time-using-ipums-api-i-only-use-census-api-before/6353)
**Author:** [@Hieu\_Tran](https://forum.ipums.org/u/Hieu_Tran)\ **Replies:** 12\ **Last updated:** [March 18, 2025, 5:42pm UTC](https://forum.ipums.org/t/this-is-my-first-time-using-ipums-api-i-only-use-census-api-before/6353 "2025-03-18T17:42:37Z")
I’m migrating to IPUMS API from CENSUS API. I was trying to look all over the documentations, but it was quite confused to me. I wanted to extract vacancy data from Puerto Rico for 2010 and 2020 with geometry to plot it … --- ## [Linked Samples in extract definition](https://forum.ipums.org/t/linked-samples-in-extract-definition/6328)
**Author:** [@Phil\_Feller](https://forum.ipums.org/u/Phil_Feller)\ **Replies:** 3\ **Last updated:** [February 5, 2025, 6:28pm UTC](https://forum.ipums.org/t/linked-samples-in-extract-definition/6328 "2025-02-05T18:28:44Z")
Is there a way to use the API to extract only linked samples? I can do this from the web UI, of course, but I’d prefer to do so though R code so that other researchers can reproduce my results. I’m working with the USA … --- ## [R ipums api - ERROR message](https://forum.ipums.org/t/r-ipums-api-error-message/5832)
**Author:** [@Jose\_Funes](https://forum.ipums.org/u/Jose_Funes)\ **Replies:** 6\ **Last updated:** [October 22, 2024, 2:11pm UTC](https://forum.ipums.org/t/r-ipums-api-error-message/5832 "2024-10-22T14:11:12Z")
hi, I am new to the IPUMS community, and I expect to actively use the IPUMS API. I am using R to get a data call using the IPUMS API key, but I am getting an error message that reads like this “Error: Your API call has… --- ## [CPS json requested extract in stata format is delivered as .dat](https://forum.ipums.org/t/cps-json-requested-extract-in-stata-format-is-delivered-as-dat/5943)
**Author:** [@FooBar1](https://forum.ipums.org/u/FooBar1)\ **Replies:** 3\ **Last updated:** [June 13, 2024, 6:27pm UTC](https://forum.ipums.org/t/cps-json-requested-extract-in-stata-format-is-delivered-as-dat/5943 "2024-06-13T18:27:06Z")
I have an extract that specifies as dataFormat stata, yet the file I download is .dat. Below is my code – the extract clearly specifies “dataFormat”:“stata” – but when I extract/unzip the file, there’s a .dat inside. W… --- ## [Revisions to fields](https://forum.ipums.org/t/revisions-to-fields/5858)
**Author:** [@Whitney\_Webber](https://forum.ipums.org/u/Whitney_Webber)\ **Replies:** 1\ **Last updated:** [May 6, 2024, 5:03pm UTC](https://forum.ipums.org/t/revisions-to-fields/5858 "2024-05-06T17:03:55Z")
How does one monitor for changes to a field? How would I have known about the updates to POVERTY and FAMUNIT that were done recently aside from monitoring the revision history? --- ## [Obtaining an API key](https://forum.ipums.org/t/obtaining-an-api-key/5810)
**Author:** [@Justin\_Hollis](https://forum.ipums.org/u/Justin_Hollis)\ **Replies:** 5\ **Last updated:** [April 16, 2024, 8:31pm UTC](https://forum.ipums.org/t/obtaining-an-api-key/5810 "2024-04-16T20:31:31Z")
It says IPUMS uses a common user management system for several data projects: IPUMS International, IPUMS USA, IPUMS CPS, IPUMS Higher Ed, NHGIS, IPUMS Health Surveys, IPUMS Time Use, and IPUMS Terra. I have an account w… --- ## [How to get weighted N of cases using the API?](https://forum.ipums.org/t/how-to-get-weighted-n-of-cases-using-the-api/5610)
**Author:** [@Nguyen\_Tran](https://forum.ipums.org/u/Nguyen_Tran)\ **Replies:** 2\ **Last updated:** [January 21, 2024, 8:20pm UTC](https://forum.ipums.org/t/how-to-get-weighted-n-of-cases-using-the-api/5610 "2024-01-21T20:20:03Z")
Context: I’m building a report at the state level and want to display, per state, the reason people moved out of that state. I got the data “Reason for moving by state and year” using the Analyze Data Online web tool an… --- ## [Enhancements to define\_extract APIs](https://forum.ipums.org/t/enhancements-to-define-extract-apis/4737)
**Author:** [@Phil\_Feller](https://forum.ipums.org/u/Phil_Feller)\ **Replies:** 6\ **Last updated:** [January 12, 2024, 6:48pm UTC](https://forum.ipums.org/t/enhancements-to-define-extract-apis/4737 "2024-01-12T18:48:41Z")
Are there any plans to enhance the define\_extract APIs? I work with the USA full-count samples (shout out to usa1850c!) and typically add a case selection to limit the output to a county or city. It appears that I’ll nee… --- ## [Proper API call formatting](https://forum.ipums.org/t/proper-api-call-formatting/5552)
**Author:** [@Daniel\_Poor](https://forum.ipums.org/u/Daniel_Poor)\ **Replies:** 3\ **Last updated:** [December 11, 2023, 5:40pm UTC](https://forum.ipums.org/t/proper-api-call-formatting/5552 "2023-12-11T17:40:21Z")
Hi there. I’m using Python to make API calls to NHGIS. I’m a rudimentary coder and now stumped with what seems to be an API syntax issue. This works: my\_key = “xxxxxxx” my\_headers = {“Authorization”: my\_key} This o… --- ## [USA API variable attach\_characteristics](https://forum.ipums.org/t/usa-api-variable-attach-characteristics/5492)
**Author:** [@jcolond](https://forum.ipums.org/u/jcolond)\ **Replies:** 8\ **Last updated:** [October 24, 2023, 8:21pm UTC](https://forum.ipums.org/t/usa-api-variable-attach-characteristics/5492 "2023-10-24T20:21:30Z")
Hi, I’m just getting started with the API, it’s been very smooth so far. I appreciate the option to make my process easier to replicate. I’m trying to get attach\_characteristics to work with the USA collection, but the … --- ## [Camel case, and a better way to "wait for data"](https://forum.ipums.org/t/camel-case-and-a-better-way-to-wait-for-data/5261)
**Author:** [@John\_Shadle](https://forum.ipums.org/u/John_Shadle)\ **Replies:** 5\ **Last updated:** [June 20, 2023, 3:45pm UTC](https://forum.ipums.org/t/camel-case-and-a-better-way-to-wait-for-data/5261 "2023-06-20T15:45:01Z")
camelCase I suppose I haven’t looked at the Forum in a while. I had no idea that IPUMS changed many of the options calls to camelCase with Version 2 of the API. Surprise! Given that change, the example below is written u… --- ## [How to get access to characteristics from the CPS API](https://forum.ipums.org/t/how-to-get-access-to-characteristics-from-the-cps-api/5176)
**Author:** [@Paul\_Vanborre-Jamin](https://forum.ipums.org/u/Paul_Vanborre-Jamin)\ **Replies:** 6\ **Last updated:** [April 10, 2023, 8:51pm UTC](https://forum.ipums.org/t/how-to-get-access-to-characteristics-from-the-cps-api/5176 "2023-04-10T20:51:34Z")
Hello, I am not able to find information on how to attach characteristics to a variables ? (for instance I tried to add SEX\_SP as a variable in the list below without success) extract = CpsExtract( \["cps1990\_03s"\],… --- ## [Upcoming workshop for the IPUMS CPS API on February 21st](https://forum.ipums.org/t/upcoming-workshop-for-the-ipums-cps-api-on-february-21st/5120)
**Author:** [@fran](https://forum.ipums.org/u/fran)\ **Replies:** 0\ **Last updated:** [February 17, 2023, 11:06pm UTC](https://forum.ipums.org/t/upcoming-workshop-for-the-ipums-cps-api-on-february-21st/5120 "2023-02-17T23:06:53Z")
Join us for a 1-hour webinar on using the IPUMS Microdata Extract API & IPUMS CPS to create reproducible workflows, held on Tuesday, February 21, 2023 at 10:30AM CT. Registration is required. --- ## [Conda vs Pip installation](https://forum.ipums.org/t/conda-vs-pip-installation/5112)
**Author:** [@Daniel\_Schwager](https://forum.ipums.org/u/Daniel_Schwager)\ **Replies:** 1\ **Last updated:** [February 15, 2023, 10:06pm UTC](https://forum.ipums.org/t/conda-vs-pip-installation/5112 "2023-02-15T22:06:59Z")
I cannot install using conda install ipumspy. How do I do this? --- ## [API downloads v web downloads](https://forum.ipums.org/t/api-downloads-v-web-downloads/3171)
**Author:** [@Drew\_Hussung](https://forum.ipums.org/u/Drew_Hussung)\ **Replies:** 5\ **Last updated:** [September 12, 2019, 12:42am UTC](https://forum.ipums.org/t/api-downloads-v-web-downloads/3171 "2019-09-12T00:42:26Z")
I’ve been having a great time exploring the API! One question has came to mind as I’ve transitioned over from downloading data manually via the web interface and doing so programmatically via the API: why split the ACS 5… --- ## [Proper format for simple API call in R](https://forum.ipums.org/t/proper-format-for-simple-api-call-in-r/4901)
**Author:** [@John\_Shadle](https://forum.ipums.org/u/John_Shadle)\ **Replies:** 6\ **Last updated:** [November 28, 2022, 4:01pm UTC](https://forum.ipums.org/t/proper-format-for-simple-api-call-in-r/4901 "2022-11-28T16:01:34Z")
Hi all. I’m new to using APIs in R, so please forgive me for this likely simple question; however, I’m pulling my hair out trying to get this to work. :slight\_smile: I’m not going to post my API key here, but suffice it… --- ## [Possible to have R API without terra support?](https://forum.ipums.org/t/possible-to-have-r-api-without-terra-support/4729)
**Author:** [@Phil\_Feller](https://forum.ipums.org/u/Phil_Feller)\ **Replies:** 4\ **Last updated:** [November 10, 2022, 6:59pm UTC](https://forum.ipums.org/t/possible-to-have-r-api-without-terra-support/4729 "2022-11-10T18:59:11Z")
Is it possible to install the ipumsr package without terra support? I’m trying to install it in R on a Linux system that doesn’t provide a current-enough gdal RPM in its repositories (the Oracle-supported version of RHEL… --- ## ["Access to this API has been disallowed"](https://forum.ipums.org/t/access-to-this-api-has-been-disallowed/4894)
**Author:** [@John\_Shadle](https://forum.ipums.org/u/John_Shadle)\ **Replies:** 2\ **Last updated:** [October 5, 2022, 9:46pm UTC](https://forum.ipums.org/t/access-to-this-api-has-been-disallowed/4894 "2022-10-05T21:46:31Z")
Greetings, all. I am trying to work through some of the sample workflows on the IPUMS site, and continue to run into issues. I am running RStudio 2022.02.3 (Build 492) with R 4.2.1 (64 bit). I’m running the code, so far… --- ## [Get API JSON request from web request?](https://forum.ipums.org/t/get-api-json-request-from-web-request/4871)
**Author:** [@Alvaro\_Leache](https://forum.ipums.org/u/Alvaro_Leache)\ **Replies:** 3\ **Last updated:** [September 27, 2022, 2:43pm UTC](https://forum.ipums.org/t/get-api-json-request-from-web-request/4871 "2022-09-27T14:43:06Z")
So I was wondering, is there a way to get the JSON call to the API that replicates whatever query you make in the web portal? I’m thinking of a case where you make a replication package, or you simply want to keep the AP… --- ## [Extract Queue Removals](https://forum.ipums.org/t/extract-queue-removals/4859)
**Author:** [@Ray\_McPherson](https://forum.ipums.org/u/Ray_McPherson)\ **Replies:** 2\ **Last updated:** [September 13, 2022, 5:18pm UTC](https://forum.ipums.org/t/extract-queue-removals/4859 "2022-09-13T17:18:34Z")
I was pulling data from the USA dataset using Python and have done so successfully several times. Today the ipums.wait\_for\_extract command was taking much longer than normal so I attempted to stop it but noticed the resu… --- ## [Can the MLP crosswalk files be downloaded via API?](https://forum.ipums.org/t/can-the-mlp-crosswalk-files-be-downloaded-via-api/4835)
**Author:** [@nmw751](https://forum.ipums.org/u/nmw751)\ **Replies:** 1\ **Last updated:** [August 29, 2022, 8:57pm UTC](https://forum.ipums.org/t/can-the-mlp-crosswalk-files-be-downloaded-via-api/4835 "2022-08-29T20:57:14Z")
I’d like to download the cross-walk files for the linked Census data from here using some sort of programmatic approach. Is this possible? --- ## [Suggestions for using {ipumsr} package with API](https://forum.ipums.org/t/suggestions-for-using-ipumsr-package-with-api/4775)
**Author:** [@Angela\_Li](https://forum.ipums.org/u/Angela_Li)\ **Replies:** 1\ **Last updated:** [July 14, 2022, 7:23pm UTC](https://forum.ipums.org/t/suggestions-for-using-ipumsr-package-with-api/4775 "2022-07-14T19:23:07Z")
Thanks for putting together the API and the {ipumsr} package! I tried out the API using {ipumsr} and I had a few questions/suggestions: Is it possible to see how long each step of generating the extract took, for a c… --- ## [Data-file size issues?](https://forum.ipums.org/t/data-file-size-issues/4739)
**Author:** [@Phil\_Feller](https://forum.ipums.org/u/Phil_Feller)\ **Replies:** 5\ **Last updated:** [June 29, 2022, 12:28pm UTC](https://forum.ipums.org/t/data-file-size-issues/4739 "2022-06-29T12:28:05Z")
I’ve been testing the API on a USA full-count census file and have encountered what might be an issue related to the file size. I first attempted to use pipes for the define\_extract\_usa(), submit\_extract(), wait\_for\_ext… --- ## [IPUMS API updating sample](https://forum.ipums.org/t/ipums-api-updating-sample/4731)
**Author:** [@Michael\_Doughty](https://forum.ipums.org/u/Michael_Doughty)\ **Replies:** 1\ **Last updated:** [June 24, 2022, 4:09pm UTC](https://forum.ipums.org/t/ipums-api-updating-sample/4731 "2022-06-24T16:09:36Z")
Hi, I was trying out the API in development and did not see an easy way to have a sample updated to the most recent month. There are some work-rounds I can think of, but they would be clunky and not as useful as a comma… --- ## [List of variables - IPUMS USA](https://forum.ipums.org/t/list-of-variables-ipums-usa/4602)
**Author:** [@Alex](https://forum.ipums.org/u/Alex)\ **Replies:** 2\ **Last updated:** [April 12, 2022, 7:42pm UTC](https://forum.ipums.org/t/list-of-variables-ipums-usa/4602 "2022-04-12T19:42:58Z")
Hello, I am wondering whether it’s possible to access to a list of all harmonized variable for IPUMS USA data with a single API request ? Thank you! [Next page](https://forum.ipums.org/c/ipums-api/16.md?page=1)