Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Elements

Query features by bounding box or H3 cell

elements.query(ElementQueryParams**kwargs) -> FeatureCollection
GET/api/v1/features

Query features by bounding box or H3 cell

ParametersExpand Collapse
bbox: Optional[str]

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

cursor: Optional[str]

Cursor for pagination

h3: Optional[str]

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

limit: Optional[int]

Maximum results (default 100, max 10000)

type: Optional[str]

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

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).

features: List[GeoJsonFeature]
geometry: GeoJsonGeometry
coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
List[float]
List[List[float]]
List[List[List[float]]]
List[List[List[List[float]]]]
type: Literal["Point", "LineString", "Polygon", 3 more]
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Dict[str, object]
type: Literal["Feature"]
id: Optional[str]

Feature identifier (type/osm_id)

osm_id: Optional[int]

OpenStreetMap ID

type: Literal["FeatureCollection"]

Query features by bounding box or H3 cell

import os
from plaza import Plaza

client = Plaza(
    api_key=os.environ.get("PLAZA_API_KEY"),  # This is the default and can be omitted
)
feature_collection = client.elements.query()
print(feature_collection.features)
Returns Examples