ZipFeeder API v2

ZipFeeder: A simple and powerful JSON API for zip codes
More information: https://zipfeeder.us
Contact Info: [email protected]
Help/Support (Powered By Freshdesk): https://zipfeederus.freshdesk.com/
Version: 2.0.0
BasePath:/api/v2
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Below are the endpoints that are currently available - Be Sure to add the base path of /api/v2 before each request: /api/v2/zipcode/02124.
  1. get /zipcode/{zip} (supports JSONP)
  2. get /zipcodes/{zips} (supports JSONP)
  3. get /zipcode/{zip}
  4. get /zipcodes/near/{zip}
  5. get /zipcodes/startwith/{zip} (supports JSONP)
  6. get /zipcodes/state/{state}

The old zipcode lookup from the earlier version of zipfeeder will continue to work indefinitely. At the current time, we have no plans to retire it, though we would prefer you use the new endpoints.

Up
get /zipcode/{zip}
ZipCode Data (zipcodeZipGet)
ZipCode endpoint which supplies zip geolocation and demographic data

Path parameters

zip (required)
Path Parameter — zip code to retrieve data on

Query parameters

key (required)
Query Parameter — Application key for tracking. Required for full lookups
full (optional)
Query Parameter — Set to '1' if you want full data for the zip code - premium accounts only
callback (optional)
Query Parameter — for JSONP - the javascript callback function name

Return type

ZipCode

Example data

Content-Type: application/json
{
  "city" : "aeiou",
  "latitude" : "aeiou",
  "county" : "aeiou",
  "id" : "aeiou",
  "state" : "aeiou",
  "region" : "aeiou",
  "csaname" : "aeiou",
  "areacode" : "aeiou",
  "longitude" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Zip Code information ZipCode

403

Valid key required Object

404

Zip Code Not Found Error

Up
get /zipcodes/{zips}
Get zip codes by state (zipcodesZipsGet)
Lookup multiple zipcodes at once (5 max)

Path parameters

zips (required)
Path Parameter — List of zipcodes, separated by commas: 02124,90210 format:

Query parameters

key (required)
Query Parameter — Application key for tracking/access. Not available for free accounts
callback (optional)
Query Parameter — for JSONP the javascript callback function to use

Return type

City

Example data

Content-Type: application/json
{
  "city" : "aeiou",
  "id" : "aeiou",
  "state" : "aeiou",
  "areacode" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of cities and their zip codes, plus some meta data City

401

Unauthorized - no valid key sent Error

403

Forbidden - pay accounts only, key doesn't have full access or key is not valid Error

404

State Not Found Error

Up
get /zipcode/{zip}
ZipCode Data (zipcodeZipGet)
ZipCode endpoint which supplies zip geolocation and demographic data

Path parameters

zip (required)
Path Parameter — zip code to retrieve data on

Query parameters

key (required)
Query Parameter — Application key for tracking. Required for full lookups
full (optional)
Query Parameter — Set to '1' if you want full data for the zip code - premium accounts only
callback (optional)
Query Parameter — for JSONP - the javascript callback function name

Return type

ZipCode

Example data

Content-Type: application/json
{
  "city" : "aeiou",
  "latitude" : "aeiou",
  "county" : "aeiou",
  "id" : "aeiou",
  "state" : "aeiou",
  "region" : "aeiou",
  "csaname" : "aeiou",
  "areacode" : "aeiou",
  "longitude" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Zip Code information ZipCode

403

Valid key required Object

404

Zip Code Not Found Error

Up
get /zipcodes/near/{zip}
Nearby Zip Codes (zipcodesNearZipGet)
Return the closest zip codes to the zip code submitted

Path parameters

zip (required)
Path Parameter — The zipcode to lookup nearby zipcodes by

Query parameters

radius (optional)
Query Parameter — The radius in miles to search for - maximum is 100, default is 10.

Return type

City

Example data

Content-Type: application/json
{
  "city" : "aeiou",
  "id" : "aeiou",
  "state" : "aeiou",
  "areacode" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Nearby Zip Codes City

403

Forbidden - pay accounts only, key doesn't have full access or key is not valid Error

0

Unexpected error Error

Up
get /zipcodes/startwith/{zip}
Zipcode Lookup (zipcodesStartwithZipGet)
This endpoint returns all zip codes that start with the submitted parameter

Path parameters

zip (required)
Path Parameter — Search string to act as a 'startswith' search for zip codes

Return type

array[ZipCode]

Example data

Content-Type: application/json
[ {
  "city" : "aeiou",
  "latitude" : "aeiou",
  "county" : "aeiou",
  "id" : "aeiou",
  "state" : "aeiou",
  "region" : "aeiou",
  "csaname" : "aeiou",
  "areacode" : "aeiou",
  "longitude" : "aeiou"
} ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

An object containing array of zipcodes

403

Forbidden - pay accounts only, key doesn't have full access or key is not valid Error

Up
get /zipcodes/state/{state}
Get zip codes by state (zipcodesStateStateGet)
Lookup zipcodes by state and possible filter by city/town - premium users only

Path parameters

state (required)
Path Parameter — 2 character abbreviation for the U.S. state format:

Query parameters

key (required)
Query Parameter — Application key for tracking/access. Not available for free accounts
q (optional)
Query Parameter — Filter city results with this parameter

Return type

City

Example data

Content-Type: application/json
{
  "city" : "aeiou",
  "id" : "aeiou",
  "state" : "aeiou",
  "areacode" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of cities and their zip codes, plus some meta data City

401

Unauthorized - no valid key sent Error

403

Forbidden - pay accounts only, key doesn't have full access or key is not valid Error

404

State Not Found Error

Up
get /zipcodes/{zips}
Get zip codes by state (zipcodesZipsGet)
Lookup multiple zipcodes at once (5 max)

Path parameters

zips (required)
Path Parameter — List of zipcodes, separated by commas: 02124,90210 format:

Query parameters

key (required)
Query Parameter — Application key for tracking/access. Not available for free accounts
callback (optional)
Query Parameter — for JSONP the javascript callback function to use

Return type

City

Example data

Content-Type: application/json
{
  "city" : "aeiou",
  "id" : "aeiou",
  "state" : "aeiou",
  "areacode" : "aeiou"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

List of cities and their zip codes, plus some meta data City

401

Unauthorized - no valid key sent Error

403

Forbidden - pay accounts only, key doesn't have full access or key is not valid Error

404

State Not Found Error

Up

Models

[ Jump to Methods ]

Table of Contents

  1. City
  2. Error
  3. ZipCode

City Up

id (optional)
String The 5 digit Zip Code
city (optional)
String The name of the city corresponding to the zip code
areacode (optional)
String The phone area code this zip belongs to
state (optional)
String The 2 character state abbreviation

Error Up

code (optional)
Integer format: int32
message (optional)
fields (optional)

ZipCode Up

id (optional)
String The 5 digit Zip Code
city (optional)
String The name of the city corresponding to the zip code
state (optional)
String The 2 character state abbreviation
county (optional)
String The county name this zip belongs to
areacode (optional)
String The phone area code this zip belongs to
region (optional)
String The region of the country this zip belongs to
csaname (optional)
String The CSA name that this zip code belongs to
latitude (optional)
String The zip code's latitude
longitude (optional)
String The zip code's longitude