CarrierFinder API Documentation
get_litbuildings
Overview
The purpose of this function is to return a list of fiber lit buildings based on the service address or lat/lon specified.
We recommend using the geo method if you have already geocoded the address. We also recommend providing state code if using geocode method.
Use the address method if you need our system to do the geocoding.
Service Endpoint
The service endpoint is found at: http://api.carrierfinder.net/api.py
Address Method
The following request will return a maximum of (5) lit buildings with a minimum carrier count per address of (2) within a (1) mile radius information for the service address: 15821 NE 8th St, Bellevue, WA
function=get_litbuildings&method=address&address='15821 NE8thstbellevue,wa'&radius=5280&count=5&carrier_count=2&userid=xxxkey=xxx
Explicit Method
The following request will return a maximum of (5) lit buildings with a minimum carrier count per address of (1) within a (1) mile radius information for the service address: 15821 NE 8th St, Bellevue, WA
function=get_litbuildings&method=geo&lat=47.6165419644115&lon=-122.129200147257&state=WA&radius=5280&count=5&carrier_count=1&userid=xxxkey= xxx< /span>
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
method
address - Return lit buildings based on address
OR
geo - Return lit buildings based on longitude / latitude
address
method = address
Site address for which telco data is being requested when using
lat
method = geo
Latitude of site
lon
method = geo
Longitude of site
street
method = geo (optional)
Street address of site
Providing street will improve the distance calculation
carrier_count
minimum carrier count per address (optional)
count
Number of addresses to return
Maximum is 25 by default
radius
radius of the search area (in feet)
carriertype
Specify carrier type (optional)
Valid carrier types are as follows:
Telco, Cableco, DataCenter, Reseller, ISP, CLEC, DLEC, Wireless, Satellite
state code
Provide a 2-digit state code if you are using geo method since this will speed up search results.
datacenter
If datacenter=Y, the system will only search for service addresses with the datacenter flag
Response Data Elements
Parameter
Description
status
Returns one of the following values:
OK - found data to return
Error - encountered an error
version
Version number of API function
count
Number of lit buildings found
site[array]
Array of site being returned
street
street address
city
City
state
State
zipcode
Zipcode
method
Method of API call used
longitude
Longitude of the search address
latitude
Latitude of the search address
xnet_code
O = OnNet
N = NearNet
xnet_id
ID of program
example: comcast_dci
xnet_description
Description of xnet_id
Example: Comcast datacenter
xnet_type
Additional information about the site
datacenter
Y - Indicates this is a datacenter
Null - Indicates this is NOT a datacenter
carrierid
Carrier ID of the carrier
carriername
Carrier name
distance
Distance from the search address - string
distance_int
Distance from the search address - integer
carriertype
Type of carrier