# Search

## Search OSM features by name

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

**get** `/api/v1/search`

Search OSM features by name

### Parameters

- `q: string`

  Search query string

- `cursor?:optional string`

  Cursor for pagination

- `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

### Returns

- `FeatureCollection`

  - `list<GeoJsonFeature> features`

    Array of GeoJSON Feature objects

  - `Type type`

    Always `FeatureCollection`

### Example

```php
<?php

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

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

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

var_dump($featureCollection);
```

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

## Search OSM features by name

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

**post** `/api/v1/search`

Search OSM features by name

### Parameters

- `q: string`

  Search query string

- `cursor?:optional string`

  Cursor for pagination

- `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

### Returns

- `FeatureCollection`

  - `list<GeoJsonFeature> features`

    Array of GeoJSON Feature objects

  - `Type type`

    Always `FeatureCollection`

### Example

```php
<?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',
  limit: 0,
  outputFields: 'output[fields]',
  outputInclude: 'output[include]',
  outputPrecision: 0,
  outputSort: 'output[sort]',
);

var_dump($featureCollection);
```

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