Skip to main content
GET
Search Residential Availability

Authorizations

X-API-Private-Key
string
header
required

Private API key for user-level authentication.

X-API-Public-Key
string
header
required

Public API key for user-level authentication.

Query Parameters

country_id
string

Filter by 2-character country code

subdivision_id
string

Filter by state/province identifier

city_name
string

Filter by city name

asn_id
integer

Filter by Autonomous System Number

zip_code_alias
string

Filter by postal/ZIP code

residential_availability_node_count
integer

Filter by node count

group_by
enum<string>

Group results by specified field(s). Multiple fields separated by commas. When grouping is used, returns aggregated node counts for each group.

Available options:
country,
subdivision,
city,
asn,
zip_code
sort_by
string

Sort results by field. Add '_desc' for descending or '_asc' for ascending. Default is descending order.

Response

200 - application/json

Search residential node count successful

data
object
message
string
Example:

"Residential Options search successful"