Skip to main content
GET
/
api
/
v1
/
core
/
coverage
Coverage-API
curl --request GET \
  --url https://api-stage.orchestro.ai/e1/api/v1/core/coverage \
  --header 'Authorization: <api-key>'
import requests

url = "https://api-stage.orchestro.ai/e1/api/v1/core/coverage"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api-stage.orchestro.ai/e1/api/v1/core/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://api-stage.orchestro.ai/e1/api/v1/core/coverage",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <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"
"net/http"
"io"
)

func main() {

url := "https://api-stage.orchestro.ai/e1/api/v1/core/coverage"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "<api-key>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api-stage.orchestro.ai/e1/api/v1/core/coverage")
.header("Authorization", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-stage.orchestro.ai/e1/api/v1/core/coverage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "coverage": [
    {
      "serviceType": "DGRD",
      "zip": [
        "00501",
        "00544",
        "00579",
        "04773",
        "04774",
        "04775",
        "04776",
        "04777",
        "04779",
        "04780",
        "04781",
        "04783",
        "04785"
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Query Parameters

accountNumber
string
required

The account number of the user or entity requesting the coverage information. This is a required parameter and must be passed in the query

Example:

"AC0088"

serviceType
string
required

The type of service for which coverage is being requested.

Example:

"GRD/DGRD"

Response

200 - application/json

Coverage API request Successful for GRD/DGRD

coverage
object[]
Example:
[
{
"serviceType": "GRD",
"zip": [
"01001",
"01002",
"01003",
"01004",
"01007",
"01009",
"01010",
"01013",
"01014",
"01020",
"01021",
"01022",
"01027"
]
}
]