Skip Navigation

Federal Communications Commission

English Display Options

Consumer Broadband Test API

Description

This API returns the Consumer Broadband Test speed test statistics for a US County given the passed Latitude and Longitude. The statistics are grouped into wireline and wireless and are the number of tests, average download speed, average upload speed, maximum download speed and maximum upload speed. This data is calculated nightly and includes all tests to date performed through the consumer broadband test.

Why We Provide It

We are providing this API to increase the value of the consumer broadband test. Currently the consumer broadband test only gives the result of the individual test. We think individuals would like to know the context of their test; do I get a similar result to the average tests in my county? The more people know about their broadband access speed the better.

Web Application Description Language (WADL)

Endpoint - http://data.fcc.gov/api/speedtest/application.wadl

WADL Content

<application>   <doc jersey:generatedBy="Jersey: 1.0.2 02/11/2009 07:45 PM"/>    <resources base="http://data.fcc.gov:80/api/speedtest/">     <resource path="">      <resource path="find">       <method name="GET" id="findSpeedTestsByCounty">        <request>         <param type="xs:double" style="query" name="latitude"/>         <param type="xs:double" style="query" name="longitude"/>         <param type="xs:string" style="query" name="format"/>         <param type="xs:string" style="query" name="jsoncallback"/>        </request>        <response>         <representation mediaType="application/x-javascript"/>         <representation mediaType="application/json"/>         <representation mediaType="application/xml"/>        </response>       </method>     </resource>    </resource>   </resources> </application>

Consumer Broadband Test Method Call

find

api call
http://data.fcc.gov/api/speedtest/find?latitude=<parameter1>&longitude=<parameter2>
sample call
http://data.fcc.gov/api/speedtest/find?latitude=38.0&longitude=-77.5
parameters
  • latitude – Latitude of a location
  • longitude – Longitude of a location
  • format (optional) – Default is xml. Valid values are: xml, json, jsonp
  • callback (optional) – jsonp callback function name
response
JSONP
callback({"@executionTime":"0.149","@status":"OK","SpeedTestCounty":{"wirelineMaxDownload":"17773.0","wirelineMaxUpload":"18680.0","wirelineAvgDownload":"9072.4","wirelineAvgUpload":"4562.2","wirelessMaxDownload":"14490.0","wirelessMaxUpload":"11180.0","wirelessAvgDownload":"9146.5","wirelessAvgUpload":"6498.5","wirelineTests":"66","wirelessTests":"13"}})
JSON
{"SpeedTestCounty": {
 "wirelineMaxDownload": "17773.0",
 "wirelineMaxUpload": "18680.0",
 "wirelineAvgDownload": "9072.4",
 "wirelineAvgUpload": "4562.2",
 "wirelessMaxDownload": "14490.0",
 "wirelessMaxUpload": "11180.0",
 "wirelessAvgDownload": "9146.5",
 "wirelessAvgUpload": "6498.5",
 "wirelineTests": "66",
 "wirelessTests": "13"},
status: "OK",
executionTime: "0.093"
}
XML
<Response executionTime="0.132" status="OK">
 <SpeedTestCounty>
  <wirelineMaxDownload>17773.0</wirelineMaxDownload>
  <wirelineMaxUpload>18680.0</wirelineMaxUpload>
  <wirelineAvgDownload>9072.4</wirelineAvgDownload>
  <wirelineAvgUpload>4562.2</wirelineAvgUpload>
  <wirelessMaxDownload>14490.0</wirelessMaxDownload>
  <wirelessMaxUpload>11180.0</wirelessMaxUpload>
  <wirelessAvgDownload>9146.5</wirelessAvgDownload>
  <wirelessAvgUpload>6498.5</wirelessAvgUpload>
  <wirelineTests>66</wirelineTests>
  <wirelessTests>13</wirelessTests>
 </SpeedTestCounty>
</Response>
Error Response

In case there is any exception on the server side it is caught and the http status code 500 is returned. (INTERNAL SERVER ERROR). The status description contains the detailed reason for the failure.

 

Previous Versions

Version 1.0.1

Version 1.0.0

close
FCC

You are leaving the FCC website

You are about to leave the FCC website and visit a third-party, non-governmental website that the FCC does not maintain or control. The FCC does not endorse any product or service, and is not responsibly for, nor can it guarantee the validity or timeliness of the content on the page you are about to visit. Additionally, the privacy policies of this third-party page may differ from those of the FCC.