CarrierFinder API Documentation
get_carriers_by_zip
Overview
The purpose of this function is to return a list of carriers based on the zip code provided.
Service Endpoint
The service endpoint is found at: http://api.carrierfinder.net/api.py
The following request will return a list of carriers within the zipcode: 98008
http://api.carrietfinder.net/api.py?function=get_carriers_by_zip&zipcode=98008&userid=xxx&key=xxx
Parameters
Parameter
Description
key
API access key
You must have a CarrierFinder account in order to create this key.
userid
User ID which this key belongs to
zipcode
Zip code of the area to search
Response Data Elements
Parameter
Description
status
Returns one of the following values:
OK - found data to return
Error - encountered an error
count
Number of lit buildings found
carriers[array]
Array of carrier data being returned
carriername
Carrier Name
carrierid
Carrier ID
carriertype
Type of carrier (LEC, CLEC, ISP, etc.)
rating
Rating
Based on channel support and commission program as the primary index
quote
Y = We are able to quote services for this carrier
N = We are not able to quote services for this carrier
sourcecodes
d = Data supplied by carrier
l = Data from lit building database
z = Cable database we obtain