README.md

boundaries

GeoJSON boundaries for Earth, masterfully formatted and normalized for your consumption.

Total # as of writing this: 83,842

Sources

• Neighborhoods
  • Zillow
• US States/Cities/Counties/Zip Codes
  • Census Bureau (TIGER 2016)
• Canada Cities Codes
  • Census Bureau (TIGER 2016)
• Countries
  • https://github.com/busrapidohq/world-countries-boundaries
• Planet (earth only)

Know of more good sources for boundary data? Send a PR!

Boundary JSON Format

Each boundary is a GeoJSON MultiPolygon. The properties object on each geometry contains the following fields:

• id (String)
  • Unique ID (slug) for this boundary
• type (String)
  • state, neighborhood, county, planet, etc.
• name (String)
  • Display Name
• code (String)
  • FIPS code for US boundaries
  • For neighborhoods, this is the Zillow ID.
  • For countries this is the ISO A3 code.

Accessing the boundaries

• You can reference the files directly from github
• You can install it as a node module (see below)

Node Module

Installation

Due to size limits on npm, you'll have to install from github.

npm install github:contra/boundaries --save

If anything was able to land on NPM, it's outdated - don't use it.

API

• listSync()
  • Synchronous
  • Returns an array of boundary IDs
• readSync(id)
  • Synchronous
  • Returns the object representing the given boundary ID
• list([cb])
  • Asynchronous form of listSync
  • Callback is optional, returns a promise
• read(id[, cb])
  • Asynchronous form of readSync
  • Callback is optional, returns a promise

Example

Simple example of listing boundaries and reading them synchronously.

ES5

var boundaries = require('boundaries');
var fs = require('fs');

var ids = boundaries.listSync();

ids.forEach(function(id) {
  var boundary = boundaries.readSync(id);
  // Do something with it!
});

ES6

import { listSync, readSync } from 'boundaries'

const ids = listSync()

ids.forEach((id) => {
  const boundary = readSync(id)
  // Do something with it!
})

Updating the search results

To update the results in files.json

go run main.go