# Search

## Search OSM features by name

`FeatureCollection Search.Query(SearchQueryParamsparameters, CancellationTokencancellationToken = default)`

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

Search OSM features by name

### Parameters

- `SearchQueryParams parameters`

  - `required string q`

    Search query string

  - `string cursor`

    Cursor for pagination

  - `Long limit`

    Maximum results (default 25, max 100)

  - `string outputFields`

    Comma-separated property fields to include

  - `string outputInclude`

    Extra computed fields: bbox, distance, center

  - `Long outputPrecision`

    Coordinate decimal precision (1-15, default 7)

  - `string outputSort`

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

  - `required IReadOnlyList<GeoJsonFeature> Features`

    Array of GeoJSON Feature objects

    - `required GeoJsonGeometry Geometry`

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

      - `required Coordinates Coordinates`

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

        - `IReadOnlyList<Double>`

        - `IReadOnlyList<IReadOnlyList<Double>>`

        - `IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>`

        - `IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>`

      - `required Type Type`

        Geometry type

        - `"Point"Point`

        - `"LineString"LineString`

        - `"Polygon"Polygon`

        - `"MultiPoint"MultiPoint`

        - `"MultiLineString"MultiLineString`

        - `"MultiPolygon"MultiPolygon`

    - `required IReadOnlyDictionary<string, JsonElement> 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.

    - `required Type Type`

      Always `Feature`

      - `"Feature"Feature`

    - `string ID`

      Compound identifier in `type/osm_id` format

  - `required Type Type`

    Always `FeatureCollection`

    - `"FeatureCollection"FeatureCollection`

### Example

```csharp
SearchQueryParams parameters = new() { Q = "q" };

var featureCollection = await client.Search.Query(parameters);

Console.WriteLine(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

`FeatureCollection Search.QueryPost(SearchQueryPostParamsparameters, CancellationTokencancellationToken = default)`

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

Search OSM features by name

### Parameters

- `SearchQueryPostParams parameters`

  - `required string q`

    Search query string

  - `string cursor`

    Cursor for pagination

  - `Long limit`

    Maximum results (default 25, max 100)

  - `string outputFields`

    Comma-separated property fields to include

  - `string outputInclude`

    Extra computed fields: bbox, distance, center

  - `Long outputPrecision`

    Coordinate decimal precision (1-15, default 7)

  - `string outputSort`

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

  - `required IReadOnlyList<GeoJsonFeature> Features`

    Array of GeoJSON Feature objects

    - `required GeoJsonGeometry Geometry`

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

      - `required Coordinates Coordinates`

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

        - `IReadOnlyList<Double>`

        - `IReadOnlyList<IReadOnlyList<Double>>`

        - `IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>`

        - `IReadOnlyList<IReadOnlyList<IReadOnlyList<IReadOnlyList<Double>>>>`

      - `required Type Type`

        Geometry type

        - `"Point"Point`

        - `"LineString"LineString`

        - `"Polygon"Polygon`

        - `"MultiPoint"MultiPoint`

        - `"MultiLineString"MultiLineString`

        - `"MultiPolygon"MultiPolygon`

    - `required IReadOnlyDictionary<string, JsonElement> 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.

    - `required Type Type`

      Always `Feature`

      - `"Feature"Feature`

    - `string ID`

      Compound identifier in `type/osm_id` format

  - `required Type Type`

    Always `FeatureCollection`

    - `"FeatureCollection"FeatureCollection`

### Example

```csharp
SearchQueryPostParams parameters = new() { Q = "q" };

var featureCollection = await client.Search.QueryPost(parameters);

Console.WriteLine(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"
}
```