---
title: "Search Place"
method: POST
path: "/multigeocode/search"
tags: ["Places_Multi-Geocode"]
---

# Search Place

`POST /multigeocode/search`

The method enables searching for known places from multiple data sources

Use this method to find known places in default or your own custom (proprietary) dataset and get a combined search result. It accepts free-form, partially correct or even incomplete search texts. Results would be ranked based on the search score of a place.

## Query parameters

- `key` string, 32 character alphanumeric string, required

## Request body

- object
  - `query` string, required — A free-form, complete or incomplete string to be searched. It allows searching for places using keywords or names.
  - `at` object, required — Specify the center of the search context expressed as coordinates.
    - `lat` number, required — Latitude coordinate of the location
    - `lng` number, required — Longitude coordinate of the location.
  - `limit` integer — Sets the maximum number of results to be returned.
  - `radius` string — Filters the results to places within the specified radius from the 'at' location. Note: Supports 'meter' (m) and 'kilometer' (km) units. If no radius is given, the search method returns as many results as specified in limit.
  - `country` string — Country of the search context provided as comma-separated [ISO 3166-1 alpha-3](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) country codes. Note: Country codes should be provided in uppercase.
  - `state` string — Specifies the state of the search place.
  - `city` string — Specifies the primary city of the place.
  - `street` string — Specifies the street name of the search place.
  - `district` string — Specifies the district of the search place.
  - `subDistrict` string — Specifies the subDistrict of the search place.

## Response `200`

- object
  - `entities` object[] — An array of objects containing the search result response. Each object represents one place returned in the search response. An empty array would be returned if no matching place is found.
    - `docId` string — The unique NextBillion ID for the result item. This ID can be used as input in “Get Place”, “Update Place”, “Delete Place” methods.
    - `place` object[] — This parameter represents the place details, including geographical information, address and other related information.
      - `geopoint` object — This parameter represents the geographical coordinates of the place. It includes the latitude and longitude values.
        - `lat` number — This parameter represents the latitude value of the place.
        - `lng` number — This parameter represents the longitude value of the place.
      - `country` string — This parameter represents the country of the place.
      - `state` string — This parameter represents the state or region of the place.
      - `city` string — This parameter represents the city or town of the place.
      - `district` string — This parameter represents the district of the place.
      - `subDistrict` string — This parameter represents the sub-district or locality of the place.
      - `street` string — This parameter represents the street name of the place.
      - `postalCode` string — This parameter represents the postal code or ZIP code of the place.
      - `house` string — This parameter represents the house or building number of the place.
      - `building` string — This parameter represents additional building information if applicable.
      - `poi` object — This parameter represents a point of interest within the place. A Point of Interest (POI) refers to a specific location or area that is of interest to individuals for various reasons. It could be a landmark, tourist attraction, business, or any other location that people might find important or intriguing.
        - `title` string — A title that describes the point of interest.
      - `address` string — This parameter represents the complete address of the place, including the street, city, state, postal code and country.
    - `dataSource` DataSource — It contains information about the dataset that returns the specific result
      - `source` string — This parameter represents the source of the data.
      - `refId` string — This parameter represents the unique reference ID associated with the data source.
      - `status` 'enable' | 'disable' — This parameter indicates if a place is searchable.
    - `score` integer — Integer value representing how good the result is. Higher score indicates a better match between the search query and the result. This can be used to accept or reject the results depending on how “relevant” a result is, for a given use case

## Other responses

- `400` — Such as missing parameters or parameters with invalid value types (for example value cannot be parsed into numbers).

---

[API](https://skmtc.net/nextbillion-ai/apis/one-spec-service.md) · [All operations](https://skmtc.net/nextbillion-ai/apis/one-spec-service/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nextbillion-ai/one-spec-service/versions/b647f1808dda/schema)
