PAparallel-web
Place Search

Place search

Changed on

Searches for places such as restaurants, shops and attractions.

post/v1/places/search

Request

  • Base URL
    https://api.parallel.ai
  • Auth
    API key in header x-api-key

Request body

querystring required

What to find, e.g. ramen, 24 hour pharmacy or a place's name.

locationstring nullable

Where to search: a city, neighborhood, address or postal code. Set this, latitude and longitude, or both; a request with neither is rejected.

latitudenumber nullable

Search center latitude; set with longitude.

longitudenumber nullable

Search center longitude; set with latitude.

max_distance_kmnumber nullable

Only places within this many km of the search center. Defaults to the size of location when it is a city or postal code, else 25.

open_nowboolean

Only places open at request time, in each place's own time zone. Places whose open state is unknown are left out.

max_resultsinteger nullable

Upper bound on results. Defaults to 10; values above the mode's maximum are reduced to it, with a warning.

mode'fast' | 'advanced' nullable

fast: lowest latency, with fewer results. advanced (default): slower, with more complete results.

session_idstring nullable

Session identifier that groups related calls made as part of a larger task. Echoed back in the response when nonempty; generated by the server if omitted, null, or empty.

client_modelstring nullable

The model generating this request and consuming the results.

Example request

{
  "location": "Shibuya, Tokyo",
  "client_model": "claude-opus-4-7"
}

Response

Successful Response

search_idstring required

Search ID. Example: search_cad0a6d2dec046bd95ae900527d880e7

session_idstring required

Session identifier, echoed back from the request when nonempty; otherwise generated by the server. Pass it to later calls made as part of the same task.

Example response

{
  "session_id": "session_8a911eb27c7a4afaa20d0d9dc98d07c0",
  "warnings": [
    {
      "type": "spec_validation_warning"
    }
  ],
  "usage": [
    {
      "name": "sku_search",
      "count": 1
    }
  ]
}

Changes