Check network coverage
curl --request POST \
--url https://apiv2.example.com/tools/check-network-coverage \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
}
}
'import requests
url = "https://apiv2.example.com/tools/check-network-coverage"
payload = { "address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: {
street1: '500 S Main St',
city: 'Natick',
zip: '01701',
country: 'US',
street2: 'Apt 1',
state: 'CA',
region: '<string>',
attention: '<string>'
}
})
};
fetch('https://apiv2.example.com/tools/check-network-coverage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.example.com/tools/check-network-coverage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => [
'street1' => '500 S Main St',
'city' => 'Natick',
'zip' => '01701',
'country' => 'US',
'street2' => 'Apt 1',
'state' => 'CA',
'region' => '<string>',
'attention' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiv2.example.com/tools/check-network-coverage"
payload := strings.NewReader("{\n \"address\": {\n \"street1\": \"500 S Main St\",\n \"city\": \"Natick\",\n \"zip\": \"01701\",\n \"country\": \"US\",\n \"street2\": \"Apt 1\",\n \"state\": \"CA\",\n \"region\": \"<string>\",\n \"attention\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiv2.example.com/tools/check-network-coverage")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"street1\": \"500 S Main St\",\n \"city\": \"Natick\",\n \"zip\": \"01701\",\n \"country\": \"US\",\n \"street2\": \"Apt 1\",\n \"state\": \"CA\",\n \"region\": \"<string>\",\n \"attention\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.example.com/tools/check-network-coverage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": {\n \"street1\": \"500 S Main St\",\n \"city\": \"Natick\",\n \"zip\": \"01701\",\n \"country\": \"US\",\n \"street2\": \"Apt 1\",\n \"state\": \"CA\",\n \"region\": \"<string>\",\n \"attention\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"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>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}Tools
Check network coverage
Check network coverage quality and availability for a specific address.
This helps customers understand service quality before placing orders and can provide product offering recommendations based on coverage.
POST
/
tools
/
check-network-coverage
Check network coverage
curl --request POST \
--url https://apiv2.example.com/tools/check-network-coverage \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
}
}
'import requests
url = "https://apiv2.example.com/tools/check-network-coverage"
payload = { "address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"state": "CA",
"region": "<string>",
"attention": "<string>"
} }
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: {
street1: '500 S Main St',
city: 'Natick',
zip: '01701',
country: 'US',
street2: 'Apt 1',
state: 'CA',
region: '<string>',
attention: '<string>'
}
})
};
fetch('https://apiv2.example.com/tools/check-network-coverage', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://apiv2.example.com/tools/check-network-coverage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => [
'street1' => '500 S Main St',
'city' => 'Natick',
'zip' => '01701',
'country' => 'US',
'street2' => 'Apt 1',
'state' => 'CA',
'region' => '<string>',
'attention' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://apiv2.example.com/tools/check-network-coverage"
payload := strings.NewReader("{\n \"address\": {\n \"street1\": \"500 S Main St\",\n \"city\": \"Natick\",\n \"zip\": \"01701\",\n \"country\": \"US\",\n \"street2\": \"Apt 1\",\n \"state\": \"CA\",\n \"region\": \"<string>\",\n \"attention\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://apiv2.example.com/tools/check-network-coverage")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": {\n \"street1\": \"500 S Main St\",\n \"city\": \"Natick\",\n \"zip\": \"01701\",\n \"country\": \"US\",\n \"street2\": \"Apt 1\",\n \"state\": \"CA\",\n \"region\": \"<string>\",\n \"attention\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://apiv2.example.com/tools/check-network-coverage")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": {\n \"street1\": \"500 S Main St\",\n \"city\": \"Natick\",\n \"zip\": \"01701\",\n \"country\": \"US\",\n \"street2\": \"Apt 1\",\n \"state\": \"CA\",\n \"region\": \"<string>\",\n \"attention\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"address": {
"street1": "500 S Main St",
"city": "Natick",
"zip": "01701",
"country": "US",
"street2": "Apt 1",
"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>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}{
"message": "<string>",
"code": "<string>",
"details": [
{
"message": "<string>",
"code": "<string>",
"property": "<string>",
"suggestion": "<string>"
}
],
"hint": "<string>"
}Authorizations
apiKeybearerAuth & apiKey
An API key that grants access to the Connect API. You can create and manage API keys in the portal.
Headers
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 string length:
256Body
application/json
Request to check network coverage for an address.
Show child attributes
Show child attributes
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
The address that was checked.
Show child attributes
Show child attributes
Overall network coverage quality at this location.
Available options:
EXCELLENT, GOOD, FAIR, POOR, NO_COVERAGE Example:
"GOOD"
Resolved coordinates for the address, if available.
Show child attributes
Show child attributes
Which network this coverage data applies to.
Example:
"tmobile-us"
Coverage information per technology, if available.
Show child attributes
Show child attributes
The roaming status at this location, if available.