Domestic 4G and 5G Nationwide Network Coverage

`POST /v1/intelligence/wireless-coverage`

Run a request to determine network types available and available coverage. Network types covered include: CAT-M, NB-IOT, LTE, LTE-AWS, 5GNW and C-BAND. This API is applicable for FWA share/backup plans, IoT, and mobility plans. If the use case is FWA unlimited qualification, please use the Domestic 4G and 5G Fixed Wireless qualification API.

HTTP Request

POST https://thingspace.verizon.com/api/m2m/v1/intelligence/wireless-coverage

Header Parameters

The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit Getting Started.

Parameter Name	Data Type	Description
Authorization (required)	string	HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}`
VZ-M2M-Token (required)	string	A valid session token returned by a Connectivity Management `POST /session/login` request.
Content-Type (required)	string	Must be `application/json`.

Request Body

Example request:

{   "accountName":"0000123456-00001",   "requestType":"NW",   "locationType":"LONGLAT",   "locations":{      "coordinatesList":[         {            "latitude":"latitude in decimal degrees",            "longitude":"longitude in decimal degrees"         },         {            "latitude":"latitude in decimal degrees",            "longitude":"longitude in decimal degrees"         }      ],   },   "networkTypesList":[      {         "networkType":"the network type queried for"      },      {         "networkType":"the network type queried for"      }   ]}

Request Body Parameters

All parameters are required unless marked optional .

Parameter	Data Type	Description
accountName	string	The numeric name of the account, including leading zeros.
requestType	string	Set to NW for 4G and 5G Nationwide coverage.
locationType	string	Specifies the location type used for the query. LONGLAT is the value to use fo this `requestType` .
locations	object	Contains the location details to be queried.
coordinatesList	array	An array of latitude/longitude pairs being queried (up to 1,000 per request and 10,000 locations per billing account per day).
latitude	string	Latitude in decimal degrees (-90° to 90°).
longitude	string	Longitude in decimal degrees (-180° to 180°).
networkTypesList	array	An array of `networkType` objects.
networkType	string	The type of network being queried. Valid values are: CAT-M, NB-IOT, LTE, LTE-AWS, 5GNW and C-BAND Note: Only one type can be specified per object.

Success Responses

Status 200 A successful response shows a system generated request ID to track the request. Example Response:

{  "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8"}

Callback Response

These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit About Callback Services. The callback service to subscribe to is IntelligenceService.

Example callback response:

{  "username" : "the user's login information",  "password" : "the user's password",  "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8",  "intelligenceResponse": {    "wirelessCoverages": {      "domesticCoverage": [        {          "location": {            "coordinates": {              "latitude": "decimal degrees",              "longitude": "decimal degrees"            }          },          "products": [            {              "networkType": "CAT-M",              "technologies": [                {                  "type": "VZW_CATM_OPL",                  "score": "138"                },                {                  "type": "LRA_CATM_OPL",                  "score": "N/A"                }              ]            },            {              "networkType": "LTE",              "technologies": [                {                  "type": "VZW_LTE_OPL",                  "score": "120"                },                {                  "type": "LRA_LTE_OPL",                  "score": "N/A"                },                {                  "type": "EXT_LTE",                  "score": "AVL"                }              ]            }          ],          "status": "SUCCESS"        },        {          "location": {            "coordinates": {              "latitude": "decimal degrees",              "longitude": "decimal degrees"            }          },          "products": [            {              "networkType": "CAT-M",              "technologies": [                {                  "type": "VZW_CATM_OPL",                  "score": "138"                },                {                  "type": "LRA_CATM_OPL",                  "score": "N/A"                }              ]            },            {              "networkType": "LTE",              "technologies": [                {                  "type": "VZW_LTE_OPL",                  "score": "120"                },                {                  "type": "LRA_LTE_OPL",                  "score": "N/A"                },                {                  "type": "EXT_LTE",                  "score": "AVL"                }              ]            }          ],          "status": "SUCCESS"        }      ]    }  },  "status": "SUCCESS",  "callbackCount": 1,  "maxCallbackThreshold": 4}

Callback Parameters

Parameter	Data Type	Description
username	string	The user's login information.
password	object	The user's password.
requestId	string	The `requestId` being viewed. This is a system generated value from the request above.
intelligenceResponse	object	Details about the callback response.
wirelessCoverages	object	Details about the wireless coverage in the area queried.
domesticCoverage	array	An array of objects containing network information based on the location information queried.
location	object	Contains the location information being queried.
coordinates	object	Contains the latitude/longitude pair being queried.
products	array	Contains objects detailing the products and services found by the query.
networkType	string	The type of network identified. Valid values are: CAT-M, NB-IOT, LTE, LTE-AWS, 5GNW and *C-BAND.
technologies	array	What technologies have been found and how strong a connection is from the location queried.
type	string	Operational path loss measurement from the transmitting antenna to the receiving equipment using the technology below: VZW_LTE_OPL: 4G LTE on Verizon’s network LRA_LTE_OPL: 4G LTE on Verizon's LTE in Rural America program (LRA) EXT_LTE: 4G LTE from a Verizon partner VZW_AWS_OPL: 4G LTE between the 1.7 GHz to 2.2 GHz frequencies on Verizon’s network LRA_AWS_OPL: 4G LTE between the 1.7 GHz to 2.2 GHz frequencies on Verizon’s LTE in Rural America program (LRA) VZW_CATM_OPL: CAT-M on Verizon’s network LRA_CATM_OPL: CAT-M on Verizon’s LTE in Rural America program (LRA) VZW_IoT_OPL: NB-IoT on Verizon’s network VZW_NW5G: Combines lower 5G Spectrum with Verizon’s LTE network. 5G Nationwide uses Dynamic Spectrum Sharing to run 4G LTE and 5G in the same spectrum band VZW_CBAND: 5G C-Band on Verizon’s network.
score	string	For LTE/AWS/CAT-M: 120 = Excellent Coverage Quality. In general, with a higher probability, to be able to connect to the LTE data network outdoors including in vehicle. Customers should be able to connect within most buildings. In-building coverage will be affected by factors such as thickness/construction type of walls and location in the building (i.e. basement, in the middle of the building with multiple walls, etc). 133 or 138 = Border or fair coverage quality. In general, customers can expect to be able to connect to the LTE outdoors. Customers may experience “dead spots” or “loss of service” in vehicle and in-building coverage will be less likely. For NB-IoT: 143 or 148 is returned if there is coverage For 5G Nationwide coverage: 133 = Only this value is returned when there is coverage. For C-Band: AVL if 5G C-Band coverage is available. Note: this response does not take into account FWA qualification for 5G BI unlimited plans. For EXT_LTE: AVL if roaming coverage exists Null (N/A) = no coverage
status	string	Status of the products query. This will be either SUCCESS or FAILED.
status	string	The status of the `intelligenceResponse`.
callbackCount	string	The number of responses for `intelligenceResponse` found.
maxCallbackThreshold	string	The maximum number of responses for `intelligenceResponse` allowed.

Failure Responses

All error messages are returned in this format:

{  "errorCode": "The 3-digit HTML error code",  "errorMessage": "string"}

Synchronous Error when greater than 1K locations passed in one request:

{   "errorCode":"UnifiedWebService.INPUT_INVALID.MaxRequestsExceeded",   "errorMessage":"Request contains more locations than the maximum allowable of \"1000\"."}

Asynchronous Error when the 10K allotment is fully exhausted:

{   "faultcode":"UnifiedWebService.REQUEST_FAILED.TelematicsRequestUnsuccessful",   "faultstring":"REQUEST_FAILED. Number of locations exceeded daily limit. Please retry tomorrow"}

Asynchronous Error when the 10K allotment is not exhausted, but the new request will exceed the 10K limit:

{   "faultcode":"UnifiedWebService.REQUEST_FAILED.TelematicsRequestUnsuccessful",   "faultstring":"REQUEST_FAILED. Number of locations may exceed daily limit. Pending locations allowance is 998"}

# Domestic 4G and 5G Nationwide Network Coverage ### `POST /v1/intelligence/wireless-coverage` Run a request to determine network types available and available coverage. Network types covered include: CAT-M, NB-IOT, LTE, LTE-AWS, 5GNW and C-BAND. This API is applicable for FWA share/backup plans, IoT, and mobility plans. If the use case is FWA unlimited qualification, please use the [Domestic 4G and 5G Fixed Wireless qualification](https://thingspace.verizon.com/documentation/api-documentation.html#/http/thingspace-intelligence/wireless-network-performance/api-reference/domestic-4g-and-5g-fixed-wireless-qualification) API. ## HTTP Request [POST https://thingspace.verizon.com/api/m2m/v1/intelligence/wireless-coverage](/docs/premium-apis/thingspace-intelligence/api-endpoints/wireless-network-performance/domestic4gand5gnationwidenetworkcoverage) ## Header Parameters The request header must set the content-type to JSON, contain a current ThingSpace authorization token and a current VZ-M2M session token. For more details on how to get these tokens, visit [Getting Started](https://thingspace.verizon.com/documentation/api-documentation.html#/http/session-management/guides/getting-started). | Parameter Name | Data Type | Description | |----------|----------|----------| | **Authorization** *(required)* | string | HTTP Authorization request header containing a valid Bearer token: `Authorization: Bearer {token}` | | **VZ-M2M-Token** *(required)* | string | A valid session token returned by a Connectivity Management `POST /session/login` request. | | **Content-Type** *(required)* | string | Must be `application/json`. | ## Request Body Example request: ``` json { "accountName":"0000123456-00001", "requestType":"NW", "locationType":"LONGLAT", "locations":{ "coordinatesList":[ { "latitude":"latitude in decimal degrees", "longitude":"longitude in decimal degrees" }, { "latitude":"latitude in decimal degrees", "longitude":"longitude in decimal degrees" } ], }, "networkTypesList":[ { "networkType":"the network type queried for" }, { "networkType":"the network type queried for" } ] } ``` ## Request Body Parameters All parameters are required unless marked *optional* . |Parameter|Data Type|Description| |-----|------|-----| | **accountName** |string| The numeric name of the account, including leading zeros.| | **requestType** |string| Set to **NW** for 4G and 5G Nationwide coverage.| | **locationType** |string| Specifies the location type used for the query. **LONGLAT** is the value to use fo this `requestType` .| | **locations** |object| Contains the location details to be queried.| | **coordinatesList** |array| An array of latitude/longitude pairs being queried (up to 1,000 per request and 10,000 locations per billing account per day).| | **latitude** |string| Latitude in decimal degrees (-90° to 90°).| | **longitude** |string| Longitude in decimal degrees (-180° to 180°).| | **networkTypesList** |array| An array of `networkType` objects.| | **networkType** | string | The type of network being queried. Valid values are: **CAT-M**, **NB-IOT**, **LTE**, **LTE-AWS**, **5GNW** and **C-BAND** **Note:** Only one type can be specified per object. | ## Success Responses **Status 200** A successful response shows a system generated request ID to track the request. Example Response: ``` json { "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8" } ``` ## Callback Response These endpoints send responses asynchronously. In order to read the results a callback is required. To learn more about callbacks, please visit [About Callback Services](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/guides/callbacks/about-callback-services). The callback service to subscribe to is [IntelligenceService](https://thingspace.verizon.com/documentation/api-documentation.html#/http/standard-apis/connectivity-management/guides/callbacks/about-callback-services/request-body-format). Example callback response: ``` json { "username" : "the user's login information", "password" : "the user's password", "requestId": "d1f08526-eeee-ffff-gggg-4456490ea9f8", "intelligenceResponse": { "wirelessCoverages": { "domesticCoverage": [ { "location": { "coordinates": { "latitude": "decimal degrees", "longitude": "decimal degrees" } }, "products": [ { "networkType": "CAT-M", "technologies": [ { "type": "VZW_CATM_OPL", "score": "138" }, { "type": "LRA_CATM_OPL", "score": "N/A" } ] }, { "networkType": "LTE", "technologies": [ { "type": "VZW_LTE_OPL", "score": "120" }, { "type": "LRA_LTE_OPL", "score": "N/A" }, { "type": "EXT_LTE", "score": "AVL" } ] } ], "status": "SUCCESS" }, { "location": { "coordinates": { "latitude": "decimal degrees", "longitude": "decimal degrees" } }, "products": [ { "networkType": "CAT-M", "technologies": [ { "type": "VZW_CATM_OPL", "score": "138" }, { "type": "LRA_CATM_OPL", "score": "N/A" } ] }, { "networkType": "LTE", "technologies": [ { "type": "VZW_LTE_OPL", "score": "120" }, { "type": "LRA_LTE_OPL", "score": "N/A" }, { "type": "EXT_LTE", "score": "AVL" } ] } ], "status": "SUCCESS" } ] } }, "status": "SUCCESS", "callbackCount": 1, "maxCallbackThreshold": 4 } ``` ## Callback Parameters |Parameter|Data Type|Description| |-----|-----|-----| | **username** |string| The user's login information.| | **password** |object| The user's password. | | **requestId** |string| The `requestId` being viewed. This is a system generated value from the request above.| | **intelligenceResponse** |object| Details about the callback response. | | **wirelessCoverages** |object| Details about the wireless coverage in the area queried.| | **domesticCoverage** |array| An array of objects containing network information based on the location information queried. | | **location** |object| Contains the location information being queried. | | **coordinates** |object| Contains the latitude/longitude pair being queried. | |**products** | array | Contains objects detailing the products and services found by the query. | | **networkType** |string| The type of network identified. Valid values are: **CAT-M**, **NB-IOT**, **LTE**, **LTE-AWS**, **5GNW** and ***C-BAND**. | | **technologies** | array | What technologies have been found and how strong a connection is from the location queried. | | **type** |string| Operational path loss measurement from the transmitting antenna to the receiving equipment using the technology below: **VZW_LTE_OPL:** 4G LTE on Verizon’s network **LRA_LTE_OPL:** 4G LTE on Verizon's LTE in Rural America program (LRA) **EXT_LTE:** 4G LTE from a Verizon partner **VZW_AWS_OPL:** 4G LTE between the 1.7 GHz to 2.2 GHz frequencies on Verizon’s network **LRA_AWS_OPL:** 4G LTE between the 1.7 GHz to 2.2 GHz frequencies on Verizon’s LTE in Rural America program (LRA) **VZW_CATM_OPL:** CAT-M on Verizon’s network **LRA_CATM_OPL:** CAT-M on Verizon’s LTE in Rural America program (LRA) **VZW_IoT_OPL:** NB-IoT on Verizon’s network **VZW_NW5G:** Combines lower 5G Spectrum with Verizon’s LTE network. 5G Nationwide uses Dynamic Spectrum Sharing to run 4G LTE and 5G in the same spectrum band **VZW_CBAND:** 5G C-Band on Verizon’s network.| | **score** |string| **For LTE/AWS/CAT-M:** **120** = Excellent Coverage Quality. In general, with a higher probability, to be able to connect to the LTE data network outdoors including in vehicle. Customers should be able to connect within most buildings. In-building coverage will be affected by factors such as thickness/construction type of walls and location in the building (i.e. basement, in the middle of the building with multiple walls, etc). **133 or 138** = Border or fair coverage quality. In general, customers can expect to be able to connect to the LTE outdoors. Customers may experience “dead spots” or “loss of service” in vehicle and in-building coverage will be less likely. **For NB-IoT:** **143 or 148** is returned if there is coverage **For 5G Nationwide coverage:** **133** = Only this value is returned when there is coverage. **For C-Band:** **AVL** if 5G C-Band coverage is available. **Note:** this response does not take into account FWA qualification for 5G BI unlimited plans. **For EXT_LTE:** **AVL** if roaming coverage exists **Null (N/A)** = no coverage | | **status** |string| Status of the products query. This will be either **SUCCESS** or **FAILED**. | | **status** |string| The status of the `intelligenceResponse`. | | **callbackCount** |string| The number of responses for `intelligenceResponse` found.| | **maxCallbackThreshold** |string| The maximum number of responses for `intelligenceResponse` allowed. | ## Failure Responses All error messages are returned in this format: ``` json { "errorCode": "The 3-digit HTML error code", "errorMessage": "string" } ``` Synchronous Error when greater than 1K locations passed in one request: ```json { "errorCode":"UnifiedWebService.INPUT_INVALID.MaxRequestsExceeded", "errorMessage":"Request contains more locations than the maximum allowable of \"1000\"." } ``` Asynchronous Error when the 10K allotment is fully exhausted: ```json { "faultcode":"UnifiedWebService.REQUEST_FAILED.TelematicsRequestUnsuccessful", "faultstring":"REQUEST_FAILED. Number of locations exceeded daily limit. Please retry tomorrow" } ``` Asynchronous Error when the 10K allotment is not exhausted, but the new request will exceed the 10K limit: ```json { "faultcode":"UnifiedWebService.REQUEST_FAILED.TelematicsRequestUnsuccessful", "faultstring":"REQUEST_FAILED. Number of locations may exceed daily limit. Pending locations allowance is 998" } ```