Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Elements

Query features by spatial predicate, bounding box, or H3 cell

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

Query features by spatial predicate, bounding box, or H3 cell

ParametersExpand Collapse
bbox: Optional[str]

Legacy shorthand. Bounding box: south,west,north,east. Use spatial predicates (near, within, intersects) instead.

contains: Optional[str]

Geometry that features must contain

crosses: Optional[str]

Geometry that features must cross

cursor: Optional[str]

Cursor for pagination

format: Optional[str]

Response format. json (default) returns paginated GeoJSON. geojson/csv/ndjson stream via chunked transfer encoding.

h3: Optional[str]

Legacy shorthand. H3 cell index. Use spatial predicates instead.

intersects: Optional[str]

Geometry that features must intersect

limit: Optional[int]

Maximum results (default 100, max 10000)

near: Optional[str]

Point geometry for proximity search (lat,lng). Requires radius.

output_buffer: Optional[float]

Buffer geometry by meters

output_centroid: Optional[bool]

Replace geometry with centroid

output_fields: Optional[str]

Comma-separated property fields to include

output_geometry: Optional[bool]

Include geometry (default true)

output_include: Optional[str]

Extra computed fields: bbox, distance, center

output_precision: Optional[int]

Coordinate decimal precision (1-15, default 7)

output_simplify: Optional[float]

Simplify geometry tolerance in meters

output_sort: Optional[str]

Sort by: distance, name, osm_id

radius: Optional[float]

Search radius in meters (for near) or buffer distance (for other predicates)

touches: Optional[str]

Geometry that features must touch

type: Optional[str]

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

within: Optional[str]

Geometry that features must be within

ReturnsExpand Collapse
class FeatureCollection: …

GeoJSON FeatureCollection (RFC 7946). For paginated endpoints, metadata is returned in HTTP response headers rather than the body:

Header Description
X-Limit Requested result limit
X-Has-More true if more results exist
X-Next-Cursor Opaque cursor for next page (cursor pagination)
X-Next-Offset Numeric offset for next page (offset pagination)
Link RFC 8288 rel="next" link to the next page

Content-Type is application/geo+json.

features: List[GeoJsonFeature]

Array of GeoJSON Feature objects

geometry: GeoJsonGeometry

GeoJSON Geometry object per RFC 7946. Coordinates use [longitude, latitude] order. 3D coordinates [lng, lat, elevation] are used for elevation endpoints.

coordinates: Union[List[float], List[List[float]], List[List[List[float]]], List[List[List[List[float]]]]]

Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc.

One of the following:
List[float]

[longitude, latitude] or [longitude, latitude, elevation]

List[List[float]]

Array of [lng, lat] positions

List[List[List[float]]]

Array of linear rings / line strings

List[List[List[List[float]]]]

Array of polygons

type: Literal["Point", "LineString", "Polygon", 3 more]

Geometry type

One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Dict[str, object]

OSM tags flattened as key-value pairs, plus @type (node/way/relation) and @id (OSM ID) metadata fields. May include distance_m for proximity queries.

type: Literal["Feature"]

Always Feature

id: Optional[str]

Compound identifier in type/osm_id format

type: Literal["FeatureCollection"]

Always FeatureCollection

Query features by spatial predicate, 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)
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "@id": "bar",
        "@type": "bar",
        "amenity": "bar",
        "cuisine": "bar",
        "name": "bar"
      },
      "type": "Feature",
      "id": "node/21154906"
    }
  ],
  "type": "FeatureCollection"
}
Returns Examples
{
  "features": [
    {
      "geometry": {
        "coordinates": [
          2.3522,
          48.8566
        ],
        "type": "Point"
      },
      "properties": {
        "@id": "bar",
        "@type": "bar",
        "amenity": "bar",
        "cuisine": "bar",
        "name": "bar"
      },
      "type": "Feature",
      "id": "node/21154906"
    }
  ],
  "type": "FeatureCollection"
}