Skip to main content
GET
Get Internet Service Availability

Authorizations

Authorization
string
header
required

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

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

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"

data
object[]
required
meta
object
required

Session metadata, including normalized input values, formatted service address, session status, and the Hum data set used for the response.