Skip to content
Plaza Plaza Docs
GuidesPlaygroundDashboard
API Reference
Elements

Find features near a geographic point

client.elements.nearby(ElementNearbyParams { lat, lng, limit, radius } query, RequestOptionsoptions?): FeatureCollection { features, type }
GET/api/v1/features/nearby

Find features near a geographic point

ParametersExpand Collapse
query: ElementNearbyParams { lat, lng, limit, radius }
lat: number

Latitude (-90 to 90)

lng: number

Longitude (-180 to 180)

limit?: number

Maximum results (default 20, max 100)

radius?: number

Search radius in meters (default 500, max 10000)

ReturnsExpand Collapse
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<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>

GeoJSON coordinates array (nesting depth varies by geometry type)

One of the following:
Array<number>
Array<Array<number>>
Array<Array<Array<number>>>
Array<Array<Array<Array<number>>>>
type: "Point" | "LineString" | "Polygon" | 3 more
One of the following:
"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: Record<string, unknown>
type: "Feature"
id?: string

Feature identifier (type/osm_id)

osm_id?: number

OpenStreetMap ID

type: "FeatureCollection"

Find features near a geographic point

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({ lat: 0, lng: 0 });

console.log(featureCollection.features);
Returns Examples