top of page

CarrierFinder API Documentation
get_telcoinfo

Overview
The purpose of this function is to return information about who the local telco is and associated information such as npa/nxx, clli code, etc.

Service Endpoint

The service endpoint is found at: http://api.carrierfinder.net/api.py

The following is an example of looking up the telco using the address method:

http://api.carrierfinder.net/api.py?function=get_telcoinfo&method=address&address='15821NE8thStBellevue,WA'&userid=xxx&key=xxx

 

The following is an example of looking up the telco using the geo method:

http://api.carrierfinder.net/api.pyfunction=get_telcoinfo&method=geo&lat=47.6143531404288&lon=-122.338864980112&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 the key belongs to

address

Site address for which the telco data is being requested (address method)

lat

Latitude for the location (geo method)

lon

Longitude for the location (geo method)

method

Specifies the method to locate telco:
address - Address of the site
geo - lat/lon of the site

Response Data Elements

Parameter

Description

status

Returns one of the following values:

ok - found data to return

error - encountered an error

none found - could not identify telco

search_address

Address which as specified as parameters

result_type

Internal code

geo_lat

Latitude of the search address

geo_lon

Longitude of the search address

geo_street

Location street address returned by geocoding routine

geo_city

Location city returned by geocoding routine

geo_state

Location state returned by geocoding routine

geo_zipcode

Location zipcode returned by geocoding routine

geo_formattedaddress

Formatted address returned by geocoding routine

telco_co_lon

Longitude of telco central office

telco_clli

clli code of telco central office

telco_co_lat

Latitude of telco central office

telco_co_distance

Distance between search address and central office address

telco_exchange

Telco exchange name

telco_co_city

Telco central office state name

telco_co_state

Telco parent name

telco_parentnumber

Telco parent number

telco_lataname

Telco lata name

telco_co_zipcode

Telco central office zipcode

telco_co_street

Telco central office street

telco_carrierid

Telco carrier ID (if exists)

telco_npa

Telco NPA

telco_nxx

Telco NXX

telco_parentname

Telco parent name

telco_telconame

Telco name

telco_telconumber

Telco number

telco_npanxx

Telco NPA NXX

telco_lata

Telco lata name

bottom of page