DeveloperAPI » Provider Statistics API - Similar Providers Within A Geography
Description
This API returns similar providers with the same availability as a provider based on either technologies or same most common upload/download speed or population served within Geography. This API would return +3/-3 providers with similar availability.
Latest data version released jun2012. Previous data versions include jun2011, dec2011.
Why We Provide It
We are providing this API to increase the value of the transparency of the National Broadband Map. With this API you now have access to the similar providers as a provider within the geography.
Review Data Dictionary
JSON XML
API Base
http://www.broadbandmap.gov/broadbandmap/
API Call
{API Base}/provider/{dataVersion}/stats/state/{stateId}/{censusMetric}/{geographyType}/{geographyId}/{holdingCompanyNumber}/similar/{searchCriteria}?format={format}&callback={functionName}
Required Parameters
dataVersion:
specify the data version for search(no defaults). Examples: jun2012, dec2011, jun2011.
{stateId}:
specify the state id in which the provider statistics needs to be retrieved. Use Geography lookup API by geography type (state) to retrieve the state ids.
{censusMetric}:
specify the census metric by which the data has to be aggregated. It can be only population as of now.
{geographyType}:
specify either one of the following geography type: county, censusplace, msa, usf, statesenate, statehouse, congdistrict, tribalnation.
{geographyId}:
specify the geography id in which the provider statistics needs to be retrieved. Use Geography lookup API by geography type to retrieve geography ids. For Tribal Nation, use 99 as stateId.
{holdingCompanyNumber}:
specify the holding company number of the provider using Provider by Geography API
{searchCriteria}:
specify the search critieria by which similar provider needs to be retrieved
Optional Parameters
format:
XML, JSON, JSONP (XML is default)
callback:
JSONP callback function name
{
"status":"OK",
"responseTime":6,
"message":[
],
"Results":{
"similarProviders":[
{
"holdingCompanyNumber":"130077",
"holdingCompanyName":"AT&T Inc.",
"percentageAvailability":0.62580
},
{
"holdingCompanyNumber":"130228",
"holdingCompanyName":"CenturyLink, Inc.",
"percentageAvailability":0.18620
},
{
"holdingCompanyNumber":"130258",
"holdingCompanyName":"Frontier Communications Corporation",
"percentageAvailability":0.05460
},
{
"holdingCompanyNumber":"130844",
"holdingCompanyName":"Millry Corporation",
"percentageAvailability":0.01420
},
{
"holdingCompanyNumber":"900313",
"holdingCompanyName":"Butler Telephone Company, Inc.",
"percentageAvailability":0.00370
},
{
"holdingCompanyNumber":"131038",
"holdingCompanyName":"Pine Belt Communications Co. Inc.",
"percentageAvailability":0.00010
}
]
}
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response status="OK" responseTime="5">
<Results>
<similarProviders>
<holdingCompanyNumber>130077</holdingCompanyNumber>
<holdingCompanyName>AT&T Inc.</holdingCompanyName>
<percentageAvailability>0.62580</percentageAvailability>
</similarProviders>
<similarProviders>
<holdingCompanyNumber>130228</holdingCompanyNumber>
<holdingCompanyName>CenturyLink, Inc.</holdingCompanyName>
<percentageAvailability>0.18620</percentageAvailability>
</similarProviders>
<similarProviders>
<holdingCompanyNumber>130258</holdingCompanyNumber>
<holdingCompanyName>Frontier Communications Corporation</holdingCompanyName>
<percentageAvailability>0.05460</percentageAvailability>
</similarProviders>
<similarProviders>
<holdingCompanyNumber>130844</holdingCompanyNumber>
<holdingCompanyName>Millry Corporation</holdingCompanyName>
<percentageAvailability>0.01420</percentageAvailability>
</similarProviders>
<similarProviders>
<holdingCompanyNumber>900313</holdingCompanyNumber>
<holdingCompanyName>Butler Telephone Company, Inc.</holdingCompanyName>
<percentageAvailability>0.00370</percentageAvailability>
</similarProviders>
<similarProviders>
<holdingCompanyNumber>131038</holdingCompanyNumber>
<holdingCompanyName>Pine Belt Communications Co. Inc.</holdingCompanyName>
<percentageAvailability>0.00010</percentageAvailability>
</similarProviders>
</Results>
</Response>