# Search

## Search OSM features by name

`$ plaza search query`

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

Search OSM features by name

### Parameters

- `--q: string`

  Search query string

- `--cursor: optional string`

  Cursor for pagination

- `--limit: optional number`

  Maximum results (default 25, max 100)

- `--output-fields: optional string`

  Comma-separated property fields to include

- `--output-include: optional string`

  Extra computed fields: bbox, distance, center

- `--output-precision: optional number`

  Coordinate decimal precision (1-15, default 7)

- `--output-sort: optional string`

  Sort by: distance, name, osm_id

### Returns

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

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

### Example

```cli
plaza search query \
  --api-key 'My API Key' \
  --q q
```

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

`$ plaza search query-post`

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

Search OSM features by name

### Parameters

- `--q: string`

  Search query string

- `--cursor: optional string`

  Cursor for pagination

- `--limit: optional number`

  Maximum results (default 25, max 100)

- `--output-fields: optional string`

  Comma-separated property fields to include

- `--output-include: optional string`

  Extra computed fields: bbox, distance, center

- `--output-precision: optional number`

  Coordinate decimal precision (1-15, default 7)

- `--output-sort: optional string`

  Sort by: distance, name, osm_id

### Returns

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

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

### Example

```cli
plaza search query-post \
  --api-key 'My API Key' \
  --q q
```

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