# 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 ### Parameters - `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 - `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 ### Returns - `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. - `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 - `"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` - `"Feature"` - `id: Optional[str]` Compound identifier in `type/osm_id` format - `type: Literal["FeatureCollection"]` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```python 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) ``` #### Response ```json { "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" } ``` ## Query features by spatial predicate, bounding box, or H3 cell `elements.query_post(ElementQueryPostParams**kwargs) -> FeatureCollection` **post** `/api/v1/features` Query features by spatial predicate, bounding box, or H3 cell ### Parameters - `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 - `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 ### Returns - `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. - `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 - `"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` - `"Feature"` - `id: Optional[str]` Compound identifier in `type/osm_id` format - `type: Literal["FeatureCollection"]` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```python 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_post() print(feature_collection.features) ``` #### Response ```json { "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" } ``` ## Get feature by type and ID `elements.retrieve(intid, ElementRetrieveParams**kwargs) -> GeoJsonFeature` **get** `/api/v1/features/{type}/{id}` Get feature by type and ID ### Parameters - `type: str` - `id: int` ### Returns - `class GeoJsonFeature: …` GeoJSON Feature representing an OSM element. Tags from the original OSM element are flattened directly into `properties` (not nested under a `tags` key). Metadata fields `@type` and `@id` identify the OSM element type and ID within properties. - `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. - `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 - `"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` - `"Feature"` - `id: Optional[str]` Compound identifier in `type/osm_id` format ### Example ```python import os from plaza import Plaza client = Plaza( api_key=os.environ.get("PLAZA_API_KEY"), # This is the default and can be omitted ) geo_json_feature = client.elements.retrieve( id=0, type="type", ) print(geo_json_feature.id) ``` #### Response ```json { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ``` ## Get feature by type and ID `elements.lookup() -> GeoJsonFeature` **post** `/api/v1/features/lookup` Get feature by type and ID ### Returns - `class GeoJsonFeature: …` GeoJSON Feature representing an OSM element. Tags from the original OSM element are flattened directly into `properties` (not nested under a `tags` key). Metadata fields `@type` and `@id` identify the OSM element type and ID within properties. - `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. - `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 - `"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` - `"Feature"` - `id: Optional[str]` Compound identifier in `type/osm_id` format ### Example ```python import os from plaza import Plaza client = Plaza( api_key=os.environ.get("PLAZA_API_KEY"), # This is the default and can be omitted ) geo_json_feature = client.elements.lookup() print(geo_json_feature.id) ``` #### Response ```json { "geometry": { "coordinates": [ 2.3522, 48.8566 ], "type": "Point" }, "properties": { "@id": "bar", "@type": "bar", "amenity": "bar", "cuisine": "bar", "name": "bar" }, "type": "Feature", "id": "node/21154906" } ``` ## Fetch multiple features by type and ID `elements.batch(ElementBatchParams**kwargs) -> FeatureCollection` **post** `/api/v1/features/batch` Fetch multiple features by type and ID ### Parameters - `elements: Iterable[Element]` Array of element references to fetch - `id: int` OSM element ID - `type: Literal["node", "way", "relation"]` OSM element type - `"node"` - `"way"` - `"relation"` ### Returns - `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. - `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 - `"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` - `"Feature"` - `id: Optional[str]` Compound identifier in `type/osm_id` format - `type: Literal["FeatureCollection"]` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```python 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.batch( elements=[{ "id": 21154906, "type": "node", }, { "id": 4589123, "type": "way", }], ) print(feature_collection.features) ``` #### Response ```json { "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" } ``` ## Find features near a geographic point `elements.nearby(ElementNearbyParams**kwargs) -> FeatureCollection` **get** `/api/v1/features/nearby` Find features near a geographic point ### Parameters - `lat: Optional[float]` Legacy shorthand. Latitude (-90 to 90). Use near param instead. - `limit: Optional[int]` Maximum results (default 20, max 100) - `lng: Optional[float]` Legacy shorthand. Longitude (-180 to 180). Use near param instead. - `near: Optional[str]` Point geometry for proximity search (lat,lng or GeoJSON). Alternative to lat/lng params. - `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[int]` Search radius in meters (default 500, max 10000) ### Returns - `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. - `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 - `"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` - `"Feature"` - `id: Optional[str]` Compound identifier in `type/osm_id` format - `type: Literal["FeatureCollection"]` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```python 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.nearby() print(feature_collection.features) ``` #### Response ```json { "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" } ``` ## Find features near a geographic point `elements.nearby_post(ElementNearbyPostParams**kwargs) -> FeatureCollection` **post** `/api/v1/features/nearby` Find features near a geographic point ### Parameters - `lat: Optional[float]` Legacy shorthand. Latitude (-90 to 90). Use near param instead. - `limit: Optional[int]` Maximum results (default 20, max 100) - `lng: Optional[float]` Legacy shorthand. Longitude (-180 to 180). Use near param instead. - `near: Optional[str]` Point geometry for proximity search (lat,lng or GeoJSON). Alternative to lat/lng params. - `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[int]` Search radius in meters (default 500, max 10000) ### Returns - `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. - `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 - `"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` - `"Feature"` - `id: Optional[str]` Compound identifier in `type/osm_id` format - `type: Literal["FeatureCollection"]` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```python 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.nearby_post() print(feature_collection.features) ``` #### Response ```json { "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" } ``` ## Domain Types ### Batch Request - `class BatchRequest: …` Fetch multiple OSM elements by their type and ID in a single request. Maximum 100 elements per batch. - `elements: List[Element]` Array of element references to fetch - `id: int` OSM element ID - `type: Literal["node", "way", "relation"]` OSM element type - `"node"` - `"way"` - `"relation"`