Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Query

Execute an Overpass QL query

FeatureCollection Query.Overpass(QueryOverpassParamsparameters, CancellationTokencancellationToken = default)
POST/api/v1/overpass

Execute an Overpass QL query

ParametersExpand Collapse
QueryOverpassParams parameters
required string data

Overpass QL query string

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

Execute an Overpass QL query

QueryOverpassParams parameters = new() { Data = "data" };

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

Console.WriteLine(featureCollection);
Returns Examples