Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Query

Execute an Overpass QL query

$ plaza query overpass
POST/api/v1/overpass

Execute an Overpass QL query

ParametersExpand Collapse
--data: string

Overpass QL query string

ReturnsExpand Collapse
feature_collection: object { features, type }

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

features: array of GeoJsonFeature { geometry, properties, type, 2 more }
geometry: object { coordinates, type }
coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

GeoJSON coordinates array (nesting depth varies by geometry type)

union_member_0: array of number
union_member_1: array of array of number
union_member_2: array of array of array of number
union_member_3: array of array of array of array of number
type: "Point" or "LineString" or "Polygon" or 3 more
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: map[unknown]
type: "Feature"
"Feature"
id: optional string

Feature identifier (type/osm_id)

osm_id: optional number

OpenStreetMap ID

type: "FeatureCollection"
"FeatureCollection"

Execute an Overpass QL query

plaza query overpass \
  --api-key 'My API Key' \
  --data data
Returns Examples