v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Residential Availability

Get Residential Availability Count

Get the total count of residential availability nodes with optional filtering capabilities. Filters are applied when parameters are present and not null.

get/public/user/residential_availability/count

Query parameters

country_idstring

Filter by 2-character country code

subdivision_idstring

Filter by state/province identifier

city_namestring

Filter by city name

asn_idinteger

Filter by Autonomous System Number

zip_code_aliasstring

Filter by postal/ZIP code

Response

Residential availability count retrieval successful

messagestring

Example response

{
  "data": {
    "total_residential_availability_node_count": 1500
  },
  "message": "Residential Availability count successful."
}