top of page

CarrierFinder API Documentation
get_cableco

Overview
The purpose of this function is to return information about who the local cableco is, along with qualification data for certain cableco's.

Service Endpoint

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

Address Method

The following request will return the cableco information for the service address: 126 E BROADWAY ST MISSOULA MT
 

http://api.carrierfinder.net/api.py?function=get_cableco&method=address&address= 126 E BROADWAY ST MISSOULA MT 59802&userid=xxx&key=xxx 
 

We recommend using address method if address has not already been geocoded.

​

Explicit Method

The following request will return the cableco information for the service address: 126 E BROADWAY ST MISSOULA MT 59802

​

http://api.carrierfinder.net/api.py?function=get_cableco&method=explicit&street=126 E BROADWAY ST&city=MISSOULA&state=MT&zipcode=59802&userid=xxx&key=xxx 

​

We recommend using address method if address has not already been geocoded.

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 - provide address to be geocoded so we can parse address

explicit - provide street, city, state, zipcode

address

Site address for which cableco is being requested (only required if method is address)

The following parameters are only required if method is explicit

street

Street address

city

City

state

State

zipcode

Zipcode

prequal

Optional (Y/N) Run cableco prequalification. Default = Y.

Response Data Elements

Parameter

Description

status

OK - Found data to return

​

Error - Encountered an error

cableconame

Name of cableco

website

Cableco website

overview

Overview of cableco

cablephone

Phone number of cableco

coax_indicator

Service indicator for Coax qualifications

coax_notes

Provides qualification data of coax for certain carriers

coax_indicator2

Service indicator for Coax qualifications

coax_notes2

Provides qualification data of coax for certain carriers

fiber_indicator

Service indicator for fiber qualifications for certain carriers

fiber_notes

Provides qualification data of fiber for certain carriers

fiber_notes2

Provides qualification data of fiber for certain carriers

search_method

Method used to return results (API or DB)

coax_indicator

Service indicator for Coax qualifications (Charter)

carrierid

Internal CarrierFinder ID

bottom of page