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

Request

Base URL
https://api.byteful.com/1.0
Auth
API key in header X-API-Private-Key and API key in header X-API-Public-Key
TypeScript
https://skmtc.dev/byteful/apis/byteful-public-user-api/docs/public/user/residential_availability/count/get.ts
A function with typed inputs. Its response is checked against the schema.

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

Changes

No recorded changes to this operation across all 1 revision of this API.