Zipcodebase

Zipcodebase integration (Location, Data). Imported from open-connector.

API key7 toolshttps://app.zipcodebase.com/api/v1

GET

zipcodebase_get_status

Return Zipcodebase account status and remaining request credits.

/status

GET

zipcodebase_search_postal_codes

Look up location information for one or more postal codes.

/search

2 parameters

Param	Type	Required	Description
codes	array	required	The postal codes to query.
country	string	optional	Optional ISO 3166-1 alpha-2 country code used to narrow the request.

GET

zipcodebase_calculate_distance

Calculate distance from one postal code to one or more comparison postal codes.

/distance

4 parameters

Param	Type	Required	Description
code	string	required	The postal code to query.
compare	array	required	The postal codes to query.
country	string	required	The ISO 3166-1 alpha-2 country code, such as us or nl.
unit	string	optional	Optional distance unit returned by Zipcodebase.

GET

zipcodebase_list_postal_codes_within_radius

List postal codes located within a radius of a postal code.

/radius

4 parameters

Param	Type	Required	Description
code	string	required	The postal code to query.
radius	number	required	The positive distance or radius value.
country	string	required	The ISO 3166-1 alpha-2 country code, such as us or nl.
unit	string	optional	Optional distance unit returned by Zipcodebase.

GET

zipcodebase_match_postal_codes_by_distance

Find submitted postal code pairs that are within a given distance.

/match

4 parameters

Param	Type	Required	Description
codes	array	required	The postal codes to query.
distance	number	required	The positive distance or radius value.
country	string	required	The ISO 3166-1 alpha-2 country code, such as us or nl.
unit	string	optional	Optional distance unit returned by Zipcodebase.

GET

zipcodebase_list_postal_codes_by_city

List postal codes associated with a city and optional state or province.

/code/city

3 parameters

Param	Type	Required	Description
city	string	required	The city name to search for.
country	string	required	The ISO 3166-1 alpha-2 country code, such as us or nl.
state_name	string	optional	The state or province name to search for.

GET

zipcodebase_list_postal_codes_by_state

List postal codes associated with a state or province.

/code/state

2 parameters

Param	Type	Required	Description
state_name	string	optional	The state or province name to search for.
country	string	optional	The ISO 3166-1 alpha-2 country code, such as us or nl.