Search parameters (either GeometrySearchParams or FuzzySearchParams)
OptionalcustomTemplate: Partial<GeometrySearchTemplate | FuzzySearchTemplate>Advanced customization for request/response handling
Promise resolving to a collection of matching places
The search service provides:
Results are ranked by relevance with scores and optional distances.
// Free-text search near a location
const results = await search({
key: 'your-api-key',
query: 'pizza restaurant',
at: [4.9041, 52.3676], // Amsterdam
limit: 10
});
// Search within a specific area
const areaResults = await search({
key: 'your-api-key',
query: 'coffee shop',
geometries: [polygon], // Search within this polygon
limit: 20
});
// Category search
const restaurants = await search({
key: 'your-api-key',
query: 'restaurant',
categorySet: [7315], // Restaurant category
at: [4.9041, 52.3676],
radius: 5000 // Within 5km
});
Universal search function for finding places by text query or within geometries.
This is a unified interface that automatically routes to either: