search places

This block is part of the places group and was last modified in core v15.0.0.

search places v15.0.0

One search box over both points of interest and settlements, with a single ranking across the two. Handles accents (Bréda finds Breda), typos (amsterdm centraal), partial words as you type, and collapses duplicate records for the same real place. Settlements outrank businesses, so Breda resolves to the municipality rather than to one of the ~2000 business names containing it. Pass near to bias results towards the current viewport. Each result carries kind, subtitle and score, so a dropdown renders straight from them.

In pins 9
  • query value required v15.0.0

    What the user typed.

  • near geo_point v15.0.0

    Bias results towards this point : normally the map centre. Empty ranks without any geographic bias.

  • bias radius (m) number v15.0.0

    How far the near boost reaches, in metres. Empty uses 25000.

  • kinds array v15.0.0

    Restrict to poi and/or settlement. Empty searches both.

  • categories array v15.0.0

    Array or comma-separated list of category groups. Accepts group ids (primary_education) or Dutch synonyms (basisschool, kroegen). Empty searches every category. Use places_categories to list them.

  • limit number v15.0.0

    Maximum number of results. Empty uses 10.

  • typo tolerance number v15.0.0

    Maximum edit distance for a fuzzy match. Empty uses 2; 0 disables typo tolerance. Short words never fuzzy-match, so bar cannot match car.

  • min confidence number v15.0.0

    Drop results below this Overture confidence (0–1). The signal is uncalibrated : median 0.80 across the Dutch dataset : so filtering may hide coverage as easily as it removes noise. Empty applies no filter.

  • dedup condition v15.0.0

    Collapse duplicate records for the same real place. On by default: Overture is not conflated, so one station can appear three times under name variants (Station Breda Centraal, Gare de Bréda, NS Station Breda). Merged results report merged_count and merged_names.

Out pins 5
  • results array v15.0.0

    Ranked results, best first. Each carries kind (poi or settlement), name, subtitle, geo_point, score, category_group and merged_count.

  • best object v15.0.0

    The top result, for convenience. Empty when nothing matched.

  • count number v15.0.0

    Number of results returned.

  • success condition v15.0.0

    True when the query ran. An empty result is still a success.

  • error value v15.0.0

    Error code when the query could not run: PLACES_NOT_AVAILABLE, QUERY_REQUIRED.

A typed query, typos and all, goes into search places. A from city point biases the ranking toward Breda, a number caps the result count, and get fields reads the name off the best match for the reply.

Studio canvas example for the search places block: one search box over every place.

Used in these guides

These documentation pages use or explain this block:

Version history

Introduced in v15.0.0.


Back to places Return to the main group to view all sub-groups Back to Places Return to the group to view all blocks within this group