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.
- query
valuerequiredv15.0.0What the user typed.
- near
geo_pointv15.0.0Bias results towards this point : normally the map centre. Empty ranks without any geographic bias.
- bias radius (m)
numberv15.0.0How far the
nearboost reaches, in metres. Empty uses 25000. - kinds
arrayv15.0.0Restrict to
poiand/orsettlement. Empty searches both. - categories
arrayv15.0.0Array or comma-separated list of category groups. Accepts group ids (
primary_education) or Dutch synonyms (basisschool,kroegen). Empty searches every category. Useplaces_categoriesto list them. - limit
numberv15.0.0Maximum number of results. Empty uses 10.
- typo tolerance
numberv15.0.0Maximum edit distance for a fuzzy match. Empty uses 2; 0 disables typo tolerance. Short words never fuzzy-match, so
barcannot matchcar. - min confidence
numberv15.0.0Drop 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
conditionv15.0.0Collapse 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 reportmerged_countandmerged_names.
- results
arrayv15.0.0Ranked results, best first. Each carries
kind(poiorsettlement),name,subtitle,geo_point,score,category_groupandmerged_count. - best
objectv15.0.0The top result, for convenience. Empty when nothing matched.
- count
numberv15.0.0Number of results returned.
- success
conditionv15.0.0True when the query ran. An empty result is still a success.
- error
valuev15.0.0Error 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.
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 