# Search

## Search OSM features by name

`client.search.query(SearchQueryParamsquery, RequestOptionsoptions?): FeatureCollection`

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

Search OSM features by name

### Parameters

- `query: SearchQueryParams`

  - `q: string`

    Search query string

  - `cursor?: string`

    Cursor for pagination

  - `limit?: number`

    Maximum results (default 25, max 100)

  - `outputFields?: string`

    Comma-separated property fields to include

  - `outputInclude?: string`

    Extra computed fields: bbox, distance, center

  - `outputPrecision?: number`

    Coordinate decimal precision (1-15, default 7)

  - `outputSort?: string`

    Sort by: distance, name, osm_id

### Returns

- `FeatureCollection`

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

    Array of GeoJSON Feature objects

    - `geometry: GeoJsonGeometry`

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

      - `coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>`

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

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

      - `type: "Point" | "LineString" | "Polygon" | 3 more`

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Record<string, 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?: string`

      Compound identifier in `type/osm_id` format

  - `type: "FeatureCollection"`

    Always `FeatureCollection`

    - `"FeatureCollection"`

### Example

```typescript
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.search.query({ q: 'q' });

console.log(featureCollection.features);
```

#### 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(SearchQueryPostParamsparams, RequestOptionsoptions?): FeatureCollection`

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

Search OSM features by name

### Parameters

- `params: SearchQueryPostParams`

  - `q: string`

    Search query string

  - `cursor?: string`

    Cursor for pagination

  - `limit?: number`

    Maximum results (default 25, max 100)

  - `outputFields?: string`

    Comma-separated property fields to include

  - `outputInclude?: string`

    Extra computed fields: bbox, distance, center

  - `outputPrecision?: number`

    Coordinate decimal precision (1-15, default 7)

  - `outputSort?: string`

    Sort by: distance, name, osm_id

### Returns

- `FeatureCollection`

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

    Array of GeoJSON Feature objects

    - `geometry: GeoJsonGeometry`

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

      - `coordinates: Array<number> | Array<Array<number>> | Array<Array<Array<number>>> | Array<Array<Array<Array<number>>>>`

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

        - `Array<number>`

        - `Array<Array<number>>`

        - `Array<Array<Array<number>>>`

        - `Array<Array<Array<Array<number>>>>`

      - `type: "Point" | "LineString" | "Polygon" | 3 more`

        Geometry type

        - `"Point"`

        - `"LineString"`

        - `"Polygon"`

        - `"MultiPoint"`

        - `"MultiLineString"`

        - `"MultiPolygon"`

    - `properties: Record<string, 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?: string`

      Compound identifier in `type/osm_id` format

  - `type: "FeatureCollection"`

    Always `FeatureCollection`

    - `"FeatureCollection"`

### Example

```typescript
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.search.queryPost({ q: 'q' });

console.log(featureCollection.features);
```

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