Internet speed test
CoverageMap API

Response objects

The objects returned by the CoverageMap API: the lookup result, locations, coverage entries, countries, providers and technologies.

These objects make up the data field of CoverageMap API responses. Every response wraps them in the shared response envelope.

How the objects fit together

Structure
Coverage lookup result
└── locations[]            Location
    └── coverage[]         Coverage entry
        ├── provider       Provider
        ├── technology     Technology or null
        ├── fccCoverage    FCC coverage object or null
        ├── speedTest      Speed test object or null
        └── summary        Summary object or null
CoverageMap API objects
ObjectReturned by
Coverage lookup resultCoverage lookup
LocationCoverage lookup result
Coverage entryLocation
ProviderCoverage entry
TechnologyCoverage entry
FCC coverageCoverage entry
Speed testCoverage entry
SummaryCoverage entry
Countries resultList countries
Providers resultList providers

Coverage lookup result

The data of a coverage lookup.

countrystring
The country looked up: the country you sent, or US when you left it out.
datasetsstring[]
The datasets you requested, in lower case.
locationsobject[]
One location per location in the request, in the same order.
Show child attributes
indexinteger
Position of the location in your request, from 0.
idstringOptional
The id you sent, as a string.
latitudenumberOptional
Latitude that was looked up. For an address, the geocoded latitude.
longitudenumberOptional
Longitude that was looked up. For an address, the geocoded longitude.
addressstringOptional
The address you sent.
confidencestringOptional
How confident the geocoder is in the coordinates found for an address.

Possible values: exact, high, medium, low

errorstringOptional
Why the location could not be looked up, for example an address that was not found. A location with an error has no coverage and is not billed.
coverageobject[]
One coverage entry per provider and technology. Empty when the location has an error.
Show child attributes
providerobject
The provider of this entry.
Show child attributes
codestring
Provider code, such as ATT, TMO or VZW.
namestring
Provider name, such as AT&T Mobility, T-Mobile US or Verizon Wireless.
technologyobjectNullable
The technology of this entry. Null when the request had no technologies and every technology is combined.
Show child attributes
codestring
Technology code, lte or 5g.
namestring
Technology name, LTE or 5GNR.
fccCoverageobjectOptionalNullable
Present when fcc-coverage was requested. An FCC coverage object, or null when the FCC does not report this provider and technology at the location.
speedTestobjectOptionalNullable
Present when speed-tests was requested. A speed test object, or null when there is no test, successful or failed, within 10 km for this provider and technology. A location with only failed tests nearby still returns the object, with a count of 0 and a positive failedCount.
summaryobjectOptionalNullable
Present when summary was requested. A summary object. When the FCC has nothing for this provider and technology and there are no nearby speed tests, every score is 0. Null only when there are no nearby speed tests and no FCC data is available for the location, for example outside the US.
Coverage lookup result
{
  "country": "US",
  "datasets": ["fcc-coverage", "summary"],
  "locations": [ ... ]
}

Location

One location from the request with what was looked up. A location sent as an address also has the address and a geocoding confidence; a location that failed has an error instead of coverage.

indexinteger
Position of the location in your request, from 0.
idstringOptional
The id you sent, as a string.
latitudenumberOptional
Latitude that was looked up. For an address, the geocoded latitude.
longitudenumberOptional
Longitude that was looked up. For an address, the geocoded longitude.
addressstringOptional
The address you sent.
confidencestringOptional
How confident the geocoder is in the coordinates found for an address.

Possible values: exact, high, medium, low

errorstringOptional
Why the location could not be looked up, for example an address that was not found. A location with an error has no coverage and is not billed.
coverageobject[]
One coverage entry per provider and technology. Empty when the location has an error.
Show child attributes
providerobject
The provider of this entry.
Show child attributes
codestring
Provider code, such as ATT, TMO or VZW.
namestring
Provider name, such as AT&T Mobility, T-Mobile US or Verizon Wireless.
technologyobjectNullable
The technology of this entry. Null when the request had no technologies and every technology is combined.
Show child attributes
codestring
Technology code, lte or 5g.
namestring
Technology name, LTE or 5GNR.
fccCoverageobjectOptionalNullable
Present when fcc-coverage was requested. An FCC coverage object, or null when the FCC does not report this provider and technology at the location.
speedTestobjectOptionalNullable
Present when speed-tests was requested. A speed test object, or null when there is no test, successful or failed, within 10 km for this provider and technology. A location with only failed tests nearby still returns the object, with a count of 0 and a positive failedCount.
summaryobjectOptionalNullable
Present when summary was requested. A summary object. When the FCC has nothing for this provider and technology and there are no nearby speed tests, every score is 0. Null only when there are no nearby speed tests and no FCC data is available for the location, for example outside the US.
Location
{
  "index": 1,
  "id": "store-2",
  "latitude": 38.897684,
  "longitude": -77.036574,
  "address": "1600 Pennsylvania Ave NW, Washington, DC 20500",
  "confidence": "exact",
  "coverage": [ ... ]
}

Coverage entry

The requested datasets for one provider and technology at a location. Only the datasets you requested are present.

providerobject
The provider of this entry.
Show child attributes
codestring
Provider code, such as ATT, TMO or VZW.
namestring
Provider name, such as AT&T Mobility, T-Mobile US or Verizon Wireless.
technologyobjectNullable
The technology of this entry. Null when the request had no technologies and every technology is combined.
Show child attributes
codestring
Technology code, lte or 5g.
namestring
Technology name, LTE or 5GNR.
fccCoverageobjectOptionalNullable
Present when fcc-coverage was requested. An FCC coverage object, or null when the FCC does not report this provider and technology at the location.
speedTestobjectOptionalNullable
Present when speed-tests was requested. A speed test object, or null when there is no test, successful or failed, within 10 km for this provider and technology. A location with only failed tests nearby still returns the object, with a count of 0 and a positive failedCount.
summaryobjectOptionalNullable
Present when summary was requested. A summary object. When the FCC has nothing for this provider and technology and there are no nearby speed tests, every score is 0. Null only when there are no nearby speed tests and no FCC data is available for the location, for example outside the US.
Coverage entry
{
  "provider": { "code": "VZW", "name": "Verizon Wireless" },
  "technology": { "code": "lte", "name": "LTE" },
  "fccCoverage": { ... },
  "speedTest": null,
  "summary": { ... }
}

Provider

codestring
Provider code, such as ATT, TMO or VZW.
namestring
Provider name, such as AT&T Mobility, T-Mobile US or Verizon Wireless.
Provider
{ "code": "VZW", "name": "Verizon Wireless" }

Technology

codestring
Technology code, lte or 5g.
namestring
Technology name, LTE or 5GNR.
Technology
{ "code": "5g", "name": "5GNR" }

Country

codestring
Two letter country code to send as country, such as US.
namestring
Country name, such as United States of America.
Country
{ "code": "US", "name": "United States of America" }

Countries result

The data of List countries.

countriesobject[]
The countries you can request, sorted by name. The United States is always included.
Show child attributes
codestring
Two letter country code to send as country, such as US.
namestring
Country name, such as United States of America.
Countries result
{
  "countries": [
    { "code": "US", "name": "United States of America" }
  ]
}

Providers result

The data of List providers.

countrystring
The country the list is for.
technologiesobject[]
Every technology at least one of your providers supports.
Show child attributes
codestring
Technology code, lte or 5g.
namestring
Technology name, LTE or 5GNR.
providersobject[]
The providers you can request, sorted by name.
Show child attributes
codestring
Provider code, such as ATT, TMO or VZW.
namestring
Provider name, such as AT&T Mobility, T-Mobile US or Verizon Wireless.
supportedTechnologiesstring[]
Technology codes this provider can be queried with.
Providers result
{
  "country": "US",
  "technologies": [
    { "code": "5g", "name": "5GNR" },
    { "code": "lte", "name": "LTE" }
  ],
  "providers": [
    { "code": "ATT", "name": "AT&T Mobility", "supportedTechnologies": ["5g", "lte"] }
  ]
}