Basic API to return NAICS codes and information
Python JavaScript
Latest commit f34a8e2 Feb 19, 2014 @louh louh Merge pull request #28 from rclosner/module
Deprecates search logic in controller in favor of NAICS modules
Permalink
Failed to load latest commit information.
config Added awareness of OpenShift environment variables Oct 3, 2013
data Script and data for business categories by NAICS id Nov 5, 2013
routes/api Update API to use naics modules Feb 11, 2014
spec
.gitignore Using config module to separate configuration (e.g. port) from code. May 23, 2013
LICENSE.md Update README to include contributing information and updates copied … Sep 17, 2013
Procfile
README.md Update README - some reformatting, link fixes, header standardization Sep 17, 2013
apiary.apib Transferring blueprint from apiary.io Sep 9, 2013
index.html Updated contributors based on https://github.com/codeforamerica/naics… Oct 2, 2013
package.json
server.js Added route for engine light status Oct 4, 2013

README.md

NAICS-API

NAICS (North American Industry Classification System) is maintained by the United States Bureau of Labor Statistics to classify business types. It is used for aggregating, presenting, and analyzing data and trends in the US economy.

The classification system is currently hosted by the Census Bureau and provided in various Excel and PDF documents, with some rudimentary HTML output and a not-so-great search tool. Our goal is to improve on the Census Bureau's offerings by providing an API to make information machine-readable, with better search functionality, to assist with developing applications that depend on understanding or collecting information about businesses.

The Product

NAICS API is currently a Node.js server that returns NAICS data in a JSON format. Information stored on the server has been scraped or collected from files on the Census.gov web site. Most of the information for 2007 and 2012 has now been scraped thanks to the addition of a python scraper by Mike Migurski (see ./data/scrape-examples-xrefs).

API documentation

Latest API documentation is hosted at Apiary.io.

API example requests

Example request

http://api.naics.us/v0/q?year=2012&code=519120

To get NAICS codes above a given code

http://api.naics.us/v0/q?year=2012&code=519120&above=1

To get NAICS codes below a given code

http://api.naics.us/v0/q?year=2012&code=51&below=1

To get all NAICS codes for a given years codes (only 2007 and 2012 are available right now)

http://api.naics.us/v0/q?year=2012

To get all NAICS codes for given search terms (searches only title and index right now)

http://api.naics.us/v0/s?year=2012&terms=libraries

Warning! The URL (server and/or structure) is likely to change in the very near future. Do not use for production (yet).

Usage

Additional information

Development setup (on Mac OS X 10.8)

First-time setup

  1. Download and install Node.js.

  2. Clone this repository to a folder on your computer. The rest of this document will refer to this folder as $PROJECT_ROOT.

  3. Install project dependencies.

    cd $PROJECT_ROOT npm install

Every time you sync $PROJECT_ROOT with the remote GitHub repo

  1. Update the project dependencies.

    cd $PROJECT_ROOT npm install

To start the REST API server

  1. Start the REST API server.

    cd $PROJECT_ROOT npm start

Contributing

Help Needed

There are other data that can be included in the API. Not all of these are within the scope of the scraper however.

  • Illustrative examples from 2007 NAICS
  • Information from NAICS prior to 2007 (2002, 1997 - low priority)
  • Data for converting between different NAICS codes and other systems, like SIC or NIGP

On the API side:

  • The API should perform searches on all the available data and return relevant results from the requester (e.g. a business type lookup application)
  • Close existing issues.

Submitting an Issue

We use the GitHub issue tracker to track bugs and features. Before submitting a bug report or feature request, check to make sure it hasn't already been submitted. When submitting a bug report, please include a Gist that includes a stack trace and any details that may be necessary to reproduce the bug, including your gem version, Ruby version, and operating system. Ideally, a bug report should include a pull request with failing specs.

Submitting a Pull Request

  1. Fork the repository.
  2. Create a topic branch.
  3. Add specs for your unimplemented feature or bug fix.
  4. Implement your feature or bug fix.
  5. Add, commit, and push your changes.
  6. Submit a pull request.

Code for America Tracker