GetCatSum

This method will return a list of categories, and the number of locations within each, given a set of criteria for a location search. This method is limited to searches in the US and Canada.

Return Value: RestCatSum

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Specify postal code, city and state (2-alpha state or province code), or latitude/longitude (degrees).

If you specify a lat/lon pair, a radius search will be performed. If you specify postal code or city/state, your configured search type (territory or radius) will be used.

If you specify a keyword, this will be used to filter results to locations containing that keyword in the name field.

You can specify a comma-delimited list of categories. This will limit the summary to locations within those categories.

Specify radius in miles.

Query Params
int32
required
string
required
string

If you specify postal code, your configured search type (territory or radius) will be used.

string

If you specify city/state, your configured search type (territory or radius) will be used.

string

2-alpha state or province code. If you specify city/state, your configured search type (territory or radius) will be used.

string

If you specify a lat/lon pair, a radius search will be performed

string

If you specify a lat/lon pair, a radius search will be performed

string

If you specify a keyword, this will be used to filter results to locations containing that keyword in the name field

string

You can specify a comma-delimited list of categories. This will limit the summary to locations within those categories.

int32

Specify radius in miles.

int32

Accepts 1 for the United States or 2 for Canada. If countryID is not provided or the value is not 1 or 2, it defaults to 1.

Responses

Language
LoadingLoading…
Response
Choose an example:
application/json