Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Elements

Query features by bounding box or H3 cell

elements.query(**kwargs) -> FeatureCollection { features, type }
GET/api/v1/features

Query features by bounding box or H3 cell

ParametersExpand Collapse
bbox: String

Bounding box: south,west,north,east. At least one of bbox or h3 is required.

cursor: String

Cursor for pagination

h3: String

H3 cell index. At least one of bbox or h3 is required.

limit: Integer

Maximum results (default 100, max 10000)

type: String

Element types (comma-separated: node,way,relation)

ReturnsExpand Collapse
class FeatureCollection { 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[GeoJsonFeature { geometry, properties, type, 2 more } ]
geometry: GeoJsonGeometry { coordinates, type }
coordinates: Array[Float] | Array[Array[Float]] | Array[Array[Array[Float]]] | Array[Array[Array[Array[Float]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array[Float]
Array[Array[Float]]
Array[Array[Array[Float]]]
Array[Array[Array[Array[Float]]]]
type: :Point | :LineString | :Polygon | 3 more
One of the following:
:Point
:LineString
:Polygon
:MultiPoint
:MultiLineString
:MultiPolygon
properties: Hash[Symbol, untyped]
type: :Feature
id: String

Feature identifier (type/osm_id)

osm_id: Integer

OpenStreetMap ID

type: :FeatureCollection

Query features by bounding box or H3 cell

require "plaza"

plaza = Plaza::Client.new(
  api_key: "My API Key",
  environment: "local" # defaults to "production"
)

feature_collection = plaza.elements.query

puts(feature_collection)
Returns Examples