Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Elements

Find features near a geographic point

$ plaza elements nearby-post
POST/api/v1/features/nearby

Find features near a geographic point

ParametersExpand Collapse
--lat: optional number

Legacy shorthand. Latitude (-90 to 90). Use near param instead.

--limit: optional number

Maximum results (default 20, max 100)

--lng: optional number

Legacy shorthand. Longitude (-180 to 180). Use near param instead.

--near: optional string

Point geometry for proximity search (lat,lng or GeoJSON). Alternative to lat/lng params.

--output-buffer: optional number

Buffer geometry by meters

--output-centroid: optional boolean

Replace geometry with centroid

--output-fields: optional string

Comma-separated property fields to include

--output-geometry: optional boolean

Include geometry (default true)

--output-include: optional string

Extra computed fields: bbox, distance, center

--output-precision: optional number

Coordinate decimal precision (1-15, default 7)

--output-simplify: optional number

Simplify geometry tolerance in meters

--output-sort: optional string

Sort by: distance, name, osm_id

--radius: optional number

Search radius in meters (default 500, max 10000)

ReturnsExpand Collapse
feature_collection: object { features, type }

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 of GeoJsonFeature { geometry, properties, type, id }

Array of GeoJSON Feature objects

geometry: object { coordinates, type }

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

coordinates: array of number or array of array of number or array of array of array of number or array of array of array of array of number

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

Point: array of number

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

LineString or MultiPoint: array of array of number

Array of [lng, lat] positions

Polygon or MultiLineString: array of array of array of number

Array of linear rings / line strings

MultiPolygon: array of array of array of array of number

Array of polygons

type: "Point" or "LineString" or "Polygon" or 3 more

Geometry type

"Point"
"LineString"
"Polygon"
"MultiPoint"
"MultiLineString"
"MultiPolygon"
properties: map[unknown]

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: optional string

Compound identifier in type/osm_id format

type: "FeatureCollection"

Always FeatureCollection

"FeatureCollection"

Find features near a geographic point

plaza elements nearby-post \
  --api-key 'My API Key'
{
  "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"
}