Skip to main content
GET
Get Residential Availability Count

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

Response

200 - application/json

Residential availability count retrieval successful

data
object
message
string
Example:

"Residential Availability count successful."