Get Internet Service Availability

Authorizations

Authorization

string

header

required

Bearer token authentication using JWT tokens. Include the token in the Authorization header as: Authorization: Bearer <token>

Obtain tokens through your Hum API account dashboard or contact [email protected] for access.

Path Parameters

token

string

required

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.

message

string

required

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."

request_status

enum<string>

required

A status code summarizing the outcome of this response.

ok: Request was successful
warning: Request was processed but with some issues
error: Request failed

Available options:

ok,

warning,

error

Example:

"ok"

data

object

required

Show child attributes

data.internet

object[]

required

Show child attributes

data.internet.provider_id

string<uuid>

required

Unique identifier for the provider

Example:

"0c970c65-7b01-3fc4-91ee-4ecb31f2acb8"

data.internet.provider_name

string

required

The name of the Internet service provider.

Example:

"Rocket Fiber"

data.internet.offerings

object[]

required

Show child attributes

data.internet.offerings.technology

enum<string>

The technology used to deliver the service.

Available options:

Fiber,

Cable,

DSL,

Satellite,

Wireless,

Other

Example:

"Fiber"

data.internet.offerings.technology_category

enum<string>

The technology category used to deliver the service.

Available options:

Terrestrial,

Satellite,

Wireless,

Other

Example:

"Terrestrial"

data.internet.offerings.max_download_speed

integer

The advertised maximum download speed in Mbps.

Required range: x >= 0

Example:

1000

data.internet.offerings.max_upload_speed

integer

The advertised maximum upload speed in Mbps.

Required range: x >= 0

Example:

1000

data.internet.product_catalog

object[]

required

Array of product categories, each containing detailed product offerings from this provider

Show child attributes

data.internet.product_catalog.category

enum<string>

required

Category identifier

Available options:

internet,

internet_add_on,

mobile,

television,

television_add_on,

telephone

Example:

"internet"

data.internet.product_catalog.category_name

string

required

Human-readable category name

Example:

"Internet Service"

data.internet.product_catalog.category_description

string

required

Description of the category

Example:

"High-speed internet access plans"

data.internet.product_catalog.products

object[]

required

Show child attributes

data.internet.product_catalog.products.id

string<uuid>

required

Unique product identifier

Example:

"8083bfe8-a53f-49eb-b0e8-a77d3e9e7577"

data.internet.product_catalog.products.sku

string

required

Product SKU

Example:

"130235-INT-CBL-01"

data.internet.product_catalog.products.name

string

required

Product name

Example:

"Internet Advantage"

data.internet.product_catalog.products.category

string

required

Product category

Example:

"internet"

data.internet.product_catalog.products.category_name

string

required

Human-readable category name

Example:

"Internet Service"

data.internet.product_catalog.products.technology

enum<string>

required

Technology used for this product

Available options:

cable,

fiber,

dsl,

satellite,

wireless,

not_applicable

Example:

"cable"

data.internet.product_catalog.products.position

integer

required

Display position within category

Required range: x >= 1

Example:

1

data.internet.product_catalog.products.select_type

enum<string>

required

How this product should be displayed in UI

Available options:

radio,

checkbox

Example:

"radio"

data.internet.product_catalog.products.description

string

required

Product description

Example:

"Boosted Internet for users looking to stream and share content quickly."

data.internet.product_catalog.products.download_speed

string

required

Download speed in Mbps. Single value (e.g., '400') or hyphen-delimited range (e.g., '50-100')

Example:

"50-100"

data.internet.product_catalog.products.upload_speed

string

required

Upload speed in Mbps. Single value (e.g., '169') or hyphen-delimited range (e.g., '10-25')

Example:

"10-25"

data.internet.product_catalog.products.data_limit

string

required

Data limit display - either GB amount (e.g., "50 GB") or "Unlimited"

Example:

"Unlimited"

data.internet.product_catalog.products.channel_count

integer

required

Number of TV channels (for TV products)

Required range: x >= 0

Example:

0

data.internet.product_catalog.products.streaming_apps

string[]

required

Included streaming apps

Example:

["Disney+ Basic", "ESPN+"]

data.internet.product_catalog.products.is_required_to_checkout

boolean

required

Whether this product is required for checkout

Example:

true

data.internet.product_catalog.products.is_contract_required

boolean

required

Whether a contract is required for this product

Example:

false

data.internet.product_catalog.products.is_modem_router_included

boolean

required

Whether modem/router is included with this product

Example:

false

data.internet.product_catalog.products.is_bundle_qualifier

boolean | null

required

Whether this product qualifies for bundle discounts

Example:

null

data.internet.product_catalog.products.bundle_discounts

object

required

Bundle discount information

Example:

{}

data.internet.product_catalog.products.is_local_checkout

boolean

required

Whether checkout is available locally

Example:

true

data.internet.product_catalog.products.required_with_plans

string[]

required

Plans that this product is required with

Example:

[]

data.internet.product_catalog.products.included_with_plans

string[]

required

Plans that include this product

Example:

[]

data.internet.product_catalog.products.only_available_with_plans

string[]

required

Plans that this product is only available with

Example:

[]

data.internet.product_catalog.products.initial_term_discount_months

integer

required

Number of months for initial term discount

Required range: x >= 0

Example:

12

data.internet.product_catalog.products.second_term_discount_months

integer

required

Number of months for second term discount

Required range: x >= 0

Example:

6

data.internet.product_catalog.products.hum_rank

integer | null

required

Hum rank score for this product (0-100, higher is better)

Required range: 0 <= x <= 100

Example:

85

data.internet.product_catalog.products.max_quantity

integer

required

Maximum quantity allowed for this product

Required range: x >= 1

Example:

1

Product-level promotional information

Show child attributes

Promotional text for this product

Example:

"$50 off your first month!"

URL for the promotional icon image

Example:

"https://cdn.letshum.com/promo_icons/sale-badge.svg"

Example:

{}

data.internet.product_catalog.products.info

string

required

Additional product information

Example:

"5-year price lock guarantee"

data.internet.product_catalog.products.pricing

object

required

Detailed pricing breakdown for this product

Show child attributes

data.internet.product_catalog.products.pricing.extra_data_fee

object

required

Show child attributes

data.internet.product_catalog.products.pricing.extra_data_fee.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.extra_data_fee.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.professional_installation_fee

object

required

Show child attributes

data.internet.product_catalog.products.pricing.professional_installation_fee.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.professional_installation_fee.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.self_installation_fee

object

required

Show child attributes

data.internet.product_catalog.products.pricing.self_installation_fee.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.self_installation_fee.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.activation_fee

object

required

Show child attributes

data.internet.product_catalog.products.pricing.activation_fee.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.activation_fee.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.initial_term_discount

object

required

Show child attributes

data.internet.product_catalog.products.pricing.initial_term_discount.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.initial_term_discount.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.second_term_discount

object

required

Show child attributes

data.internet.product_catalog.products.pricing.second_term_discount.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.second_term_discount.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.autopay_discount

object

required

Show child attributes

data.internet.product_catalog.products.pricing.autopay_discount.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.autopay_discount.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.paperless_billing_discount

object

required

Show child attributes

data.internet.product_catalog.products.pricing.paperless_billing_discount.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.paperless_billing_discount.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.combined_autopay_paperless_discount

object

required

Show child attributes

data.internet.product_catalog.products.pricing.combined_autopay_paperless_discount.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.combined_autopay_paperless_discount.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.net_monthly_price

object

required

Show child attributes

data.internet.product_catalog.products.pricing.net_monthly_price.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.net_monthly_price.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.product_catalog.products.pricing.gross_monthly_fee

object

required

Show child attributes

data.internet.product_catalog.products.pricing.gross_monthly_fee.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.product_catalog.products.pricing.gross_monthly_fee.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

data.internet.telephone

string | null

The telephone number associated with the record.

Example:

"+18332981433"

data.internet.provider_icon

string<uri> | null

URL for the provider icon image

data.internet.provider_logo

string<uri> | null

The logo of the service provider.

Example:

"https://harmony.letshum.com/images/providers/rocketfiber.png"

data.internet.url

string<uri>

URL for accessing the provider website through Hum's tracking system

Example:

"https://provider.example.com/register?utm_source=Hum"

data.internet.security_token

string | null

Internal HUM token. This field is provided for informational purposes only and is not necessary for API integration or use for non-HUM purposes.

Example:

"fUdh4KG2XQDZarZvPZwSR_YRLPp5eFbD7QUTu7l-53HJ0T3nU2fjaesdOp1O2wUAO9"

data.internet.buyflow_type

enum<string>

The type of buyflow/affiliate network used for this provider's URL. 'direct' for standard provider URLs, 'cj' for Commission Junction affiliate links, 'impact' for Impact Radius affiliate links.

Available options:

direct,

cj,

impact

Example:

"direct"

data.internet.button_label

string

The text to display on the provider's call-to-action button

Example:

"Get Started"

data.internet.min_plan_price

object

Show child attributes

data.internet.min_plan_price.amount_cents

number<integer>

The price amount in whole cents. For example, $49.99 would be 4999.

Example:

4999

data.internet.min_plan_price.currency

string

The currency used for the price. USD, for example, would be US Dollars. CDN would be Canadian Dollars.

Example:

"USD"

Provider-level promotional information

Show child attributes

Promotional text from the provider

Example:

"$50 off your first month!"

Promotional logo identifier

Example:

"sale-badge"

URL for the promotional icon image

Example:

"https://cdn.letshum.com/promo_icons/banknotes.svg"

URL/buyflow-specific promotional information

Show child attributes

Promotional text specific to this URL/technology

Example:

"Limited time fiber offer!"

Promotional logo identifier

Example:

"fiber-special"

URL for the promotional icon image

Example:

"https://cdn.letshum.com/promo_icons/fiber-deal.svg"

Sessions

Service Availability

Health Check

Informational

Get Internet Service Availability

Data Provided

Response Timing

Data Freshness

Example Response

Authorizations

Path Parameters

Response