Skip to content

Search OSM features by name

$client->search->queryPost(string q, ?string cursor, ?string format, ?int limit, ?string outputFields, ?string outputInclude, ?int outputPrecision, ?string outputSort): FeatureCollection

POST/api/v1/search

Search OSM features by name

ParametersExpand Collapse

q: string

Search query string

cursor?:optional string

Cursor for pagination

format?:optional string

Response format: json (default), geojson, csv, ndjson

limit?:optional int

Maximum results (default 25, max 100)

outputFields?:optional string

Comma-separated property fields to include

outputInclude?:optional string

Extra computed fields: bbox, distance, center

outputPrecision?:optional int

Coordinate decimal precision (1-15, default 7)

outputSort?:optional string

Sort by: distance, name, osm_id

ReturnsExpand Collapse

FeatureCollection

list<GeoJsonFeature> features

Array of GeoJSON Feature objects

Type type

Always FeatureCollection

Search OSM features by name

<?php

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

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

$featureCollection = $client->search->queryPost(
  q: 'q',
  cursor: 'cursor',
  format: 'format',
  limit: 0,
  outputFields: 'output[fields]',
  outputInclude: 'output[include]',
  outputPrecision: 0,
  outputSort: 'output[sort]',
);

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"
}