CV XE GIS Home Page

  ProximityOne Main

  New Topics & Updates

  S&O Metro Reports

  Situation & Outlook

  Related Sections
  - Applications Gallery
  - States
  - School Districts
  - Metros
  - Congressional
  - Counties
  - Census Tracts
  - Block Groups
  - Census Blocks
  - ZIP Codes
  - Urban Areas

  - County Interactive
  - 5-year Projections
  - Quarterly Projections
  - 2030 Projections
  - 2060 Projections

    Visual Analysis

  Interactive Tables

  National Scope
  Demographic Change
  - States
  - Metros
  - Congressional Dist
  - School Districts
  - Counties
  - Cities/Places
  - Census Tracts

Decision-Making Information
  information resources & solutions
  (888) DMI-SOLN
  (888) 364-7656

Put data to work more effectively.
Certificate in Data Analytics

Data Analytics Blog
Power of Combining Maps with Data

Support & Technical Assistance
help using these resources

APIGateway -- Demographic Economic Data Extraction
  ... create custom demographic-economic files from large Web-based datasets
  ... use structured, menu-based API tools to extract data you need
  ... for both developers & users with no coding experience

Use the APIGateway to extract demographic-economic data from various statistical programs and datasets using API methods and tools. Extract data from statistical programs including:
  • Census 2000, Census 2010, Census 2020,
  • American Community Survey annually through ACS 2019
    ..ACS 2020 data in Sep 2021.
  • BEA Economic Time Series
  • BLS Economic Time Series
  • Situation & Outlook demographic-estimates & projections
  • Many other statistical programs - see operations details for complete list.

APIGateway Videos
  • Getting Started
  • Accessing Census 2010 Block Demographics
    .. using geography based on geocoded address file

About APIGateway
APIGateway is an integrated feature of the CV XE GIS software. APIGateway is available in all versions of CV XE GIS including the no fee User Group version.
Get started now:
  • Run the CV XE GIS installer; requires User Group ID -- Join User Group.
  • Follow the steps described below to use APIGateway.
  • Participate in weekly Data Analytics Lab where we cover use of APIGateway.

Benefits from using APIGateway include the ability to setup custom data extraction (geographic code lists and subject matter code lists) that can be re-used and completely controlled by the user. Downloaded data may be saved as XLS, CSV, or dBase (.dbf) files that can be converted to other formats. Use the data with your preferred statistical analysis software. The dBase structure lends itself to easy merger of multi-sourced subject matter data for the same geography (e.g., Census 2010 and ACS). The dBase structure also enables easy integration of subject matter data into corresponding shapefiles.

APIGateway makes use of Application Programming Interface (API) operations that enable downloading data directly from servers. As a result, the data extraction application makes little use of locally stored data. An Internet connection is required for most applications.

APIGateway is a batch-oriented application that makes use of the user interface shown below. The steps to create a dataset are:
1. Select the source dataset containing the data (Dataset selection/dropdown)
2. Select the type of geographic area for which the data are to be extracted (Geographic Level selection/dropdown)
4. Open a text file containing a list of the geocodes (or enter the geocodes) for the areas to be extracted
3. Open a text file containing a list of the subject matter items/fieldnames (or enter the fieldnames) to be extracted
5. Click Run button to start processing.

The following graphic illustrates using the APIGateway to create an extract/dataset for selected ACS 2019 5 year estimates for block groups in Alexandria, VA. The extracted data are displayed in the grid with block group rows and subject matter columns. The "RecLimit" (see at left in Operations) defaults to the first 5 areas. Each row in the grid corresponds to the data retrieved for a geographic area. Each column in the grid corresponds to the subject matter retreived. The header are subject matter field names. In this example Census Bureau item codes for ACS 2019 summary file.

Structure/Description of the User Interface
1. Top: main menu bar (most operations can be performed using other visible controls)

2. Left control panel
2.1. API Operations
2.1.1. Run button; when all settings are ready, click this button to start processing
2.1.2. Dataset selection/dropdown
2.1.3. Geographic Level selection/dropdown
2.1.4. RecLimit -- Record Limit; if not empty processing will be for first RecLimit number of geographic areas

2.2. Geographic Areas panel
2.2.1. Open button -- use to open file containing geocodes list of areas to be processed
2.2.2. Active File -- name of file used to populate the Geographic Areas listbox
    the start-up file path/name is specified in the INI/start-up settings form
2.2.3. AddGeos -- enables user to manually enter geocodes to be processed
2.2.4. Count -- number of geocodes in Geographic Areas listbox
2.2.5. Query -- select only those geocodes in Geographic Areas listbox that match this make criteria
2.2.6. Geographic Areas listbox -- contains list of geocodes to be processed when Run button is clicked

2.3. Subject Matter Items panel
2.3.1. Open button -- use to open file containing subject matter items/fieldnames to be processed
2.3.2. Active File -- name of file used to populate the Subject Matter Items listbox
    the start-up file path/name is specified in the INI/start-up settings form
2.3.3. AddItems -- enables user to manually enter fieldnames to be processed
2.3.4. Subject Matter Items listbox -- contains list of fieldnames to be processed when Run button is clicked

3. Data Display grid -- used to display data retrieved
3.1. Output File Name (above data grid)
    the start-up file path/name is specified by the options chosen in the Operations panel at left
    optionally modify this name before clicking "Run" button
3.2. Data display grid

When the Run button is clicked, each geocode in the Geographic areas listbox is processed. A record is written to the output file with columns/data values corresponding to the fieldnames in the Subject matter items listbox.

Using APIGateway
• With CV XE GIS running, click File>APIGateway
• Select the Dataset from dropdown list.
• Select the Geographic Level from dropdown list.
• Create/select the Geocode List file
• Create/select the Items List file
• Click run
• Processing results are displayed in grid
• Optionally click on a column header to sort the grid on that column; click again to sort in other direction
• Optionally use File>SaveAs to save data in grid to file
    - optionally toggle File>Settings>ExportShowXLS to automatically open if saved as XLS.
• Structure of the output file.
• Modifying settings using the Settings form (for start-up configuration)

Geographic Areas Listbox & Geocodes List File ..
goto top
Geographic areas processed in a "run" are those listed in the Geographic Areas listbox.
The Geographic Areas listbox is populated when the user:
1) changes the geotype dropdown, or
... the Geographic Areas listbox automatically populates with the U.S. national scope geocodes.
2) uses File>Open Geographic Areas file
... the Geographic Areas listbox is populated with geocodes from the Geocode List file .

Alternatively use the AddItems button to add a selection of geocodes

Start-up View/Settings
The start-up Geographic Areas listbox includes a 106 block group codes (Alexandria, VA Census 2010). For Census 2010 and ACS datasets, the block group codes are Census 2010 vintage codes. For Census 2000 datasets, the block group codes are Census 2000 vintage codes. Open a geocodes list file using File>Open Geocodes File.

The block group code must be a numeric code structured like SSCCCTTTTTTG where SS is the FIPS state code, CCC is the FIPS county code, TTTTTT is the census tract code and G is the block group code.

Sample block group code files are provided with the installer.
• api_geo_51510_bg00.txt -- all Census 2000 block groups in Alexandria, VA
• api_geo_51510_bg10.txt -- all Census 2010 block groups in Alexandria, VA

More detail on geography selection and codes is available via the APIGateway Help feature.

Subject Matter Items and Items List File
The Items List file is a text file that contains a list of codes for subject matter items to be extracted. The start-up list includes a few sample ACS subject matter items (items_acs.txt). Open an items list file using File>Open Items File.

The item code must correspond exactly to the "name" of the item assigned by Census or other authority for use with API calls. Sample item code files are included with the installer.
• api_items_2000_sf3.txt -- selected Census 2000 SF3 items
• api_items_2010_sf1.txt -- selected Census 2010 SF1 items
• api_items_acs.txt -- selected ACS summary file items

Get ACS detailed subject matter item names here.

More detail on subject matter selection is available via the APIGateway Help feature.

Output and Saving Results
• Data displayed in the grid is automatically saved to the output file name specified in the INI Settings.
• Optionally use File>SaveAs to save the grid context to file.

Additional Processing & Operations Information
1. Geocodes not found (an error in the geocodes list file).
If a geocode is not located, the data record is written with the specified geocode but all subject matter field values are written as -1.

2. Geocodes & Item Codes Manual Entry.
Optionally use the mouse to empty the Geocodes List and/or Item Codes List and key in codes manually. Use this feature to look-up any one or a few item value(s) for one or a few block group(s).

3. How to determine block group geocodes of interest? What is my block group code?
Option 1. For all block groups in county(s) or state(s), use TIGER files. See the above discussion under Geocode List File. Option 2. Use the APIGeocoder (all versions including no fee version). Use the "CodeOne" button to code one address; the geocode is displayed in the grid or code a group of addresses.

ProximityOne User Group
Join the ProximityOne User Group to keep up-to-date with new developments relating to metros and component geography decision-making information resources. Receive updates and access to tools and resources available only to members. Use this form to join the User Group.

Support Using these Resources
Learn more about accessing and using demographic-economic data and related analytical tools. Join us in a Data Analytics Lab session. There is no fee for these one-hour Web sessions. Each informal session is focused on a specific topic. The open structure also provides for Q&A and discussion of application issues of interest to participants.

Additional Information
ProximityOne develops geographic-demographic-economic data and analytical tools and helps organizations knit together and use diverse data in a decision-making and analytical framework. We develop custom demographic/economic estimates and projections, develop geographic and geocoded address files, and assist with impact and geospatial analyses. Wide-ranging organizations use our tools (software, data, methodologies) to analyze their own data integrated with other data. Follow ProximityOne on Twitter at Contact ProximityOne (888-364-7656) with questions about data covered in this section or to discuss custom estimates, projections or analyses for your areas of interest.

Copyright © . Proximity. All Rights Reserved.
Sitemap |  Contact Us |  News