Documentation > Workflows & Code > Explore Metadata > NHGIS > Dataset Metadata

IPUMS NHGIS Dataset Metadata

NHGIS summary tables are organized into datasets distinguished by the years, geographic levels and topics they cover; by the data source and survey coverage (e.g., sample-based vs. 100% count); and by the breakdown variables available. An overview of datasets and a catalog of source documentation are available on the NHGIS website.

Get High-Level Metadata for All Datasets

Get All Datasets

This API call will return a list of all available datasets. The entry for each dataset includes metadata for the dataset’s name and description. The unique identifier for each dataset is in the name field. This is needed for retrieving details about a single dataset (see next section).

my_headers = {"Authorization": my_key}
url = "https://api.ipums.org/metadata/nhgis/datasets?version=2"
nhgis_metadata = requests.get(url, headers=my_headers)
pprint(nhgis_metadata.json())

# Results

{ 'data': [ { 'description': 'Population Data [US, States & Counties]',
              'group': '1790 Census',
              'name': '1790_cPop',
              'sequence': 101},
            { 'description': 'Population Data [US, States & Counties]',
              'group': '1800 Census',
              'name': '1800_cPop',
              'sequence': 201},
            { 'description': 'Population Data [US, States & Counties]',
              'group': '1810 Census',
              'name': '1810_cPop',
              'sequence': 301},
            { 'description': 'Population Data [US, States & Counties]',
              'group': '1820 Census',
              'name': '1820_cPop',
              'sequence': 401},
            { 'description': 'Population Data [US, States & Counties]',
              'group': '1830 Census',
              'name': '1830_cPop',
              'sequence': 501},
            { 'description': 'Agriculture Data [US, States & Counties]',
              'group': '1840 Census',
              'name': '1840_cAg',
              'sequence': 601},

          [SNIP]

            { 'description': '1-Year Data',
              'group': '2021 American Community Survey',
              'name': '2021_ACS1',
              'sequence': 6001},
            { 'description': '5-Year Data [2017-2021, Block Groups & Larger '
                             'Areas]',
              'group': '2021 American Community Survey',
              'name': '2017_2021_ACS5a',
              'sequence': 6002},
            { 'description': '5-Year Data [2017-2021, Tracts & Larger Areas]',
              'group': '2021 American Community Survey',
              'name': '2017_2021_ACS5b',
              'sequence': 6003},
            { 'description': '5-Year Data [2017-2021, Summary by Residence 1 '
                             'Year Ago]',
              'group': '2021 American Community Survey',
              'name': '2017_2021_ACS5c',
              'sequence': 6004},
            { 'description': '5-Year Data [2017-2021, Summary by Place of '
                             'Work]',
              'group': '2021 American Community Survey',
              'name': '2017_2021_ACS5d',
              'sequence': 6005}],
  'links': {'nextPage': None, 'previousPage': None},
  'pageNumber': 1,
  'pageSize': 500,
  'totalCount': 253}
url <- "https://api.ipums.org/metadata/nhgis/datasets?version=2"
result <- GET(url, add_headers(Authorization = my_key))
res_df <- content(result, "parsed", simplifyDataFrame = TRUE)
head(res_df, n = 20L) # Contains metadata

# Results

$data
               name                                                group
1         1790_cPop                                          1790 Census
2         1800_cPop                                          1800 Census
3         1810_cPop                                          1810 Census
4         1820_cPop                                          1820 Census
5         1830_cPop                                          1830 Census
6          1840_cAg                                          1840 Census
7         1840_cMfg                                          1840 Census
8        1840_cPopX                                          1840 Census
9          1850_cAg                                          1850 Census
10        1850_cPAX                                          1850 Census
[SNIP]

$pageNumber
[1] 1

$pageSize
[1] 500

$totalCount
[1] 253

$links
$links$previousPage
NULL

$links$nextPage
NULL
curl -X GET \
  "https://api.ipums.org/metadata/nhgis/datasets?version=2" \
  -H "Authorization: $MY_KEY" | jq

# Results 

{
  "data": [
    {
      "name": "1790_cPop",
      "group": "1790 Census",
      "description": "Population Data [US, States & Counties]",
      "sequence": 101
    },
    {
      "name": "1800_cPop",
      "group": "1800 Census",
      "description": "Population Data [US, States & Counties]",
      "sequence": 201
    },

[SNIP]

    {
      "name": "2017_2021_ACS5c",
      "group": "2021 American Community Survey",
      "description": "5-Year Data [2017-2021, Summary by Residence 1 Year Ago]",
      "sequence": 6004
    },
    {
      "name": "2017_2021_ACS5d",
      "group": "2021 American Community Survey",
      "description": "5-Year Data [2017-2021, Summary by Place of Work]",
      "sequence": 6005
    }
  ],
  "pageNumber": 1,
  "pageSize": 500,
  "totalCount": 253,
  "links": {
    "previousPage": null,
    "nextPage": null
  }
}

Note that this is a paginated endpoint. The default page size is 500 items. If there were more than 500 items, or if the pageSize parameter were set to less than 253 in this example, the links->nextPage field would have a URL to retrieve the next page of results.

Get All Data Tables

This API call will return a list of all available data tables across all datasets. Since IPUMS NHGIS contains collections of related datasets (e.g. the 2021 5-year ACS summary files are split across four datasets), this endpoint can be useful for retrieving lists of data tables across related datasets. It can also be used for finding all data tables with a specific keyword in their description or universe.

my_headers = {"Authorization": my_key}
url = "https://api.ipums.org/metadata/nhgis/data_tables?version=2"
nhgis_metadata = requests.get(url, headers=my_headers)
pprint(nhgis_metadata.json())

# Results 

{
    "data": [
        {
            "name": "NT1",
            "description": "Total Population",
            "universe": "Persons",
            "nhgisCode": "AAA",
            "sequence": 1,
            "datasetName": "1790_cPop",
            "nVariables": 1
        },
        {
            "name": "NT2",
            "description": "Urban Population (Incorporated Places 2,500 and Over)",
            "universe": "Urban Persons (Incorporated Places 2,500 and Over)",
            "nhgisCode": "AAK",
            "sequence": 2,
            "datasetName": "1790_cPop",
            "nVariables": 1
        },
        {
            "name": "NT3",
            "description": "Urban Population in Cities of 25,000 and Over",
            "universe": "Urban Persons in Cities of 25,000 and Over",
            "nhgisCode": "AAN",
            "sequence": 3,
            "datasetName": "1790_cPop",
            "nVariables": 1
        },

    [SNIP]

        {
            "name": "NT9",
            "description": "Total Number of People Employed in All Classes of Occupations",
            "universe": "Employed Persons",
            "nhgisCode": "ALY",
            "sequence": 9,
            "datasetName": "1870_sROG",
            "nVariables": 1
        },
        {
            "name": "NT10",
            "description": "People Employed in All Classes of Occupations by Age by Sex",
            "universe": "Employed Persons",
            "nhgisCode": "ALI",
            "sequence": 10,
            "datasetName": "1870_sROG",
            "nVariables": 6
        },
        {
            "name": "NT11",
            "description": "People Employed in All Classes of Occupations by Place of Birth",
            "universe": "Employed Persons",
            "nhgisCode": "ALJ",
            "sequence": 11,
            "datasetName": "1870_sROG",
            "nVariables": 13
        }
    ],
    "pageNumber": 1,
    "pageSize": 500,
    "totalCount": 46031,
    "links": {
        "previousPage": null,
        "nextPage": "https://api.ipums.org/metadata/nhgis/data_tables?pageNumber=2&pageSize=500&version=2"
    }
}
url <- "https://api.ipums.org/metadata/nhgis/data_tables?version=2"
result <- GET(url, add_headers(Authorization = my_key))
res_df <- content(result, "parsed", simplifyDataFrame = TRUE)
head(res_df, n = 20L) # Contains metadata

# Results 

$data
    name                                                                                    description
1    NT1                                                                               Total Population
2    NT2                                          Urban Population (Incorporated Places 2,500 and Over)
3    NT3                                                  Urban Population in Cities of 25,000 and Over
4    NT4                                          White Males and Estimated White Females by Sex by Age
5    NT5                                                                        White Population by Sex
6    NT6                                                                              Race/Slave Status
7    NT9                                                                       Total Number of Families
8   NT10                                                                       Number of Family Members
9   NT12                                                                White Population by Nationality
10  NT13                                                                Families by Slaveholding Status
11  NT14                                                        Families by Slaveholding Status by Race
12  NT15                                                    White Family Members by Slaveholding Status
13  NT16                             Average Number of Members in White Families by Slaveholding Status
14  NT17                                             Percent of Families by Slaveholding Status by Race
15  NT18                                                                         Total Number of Slaves
16  NT19                                               Average Number of Slaves per Slaveholding Family
17  NT20                                                      Slaveholding Families by Number of Slaves
18  NT21                                                                                           Race
19   NT1                                                 Total Population (from Original Census Report)
20   NT2                                                     Total Population (from 1900 Census Report)
21   NT3                                                                         Total Urban Population
22   NT4                                            Total Urban Population in Cities of 25,000 and Over
23   NT5                                                            Free White Population by Sex by Age
24   NT6                                  Nonwhite Population, Except Indians Not Taxed by Slave Status
25   NT8                                                                               Total Population
26   NT9                                                                        White Population by Sex
27  NT10                                                                                           Race
28   NT1                                                 Total Population (from Original Census Report)
29   NT2                                                     Total Population (from 1900 Census Report)
30   NT3                                                                Urban Population 2,500 and Over
31   NT4                                                  Urban Population in Cities of 25,000 and Over
32   NT5                                                            Free White Population by Sex by Age
33   NT6                                  Nonwhite Population, Except Indians Not Taxed by Slave Status
34   NT8                                                                               Total Population
35   NT9                                                                        White Population by Sex
36  NT10                                                                                           Race
37   NT1                                                                               Total Population
38   NT2                                                                Urban Population 2,500 and Over
39   NT3                                                  Urban Population in Cities of 25,000 and Over
40  NT4A                                                            Free White Population by Sex by Age
41  NT4B                                                         Free White Males 16 to 18 Years of Age
42   NT5                                                          Total Foreign Persons Not Naturalized
43   NT6                                                 Number of Persons Engaged in Selected Industry
44   NT7                                               Colored Population by Slave Status by Sex by Age
45   NT8                   Free Population with Race, Sex, and Age Unspecified Except Indians Not Taxed
46   NT9                                                                               Total Population
47  NT10                                                                       Race/Slave Status by Sex
48  NT12                                                                                            Sex
49  NT13                                                                                           Race
50   NT1                                                                               Total Population
51   NT2                                                                Urban Population 2,500 and Over
52   NT3                                                  Urban Population in Cities of 25,000 and Over
53   NT4                                                            Free White Population by Sex by Age
54   NT5                                               Colored Population by Slave Status by Sex by Age
55   NT6                                                      Total Population from the Original Census
56   NT7                                                   Persons Who Are Deaf and Dumb by Race by Age
57   NT8                                                                  Persons Who Are Blind by Race
58   NT9                                                           Number of Foreigners Not Naturalized
59  NT12                                                                       Race/Slave Status by Sex
60  NT13                                                                                           Race
61  NT15                                                             Colored Population by Slave Status
62  NT16                                                                                            Sex
63  NT17                                                 Total Slave and Free Colored Population by Sex
64  NT19                                               White Population 80 Years of Age and Over by Sex
65  NT1A                                                                                      Livestock
66  NT1B                                                                               Value of Poultry
67   NT2                                                                               Farm Productions
68   NT3                                                               Value of Non-Field-Crop Products
69   NT4                                                       Production Groups and Specialty Products
70   NT5                                                                      Price of Farm Productions
71   NT6                                                            Estimated Value of Farm Productions
72  NT7A                                                              Estimated Total Crop Output Value
73  NT7B                                                                     Value of Production Groups
74   NT8                                                         Estimated Value of Agricultural Output
75   NT9                                                                                     Population
76   NT1                                                                               Total Population
77   NT2                                                            Fuel Consumed in Iron Manufacturing
78   NT3                                                         Total Capital Invested in Manufactures
79   NT4                                                                          Type of Establishment
80   NT5                                                                            Value of Production
81   NT6                                                                            Production of Goods
82   NT7                                                                               Capital Invested
83   NT8                                                                                     Employment
84   NT9               Men Employed by Type of Establishment for Selected Industries Employing Only Men
85  NT10 Persons Employed by Type of Establishment for Textile and Leather Manufacturing Establishments
86  NT11                                                                             Number of Spindles
87   NT1                                                                               Total Population
88   NT2                                                                         Total Urban Population
89   NT3                                            Total Urban Population in Cities of 25,000 and Over
90   NT4                                                            Free White Population by Sex by Age
91   NT5                                               Colored Population by Slave Status by Sex by Age
92   NT6                                                                               Total Population
93   NT7                                                              Employed Population by Occupation
94   NT8                              Total Pensioners for Revolutionary War or other Military Services
95   NT9                                                   Number of Deaf and Dumb White Persons by Age
96  NT10                                                                          Blind Persons by Race
97  NT11                                      Insane and Idiot Persons by Race by Public/Private Charge
98  NT12                                                      Deaf and Dumb Colored Persons of All Ages
99  NT13                                                                Number of Learning Institutions
100 NT14                                            Number of Students by Type of Learning Institutions
101 NT15                                                                Total Scholars at Public Charge
102 NT16                      Total White Population Over Twenty Years of Age Who Cannot Read and Write
103 NT17                                                        Number of Printing and Binding Services
104 NT19                                                               Newspapers by Frequency of Issue
105 NT21                                                 Total Persons Employed in Printing and Binding
106 NT22                                                 Total Capital Invested in Printing and Binding
107 NT23                                                        Total Capital Invested in Manufacturing
108 NT24                                                                        White Population by Sex
109 NT25                                                                              Race/Slave Status
110 NT26                                               White Population 80 Years of Age and Over by Sex
111 NT28                                                      Colored Population by Slave Status by Sex
112 NT29                                                                                            Sex
113 NT30                                                                             Navigable Waterway
114  NT1                                                                          Total Number of Farms
115  NT2                                                              Improved/Unimproved Land in Farms
116  NT3                                                       Value of Farms, Implements and Machinery
117  NT4                                                                                      Livestock
118  NT5                                                                       Total Value of Livestock
119  NT6                                                                               Farm Productions
120  NT7                                                         Value of Non-Field-Crop Product Groups
121  NT8                                                           Price of Farm Productions, 1859/1860
122  NT9                                                            Estimated Value of Farm Productions
123 NT10                                                         Estimated Value of Farm Product Groups
124 NT11                                                   Estimated Value of Total Agricultural Output
125  NT1                                                                               Total Population
126  NT2                                                                Urban Population 2,500 and Over
127  NT3                                                        Population in Cities of 25,000 and Over
128  NT4                                                                Race/Slave Status by Sex by Age
129  NT5                                                                       Race/Slave Status by Sex
130  NT6                                                                              Race/Slave Status
131 NT10                                                                         Births by Slave Status
132 NT12                                                                                   Total Births
133 NT13                               Total White Persons Married During the Year Ending June 1, 1850.
134 NT14                                     Total Persons Married During the Year Ending June 1, 1850.
135 NT15                                     Deaths During the Year Ending June 1, 1850 by Slave Status
136 NT17                                               Total Deaths During the Year Ending June 1, 1850
137 NT18                                              Total Dwellings of White and Free-Colored Persons
138 NT19                                                          Total White and Free-Colored Families
139 NT20                                                                 Types of Learning Institutions
140 NT21                               Persons at Learning Institutions by Type of Learning Institution
141 NT23                               Annual Income by Types of Learning Institutions by Income Source
142 NT24                                          Total Annual Income by Types of Learning Institutions
                                                                      universe nhgisCode sequence datasetName nVariables
1                                                                      Persons       AAA        1   1790_cPop          1
2                           Urban Persons (Incorporated Places 2,500 and Over)       AAK        2   1790_cPop          1
3                                   Urban Persons in Cities of 25,000 and Over       AAN        3   1790_cPop          1
4                                                                White Persons       AAO        4   1790_cPop          4
5                                                                White Persons       AAP        5   1790_cPop          2
6                                                                      Persons       AAQ        6   1790_cPop          3
7                                                                     Families       AAR        7   1790_cPop          1
8                                                                     Families       AAB        8   1790_cPop         11
9                                                                White Persons       AAC        9   1790_cPop          8
10                                                                    Families       AAD       10   1790_cPop          2
11                                                                    Families       AAE       11   1790_cPop          4
12                                                        White Family Members       AAF       12   1790_cPop          2
13                                                              White Families       AAG       13   1790_cPop          2
14                                                                    Families       AAH       14   1790_cPop          4
15                                                                      Slaves       AAI       15   1790_cPop          1
16                                                                      Slaves       AAJ       16   1790_cPop          1
17                                                       Slaveholding Families       AAL       17   1790_cPop         10
18                                                                     Persons       AAM       18   1790_cPop          2
19                                                                     Persons       AAS        1   1800_cPop          1
20                                                                     Persons       AAU        2   1800_cPop          1
21                                                               Urban Persons       AAV        3   1800_cPop          1
22                                  Urban Persons in Cities of 25,000 and Over       AAW        4   1800_cPop          1
23                                                          Free White Persons       AAX        5   1800_cPop         10
24                                  Non-White Persons Except Indians Not Taxed       AAY        6   1800_cPop          2
25                                                                     Persons       AAZ        7   1800_cPop          1
26                                                               White Persons       AA0        8   1800_cPop          2
27                                                                     Persons       AAT        9   1800_cPop          2
28                                                                     Persons       AA1        1   1810_cPop          1
29                                                                     Persons       AA3        2   1810_cPop          1
30                          Urban Persons (Incorporated Places 2,500 and Over)       AA4        3   1810_cPop          1
31                                  Urban Persons in Cities of 25,000 and Over       AA5        4   1810_cPop          1
32                                                          Free White Persons       AA6        5   1810_cPop         10
33                                  Non-White Persons Except Indians Not Taxed       AA7        6   1810_cPop          2
34                                                                     Persons       AA8        7   1810_cPop          1
35                                                               White Persons       AA9        8   1810_cPop          2
36                                                                     Persons       AA2        9   1810_cPop          2
37                                                                     Persons       ABA        1   1820_cPop          1
38                          Urban Persons (Incorporated Places 2,500 and Over)       ABE        2   1820_cPop          1
39                                  Urban Persons in Cities of 25,000 and Over       ABF        3   1820_cPop          1
40                               Free White Persons with Sex and Age Specified       ABG        4   1820_cPop         10
41                                      Free White Males 16 to 18 Years of Age       ABH        5   1820_cPop          1
42                                        Foreign-Born Persons Not Naturalized       ABI        6   1820_cPop          1
43                  Persons Engaged in Agriculture, Commerce and Manufacturing       ABJ        7   1820_cPop          3
44                                  Colored Persons with Sex and Age Specified       ABK        8   1820_cPop         16
45   Free Persons with Race, Sex, and Age Unspecified Except Indians Not Taxed       ABL        9   1820_cPop          1
46                                                                     Persons       ABM       10   1820_cPop          1
47                                          Persons with Sex and Age Specified       ABB       11   1820_cPop          6
48                                          Persons with Sex and Age Specified       ABC       12   1820_cPop          2
49                                          Persons with Sex and Age Specified       ABD       13   1820_cPop          2
50                                                                     Persons       ABN        1   1830_cPop          1
51                          Urban Persons (Incorporated Places 2,500 and Over)       ABU        2   1830_cPop          1
52                                  Urban Persons in Cities of 25,000 and Over       ABV        3   1830_cPop          1
53                                                          Free White Persons       ABW        4   1830_cPop         26
54                                                             Colored Persons       ABX        5   1830_cPop         24
55                                                                     Persons       ABY        6   1830_cPop          1
56                                                       Deaf and Dumb Persons       ABZ        7   1830_cPop          6
57                                                               Blind Persons       AB0        8   1830_cPop          2
58                                        Foreign-Born Persons Not Naturalized       AB1        9   1830_cPop          1
59                                                                     Persons       ABO       10   1830_cPop          6
60                                                                     Persons       ABP       11   1830_cPop          2
61                                                             Colored Persons       ABQ       12   1830_cPop          2
62                                                                     Persons       ABR       13   1830_cPop          2
63                                              Slave and Free Colored Persons       ABS       14   1830_cPop          2
64                                             White Persons 80 Years and Over       ABT       15   1830_cPop          2
65                                                                       Farms       AB2        1    1840_cAg          4
66                                                                       Farms       AB3        2    1840_cAg          1
67                                                                       Farms       AB4        3    1840_cAg         22
68                                                                       Farms       AB5        4    1840_cAg          5
69                                                                       Farms       AB6        5    1840_cAg          4
70                                                                       Farms       AB7        6    1840_cAg         22
71                                                                       Farms       AB8        7    1840_cAg         22
72                                                                       Farms       AB9        8    1840_cAg          1
73                                                                       Farms       ACA        9    1840_cAg          3
74                                                                       Farms       ACB       10    1840_cAg          1
75                                                                     Persons       ACC       11    1840_cAg          1
76                                                                     Persons       AC4        1   1840_cMfg          1
77                                           Iron Manufacturing Establishments       AC7        2   1840_cMfg          1
78                                                Manufacturing Establishments       AC8        3   1840_cMfg          1
79                                       Establishments of Selected Industries       AC9        4   1840_cMfg         30
80                                       Establishments of Selected Industries       ADA        5   1840_cMfg         41
81                                       Establishments of Selected Industries       ADB        6   1840_cMfg         30
82                                       Establishments of Selected Industries       ADC        7   1840_cMfg         39
83                                     Employed Persons in Selected Industries       ADD        8   1840_cMfg          7
84  Males Employed in Establishments of Selected Industries Employing Only Men       ADE        9   1840_cMfg         36
85        Employed Persons in Textile and Leather Manufacturing Establishments       AC5       10   1840_cMfg          9
86                                         Cotton Manufacturing Establishments       AC6       11   1840_cMfg          1
87                                                                     Persons       ACD        1  1840_cPopX          1
88                                                               Urban Persons       ACN        2  1840_cPopX          1
89                                  Urban Persons in Cities of 25,000 and Over       ACW        3  1840_cPopX          1
90                                                          Free White Persons       ACY        4  1840_cPopX         26
91                                                             Colored Persons       ACZ        5  1840_cPopX         24
92                                                                     Persons       AC0        6  1840_cPopX          1
93                                                            Employed Persons       AC1        7  1840_cPopX          7
94                 Pensioners for Revolutionary War or Other Military Services       AC2        8  1840_cPopX          1
95                                                 Deaf and Dumb White Persons       AC3        9  1840_cPopX          3
96                                                               Blind Persons       ACE       10  1840_cPopX          2
97                                                    Insane and Idiot Persons       ACF       11  1840_cPopX          4
98                                               Deaf and Dumb Colored Persons       ACG       12  1840_cPopX          1
99                                                       Learning Institutions       ACH       13  1840_cPopX          3
100                                                                   Students       ACI       14  1840_cPopX          3
101                                                  Scholars at Public Charge       ACJ       15  1840_cPopX          1
102                      White Persons Over 20 Years Who Cannot Read and Write       ACK       16  1840_cPopX          1
103                                             Printing Offices and Binderies       ACL       17  1840_cPopX          2
104                                                                Periodicals       ACM       18  1840_cPopX          4
105                          Employed Persons in Printing and Binding Services       ACO       19  1840_cPopX          1
106                                             Printing Offices and Binderies       ACP       20  1840_cPopX          1
107                                               Manufacturing Establishments       ACQ       21  1840_cPopX          1
108                                                              White Persons       ACR       22  1840_cPopX          2
109                                                                    Persons       ACS       23  1840_cPopX          3
110                                            White Persons 80 Years and Over       ACT       24  1840_cPopX          2
111                                                            Colored Persons       ACU       25  1840_cPopX          4
112                                                                    Persons       ACV       26  1840_cPopX          2
113                                                  Specified Geographic Area       ACX       27  1840_cPopX          1
114                                                                      Farms       ADF        1    1850_cAg          1
115                                                                      Farms       ADI        2    1850_cAg          2
116                                                                      Farms       ADJ        3    1850_cAg          2
117                                                                      Farms       ADK        4    1850_cAg          7
118                                                                      Farms       ADL        5    1850_cAg          1
119                                                                      Farms       ADM        6    1850_cAg         30
120                                                                      Farms       ADN        7    1850_cAg          4
121                                                                      Farms       ADO        8    1850_cAg         30
122                                                                      Farms       ADP        9    1850_cAg         30
123                                                                      Farms       ADG       10    1850_cAg          2
124                                                                      Farms       ADH       11    1850_cAg          1
125                                                                    Persons       ADQ        1   1850_cPAX          1
126                         Urban Persons (Incorporated Places 2,500 and Over)       ADZ        2   1850_cPAX          1
127                                       Persons in Cities of 25,000 and Over       AD9        3   1850_cPAX          1
128                                                                    Persons       AEL        4   1850_cPAX         90
129                                                                    Persons       AEW        5   1850_cPAX          6
130                                                                    Persons       AE6        6   1850_cPAX          3
131                                 Births During the Year Ending June 1, 1850       ADR        7   1850_cPAX          2
132                                 Births During the Year Ending June 1, 1850       ADS        8   1850_cPAX          1
133                  White Persons Married During the Year Ending June 1, 1850       ADT        9   1850_cPAX          1
134                        Persons Married During the Year Ending June 1, 1850       ADU       10   1850_cPAX          1
135                                 Deaths During the Year Ending June 1, 1850       ADV       11   1850_cPAX          2
136                                 Deaths During the Year Ending June 1, 1850       ADW       12   1850_cPAX          1
137                                Dwellings of White and Free-Colored Persons       ADX       13   1850_cPAX          1
138                                            White and Free Colored Families       ADY       14   1850_cPAX          1
139                                                      Learning Institutions       AD0       15   1850_cPAX          3
140                               Teachers and Pupils in Learning Institutions       AD1       16   1850_cPAX          6
141                                                      Learning Institutions       AD2       17   1850_cPAX         12
142                                                      Learning Institutions       AD3       18   1850_cPAX          3
 [ reached 'max' / getOption("max.print") -- omitted 358 rows ]

$pageNumber
[1] 1

$pageSize
[1] 500

$totalCount
[1] 46031

$links
$links$previousPage
NULL

$links$nextPage
[1] "https://api.ipums.org/metadata/nhgis/data_tables?pageNumber=2&pageSize=500&version=2"
curl -X GET \
  "https://api.ipums.org/metadata/nhgis/data_tables?version=2" \
  -H "Authorization: $MY_KEY" | jq

# Results 

{
  "data": [
    {
      "name": "NT1",
      "description": "Total Population",
      "universe": "Persons",
      "nhgisCode": "AAA",
      "sequence": 1,
      "datasetName": "1790_cPop",
      "nVariables": 1
    },
    {
      "name": "NT2",
      "description": "Urban Population (Incorporated Places 2,500 and Over)",
      "universe": "Urban Persons (Incorporated Places 2,500 and Over)",
      "nhgisCode": "AAK",
      "sequence": 2,
      "datasetName": "1790_cPop",
      "nVariables": 1
    },
    {
      "name": "NT3",
      "description": "Urban Population in Cities of 25,000 and Over",
      "universe": "Urban Persons in Cities of 25,000 and Over",
      "nhgisCode": "AAN",
      "sequence": 3,
      "datasetName": "1790_cPop",
      "nVariables": 1
    },

[SNIP]

    {
      "name": "NT9",
      "description": "Total Number of People Employed in All Classes of Occupations",
      "universe": "Employed Persons",
      "nhgisCode": "ALY",
      "sequence": 9,
      "datasetName": "1870_sROG",
      "nVariables": 1
    },
    {
      "name": "NT10",
      "description": "People Employed in All Classes of Occupations by Age by Sex",
      "universe": "Employed Persons",
      "nhgisCode": "ALI",
      "sequence": 10,
      "datasetName": "1870_sROG",
      "nVariables": 6
    },
    {
      "name": "NT11",
      "description": "People Employed in All Classes of Occupations by Place of Birth",
      "universe": "Employed Persons",
      "nhgisCode": "ALJ",
      "sequence": 11,
      "datasetName": "1870_sROG",
      "nVariables": 13
    }
  ],
  "pageNumber": 1,
  "pageSize": 500,
  "totalCount": 46031,
  "links": {
    "previousPage": null,
    "nextPage": "https://api.ipums.org/metadata/nhgis/data_tables?pageNumber=2&pageSize=500&version=2"
  }
}

Note that this is a paginated endpoint. The default page size is 500 items. As there are more than 500 items in this example, the links->nextPage field contains the URL to retrieve the next page of results.

Get Detailed Metadata for a Single Dataset

This API call will return the details of a single dataset, 1790_cPop in this example. The details include the name and description of each each table within the dataset, as well as the geographic levels for which this dataset is available.

my_headers = {"Authorization": my_key}
url = "https://api.ipums.org/metadata/nhgis/datasets/1790_cPop?version=2"
nhgis_metadata = requests.get(url, headers=my_headers)
pprint(nhgis_metadata.json())

# Results 

{ 'dataTables': [ { 'description': 'Total Population',
                    'name': 'NT1',
                    'nhgisCode': 'AAA',
                    'sequence': 1},
                  { 'description': 'Urban Population (Incorporated Places '
                                   '2,500 and Over)',
                    'name': 'NT2',
                    'nhgisCode': 'AAK',
                    'sequence': 2},
                  { 'description': 'Urban Population in Cities of 25,000 and '
                                   'Over',
                    'name': 'NT3',
                    'nhgisCode': 'AAN',
                    'sequence': 3},
                  { 'description': 'White Males and Estimated White Females by '
                                   'Sex by Age',
                    'name': 'NT4',
                    'nhgisCode': 'AAO',
                    'sequence': 4},
                  { 'description': 'White Population by Sex',
                    'name': 'NT5',
                    'nhgisCode': 'AAP',
                    'sequence': 5},
                  { 'description': 'Race/Slave Status',
                    'name': 'NT6',
                    'nhgisCode': 'AAQ',
                    'sequence': 6},
                  { 'description': 'Total Number of Families',
                    'name': 'NT9',
                    'nhgisCode': 'AAR',
                    'sequence': 7},
                  { 'description': 'Number of Family Members',
                    'name': 'NT10',
                    'nhgisCode': 'AAB',
                    'sequence': 8},
                  { 'description': 'White Population by Nationality',
                    'name': 'NT12',
                    'nhgisCode': 'AAC',
                    'sequence': 9},
                  { 'description': 'Families by Slaveholding Status',
                    'name': 'NT13',
                    'nhgisCode': 'AAD',
                    'sequence': 10},
                  { 'description': 'Families by Slaveholding Status by Race',
                    'name': 'NT14',
                    'nhgisCode': 'AAE',
                    'sequence': 11},
                  { 'description': 'White Family Members by Slaveholding '
                                   'Status',
                    'name': 'NT15',
                    'nhgisCode': 'AAF',
                    'sequence': 12},
                  { 'description': 'Average Number of Members in White '
                                   'Families by Slaveholding Status',
                    'name': 'NT16',
                    'nhgisCode': 'AAG',
                    'sequence': 13},
                  { 'description': 'Percent of Families by Slaveholding Status '
                                   'by Race',
                    'name': 'NT17',
                    'nhgisCode': 'AAH',
                    'sequence': 14},
                  { 'description': 'Total Number of Slaves',
                    'name': 'NT18',
                    'nhgisCode': 'AAI',
                    'sequence': 15},
                  { 'description': 'Average Number of Slaves per Slaveholding '
                                   'Family',
                    'name': 'NT19',
                    'nhgisCode': 'AAJ',
                    'sequence': 16},
                  { 'description': 'Slaveholding Families by Number of Slaves',
                    'name': 'NT20',
                    'nhgisCode': 'AAL',
                    'sequence': 17},
                  { 'description': 'Race',
                    'name': 'NT21',
                    'nhgisCode': 'AAM',
                    'sequence': 18}],
  'description': 'Population Data [US, States & Counties]',
  'geogLevels': [ { 'description': 'Nation',
                    'hasGeogExtentSelection': False,
                    'name': 'nation',
                    'sequence': 1},
                  { 'description': 'State',
                    'hasGeogExtentSelection': False,
                    'name': 'state',
                    'sequence': 4},
                  { 'description': 'State--County',
                    'hasGeogExtentSelection': False,
                    'name': 'county',
                    'sequence': 25}],
  'group': '1790 Census',
  'hasMultipleDataTypes': False,
  'name': '1790_cPop',
  'nhgisId': 'ds1',
  'sequence': 101}
url <- "https://api.ipums.org/metadata/nhgis/datasets/1790_cPop?version=2"
result <- GET(url, add_headers(Authorization = my_key))
res_df <- content(result, "parsed", simplifyDataFrame = TRUE)
head(res_df, n = 20L) # Contains metadata
   
# Results 

$name
[1] "1790_cPop"

$nhgisId
[1] "ds1"

$group
[1] "1790 Census"

$description
[1] "Population Data [US, States & Counties]"

$sequence
[1] 101

$hasMultipleDataTypes
[1] FALSE

$dataTables
   name nhgisCode                                                        description sequence
1   NT1       AAA                                                   Total Population        1
2   NT2       AAK              Urban Population (Incorporated Places 2,500 and Over)        2
3   NT3       AAN                      Urban Population in Cities of 25,000 and Over        3
4   NT4       AAO              White Males and Estimated White Females by Sex by Age        4
5   NT5       AAP                                            White Population by Sex        5
6   NT6       AAQ                                                  Race/Slave Status        6
7   NT9       AAR                                           Total Number of Families        7
8  NT10       AAB                                           Number of Family Members        8
9  NT12       AAC                                    White Population by Nationality        9
10 NT13       AAD                                    Families by Slaveholding Status       10
11 NT14       AAE                            Families by Slaveholding Status by Race       11
12 NT15       AAF                        White Family Members by Slaveholding Status       12
13 NT16       AAG Average Number of Members in White Families by Slaveholding Status       13
14 NT17       AAH                 Percent of Families by Slaveholding Status by Race       14
15 NT18       AAI                                             Total Number of Slaves       15
16 NT19       AAJ                   Average Number of Slaves per Slaveholding Family       16
17 NT20       AAL                          Slaveholding Families by Number of Slaves       17
18 NT21       AAM                                                               Race       18

$geogLevels
    name   description hasGeogExtentSelection sequence
1 nation        Nation                  FALSE        1
2  state         State                  FALSE        4
3 county State--County                  FALSE       25
curl -X GET \
  "https://api.ipums.org/metadata/nhgis/datasets/1790_cPop?version=2" \
  -H "Authorization: $MY_KEY" | jq

# Results 

{
  "name": "1790_cPop",
  "nhgisId": "ds1",
  "group": "1790 Census",
  "description": "Population Data [US, States & Counties]",
  "sequence": 101,
  "hasMultipleDataTypes": false,
  "dataTables": [
    {
      "name": "NT1",
      "nhgisCode": "AAA",
      "description": "Total Population",
      "sequence": 1
    },
    {
      "name": "NT2",
      "nhgisCode": "AAK",
      "description": "Urban Population (Incorporated Places 2,500 and Over)",
      "sequence": 2
    },
    {
      "name": "NT3",
      "nhgisCode": "AAN",
      "description": "Urban Population in Cities of 25,000 and Over",
      "sequence": 3
    },
    {
      "name": "NT4",
      "nhgisCode": "AAO",
      "description": "White Males and Estimated White Females by Sex by Age",
      "sequence": 4
    },
    {
      "name": "NT5",
      "nhgisCode": "AAP",
      "description": "White Population by Sex",
      "sequence": 5
    },
    {
      "name": "NT6",
      "nhgisCode": "AAQ",
      "description": "Race/Slave Status",
      "sequence": 6
    },
    {
      "name": "NT9",
      "nhgisCode": "AAR",
      "description": "Total Number of Families",
      "sequence": 7
    },
    {
      "name": "NT10",
      "nhgisCode": "AAB",
      "description": "Number of Family Members",
      "sequence": 8
    },
    {
      "name": "NT12",
      "nhgisCode": "AAC",
      "description": "White Population by Nationality",
      "sequence": 9
    },
    {
      "name": "NT13",
      "nhgisCode": "AAD",
      "description": "Families by Slaveholding Status",
      "sequence": 10
    },
    {
      "name": "NT14",
      "nhgisCode": "AAE",
      "description": "Families by Slaveholding Status by Race",
      "sequence": 11
    },
    {
      "name": "NT15",
      "nhgisCode": "AAF",
      "description": "White Family Members by Slaveholding Status",
      "sequence": 12
    },
    {
      "name": "NT16",
      "nhgisCode": "AAG",
      "description": "Average Number of Members in White Families by Slaveholding Status",
      "sequence": 13
    },
    {
      "name": "NT17",
      "nhgisCode": "AAH",
      "description": "Percent of Families by Slaveholding Status by Race",
      "sequence": 14
    },
    {
      "name": "NT18",
      "nhgisCode": "AAI",
      "description": "Total Number of Slaves",
      "sequence": 15
    },
    {
      "name": "NT19",
      "nhgisCode": "AAJ",
      "description": "Average Number of Slaves per Slaveholding Family",
      "sequence": 16
    },
    {
      "name": "NT20",
      "nhgisCode": "AAL",
      "description": "Slaveholding Families by Number of Slaves",
      "sequence": 17
    },
    {
      "name": "NT21",
      "nhgisCode": "AAM",
      "description": "Race",
      "sequence": 18
    }
  ],
  "geogLevels": [
    {
      "name": "nation",
      "description": "Nation",
      "hasGeogExtentSelection": false,
      "sequence": 1
    },
    {
      "name": "state",
      "description": "State",
      "hasGeogExtentSelection": false,
      "sequence": 4
    },
    {
      "name": "county",
      "description": "State--County",
      "hasGeogExtentSelection": false,
      "sequence": 25
    }
  ]
}

Dataset Attributes

  • name: The unique identifier of the dataset.
  • group: The group of datasets to which this dataset belongs.
  • description: A short description of the dataset.
  • sequence: The order in which the dataset will appear in the metadata API and extracts.
  • has_multiple_data_types: A boolean indicating if multiple data types exist for this dataset. For example, the American Community Survey datasets have margins of error as well as estimate data types. Use the breakdown_and_data_type_layout parameter on your extract to specify how these data types are structured in your extract.
  • data_tables: A list of data tables available for this dataset.
  • geog_levels: A list of geographic levels available for this dataset.
    • name: The unique identifier of the geographic level.
    • description: A short description of the geographic level.
    • has_geog_extent_selection: Whether or not extent selection is applied (and required) for this geography level. See geographic_instances for a list of valid extents.
  • breakdowns: A list of breakdowns available for this dataset.
  • years: (Optional) If a dataset includes data from multiple years, then this is a list of its years.
  • geographic_instances: (Optional) If a dataset has any geographic levels that have extent selection, then this a list of the valid extents for this dataset.

Get Metadata for a Table

This API call will return the metadata details for a specific table, NP19 from 1990_STF1 in this example. This includes the NHGIS code, which appears in the codebook and is prepended to the variable names in the extract. The universe information is also returned, along with codes and descriptions for each variable.

my_headers = {"Authorization": my_key}
url = "https://api.ipums.org/metadata/nhgis/datasets/1990_STF1/data_tables/NP19?version=2"
nhgis_metadata = requests.get(url, headers=my_headers)
pprint(nhgis_metadata.json())

# Results 

{ 'datasetName': '1990_STF1',
  'description': 'Race of Householder by Household Type',
  'name': 'NP19',
  'nhgisCode': 'EUC',
  'sequence': 20,
  'universe': 'Households',
  'variables': [ { 'description': 'White >> Family households: Married-couple '
                                  'family: With related children',
                   'nhgisCode': 'EUC001'},
                 { 'description': 'White >> Family households: Married-couple '
                                  'family: No related children',
                   'nhgisCode': 'EUC002'},
                 { 'description': 'White >> Family households: Other family: '
                                  'Male householder, no wife present: With '
                                  'related children',
                   'nhgisCode': 'EUC003'},
                 { 'description': 'White >> Family households: Other family: '
                                  'Male householder, no wife present: No '
                                  'related children',
                   'nhgisCode': 'EUC004'},
                 { 'description': 'White >> Family households: Other family: '
                                  'Female householder, no husband present: '
                                  'With related children',
                   'nhgisCode': 'EUC005'},
                 { 'description': 'White >> Family households: Other family: '
                                  'Female householder, no husband present: No '
                                  'related children',
                   'nhgisCode': 'EUC006'},
                 { 'description': 'White >> Nonfamily households: Householder '
                                  'living alone',
                   'nhgisCode': 'EUC007'},
                 { 'description': 'White >> Nonfamily households: Householder '
                                  'not living alone',
                   'nhgisCode': 'EUC008'},
                 { 'description': 'Black >> Family households: Married-couple '
                                  'family: With related children',
                   'nhgisCode': 'EUC009'},
                 { 'description': 'Black >> Family households: Married-couple '
                                  'family: No related children',
                   'nhgisCode': 'EUC010'},
                 { 'description': 'Black >> Family households: Other family: '
                                  'Male householder, no wife present: With '
                                  'related children',
                   'nhgisCode': 'EUC011'},
                 { 'description': 'Black >> Family households: Other family: '
                                  'Male householder, no wife present: No '
                                  'related children',
                   'nhgisCode': 'EUC012'},
                 { 'description': 'Black >> Family households: Other family: '
                                  'Female householder, no husband present: '
                                  'With related children',
                   'nhgisCode': 'EUC013'},
                 { 'description': 'Black >> Family households: Other family: '
                                  'Female householder, no husband present: No '
                                  'related children',
                   'nhgisCode': 'EUC014'},
                 { 'description': 'Black >> Nonfamily households: Householder '
                                  'living alone',
                   'nhgisCode': 'EUC015'},
                 { 'description': 'Black >> Nonfamily households: Householder '
                                  'not living alone',
                   'nhgisCode': 'EUC016'},
                 { 'description': 'American Indian, Eskimo, or Aleut >> Family '
                                  'households: Married-couple family: With '
                                  'related children',
                   'nhgisCode': 'EUC017'},
                 { 'description': 'American Indian, Eskimo, or Aleut >> Family '
                                  'households: Married-couple family: No '
                                  'related children',
                   'nhgisCode': 'EUC018'},
                 { 'description': 'American Indian, Eskimo, or Aleut >> Family '
                                  'households: Other family: Male householder, '
                                  'no wife present: With related children',
                   'nhgisCode': 'EUC019'},
                 { 'description': 'American Indian, Eskimo, or Aleut >> Family '
                                  'households: Other family: Male householder, '
                                  'no wife present: No related children',
                   'nhgisCode': 'EUC020'},
                 { 'description': 'American Indian, Eskimo, or Aleut >> Family '
                                  'households: Other family: Female '
                                  'householder, no husband present: With '
                                  'related children',
                   'nhgisCode': 'EUC021'},
                 { 'description': 'American Indian, Eskimo, or Aleut >> Family '
                                  'households: Other family: Female '
                                  'householder, no husband present: No related '
                                  'children',
                   'nhgisCode': 'EUC022'},
                 { 'description': 'American Indian, Eskimo, or Aleut >> '
                                  'Nonfamily households: Householder living '
                                  'alone',
                   'nhgisCode': 'EUC023'},
                 { 'description': 'American Indian, Eskimo, or Aleut >> '
                                  'Nonfamily households: Householder not '
                                  'living alone',
                   'nhgisCode': 'EUC024'},
                 { 'description': 'Asian or Pacific Islander >> Family '
                                  'households: Married-couple family: With '
                                  'related children',
                   'nhgisCode': 'EUC025'},
                 { 'description': 'Asian or Pacific Islander >> Family '
                                  'households: Married-couple family: No '
                                  'related children',
                   'nhgisCode': 'EUC026'},
                 { 'description': 'Asian or Pacific Islander >> Family '
                                  'households: Other family: Male householder, '
                                  'no wife present: With related children',
                   'nhgisCode': 'EUC027'},
                 { 'description': 'Asian or Pacific Islander >> Family '
                                  'households: Other family: Male householder, '
                                  'no wife present: No related children',
                   'nhgisCode': 'EUC028'},
                 { 'description': 'Asian or Pacific Islander >> Family '
                                  'households: Other family: Female '
                                  'householder, no husband present: With '
                                  'related children',
                   'nhgisCode': 'EUC029'},
                 { 'description': 'Asian or Pacific Islander >> Family '
                                  'households: Other family: Female '
                                  'householder, no husband present: No related '
                                  'children',
                   'nhgisCode': 'EUC030'},
                 { 'description': 'Asian or Pacific Islander >> Nonfamily '
                                  'households: Householder living alone',
                   'nhgisCode': 'EUC031'},
                 { 'description': 'Asian or Pacific Islander >> Nonfamily '
                                  'households: Householder not living alone',
                   'nhgisCode': 'EUC032'},
                 { 'description': 'Other race >> Family households: '
                                  'Married-couple family: With related '
                                  'children',
                   'nhgisCode': 'EUC033'},
                 { 'description': 'Other race >> Family households: '
                                  'Married-couple family: No related children',
                   'nhgisCode': 'EUC034'},
                 { 'description': 'Other race >> Family households: Other '
                                  'family: Male householder, no wife present: '
                                  'With related children',
                   'nhgisCode': 'EUC035'},
                 { 'description': 'Other race >> Family households: Other '
                                  'family: Male householder, no wife present: '
                                  'No related children',
                   'nhgisCode': 'EUC036'},
                 { 'description': 'Other race >> Family households: Other '
                                  'family: Female householder, no husband '
                                  'present: With related children',
                   'nhgisCode': 'EUC037'},
                 { 'description': 'Other race >> Family households: Other '
                                  'family: Female householder, no husband '
                                  'present: No related children',
                   'nhgisCode': 'EUC038'},
                 { 'description': 'Other race >> Nonfamily households: '
                                  'Householder living alone',
                   'nhgisCode': 'EUC039'},
                 { 'description': 'Other race >> Nonfamily households: '
                                  'Householder not living alone',
                   'nhgisCode': 'EUC040'}]}
url <- "https://api.ipums.org/metadata/nhgis/datasets/1990_STF1/data_tables/NP19?version=2"
result <- GET(url, add_headers(Authorization = my_key))
res_df <- content(result, "parsed", simplifyDataFrame = TRUE)
head(res_df, n = 20L) # Contains metadata

# Results 

$name
[1] "NP19"

$description
[1] "Race of Householder by Household Type"

$universe
[1] "Households"

$nhgisCode
[1] "EUC"

$sequence
[1] 20

$datasetName
[1] "1990_STF1"

$variables
                                                                                                                           description nhgisCode
1                                                             White >> Family households: Married-couple family: With related children    EUC001
2                                                               White >> Family households: Married-couple family: No related children    EUC002
3                                   White >> Family households: Other family: Male householder, no wife present: With related children    EUC003
4                                     White >> Family households: Other family: Male householder, no wife present: No related children    EUC004
5                              White >> Family households: Other family: Female householder, no husband present: With related children    EUC005
6                                White >> Family households: Other family: Female householder, no husband present: No related children    EUC006
7                                                                              White >> Nonfamily households: Householder living alone    EUC007
8                                                                          White >> Nonfamily households: Householder not living alone    EUC008
9                                                             Black >> Family households: Married-couple family: With related children    EUC009
10                                                              Black >> Family households: Married-couple family: No related children    EUC010
11                                  Black >> Family households: Other family: Male householder, no wife present: With related children    EUC011
12                                    Black >> Family households: Other family: Male householder, no wife present: No related children    EUC012
13                             Black >> Family households: Other family: Female householder, no husband present: With related children    EUC013
14                               Black >> Family households: Other family: Female householder, no husband present: No related children    EUC014
15                                                                             Black >> Nonfamily households: Householder living alone    EUC015
16                                                                         Black >> Nonfamily households: Householder not living alone    EUC016
17                                American Indian, Eskimo, or Aleut >> Family households: Married-couple family: With related children    EUC017
18                                  American Indian, Eskimo, or Aleut >> Family households: Married-couple family: No related children    EUC018
19      American Indian, Eskimo, or Aleut >> Family households: Other family: Male householder, no wife present: With related children    EUC019
20        American Indian, Eskimo, or Aleut >> Family households: Other family: Male householder, no wife present: No related children    EUC020
21 American Indian, Eskimo, or Aleut >> Family households: Other family: Female householder, no husband present: With related children    EUC021
22   American Indian, Eskimo, or Aleut >> Family households: Other family: Female householder, no husband present: No related children    EUC022
23                                                 American Indian, Eskimo, or Aleut >> Nonfamily households: Householder living alone    EUC023
24                                             American Indian, Eskimo, or Aleut >> Nonfamily households: Householder not living alone    EUC024
25                                        Asian or Pacific Islander >> Family households: Married-couple family: With related children    EUC025
26                                          Asian or Pacific Islander >> Family households: Married-couple family: No related children    EUC026
27              Asian or Pacific Islander >> Family households: Other family: Male householder, no wife present: With related children    EUC027
28                Asian or Pacific Islander >> Family households: Other family: Male householder, no wife present: No related children    EUC028
29         Asian or Pacific Islander >> Family households: Other family: Female householder, no husband present: With related children    EUC029
30           Asian or Pacific Islander >> Family households: Other family: Female householder, no husband present: No related children    EUC030
31                                                         Asian or Pacific Islander >> Nonfamily households: Householder living alone    EUC031
32                                                     Asian or Pacific Islander >> Nonfamily households: Householder not living alone    EUC032
33                                                       Other race >> Family households: Married-couple family: With related children    EUC033
34                                                         Other race >> Family households: Married-couple family: No related children    EUC034
35                             Other race >> Family households: Other family: Male householder, no wife present: With related children    EUC035
36                               Other race >> Family households: Other family: Male householder, no wife present: No related children    EUC036
37                        Other race >> Family households: Other family: Female householder, no husband present: With related children    EUC037
38                          Other race >> Family households: Other family: Female householder, no husband present: No related children    EUC038
39                                                                        Other race >> Nonfamily households: Householder living alone    EUC039
40                                                                    Other race >> Nonfamily households: Householder not living alone    EUC040
curl -X GET \
  "https://api.ipums.org/metadata/nhgis/datasets/1990_STF1/data_tables/NP19?version=2" \
  -H "Authorization: $MY_KEY"

# Results 

{
  "name": "NP19",
  "description": "Race of Householder by Household Type",
  "universe": "Households",
  "nhgisCode": "EUC",
  "sequence": 20,
  "datasetName": "1990_STF1",
  "variables": [
    {
      "description": "White >> Family households: Married-couple family: With related children",
      "nhgisCode": "EUC001"
    },
    {
      "description": "White >> Family households: Married-couple family: No related children",
      "nhgisCode": "EUC002"
    },
    {
      "description": "White >> Family households: Other family: Male householder, no wife present: With related children",
      "nhgisCode": "EUC003"
    },
    {
      "description": "White >> Family households: Other family: Male householder, no wife present: No related children",
      "nhgisCode": "EUC004"
    },
    {
      "description": "White >> Family households: Other family: Female householder, no husband present: With related children",
      "nhgisCode": "EUC005"
    },
    {
      "description": "White >> Family households: Other family: Female householder, no husband present: No related children",
      "nhgisCode": "EUC006"
    },
    {
      "description": "White >> Nonfamily households: Householder living alone",
      "nhgisCode": "EUC007"
    },
    {
      "description": "White >> Nonfamily households: Householder not living alone",
      "nhgisCode": "EUC008"
    },
    {
      "description": "Black >> Family households: Married-couple family: With related children",
      "nhgisCode": "EUC009"
    },
    {
      "description": "Black >> Family households: Married-couple family: No related children",
      "nhgisCode": "EUC010"
    },
    {
      "description": "Black >> Family households: Other family: Male householder, no wife present: With related children",
      "nhgisCode": "EUC011"
    },
    {
      "description": "Black >> Family households: Other family: Male householder, no wife present: No related children",
      "nhgisCode": "EUC012"
    },
    {
      "description": "Black >> Family households: Other family: Female householder, no husband present: With related children",
      "nhgisCode": "EUC013"
    },
    {
      "description": "Black >> Family households: Other family: Female householder, no husband present: No related children",
      "nhgisCode": "EUC014"
    },
    {
      "description": "Black >> Nonfamily households: Householder living alone",
      "nhgisCode": "EUC015"
    },
    {
      "description": "Black >> Nonfamily households: Householder not living alone",
      "nhgisCode": "EUC016"
    },
    {
      "description": "American Indian, Eskimo, or Aleut >> Family households: Married-couple family: With related children",
      "nhgisCode": "EUC017"
    },
    {
      "description": "American Indian, Eskimo, or Aleut >> Family households: Married-couple family: No related children",
      "nhgisCode": "EUC018"
    },
    {
      "description": "American Indian, Eskimo, or Aleut >> Family households: Other family: Male householder, no wife present: With related children",
      "nhgisCode": "EUC019"
    },
    {
      "description": "American Indian, Eskimo, or Aleut >> Family households: Other family: Male householder, no wife present: No related children",
      "nhgisCode": "EUC020"
    },
    {
      "description": "American Indian, Eskimo, or Aleut >> Family households: Other family: Female householder, no husband present: With related children",
      "nhgisCode": "EUC021"
    },
    {
      "description": "American Indian, Eskimo, or Aleut >> Family households: Other family: Female householder, no husband present: No related children",
      "nhgisCode": "EUC022"
    },
    {
      "description": "American Indian, Eskimo, or Aleut >> Nonfamily households: Householder living alone",
      "nhgisCode": "EUC023"
    },
    {
      "description": "American Indian, Eskimo, or Aleut >> Nonfamily households: Householder not living alone",
      "nhgisCode": "EUC024"
    },
    {
      "description": "Asian or Pacific Islander >> Family households: Married-couple family: With related children",
      "nhgisCode": "EUC025"
    },
    {
      "description": "Asian or Pacific Islander >> Family households: Married-couple family: No related children",
      "nhgisCode": "EUC026"
    },
    {
      "description": "Asian or Pacific Islander >> Family households: Other family: Male householder, no wife present: With related children",
      "nhgisCode": "EUC027"
    },
    {
      "description": "Asian or Pacific Islander >> Family households: Other family: Male householder, no wife present: No related children",
      "nhgisCode": "EUC028"
    },
    {
      "description": "Asian or Pacific Islander >> Family households: Other family: Female householder, no husband present: With related children",
      "nhgisCode": "EUC029"
    },
    {
      "description": "Asian or Pacific Islander >> Family households: Other family: Female householder, no husband present: No related children",
      "nhgisCode": "EUC030"
    },
    {
      "description": "Asian or Pacific Islander >> Nonfamily households: Householder living alone",
      "nhgisCode": "EUC031"
    },
    {
      "description": "Asian or Pacific Islander >> Nonfamily households: Householder not living alone",
      "nhgisCode": "EUC032"
    },
    {
      "description": "Other race >> Family households: Married-couple family: With related children",
      "nhgisCode": "EUC033"
    },
    {
      "description": "Other race >> Family households: Married-couple family: No related children",
      "nhgisCode": "EUC034"
    },
    {
      "description": "Other race >> Family households: Other family: Male householder, no wife present: With related children",
      "nhgisCode": "EUC035"
    },
    {
      "description": "Other race >> Family households: Other family: Male householder, no wife present: No related children",
      "nhgisCode": "EUC036"
    },
    {
      "description": "Other race >> Family households: Other family: Female householder, no husband present: With related children",
      "nhgisCode": "EUC037"
    },
    {
      "description": "Other race >> Family households: Other family: Female householder, no husband present: No related children",
      "nhgisCode": "EUC038"
    },
    {
      "description": "Other race >> Nonfamily households: Householder living alone",
      "nhgisCode": "EUC039"
    },
    {
      "description": "Other race >> Nonfamily households: Householder not living alone",
      "nhgisCode": "EUC040"
    }
  ]
}

Data Table Attributes

  • name: The unique identifier for the data table within its dataset.
  • description: A short description of the data table.
  • universe: The statistical population (set of entities) measured by this data table (e.g., persons, families, occupied housing units, etc.).
  • nhgis_code: The code for this data table that will appear in extract.
  • sequence: The order for which this data table will appear in the metadata API and extracts.
  • variables: A list of variables within the table.