Developing Custom Datasets
Contents
File>APIGateway enables access to demographic-economic subject matter via API calls. Query, view, analyze, download data to the census block and block group levels using API technology.
Use the APIGateway to extract the specific subject matter, for the specific geographic level, for the specific geography that you need -- using a common user interface.
Availability
Levels Viewer,1,2, 3 as option
Census 2010 Summary File 1 census block level data.
-- see more information below in this section
Overview of Operations
Selections are made using the settings in the upper part of control panel at left (see above view).
After making selections click File>All Geos to proceed with dataset development.
Dataset is developed in dBase structure; transportable to other file structures.
The example application generates a dBase file containing selected Census 2010 Summary File 1 block group data. The next graphic shows a display of the dataset using the dBrowse tool. The file contains a record for the first 10 block group records with fields shown as column headers.
See additional information about these data (tables P004 and P004) at http://proximityone.com/blockgroups.htm#bgdata in the scroll section "Census 2010 Race/Ethnicity Block Group Dataset."
Operations shown in the upper left control panel are summarized below.
Dataset
Source dataset; default value: 2010 Census SF1
Options:
S&O 5 Year -- ProximityOne 5-year (2013-2017) demographic estimates and projections
S&O 2060 -- ProximityOne long-term demographic estimates and projections
1990 Census SF1
1990 Census SF3
2000 Census SF1
2000 Census SF3
2010 Census SF1
2010 Census SF2
2010 ACS 1 Year
2010 ACS 5 Year
2011 ACS 1 Year
2011 ACS 5 Year
2012 ACS 1 Year (September 2013)
2012 ACS 5 Year (December 2013)
Geo Summary Level
Geographic summary level for data extraction; default value: Block Group (150)
Varies based on Dataset selected
Options:
Region
Division
State
County
County subdivision
Census tract
Block group
Census Block (decennial census SF1)
Place/city
American Indian Area/Alaska Native Area/Hawaiian Home Land
Core-Based Statistical Area (metro)
Combined Statistical Area
Urban Area
Congressional District
State Legislative District (upper chamber)
State Legislative District (lower chamber)
Public Use Microdata Area
ZIP Code Tabulation Area
School District
Control File
Default value: c:\cvxe\1\bg2010.dbf
| • | Above example makes use of Census 2010 block group geocode control file. |
| • | Control files are U.S. national scope geocode dBase files provided by ProximityOne. |
Control File Query
Default value: substr(geoid,1,2)='15'
Optional SQL-like query placed on Control File
| • | In above example only records with state FIPS code 15 (Hawaii) are selected. |
| • | If no query is used, this item must be blank. |
| • | An alternative value substr(geoid,1,5)='36065' says to use any geography with state FIPS code 36 (New York) and county FIPS code 065 (Oneida County) |
Output Dataset
Default value: c:\cvxe\1\bg_sf1_2010_p003p004_15.dbf
| • | Full path and dBase file name to be created in the API run |
Field Names
Default value: p0030001,p0030002,p0030003,p0030004,p0030005,p0030006,p0030007,p0030008,p0040003
| • | Field names are used as specified in Subject Matter by Dataset (below) |
| • | Maximum of 50 items per extract. |
Subject Matter Program & Datasets
Census Bureau
ACS 2011
- 1-year, 113th Congressional Districts
- 5-year, multi-geo, to block group level; includes school districts
http://proximityone.com/acs0711/ACS2011_5-Year_TableShells.xls
http://proximityone.com/acs0711/ACS_2007_2011_SF_Tech_Doc.pdf
ACS 2010
- 5-year, multi-geo, to block group level
http://proximityone.com/acs0610/ACS2010_5-Year_TableShells.xls
http://proximityone.com/acs0610/ACS_2006-2010_SF_Tech_Doc.pdf
http://proximityone.com/acs0610/Sequence_Number_and_Table_Number_Lookup.txt
http://proximityone.com/acs0610/Sequence_Number_and_Table_Number_Lookup.xls
Census 2010
- Summary File 1, multi-geo, to census block level
http://proximityone.com/cen2010/cen2010_sf1.pdf
2000 Census
- Summary File 1, multi-geo to block level
http://proximityone.com/cen2000/cen2000_sf1.pdf
- Summary File 3, multi-geo to block group level
http://proximityone.com/cen2000/cen2000_sf3.pdf
1990 Census
- Summary File 1, multi geo to block group level
http://proximityone.com/cen1990/1a_tbl_mtx.txt
- Summary File 3, multi-geo to block group level
http://proximityone.com/cen1990/3c_tbl_mtx.txt
Bureau of Labor Statistics - Employment & Unemployment
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID CEU0800000003 Positions Value Field Name 1-2 CE Prefix 3 U Seasonal Adjustment Code 4-11 08000000 Supersector and Industry Codes 12-13 03 Data Type CodeCodes and corresponding titles:
Seasonal Adjustment Codes ... Super Sector Codes ... Industry Codes ... Data Type Codes
State and Area Employment, Hours, and Earnings
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID SMU19197801523800001 Positions Value Field Name 1-2 SM Prefix 3 U Seasonal Adjustment Code 4-5 19 State Code 6-10 19780 Area Code 11-18 15238000 SuperSector and Industry Code 19-20 01 Data Type CodeCodes and corresponding titles:
State Codes ... Area Codes ... SuperSector Codes ... Industry Codes ... Data Type Codes
State and County Employment and Wages from Quarterly Census of Employment and Wages
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID ENU040131050A0115 Positions Value Field Name 1-2 EN Prefix 3 U Seasonal Adjustment Code 4-8 04013 Area Code 9 1 Data Type Code 10 0 Size Code 11 5 Ownership Code 12-17 0A0115 Industry CodeCodes and corresponding titles:
Area Codes ... Data Type Codes ... Size Codes ... Ownership Codes ... Industry Codes
Occupational Employment Statistics (OES)
Survey Overview ... format and sample identifier:
1 2 1234567890123456789012345 Series ID OEUN000000011100011000001 Positions Value Field Name 1-2 OE Prefix 3 U Seasonal Adjustment Code 4 N Area Type Code 5-11 0000000 Area Code 12-17 111000 Industry Code 18-23 110000 Occupation Code 24-25 01 Data Type CodeCodes and corresponding titles:
Seasonal Adjustment ... Occupation Codes ... Industry Codes ... Area Codes ... Area Type Codes ... Data Type Codes
Business Employment Dynamics
Survey Overview ... format and sample identifier:
1 2 1234567890123456789012345678 Series ID BDS0000000000000000110101LQ5 Positions Value Field Name 1-2 BD Prefix 3 S Seasonal Adjustment Code 4-13 0000000000 Area Code 14-19 000000 Industry Code 20 0 Unit Analysis Code 21 0 Data Element Code 22-23 01 Size Class Code 24-25 01 Data Class Code 26 L Rate/Level Code 27 Q Record Type Code 28 5 Ownership CodeCodes and corresponding titles:
Seasonal Adjustment ... Area ... Industry ... Data Element ... Data Class ... Rate/Level
Local Area Unemployment Statistics
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID LASDV17169703 Positions Value Field Name 1-2 LA Prefix 3 S Seasonal Adjustment Code 4-11 DV171697 Area Code 12-13 03 Measure CodeCodes and corresponding titles:
Area Codes ... Measure Codes
Job Openings and Labor Turnover Survey (SIC basis)
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID JLU00000000HIL Positions Value Field Name 1-2 JL Prefix 3 U Seasonal Adjustment Code 4-9 000000 Industry Code 10-11 00 Region Code 12-13 HI Data Element Code 14 L Rate/Level CodeCodes and corresponding titles:
Industry ... Region ... Data Element Codes ... Rate/Level Codes
Job Openings and Labor Turnover Survey
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID JTU00000000HIL Positions Value Field Name 1-2 JT Prefix 3 U Seasonal Adjustment Code 4-9 000000 Industry Code 10-11 00 Region Code 12-13 HI Data Element Code 14 L Rate/Level CodeCodes and corresponding titles:
Industry ... Region ... Data Element Codes ... Rate/Level Codes
Bureau of Labor Statistics - Spending, Prices & Costs
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID CXUAB000101 Positions Value Field Name 1-2 CX Prefix 3 U Seasonal Adjustment Code 4-7 AB00 Item Code 8-9 01 Table Code 10-11 01 Column CodeCodes and corresponding titles:
Item Codes ... Table Codes ... Column Codes
Inflation & Prices
Average Price Data
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID APU000070111 Positions Value Field Name 1-2 AP Prefix 3 U Seasonal Adjustment Code 4-7 0000 Area Code 8-13 701111 Item CodeCodes and corresponding titles:
Area Codes ... Item Codes
Consumer Price Index - All Urban Consumers
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID CUUR0000SA0L1E Positions Value Field Name 1-2 CU Prefix 3 U Not Seasonal Adjustment Code 4 R Periodicity Code 5-8 0000 Area Code 9 S Base Code 10-16 A0L1E Item CodeCodes and corresponding titles:
Area Codes ... Item Codes
Consumer Price Index - Urban Wage Earners and Clerical Workers
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID CWSR0000SA111211 Positions Value Field Name 1-2 CW Prefix 3 S Seasonal Adjustment Code 4 R Periodicity Code 5-8 0000 Area Code 9 S Base Code 10-16 A111211 Item CodeCodes and corresponding titles:
Area Codes ... Item Codes
Chained CPI-All Urban Consumers
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID SUUR0000SA0 Positions Value Field Name 1-2 SU Prefix 3 U Seasonal Adjustment Code 4 R Periodicity Code 5-8 0000 Area Code 9-11 SA0 Item CodeCodes and corresponding titles:
Area Codes ... Item Codes
Producer Price Index Industry Data - Current Series
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID PCU3131113131117551 Positions Value Field Name 1-2 PC Prefix 3 U Seasonal Adjustment Code 4-9 313111 Industry Code 10-19 3131117551 Product Code
For higher-level index aggregations (NAICS industry groups whose length is less than 6 digits) will use hyphens as place holders. For example:
1 2 12345678901234567890 Series ID PCU3131—3131— Positions Value Field Name 1-2 PC Prefix 3 U Seasonal Adjustment Code 4-9 3131— Industry Code 10-15 3131— Product CodeCodes and corresponding titles:
Industry Codes ... Product Codes
Producer Price Index - Commodities
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID WPS01220205 Positions Value Field Name 1-2 WP Prefix 3 S Seasonal Adjustment Code 4-5 01 Group Code 6-11 220205 Item CodeCodes and corresponding titles:
Group Codes ... Item Codes
Producer Price Index Commodity - Discontinued Series
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID WDS01220205 Positions Value Field Name 1-2 WD Prefix 3 S Seasonal Adjustment Code 4-5 01 Group Code 6-11 220205 Item CodeCodes and corresponding titles:
Group Codes ... Item Codes
Pay & Benefits
Work Stoppage Data
Seasonal Adjustment Code 4-6 B00 Measure Code Codes and corresponding titles:
Measure Codes
Employment Cost Index (NAICS)
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID CIS1010000000000I Positions Value Field Name 1-2 CI Prefix 3 S Seasonal Adjustment Code 4 1 Sector Code 5-6 01 Compensation Code 7-16 0000000000 Industry/Occupation Code 17 I Periodicity CodeCodes and corresponding titles:
Compensation Codes
Industry Codes
Sector Codes
Periodicity Codes
Employer Cost for Employee Compensation
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID CMU010000100000P Positions Value Field Name 1-2 CM Prefix 3 U Seasonal Adjustment Code 4 0 Sector Code 5-6 10000 Compensation Component Code 7-16 100000 Employer/Employee_Characteristics Code 17 P Cost Factor CodeCodes and corresponding titles:
Sector Codes ... Compensation Component ... Employer/Employee_Characteristics Codes ... Cost Factor Codes
Bureau of Labor Statistics - International, Projections
Import/Export Price Indexes
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID EIUCOCANMANU Positions Value Field Name 1-2 EI Prefix 3 U Seasonal Adjustment Code 4-5 CO Index Code 6-12 CANMANU Series NameCodes and corresponding titles:
Index Codes ... Series Names
Foreign Labor Statistics
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID INS0022AU0 Positions Value Field Name 1-2 IN Prefix 3 S Seasonal Adjustment Code 4-7 0022 Group Code 8-9 AU Country Code 10 0 Suffix CodeCodes and corresponding titles:
Group Codes ... Country Codes ... Suffix Codes
Projections
Employment Projections
Survey Overview ... format and sample identifier:
1 2 12345678901234567890 Series ID EPUP02202 Positions Value Field Name 1-2 EP Prefix 3 U Seasonal Adjustment Code 4 P Projection Code 5-7 022 Industry Code 8-9 02 Data Type CodeCodes and corresponding titles:
Projection Codes ... Industry Codes ... Data Type Codes
APIGateway Application Examples
The following examples illustrate use of the APIGateway. Several examples shows tables extracted by different data sources and geographic levels. The settings used for each application are summarized. A graphic for each example shows the output from the operation. In those cases where FactFinder provides access to the data, the FactFinder output is also shown. APIGateway users can directly replicate these operations.
Tables P003 and P004 Census 2010 by Block Group
RACE
Universe: Total population
2010 Census Summary File 1
Control File: c:\cvxe\1\bg2010.dbf
Control File Query: substr(geoid,1,2)='15'
-- filters control file to geographies that meet only this condition; for all records/geographies set to null/empty
-- this filter says to restrict processing to state of Hawaii (state FIPS code 15)
-- within this group, number of records/geographies extracted controlled by Records edit box; a number or ALL for all geographies
Output Dataset: c:\cvxe\1\BG_SF1_2010_P003P004_15.dbf
Items: p0030001,p0030002,p0030003,p0030004,p0030005,p0030006,p0030007,p0030008,p0040003
-- items are the table/item descriptors listed in the documentation
FactFinder display not available; no block group data
Tables P003 and P004 Census 2010 by ZIP Code Area
P003 RACE
Universe: Total population
2010 Census Summary File 1
P004 HISPANIC OR LATINO ORIGIN
Universe: Total population
2010 Census Summary File 1
Control File: c:\cvxe\1\uszcta2010.dbf
Control File Query: substr(geoid,1,3)='967'
-- filters control file to geographies that meet only this condition; for all records/geographies set to null/empty
-- this filter says to restrict processing to 3-digit ZIP codes 967 (Hawaii)
-- within this group, number of records/geographies extracted controlled by Records edit box; a number or ALL for all geographies
Output Dataset: c:\cvxe\1\ZP_SF1_2010_P003P004_15.dbf
Items: p0030001,p0030002,p0030003,p0030004,p0030005,p0030006,p0030007,p0030008,p0040003
-- items are the table/item descriptors listed in the documentation
FactFinder display for one geographic area
Table B23025 ACS 2011 5Year by Block Group
EMPLOYMENT STATUS FOR THE POPULATION 16 YEARS AND OVER
Universe: Population 16 years and over
2007-2011 American Community Survey 5-Year Estimates
Control File: c:\cvxe\1\bg2010.dbf
Control File Query: substr(geoid,1,2)='15'
-- filters control file to geographies that meet only this condition; for all records/geographies set to null/empty
-- this filter says to restrict processing to state of Hawaii (state FIPS code 15)
-- within this group, number of records/geographies extracted controlled by Records edit box; a number or ALL for all geographies
Output Dataset: c:\cvxe\1\BG_ACS5_2011_B23025_15.dbf
Items: B23025_001E,B23025_002E,B23025_003E,B23025_004E,B23025_005E,B23025_006E,B23025_007E
-- items are the table/item descriptors listed in the documentation
FactFinder display not available; no block group data
Table B23025 ACS 2011 5Year by ZIP Code Area
EMPLOYMENT STATUS FOR THE POPULATION 16 YEARS AND OVER
Universe: Population 16 years and over
2007-2011 American Community Survey 5-Year Estimates
Control File: c:\cvxe\1\uszcta2010.dbf
Control File Query: substr(geoid,1,3)='967'
-- filters control file to geographies that meet only this condition; for all records/geographies set to null/empty
-- this filter says to restrict processing to 3-digit ZIP codes 967 (Hawaii)
-- within this group, number of records/geographies extracted controlled by Records edit box; a number or ALL for all geographies
Output Dataset: c:\cvxe\1\ZP_ACS5_2011_B23025_15.dbf
Items: B23025_001E,B23025_002E,B23025_003E,B23025_004E,B23025_005E,B23025_006E,B23025_007E
-- items are the table/item descriptors listed in the documentation
FactFinder display for one geographic area
Table B06007 ACS 2011 5Year by ZIP Code Area -- these data not available by block group
PLACE OF BIRTH BY LANGUAGE SPOKEN AT HOME AND ABILITY TO SPEAK ENGLISH IN THE UNITED STATES
Universe: Population 5 years and over in the United States
2007-2011 American Community Survey 5-Year Estimates
Control File: c:\cvxe\1\uszcta2010.dbf
Control File Query: substr(geoid,1,3)='967'
-- filters control file to geographies that meet only this condition; for all records/geographies set to null/empty
-- this filter says to restrict processing to 3-digit ZIP codes 967 (Hawaii)
-- within this group, number of records/geographies extracted controlled by Records edit box; a number or ALL for all geographies
Output Dataset: c:\cvxe\1\ZP_ACS5_2011_B06007_15.dbf
Items: B06007_001E,B06007_002E,B06007_003E,B06007_004E,B06007_005E,B06007_006E,B06007_007E,B06007_008E,B06007_009E,B06007_010E,B06007_011E,B06007_012E,B06007_013E,B06007_014E,B06007_015E,B06007_016E,B06007_017E,B06007_018E,B06007_019E,B06007_020E,B06007_021E,B06007_022E,B06007_023E,B06007_024E,B06007_025E,B06007_026E,B06007_027E,B06007_028E,B06007_029E,B06007_030E,B06007_031E,B06007_032E,B06007_033E,B06007_034E,B06007_035E,B06007_036E,B06007_037E,B06007_038E,B06007_039E,B06007_040E
-- items are the table/item descriptors listed in the documentation
FactFinder display for one geographic area
