Skip to content

escaladesports/zip-info-api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

44 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Zip Code Info API

An API for getting city information and coordinates from zip codes. Also includes autocomplete.

Endpoints

Information

Endpoint: https://zip-info-api.netlify.com/complete/{ZIP_CODE}

Example result:

{
   "city": "Atlanta",
   "state": "GA",
   "lat": 33.8913,
   "long": -84.0746
}

Autocomplete

Endpoint: https://zip-info-api.netlify.com/partial/{PARTIAL_ZIP_CODE}

Example result:

[
   {
      "zip": "99901",
      "city": "Ketchikan",
      "state": "AK",
      "lat": 55.372,
      "long": -131.6832
   },
   {
      "zip": "99928",
      "city": "Ward Cove",
      "state": "AK",
      "lat": 55.3954,
      "long": -131.6754
   },
   ...

Building Your Own

With CLI

Installation

With npm:

npm install --global zip-info-api

Or with Yarn:

yarn global add zip-info-api

Usage

zip-info-api build

With Node

Installation

With npm:

npm install --save zip-info-api

Or with Yarn:

yarn add zip-info-api

Usage

var buildApi = require('zip-info-api')

buildApi({
   path: './',
   minimumDigits: 1,
})

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published