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 required
v15.0.0valueWhat the user typed.
- near
v15.0.0geo_pointBias results towards this point : normally the map centre. Empty ranks without any geographic bias.
- bias radius (m)
v15.0.0numberHow far the
nearboost reaches, in metres. Empty uses 25000. - kinds
v15.0.0arrayRestrict to
poiand/orsettlement. Empty searches both. - categories
v15.0.0arrayArray 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
v15.0.0numberMaximum number of results. Empty uses 10.
- typo tolerance
v15.0.0numberMaximum edit distance for a fuzzy match. Empty uses 2; 0 disables typo tolerance. Short words never fuzzy-match, so
barcannot matchcar. - min confidence
v15.0.0numberDrop 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
v15.0.0conditionCollapse 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
v15.0.0arrayRanked results, best first. Each carries
kind(poiorsettlement),name,subtitle,geo_point,score,category_groupandmerged_count. - best
v15.0.0objectThe top result, for convenience. Empty when nothing matched.
- count
v15.0.0numberNumber of results returned.
- success
v15.0.0conditionTrue when the query ran. An empty result is still a success.
- error
v15.0.0valueError code when the query could not run:
PLACES_NOT_AVAILABLE,QUERY_REQUIRED.
Core Releases
v15.0.0 This block was introduced inv15.0.0, click here to see the release notes. 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
