Get Internet Service Availability
curl --request GET \
--url https://api-sandbox.letshum.com/sessions/{token}/services/internet \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.letshum.com/sessions/{token}/services/internet"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.letshum.com/sessions/{token}/services/internet', 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-sandbox.letshum.com/sessions/{token}/services/internet",
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: Bearer <token>"
],
]);
$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-sandbox.letshum.com/sessions/{token}/services/internet"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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-sandbox.letshum.com/sessions/{token}/services/internet")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.letshum.com/sessions/{token}/services/internet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "What happened in the most recent request.",
"request_status": "ok",
"data": [
{
"provider_id": "130317",
"provider_name": "Rocket Fiber",
"telephone": "+18332981433",
"provider_icon": "<string>",
"provider_logo": "https://harmony.letshum.com/images/providers/rocketfiber.png",
"url": "https://provider.example.com/register?utm_source=Hum",
"button_label": "Get Started",
"min_plan_price": {
"amount_cents": 4999,
"currency": "USD"
},
"provider_promo": {
"promo_text": "$50 off your first month!",
"promo_logo": "sale-badge",
"promo_logo_url": "https://cdn.letshum.com/promo_icons/banknotes.svg"
},
"url_promo": {
"promo_text": "Limited time fiber offer!",
"promo_logo": "fiber-special",
"promo_logo_url": "https://cdn.letshum.com/promo_icons/fiber-deal.svg"
},
"offerings": [
{
"technology": "Fiber",
"max_download_speed": 1000,
"max_upload_speed": 1000
}
],
"product_catalog": [
{
"category": "internet",
"category_name": "Internet Service",
"category_description": "High-speed internet access plans",
"products": [
{
"id": "8083bfe8-a53f-49eb-b0e8-a77d3e9e7577",
"sku": "130235-INT-CBL-01",
"name": "Internet Advantage",
"category": "internet",
"category_name": "Internet Service",
"technology": "cable",
"position": 1,
"select_type": "radio",
"description": "Boosted Internet for users looking to stream and share content quickly.",
"download_speed": "50-100",
"upload_speed": "10-25",
"data_limit": "Unlimited",
"channel_count": 0,
"streaming_apps": [
"Disney+ Basic",
"ESPN+"
],
"is_required_to_checkout": true,
"is_contract_required": false,
"is_modem_router_included": false,
"is_bundle_qualifier": null,
"bundle_discounts": {},
"is_local_checkout": true,
"required_with_plans": [],
"included_with_plans": [],
"only_available_with_plans": [],
"initial_term_discount_months": 12,
"second_term_discount_months": null,
"hum_rank": 85,
"max_quantity": 1,
"product_promo": {},
"info": "5-year price lock guarantee",
"pricing": {
"extra_data_fee": {
"amount_cents": 4999,
"currency": "USD"
},
"professional_installation_fee": {
"amount_cents": 4999,
"currency": "USD"
},
"self_installation_fee": {
"amount_cents": 4999,
"currency": "USD"
},
"activation_fee": {
"amount_cents": 4999,
"currency": "USD"
},
"initial_term_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"second_term_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"third_term_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"autopay_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"paperless_billing_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"combined_autopay_paperless_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"net_monthly_price": {
"amount_cents": 4999,
"currency": "USD"
},
"gross_monthly_fee": {
"amount_cents": 4999,
"currency": "USD"
}
}
}
]
}
]
}
],
"meta": {
"session_token": "XqCmeTVgYXrbWrZFZEymkD",
"session_status": "open",
"agent_status": {
"geocoding": "matched",
"internet": "matched",
"checkout": "pending"
},
"session_params": {
"street1": "29090 Tiffany Dr E",
"street2": null,
"city": "Southfield",
"state": "MI",
"zip": "48034",
"latitude": "42.50189",
"longitude": "-83.29528",
"campaign_id": null
},
"service_address": "1420 Washington Blvd, Detroit, MI 48201",
"mdu": false,
"created_at": "2024-09-20T23:13:31.179Z",
"updated_at": "2024-09-20T23:13:31.179Z",
"responded_at": "2024-09-20T23:13:31.179Z",
"hum_data_set": "25041808"
},
"qualify_status": "available"
}Service Availability
Get Internet Service Availability
Retrieves available Internet service providers and their offerings for the service address associated with the current session.
Data Provided
- Internet Service Providers (ISPs)
- Available plans and pricing
- Technology types (Fiber, Cable, DSL, etc.)
- Maximum speeds
- Provider contact information
- Checkout URLs
Data Freshness
Provider and product data comes from the current Hum data set identified by meta.hum_data_set.
Example Response
{
"message": "Service coverage for 29090 TIFFANY DR E, SOUTHFIELD, MI 48034",
"request_status": "ok",
"data": [
{
"provider_id": "130317",
"provider_name": "Xfinity",
"telephone": "+18332981431",
"provider_icon": null,
"provider_logo": "https://cdn.example.com/providers/xfinity-logo.png",
"url": "https://affiliate.example.com/xfinity?session=SESSION_TOKEN",
"button_label": "xfinity.com",
"min_plan_price": {
"amount_cents": 4000,
"currency": "USD"
},
"provider_promo": {},
"url_promo": {},
"offerings": [
{
"technology": "Cable",
"max_download_speed": 1200,
"max_upload_speed": 35
}
],
"product_catalog": []
}
],
"meta": {
"session_token": "SESSION_TOKEN_PLACEHOLDER",
"session_status": "open",
"session_params": {
"street1": "29090 Tiffany Dr E",
"street2": null,
"city": "Southfield",
"state": "MI",
"zip": "48034",
"latitude": "42.50189",
"longitude": "-83.29528",
"campaign_id": null
},
"service_address": "29090 Tiffany Dr E, Southfield, MI 48034-4540",
"mdu": false,
"agent_status": {
"geocoding": "matched",
"internet": "matched",
"checkout": "pending"
},
"created_at": "2026-07-13T12:26:15.618-04:00",
"updated_at": "2026-07-13T12:26:15.618-04:00",
"responded_at": "2026-07-13T16:26:17.471Z",
"hum_data_set": "26011015"
}
}
Note: Some providers may return an empty product_catalog array.
GET
/
sessions
/
{token}
/
services
/
internet
Get Internet Service Availability
curl --request GET \
--url https://api-sandbox.letshum.com/sessions/{token}/services/internet \
--header 'Authorization: Bearer <token>'import requests
url = "https://api-sandbox.letshum.com/sessions/{token}/services/internet"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api-sandbox.letshum.com/sessions/{token}/services/internet', 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-sandbox.letshum.com/sessions/{token}/services/internet",
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: Bearer <token>"
],
]);
$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-sandbox.letshum.com/sessions/{token}/services/internet"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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-sandbox.letshum.com/sessions/{token}/services/internet")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-sandbox.letshum.com/sessions/{token}/services/internet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"message": "What happened in the most recent request.",
"request_status": "ok",
"data": [
{
"provider_id": "130317",
"provider_name": "Rocket Fiber",
"telephone": "+18332981433",
"provider_icon": "<string>",
"provider_logo": "https://harmony.letshum.com/images/providers/rocketfiber.png",
"url": "https://provider.example.com/register?utm_source=Hum",
"button_label": "Get Started",
"min_plan_price": {
"amount_cents": 4999,
"currency": "USD"
},
"provider_promo": {
"promo_text": "$50 off your first month!",
"promo_logo": "sale-badge",
"promo_logo_url": "https://cdn.letshum.com/promo_icons/banknotes.svg"
},
"url_promo": {
"promo_text": "Limited time fiber offer!",
"promo_logo": "fiber-special",
"promo_logo_url": "https://cdn.letshum.com/promo_icons/fiber-deal.svg"
},
"offerings": [
{
"technology": "Fiber",
"max_download_speed": 1000,
"max_upload_speed": 1000
}
],
"product_catalog": [
{
"category": "internet",
"category_name": "Internet Service",
"category_description": "High-speed internet access plans",
"products": [
{
"id": "8083bfe8-a53f-49eb-b0e8-a77d3e9e7577",
"sku": "130235-INT-CBL-01",
"name": "Internet Advantage",
"category": "internet",
"category_name": "Internet Service",
"technology": "cable",
"position": 1,
"select_type": "radio",
"description": "Boosted Internet for users looking to stream and share content quickly.",
"download_speed": "50-100",
"upload_speed": "10-25",
"data_limit": "Unlimited",
"channel_count": 0,
"streaming_apps": [
"Disney+ Basic",
"ESPN+"
],
"is_required_to_checkout": true,
"is_contract_required": false,
"is_modem_router_included": false,
"is_bundle_qualifier": null,
"bundle_discounts": {},
"is_local_checkout": true,
"required_with_plans": [],
"included_with_plans": [],
"only_available_with_plans": [],
"initial_term_discount_months": 12,
"second_term_discount_months": null,
"hum_rank": 85,
"max_quantity": 1,
"product_promo": {},
"info": "5-year price lock guarantee",
"pricing": {
"extra_data_fee": {
"amount_cents": 4999,
"currency": "USD"
},
"professional_installation_fee": {
"amount_cents": 4999,
"currency": "USD"
},
"self_installation_fee": {
"amount_cents": 4999,
"currency": "USD"
},
"activation_fee": {
"amount_cents": 4999,
"currency": "USD"
},
"initial_term_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"second_term_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"third_term_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"autopay_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"paperless_billing_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"combined_autopay_paperless_discount": {
"amount_cents": 4999,
"currency": "USD"
},
"net_monthly_price": {
"amount_cents": 4999,
"currency": "USD"
},
"gross_monthly_fee": {
"amount_cents": 4999,
"currency": "USD"
}
}
}
]
}
]
}
],
"meta": {
"session_token": "XqCmeTVgYXrbWrZFZEymkD",
"session_status": "open",
"agent_status": {
"geocoding": "matched",
"internet": "matched",
"checkout": "pending"
},
"session_params": {
"street1": "29090 Tiffany Dr E",
"street2": null,
"city": "Southfield",
"state": "MI",
"zip": "48034",
"latitude": "42.50189",
"longitude": "-83.29528",
"campaign_id": null
},
"service_address": "1420 Washington Blvd, Detroit, MI 48201",
"mdu": false,
"created_at": "2024-09-20T23:13:31.179Z",
"updated_at": "2024-09-20T23:13:31.179Z",
"responded_at": "2024-09-20T23:13:31.179Z",
"hum_data_set": "25041808"
},
"qualify_status": "available"
}Authorizations
Bearer token authentication using API tokens.
Include the token in the Authorization header as: Authorization: Bearer <token>
Obtain tokens from your Hum representative or contact support@letshum.com. There is no self-serve API key dashboard.
Path Parameters
The session token identifying the specific session The session token provided by the Hum API. Used to connect the response to the session in the client system.
Example:
"XqCmeTVgYXrbWrZFZEymkD"
Response
Internet service providers, available plans, and logos/urls for a given service address.
A message returned by the API. Includes a human-readable message about the status of the request.
Example:
"What happened in the most recent request."
An informational summary returned in API response bodies: ok for successful responses, warning for standard request errors, and error for endpoint-specific failures. Integrations must use the HTTP status code, not request_status, to determine whether a request succeeded.
Available options:
ok, warning, error Example:
"ok"
Show child attributes
Show child attributes
Session metadata, including normalized input values, formatted service address, session status, and the Hum data set used for the response.
Show child attributes
Show child attributes
The status of Internet service qualification for the address distinguishes a completed lookup from one that is not ready yet.
The answer is ready:
available: Providers were found and are returned indata.no_service: No providers serve this address.datais[]. You can act on this now, but Hum re-checks periodically, so re-validate it if you store it long term.
The answer is not ready, keep polling:
pending: The lookup has not finished.datais[]. Retry by pollingGET /sessions/{token}/services/internet.retry_later: A transient upstream problem.datais[]. Retry by pollingGET /sessions/{token}/services/internet.
Something went wrong:
failed: The lookup errored for this address.datais[].
A pending lookup finishes as one of three values: available when providers are found, no_service when the lookup completes and finds none, or failed when it errors. retry_later arises separately and does not follow from pending. These three values should end the polling loop.
Available options:
available, no_service, pending, failed, retry_later Example:
"available"
Was this page helpful?