Skip to content
Plaza Plaza Docs
GuidesBlogPlaygroundDashboard
API Reference
Elements

Find features near a geographic point

$client->elements->nearbyPost(?float lat, ?int limit, ?float lng, ?string near, ?float outputBuffer, ?bool outputCentroid, ?string outputFields, ?bool outputGeometry, ?string outputInclude, ?int outputPrecision, ?float outputSimplify, ?string outputSort, ?int radius): FeatureCollection
POST/api/v1/features/nearby

Find features near a geographic point

ParametersExpand Collapse
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 string

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

outputBuffer?:optional float

Buffer geometry by meters

outputCentroid?:optional bool

Replace geometry with centroid

outputFields?:optional string

Comma-separated property fields to include

outputGeometry?:optional bool

Include geometry (default true)

outputInclude?:optional string

Extra computed fields: bbox, distance, center

outputPrecision?:optional int

Coordinate decimal precision (1-15, default 7)

outputSimplify?:optional float

Simplify geometry tolerance in meters

outputSort?:optional string

Sort by: distance, name, osm_id

radius?:optional int

Search radius in meters (default 500, max 10000)

ReturnsExpand Collapse
list<GeoJsonFeature> features

Array of GeoJSON Feature objects

Type type

Always FeatureCollection

Find features near a geographic point

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

$client = new Client(apiKey: 'My API Key', environment: 'local');

$featureCollection = $client->elements->nearbyPost(
  lat: 0,
  limit: 0,
  lng: 0,
  near: 'near',
  outputBuffer: 0,
  outputCentroid: true,
  outputFields: 'output[fields]',
  outputGeometry: true,
  outputInclude: 'output[include]',
  outputPrecision: 0,
  outputSimplify: 0,
  outputSort: 'output[sort]',
  radius: 0,
);

var_dump($featureCollection);
{
  "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"
}