# Search

## Search OSM features by name

`search().query(SearchQueryParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection`

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

Search OSM features by name

### Parameters

- `params: SearchQueryParams`

  - `q: String`

    Search query string

  - `cursor: Optional<String>`

    Cursor for pagination

  - `limit: Optional<Long>`

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

    Coordinate decimal precision (1-15, default 7)

  - `outputSort: Optional<String>`

    Sort by: distance, name, osm_id

### Returns

- `class 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: List<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: Coordinates`

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

        - `List<Double>`

        - `List<List<Double>>`

        - `List<List<List<Double>>>`

        - `List<List<List<List<Double>>>>`

      - `type: Type`

        Geometry type

        - `POINT("Point")`

        - `LINE_STRING("LineString")`

        - `POLYGON("Polygon")`

        - `MULTI_POINT("MultiPoint")`

        - `MULTI_LINE_STRING("MultiLineString")`

        - `MULTI_POLYGON("MultiPolygon")`

    - `properties: Properties`

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

      Always `Feature`

      - `FEATURE("Feature")`

    - `id: Optional<String>`

      Compound identifier in `type/osm_id` format

  - `type: Type`

    Always `FeatureCollection`

    - `FEATURE_COLLECTION("FeatureCollection")`

### Example

```kotlin
package com.plazafyi.example

import com.plazafyi.client.PlazaClient
import com.plazafyi.client.okhttp.PlazaOkHttpClient
import com.plazafyi.models.FeatureCollection
import com.plazafyi.models.search.SearchQueryParams

fun main() {
    val client: PlazaClient = PlazaOkHttpClient.fromEnv()

    val params: SearchQueryParams = SearchQueryParams.builder()
        .q("q")
        .build()
    val featureCollection: FeatureCollection = client.search().query(params)
}
```

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

`search().queryPost(SearchQueryPostParamsparams, RequestOptionsrequestOptions = RequestOptions.none()) : FeatureCollection`

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

Search OSM features by name

### Parameters

- `params: SearchQueryPostParams`

  - `q: String`

    Search query string

  - `cursor: Optional<String>`

    Cursor for pagination

  - `limit: Optional<Long>`

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

    Coordinate decimal precision (1-15, default 7)

  - `outputSort: Optional<String>`

    Sort by: distance, name, osm_id

### Returns

- `class 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: List<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: Coordinates`

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

        - `List<Double>`

        - `List<List<Double>>`

        - `List<List<List<Double>>>`

        - `List<List<List<List<Double>>>>`

      - `type: Type`

        Geometry type

        - `POINT("Point")`

        - `LINE_STRING("LineString")`

        - `POLYGON("Polygon")`

        - `MULTI_POINT("MultiPoint")`

        - `MULTI_LINE_STRING("MultiLineString")`

        - `MULTI_POLYGON("MultiPolygon")`

    - `properties: Properties`

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

      Always `Feature`

      - `FEATURE("Feature")`

    - `id: Optional<String>`

      Compound identifier in `type/osm_id` format

  - `type: Type`

    Always `FeatureCollection`

    - `FEATURE_COLLECTION("FeatureCollection")`

### Example

```kotlin
package com.plazafyi.example

import com.plazafyi.client.PlazaClient
import com.plazafyi.client.okhttp.PlazaOkHttpClient
import com.plazafyi.models.FeatureCollection
import com.plazafyi.models.search.SearchQueryPostParams

fun main() {
    val client: PlazaClient = PlazaOkHttpClient.fromEnv()

    val params: SearchQueryPostParams = SearchQueryPostParams.builder()
        .q("q")
        .build()
    val featureCollection: FeatureCollection = client.search().queryPost(params)
}
```

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