Endpoints
Places
Session-authenticated location search endpoints used during business setup, competitor add, and map workflows.
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-userplaces_search daily safeguard.
Search text. At least 2 characters.
GET /api/places/search
Searches for businesses by text query and returns compact listing candidates.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.Address or area to search around.
Business category used to choose relevant nearby candidates.
Optional more specific service or niche.
Search radius in meters. The API schema bounds this value.
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.Latitude.
Longitude.
Errors
| Status | Meaning |
|---|---|
400 | Invalid request body or query |
401 | Missing dashboard session |
429 | IP or places_search daily safeguard exceeded |
500 | Location search is not configured |
502 | External location lookup failed |