Skip to main content
POST
/
tools
/
check-network-coverage
{
  "address": {
    "street1": "500 S Main St",
    "street2": "Apt 1",
    "city": "Natick",
    "zip": "01701",
    "country": "US",
    "state": "CA",
    "region": "<string>",
    "attention": "<string>"
  },
  "coverageLevel": "GOOD",
  "coordinates": {
    "latitude": 59.3293,
    "longitude": 18.0686
  },
  "networkProviderId": "tmobile-us",
  "coverage": {
    "3g": {
      "available": true
    },
    "4g": {
      "available": true
    },
    "5g": {
      "available": true
    },
    "additionalProperties": {
      "available": true
    }
  },
  "roamingStatus": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Headers

​
X-Idempotency-Key
string

A unique key to ensure idempotency of requests. If a request with the same key has already been processed, the same result will be returned. The key must be unique for each distinct operation. Keys are expired after 24 hours, but we recommend using a new key for each request.

Modified requests with the same idempotency keys are rejected with a 409 Conflict status code.

Maximum length: 256

Body

application/json

Address to check network coverage for.

Request to check network coverage for an address.

​
address
object
required

Response

Network coverage information retrieved.

Network coverage information for a specific address.

What data is returned is dependent on the underlying network provider so only the required fields

​
address
object
required

The address that was checked.

​
coverageLevel
enum<string>
required

Overall network coverage quality at this location.

Available options:
EXCELLENT,
GOOD,
FAIR,
POOR,
NO_COVERAGE
Example:

"GOOD"

​
coordinates
object

Resolved coordinates for the address, if available.

​
networkProviderId
string

Which network this coverage data applies to.

Example:

"tmobile-us"

​
coverage
object

Coverage information per technology, if available.

​
roamingStatus
string

The roaming status at this location, if available.

⌘I