Skip to main content
POST
Places endpoints are dashboard endpoints. They use the signed-in app session, not X-NearIQ-Key, and they are rate limited because they can call external location data providers. Reads are bounded to the fields NearIQ needs for setup and competitor discovery.
These endpoints are not public v1 API-key endpoints. They require an authenticated dashboard session and may return 401 when the session is missing.

POST /api/places/autocomplete

Returns short place suggestions for typeahead inputs. The app applies an IP rate limit and a per-user places_search daily safeguard.
string
required
Search text. At least 2 characters.

GET /api/places/search

Searches for businesses by text query and returns compact listing candidates.
string
required
Business or category query. At least 2 characters.

POST /api/places/nearby

Finds nearby business candidates around an address. This powers competitor discovery and setup suggestions.
string
required
Address or area to search around.
string
required
Business category used to choose relevant nearby candidates.
string
Optional more specific service or niche.
number
Search radius in meters. The API schema bounds this value.
number
Maximum number of returned candidates. The API schema bounds this value.

POST /api/places/reverse-geocode

Converts a map coordinate into a best-effort address label.
number
required
Latitude.
number
required
Longitude.

Errors