# Elements ## Query features by spatial predicate, bounding box, or H3 cell `client.elements.query(ElementQueryParamsquery?, RequestOptionsoptions?): FeatureCollection` **get** `/api/v1/features` Query features by spatial predicate, bounding box, or H3 cell ### Parameters - `query: ElementQueryParams` - `bbox?: string` Legacy shorthand. Bounding box: south,west,north,east. Use spatial predicates (near, within, intersects) instead. - `contains?: string` Geometry that features must contain - `crosses?: string` Geometry that features must cross - `cursor?: string` Cursor for pagination - `h3?: string` Legacy shorthand. H3 cell index. Use spatial predicates instead. - `intersects?: string` Geometry that features must intersect - `limit?: number` Maximum results (default 100, max 10000) - `near?: string` Point geometry for proximity search (lat,lng). Requires radius. - `outputBuffer?: number` Buffer geometry by meters - `outputCentroid?: boolean` Replace geometry with centroid - `outputFields?: string` Comma-separated property fields to include - `outputGeometry?: boolean` Include geometry (default true) - `outputInclude?: string` Extra computed fields: bbox, distance, center - `outputPrecision?: number` Coordinate decimal precision (1-15, default 7) - `outputSimplify?: number` Simplify geometry tolerance in meters - `outputSort?: string` Sort by: distance, name, osm_id - `radius?: number` Search radius in meters (for near) or buffer distance (for other predicates) - `touches?: string` Geometry that features must touch - `type?: string` Element types (comma-separated: node,way,relation) - `within?: string` Geometry that features must be within ### Returns - `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: Array` 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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Record` 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: "Feature"` Always `Feature` - `"Feature"` - `id?: string` Compound identifier in `type/osm_id` format - `type: "FeatureCollection"` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const featureCollection = await client.elements.query(); console.log(featureCollection.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 `client.elements.queryPost(ElementQueryPostParamsparams?, RequestOptionsoptions?): FeatureCollection` **post** `/api/v1/features` Query features by spatial predicate, bounding box, or H3 cell ### Parameters - `params: ElementQueryPostParams` - `bbox?: string` Legacy shorthand. Bounding box: south,west,north,east. Use spatial predicates (near, within, intersects) instead. - `contains?: string` Geometry that features must contain - `crosses?: string` Geometry that features must cross - `cursor?: string` Cursor for pagination - `h3?: string` Legacy shorthand. H3 cell index. Use spatial predicates instead. - `intersects?: string` Geometry that features must intersect - `limit?: number` Maximum results (default 100, max 10000) - `near?: string` Point geometry for proximity search (lat,lng). Requires radius. - `outputBuffer?: number` Buffer geometry by meters - `outputCentroid?: boolean` Replace geometry with centroid - `outputFields?: string` Comma-separated property fields to include - `outputGeometry?: boolean` Include geometry (default true) - `outputInclude?: string` Extra computed fields: bbox, distance, center - `outputPrecision?: number` Coordinate decimal precision (1-15, default 7) - `outputSimplify?: number` Simplify geometry tolerance in meters - `outputSort?: string` Sort by: distance, name, osm_id - `radius?: number` Search radius in meters (for near) or buffer distance (for other predicates) - `touches?: string` Geometry that features must touch - `type?: string` Element types (comma-separated: node,way,relation) - `within?: string` Geometry that features must be within ### Returns - `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: Array` 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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Record` 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: "Feature"` Always `Feature` - `"Feature"` - `id?: string` Compound identifier in `type/osm_id` format - `type: "FeatureCollection"` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const featureCollection = await client.elements.queryPost(); console.log(featureCollection.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 `client.elements.retrieve(numberid, ElementRetrieveParamsparams, RequestOptionsoptions?): GeoJsonFeature` **get** `/api/v1/features/{type}/{id}` Get feature by type and ID ### Parameters - `id: number` - `params: ElementRetrieveParams` - `type: string` Element type (node, way, relation) ### Returns - `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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Record` 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: "Feature"` Always `Feature` - `"Feature"` - `id?: string` Compound identifier in `type/osm_id` format ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const geoJsonFeature = await client.elements.retrieve(0, { type: 'type' }); console.log(geoJsonFeature.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 `client.elements.lookup(RequestOptionsoptions?): GeoJsonFeature` **post** `/api/v1/features/lookup` Get feature by type and ID ### Returns - `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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Record` 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: "Feature"` Always `Feature` - `"Feature"` - `id?: string` Compound identifier in `type/osm_id` format ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const geoJsonFeature = await client.elements.lookup(); console.log(geoJsonFeature.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 `client.elements.batch(ElementBatchParamsbody, RequestOptionsoptions?): FeatureCollection` **post** `/api/v1/features/batch` Fetch multiple features by type and ID ### Parameters - `body: ElementBatchParams` - `elements: Array` Array of element references to fetch - `id: number` OSM element ID - `type: "node" | "way" | "relation"` OSM element type - `"node"` - `"way"` - `"relation"` ### Returns - `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: Array` 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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Record` 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: "Feature"` Always `Feature` - `"Feature"` - `id?: string` Compound identifier in `type/osm_id` format - `type: "FeatureCollection"` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const featureCollection = await client.elements.batch({ elements: [ { id: 21154906, type: 'node' }, { id: 4589123, type: 'way' }, ], }); console.log(featureCollection.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 `client.elements.nearby(ElementNearbyParamsquery?, RequestOptionsoptions?): FeatureCollection` **get** `/api/v1/features/nearby` Find features near a geographic point ### Parameters - `query: ElementNearbyParams` - `lat?: number` Legacy shorthand. Latitude (-90 to 90). Use near param instead. - `limit?: number` Maximum results (default 20, max 100) - `lng?: number` Legacy shorthand. Longitude (-180 to 180). Use near param instead. - `near?: string` Point geometry for proximity search (lat,lng or GeoJSON). Alternative to lat/lng params. - `outputBuffer?: number` Buffer geometry by meters - `outputCentroid?: boolean` Replace geometry with centroid - `outputFields?: string` Comma-separated property fields to include - `outputGeometry?: boolean` Include geometry (default true) - `outputInclude?: string` Extra computed fields: bbox, distance, center - `outputPrecision?: number` Coordinate decimal precision (1-15, default 7) - `outputSimplify?: number` Simplify geometry tolerance in meters - `outputSort?: string` Sort by: distance, name, osm_id - `radius?: number` Search radius in meters (default 500, max 10000) ### Returns - `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: Array` 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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Record` 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: "Feature"` Always `Feature` - `"Feature"` - `id?: string` Compound identifier in `type/osm_id` format - `type: "FeatureCollection"` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const featureCollection = await client.elements.nearby(); console.log(featureCollection.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 `client.elements.nearbyPost(ElementNearbyPostParamsparams?, RequestOptionsoptions?): FeatureCollection` **post** `/api/v1/features/nearby` Find features near a geographic point ### Parameters - `params: ElementNearbyPostParams` - `lat?: number` Legacy shorthand. Latitude (-90 to 90). Use near param instead. - `limit?: number` Maximum results (default 20, max 100) - `lng?: number` Legacy shorthand. Longitude (-180 to 180). Use near param instead. - `near?: string` Point geometry for proximity search (lat,lng or GeoJSON). Alternative to lat/lng params. - `outputBuffer?: number` Buffer geometry by meters - `outputCentroid?: boolean` Replace geometry with centroid - `outputFields?: string` Comma-separated property fields to include - `outputGeometry?: boolean` Include geometry (default true) - `outputInclude?: string` Extra computed fields: bbox, distance, center - `outputPrecision?: number` Coordinate decimal precision (1-15, default 7) - `outputSimplify?: number` Simplify geometry tolerance in meters - `outputSort?: string` Sort by: distance, name, osm_id - `radius?: number` Search radius in meters (default 500, max 10000) ### Returns - `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: Array` 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: Array | Array> | Array>> | Array>>>` Coordinates array. Nesting depth varies by geometry type: Point = [lng, lat], LineString = [[lng, lat], ...], Polygon = [[[lng, lat], ...], ...], etc. - `Array` - `Array>` - `Array>>` - `Array>>>` - `type: "Point" | "LineString" | "Polygon" | 3 more` Geometry type - `"Point"` - `"LineString"` - `"Polygon"` - `"MultiPoint"` - `"MultiLineString"` - `"MultiPolygon"` - `properties: Record` 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: "Feature"` Always `Feature` - `"Feature"` - `id?: string` Compound identifier in `type/osm_id` format - `type: "FeatureCollection"` Always `FeatureCollection` - `"FeatureCollection"` ### Example ```typescript import Plaza from '@plazafyi/sdk'; const client = new Plaza({ apiKey: process.env['PLAZA_API_KEY'], // This is the default and can be omitted }); const featureCollection = await client.elements.nearbyPost(); console.log(featureCollection.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 - `BatchRequest` Fetch multiple OSM elements by their type and ID in a single request. Maximum 100 elements per batch. - `elements: Array` Array of element references to fetch - `id: number` OSM element ID - `type: "node" | "way" | "relation"` OSM element type - `"node"` - `"way"` - `"relation"`