v1

latestOpenAPI 3.0.12026-07-265331168.0 KB

Residential Availability

Search Residential Availability

Search residential avairecords with optional grouping capabilities. Use group_by parameter to aggregate results by specified field(s).

get/public/user/residential_availability/search

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

residential_availability_node_countinteger

Filter by node count

group_by'country' | 'subdivision' | 'city' | 'asn' | 'zip_code'

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

sort_bystring

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

Response

Search residential node count successful

messagestring

Example response

{
  "data": {
    "residential_options": [
      {
        "asn_id": 15169,
        "city_name": "San Francisco",
        "country_id": "US",
        "residential_availability_node_count": 100,
        "subdivision_id": "CA",
        "zip_code_alias": "94107"
      }
    ]
  },
  "message": "Residential Options search successful"
}