Skip to main content
POST
/
api
/
places
/
autocomplete
curl -X POST "https://app.neariq.io/api/places/autocomplete" \
  -H "Content-Type: application/json" \
  -H "Cookie: <dashboard session cookie>" \
  -d '{ "input": "Aster Grove Fit" }'
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.
curl -X POST "https://app.neariq.io/api/places/autocomplete" \
  -H "Content-Type: application/json" \
  -H "Cookie: <dashboard session cookie>" \
  -d '{ "input": "Aster Grove Fit" }'
input
string
required
Search text. At least 2 characters.
{
  "suggestions": [
    {
      "placeId": "ChIJ123...",
      "text": "Aster Grove Fitness, Austin, TX",
      "mainText": "Aster Grove Fitness",
      "secondaryText": "Austin, TX"
    }
  ]
}

GET /api/places/search

Searches for businesses by text query and returns compact listing candidates.
curl "https://app.neariq.io/api/places/search?q=coffee%20shop%20austin" \
  -H "Cookie: <dashboard session cookie>"
q
string
required
Business or category query. At least 2 characters.
{
  "results": [
    {
      "place_id": "ChIJ123...",
      "name": "Aster Grove Coffee",
      "address": "100 Market St, Austin, TX",
      "rating": 4.8,
      "review_count": 188,
      "types": ["cafe", "food"],
      "website_url": "https://example.com"
    }
  ]
}

POST /api/places/nearby

Finds nearby business candidates around an address. This powers competitor discovery and setup suggestions.
curl -X POST "https://app.neariq.io/api/places/nearby" \
  -H "Content-Type: application/json" \
  -H "Cookie: <dashboard session cookie>" \
  -d '{
    "address": "100 Market St, Austin, TX",
    "category": "Fitness",
    "subcategory": "Pilates studio",
    "radius_meters": 3000,
    "max_results": 8
  }'
address
string
required
Address or area to search around.
category
string
required
Business category used to choose relevant nearby candidates.
subcategory
string
Optional more specific service or niche.
radius_meters
number
Search radius in meters. The API schema bounds this value.
max_results
number
Maximum number of returned candidates. The API schema bounds this value.
{
  "results": [
    {
      "place_id": "ChIJ456...",
      "name": "Apex Grove Strength",
      "address": "210 Example Ave, Austin, TX",
      "rating": 4.7,
      "review_count": 312,
      "types": ["gym", "health"]
    }
  ],
  "center": {
    "latitude": 30.2672,
    "longitude": -97.7431
  }
}

POST /api/places/reverse-geocode

Converts a map coordinate into a best-effort address label.
curl -X POST "https://app.neariq.io/api/places/reverse-geocode" \
  -H "Content-Type: application/json" \
  -H "Cookie: <dashboard session cookie>" \
  -d '{ "lat": 30.2672, "lng": -97.7431 }'
lat
number
required
Latitude.
lng
number
required
Longitude.
{
  "address": "100 Market St, Austin, TX"
}

Errors

StatusMeaning
400Invalid request body or query
401Missing dashboard session
429IP or places_search daily safeguard exceeded
500Location search is not configured
502External location lookup failed