API Reference

Search

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Search OSM features by name

FeatureCollection Search.Query(SearchQueryParamsparameters, CancellationTokencancellationToken = default)

GET/api/v1/search

Search OSM features by name

ParametersExpand Collapse

SearchQueryParams parameters

required string q

Search query string

string cursor

Cursor for pagination

Long limit

Maximum results (default 25, max 100)

ReturnsExpand Collapse

class FeatureCollection:

Bare GeoJSON FeatureCollection. Pagination metadata is returned in HTTP headers (X-Limit, X-Has-More, X-Next-Cursor, X-Next-Offset, Link).

required IReadOnlyList<GeoJsonFeature> Features

required GeoJsonGeometry Geometry

required Coordinates Coordinates

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:

IReadOnlyList<Double>

IReadOnlyList<IReadOnlyList<Double>>

IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>

IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>

required Type Type

One of the following:

"Point"Point

"LineString"LineString

"Polygon"Polygon

"MultiPoint"MultiPoint

"MultiLineString"MultiLineString

"MultiPolygon"MultiPolygon

required IReadOnlyDictionary<string, JsonElement> Properties

required Type Type

string ID

Feature identifier (type/osm_id)

Long OsmID

OpenStreetMap ID

required Type Type

Search OSM features by name

C#

HTTP

TypeScript

Python

Java

Kotlin

Go

Ruby

CLI Tool

PHP

C#

SearchQueryParams parameters = new() { Q = "q" };

var featureCollection = await client.Search.Query(parameters);

Console.WriteLine(featureCollection);

Returns Examples