Developer

API » 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 jun2014. Previous data versions include jun2011, dec2011, jun2012, dec2012, jun2013, dec2013.

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
https://www.broadbandmap.gov/broadbandmap/

API Call
{API Base}/provider/{dataVersion}/stats/state/{stateId}/{censusMetric}/{geographyType}/{geographyId}/{holdingCompanyNumber}/similar/{searchCriteria}?format={format}&callback={functionName}

Sample Call
https://www.broadbandmap.gov/broadbandmap/provider/jun2014/stats/state/01/population/congdistrict/0111301/130077/similar/asymmetricdsl?format=json

Required Parameters
dataVersion:
specify the data version for search(no defaults). Examples: jun2014, dec2013, jun2013, dec2012, 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

Response

JSON   XML

{
 "status":"OK",
 "responseTime":13,
 "message":[
  
 ],
 "Results":{
  "similarProviders":[
   {
    "holdingCompanyNumber":"130077",
    "holdingCompanyName":"AT&T Inc.",
    "percentageAvailability":0.66080
   },
   {
    "holdingCompanyNumber":"130228",
    "holdingCompanyName":"CenturyLink, Inc.",
    "percentageAvailability":0.18170
   },
   {
    "holdingCompanyNumber":"130258",
    "holdingCompanyName":"Frontier Communications Corporation",
    "percentageAvailability":0.05110
   },
   {
    "holdingCompanyNumber":"130844",
    "holdingCompanyName":"Millry Corporation",
    "percentageAvailability":0.01380
   },
   {
    "holdingCompanyNumber":"900313",
    "holdingCompanyName":"Butler Telephone Company",
    "percentageAvailability":0.00300
   }
  ]
 }
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response status="OK" responseTime="13">
  <Results>
    <similarProviders>
      <holdingCompanyNumber>130077</holdingCompanyNumber>
      <holdingCompanyName>AT&amp;T Inc.</holdingCompanyName>
      <percentageAvailability>0.66080</percentageAvailability>
   </similarProviders>
   <similarProviders>
     <holdingCompanyNumber>130228</holdingCompanyNumber>
     <holdingCompanyName>CenturyLink, Inc.</holdingCompanyName>
     <percentageAvailability>0.18170</percentageAvailability>
  </similarProviders>
  <similarProviders>
    <holdingCompanyNumber>130258</holdingCompanyNumber>
    <holdingCompanyName>Frontier Communications Corporation</holdingCompanyName>
    <percentageAvailability>0.05110</percentageAvailability>
 </similarProviders>
 <similarProviders>
   <holdingCompanyNumber>130844</holdingCompanyNumber>
   <holdingCompanyName>Millry Corporation</holdingCompanyName>
   <percentageAvailability>0.01380</percentageAvailability>
</similarProviders>
<similarProviders>
  <holdingCompanyNumber>900313</holdingCompanyNumber>
  <holdingCompanyName>Butler Telephone Company</holdingCompanyName>
  <percentageAvailability>0.00300</percentageAvailability>
</similarProviders>
</Results>
</Response>




Back to Top

You are automatically leaving the National Broadband Map site press escape key to cancel

You're leaving the National Broadband Map Website

You are now leaving the National Broadband Map web site, and will be automatically forwarded to the following site:

%url%

This link is provided for informational purposes only. We do not endorse any other product or service, and are not responsible for the content of other websites, including their accuracy, completeness, or timeliness.