Developer

API » Almanac API - Parameters


Description
The Almanac API is designed to get all almanac parameters used by the Almanac API for ranking.

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 full suite of data which populates our Rank page.

Review Data Dictionary

JSON   XML

API Base
http://www.broadbandmap.gov/broadbandmap/

API Call
{API Base}/almanac/parameters?format={format}&callback={functionName}

Sample Call
http://www.broadbandmap.gov/broadbandmap/almanac/parameters?format=json

Required Parameters
n/a

Optional Parameters
format:
XML, JSON, JSONP (XML is default)

callback:
JSONP callback function name

Response

JSON   XML 

{
 "status":"OK",
 "responseTime":0,
 "message":[
  
 ],
 "Results":{
  "rankBys":{
   "property":[
    "nation",
    "state"
   ]
  },
  "geographies":{
   "property":[
    "tribalnation",
    "county",
    "usf",
    "statehouse",
    "congdistrict",
    "state",
    "statesenate",
    "msa",
    "censusplace",
    "nation"
   ]
  },
  "censusMetrics":{
   "property":[
    "household",
    "population"
   ]
  },
  "metrics":{
   "property":[
    "speed",
    "technology",
    "provider",
    "demographic"
   ]
  },
  "demographics":{
   "property":[
    "ageBetween20to34",
    "ageBetween35to59",
    "ageBetween5to19",
    "ageGreaterThan60",
    "ageUnder5",
    "educationBachelorOrGreater",
    "educationHighSchoolGraduate",
    "households",
    "incomeBelowPoverty",
    "incomeBetween100to200",
    "incomeBetween25to50",
    "incomeBetween50to100",
    "incomeGreater200",
    "incomeLessThan25",
    "landArea",
    "medianIncome",
    "population",
    "raceAsian",
    "raceBlack",
    "raceHispanic",
    "raceNativeAmerican",
    "raceWhite"
   ]
  },
  "providers":{
   "property":[
    "providerEquals0",
    "providerGreaterThan1",
    "providerGreaterThan2",
    "providerGreaterThan3",
    "providerGreaterThan4",
    "providerGreaterThan5",
    "providerGreaterThan6",
    "providerGreaterThan7",
    "providerGreaterThan8",
    "wirelessProviderEquals0",
    "wirelessProviderGreaterThan1",
    "wirelessProviderGreaterThan2",
    "wirelessProviderGreaterThan3",
    "wirelessProviderGreaterThan4",
    "wirelessProviderGreaterThan5",
    "wirelessProviderGreaterThan6",
    "wirelessProviderGreaterThan7",
    "wirelessProviderGreaterThan8",
    "wirelineProviderEquals0",
    "wirelineProviderGreaterThan1",
    "wirelineProviderGreaterThan2",
    "wirelineProviderGreaterThan3",
    "wirelineProviderGreaterThan4",
    "wirelineProviderGreaterThan5",
    "wirelineProviderGreaterThan6",
    "wirelineProviderGreaterThan7",
    "wirelineProviderGreaterThan8"
   ]
  },
  "speeds":{
   "property":[
    "downloadSpeedGreaterThan100000k",
    "downloadSpeedGreaterThan10000k",
    "downloadSpeedGreaterThan1500k",
    "downloadSpeedGreaterThan1Gig",
    "downloadSpeedGreaterThan25000k",
    "downloadSpeedGreaterThan3000k",
    "downloadSpeedGreaterThan3000kAndUploadSpeedGreaterThan768k",
    "downloadSpeedGreaterThan50000k",
    "downloadSpeedGreaterThan6000k",
    "downloadSpeedGreaterThan768k",
    "downloadSpeedGreaterThan768kAndUploadSpeedGreaterThan200k",
    "uploadSpeedGreaterThan100000k",
    "uploadSpeedGreaterThan10000k",
    "uploadSpeedGreaterThan1500k",
    "uploadSpeedGreaterThan1Gig",
    "uploadSpeedGreaterThan200k",
    "uploadSpeedGreaterThan25000k",
    "uploadSpeedGreaterThan3000k",
    "uploadSpeedGreaterThan50000k",
    "uploadSpeedGreaterThan6000k",
    "uploadSpeedGreaterThan768k",
    "uploadSpeedLessThan200k"
   ]
  },
  "technologies":{
   "property":[
    "anyTechnology",
    "anyWireless",
    "anyWireline",
    "asymmetricDsl",
    "cable",
    "cableDocsis",
    "cableOther",
    "copper",
    "dsl",
    "fixedWireless",
    "fixedWirelessLicensed",
    "fixedWirelessUnlicensed",
    "mobileWireless",
    "opticalFiber",
    "otherTechnology",
    "powerline",
    "satellite",
    "symmetricDsl"
   ]
  }
 }
}

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Response status="OK" responseTime="0">
  <Results>
    <rankBys>
      <property>nation</property>
      <property>state</property>
   </rankBys>
   <geographies>
     <property>tribalnation</property>
     <property>county</property>
     <property>usf</property>
     <property>statehouse</property>
     <property>congdistrict</property>
     <property>state</property>
     <property>statesenate</property>
     <property>msa</property>
     <property>censusplace</property>
     <property>nation</property>
  </geographies>
  <censusMetrics>
    <property>household</property>
    <property>population</property>
 </censusMetrics>
 <metrics>
   <property>speed</property>
   <property>technology</property>
   <property>provider</property>
   <property>demographic</property>
</metrics>
<demographics>
  <property>ageBetween20to34</property>
  <property>ageBetween35to59</property>
  <property>ageBetween5to19</property>
  <property>ageGreaterThan60</property>
  <property>ageUnder5</property>
  <property>educationBachelorOrGreater</property>
  <property>educationHighSchoolGraduate</property>
  <property>households</property>
  <property>incomeBelowPoverty</property>
  <property>incomeBetween100to200</property>
  <property>incomeBetween25to50</property>
  <property>incomeBetween50to100</property>
  <property>incomeGreater200</property>
  <property>incomeLessThan25</property>
  <property>landArea</property>
  <property>medianIncome</property>
  <property>population</property>
  <property>raceAsian</property>
  <property>raceBlack</property>
  <property>raceHispanic</property>
  <property>raceNativeAmerican</property>
  <property>raceWhite</property>
</demographics>
<providers>
 <property>providerEquals0</property>
 <property>providerGreaterThan1</property>
 <property>providerGreaterThan2</property>
 <property>providerGreaterThan3</property>
 <property>providerGreaterThan4</property>
 <property>providerGreaterThan5</property>
 <property>providerGreaterThan6</property>
 <property>providerGreaterThan7</property>
 <property>providerGreaterThan8</property>
 <property>wirelessProviderEquals0</property>
 <property>wirelessProviderGreaterThan1</property>
 <property>wirelessProviderGreaterThan2</property>
 <property>wirelessProviderGreaterThan3</property>
 <property>wirelessProviderGreaterThan4</property>
 <property>wirelessProviderGreaterThan5</property>
 <property>wirelessProviderGreaterThan6</property>
 <property>wirelessProviderGreaterThan7</property>
 <property>wirelessProviderGreaterThan8</property>
 <property>wirelineProviderEquals0</property>
 <property>wirelineProviderGreaterThan1</property>
 <property>wirelineProviderGreaterThan2</property>
 <property>wirelineProviderGreaterThan3</property>
 <property>wirelineProviderGreaterThan4</property>
 <property>wirelineProviderGreaterThan5</property>
 <property>wirelineProviderGreaterThan6</property>
 <property>wirelineProviderGreaterThan7</property>
 <property>wirelineProviderGreaterThan8</property>
</providers>
<speeds>
<property>downloadSpeedGreaterThan100000k</property>
<property>downloadSpeedGreaterThan10000k</property>
<property>downloadSpeedGreaterThan1500k</property>
<property>downloadSpeedGreaterThan1Gig</property>
<property>downloadSpeedGreaterThan25000k</property>
<property>downloadSpeedGreaterThan3000k</property>
<property>downloadSpeedGreaterThan3000kAndUploadSpeedGreaterThan768k</property>
<property>downloadSpeedGreaterThan50000k</property>
<property>downloadSpeedGreaterThan6000k</property>
<property>downloadSpeedGreaterThan768k</property>
<property>downloadSpeedGreaterThan768kAndUploadSpeedGreaterThan200k</property>
<property>uploadSpeedGreaterThan100000k</property>
<property>uploadSpeedGreaterThan10000k</property>
<property>uploadSpeedGreaterThan1500k</property>
<property>uploadSpeedGreaterThan1Gig</property>
<property>uploadSpeedGreaterThan200k</property>
<property>uploadSpeedGreaterThan25000k</property>
<property>uploadSpeedGreaterThan3000k</property>
<property>uploadSpeedGreaterThan50000k</property>
<property>uploadSpeedGreaterThan6000k</property>
<property>uploadSpeedGreaterThan768k</property>
<property>uploadSpeedLessThan200k</property>
</speeds>
<technologies>
<property>anyTechnology</property>
<property>anyWireless</property>
<property>anyWireline</property>
<property>asymmetricDsl</property>
<property>cable</property>
<property>cableDocsis</property>
<property>cableOther</property>
<property>copper</property>
<property>dsl</property>
<property>fixedWireless</property>
<property>fixedWirelessLicensed</property>
<property>fixedWirelessUnlicensed</property>
<property>mobileWireless</property>
<property>opticalFiber</property>
<property>otherTechnology</property>
<property>powerline</property>
<property>satellite</property>
<property>symmetricDsl</property>
</technologies>
</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.