--- title: "Use to perform free form searches inside a one more more geometries." method: POST path: "/search/geometry/{format}" --- # Use to perform free form searches inside a one more more geometries. `POST /search/geometry/{format}` The `Post Search Inside Geometry` API is and HTTP `POST` request that allows you to perform a free form search inside a single geometry or multiple geometries. The search results that fall inside the geometry/geometries will be returned.

To send the geometry you will use a POST request where the request body will contain the `geometry` object represented as GeoJSON and the **Content-Type** header will be set to _application/json_. The geographical features to be searched can be modeled as Polygon and/or Circle geometries represented using any one of the following GeoJSON types:.

## Query parameters - `api-version` string, required - `query` string, required - `limit` integer - `categorySet` integer[] - `extendedPostalCodesFor` string[] - `idxSet` string[] - `openingHours` 'nextSevenDays' ## Parameters - `../../../Common/preview/1.0/common.json#/components/parameters/ClientId` — unresolved $ref - `../../../Common/preview/1.0/common.json#/components/parameters/ResponseFormat` — unresolved $ref - `../../../Common/preview/1.0/common.json#/components/parameters/Language` — unresolved $ref - `../../../Common/preview/1.0/common.json#/components/parameters/View` — unresolved $ref ## Request body - SearchInsideGeometryRequest — This type represents the request body for the Search Inside Geometry service. - `geometry` GeoJsonObject — unresolved $ref ## Response `200` OK - SearchAddressResult — This object is returned from a successful Search calls. - `summary` SearchSummary — Summary object for a Search API response. - `query` string — The query parameter that was used to produce these search results. - `queryType` 'NEARBY' | 'NON_NEAR' — The type of query being returned: NEARBY or NON_NEAR. - `queryTime` integer — Time spent resolving the query, in milliseconds. - `numResults` integer — Number of results in the response. - `limit` integer — Maximum number of responses that will be returned - `offset` integer — The starting offset of the returned Results within the full Result set. - `totalResults` integer — The total number of Results found. - `fuzzyLevel` integer — The maximum fuzzy level required to provide Results. - `geoBias` LatLongPairAbbreviated — unresolved $ref - `results` SearchAddressResultItem[] — A list of Search API results. - `type` 'POI' | 'Street' | 'Geography' | 'Point Address' | 'Address Range' | 'Cross Street' — One of: * POI * Street * Geography * Point Address * Address Range * Cross Street - `id` string — Id property - `score` number, double — The value within a result set to indicate the relative matching score between results. You can use this to determine that result x is twice as likely to be as relevant as result y if the value of x is 2x the value of y. The values vary between queries and is only meant as a relative value for one result set. - `dist` number, double — Straight line distance between the result and geobias location in meters. - `info` string — Information about the original data source of the Result. Used for support requests. - `entityType` 'Country' | 'CountrySubdivision' | 'CountrySecondarySubdivision' | 'CountryTertiarySubdivision' | 'Municipality' | 'MunicipalitySubdivision' | 'Neighbourhood' | 'PostalCodeArea' — Geography entity type. Present only when entityType was requested and is available. - `poi` PointOfInterest — Details of the returned POI including information such as the name, phone, url address, and classifications. - `name` string — Name of the POI property - `phone` string — Telephone number property - `url` string — Website URL property - `categorySet` PointOfInterestCategorySet[] — The list of the most specific POI categories - `id` integer — Category ID - `categories` string[] — Categories array - `classifications` Classification[] — Classification array - `code` string — Code property - `names` ClassificationName[] — Names array - `nameLocale` string — Name Locale property - `name` string — Name property - `brands` Brand[] — Brands array. The name of the brand for the POI being returned. - `name` string — Name of the brand - `openingHours` OperatingHours — Opening hours for a POI (Points of Interest). - `mode` string — Value used in the request: none or "nextSevenDays" - `timeRanges` OperatingHoursTimeRange[] — List of time ranges for the next 7 days - `startTime` OperatingHoursTime — Represents a date and time - `date` string — Represents current calendar date in POI time zone, e.g. "2019-02-07". - `hour` integer — Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. - `minute` integer — Minutes are in the local time of a POI; possible values are 0 - 59. - `endTime` OperatingHoursTime — Represents a date and time - `date` string — Represents current calendar date in POI time zone, e.g. "2019-02-07". - `hour` integer — Hours are in the 24 hour format in the local time of a POI; possible values are 0 - 23. - `minute` integer — Minutes are in the local time of a POI; possible values are 0 - 59. - `address` Address — The address of the result - `buildingNumber` string — The building number on the street. **Important**: This property is *deprecated*. Use `streetNumber` instead. - `street` string — The street name. **Important**: This property is *deprecated*. Use `streetName` instead. - `crossStreet` string — The name of the street being crossed. - `streetNumber` string — The building number on the street. - `routeNumbers` string[] — The codes used to unambiguously identify the street - `streetName` string — The street name. - `streetNameAndNumber` string — The street name and number. Only available for the Search Address Reverse APIs. - `neighbourhood` string — A Neighbourhood is a geographically localized area within a city or town with distinctive characteristics and social interactions between inhabitants. - `municipality` string — City / Town
Note: `municipality` represents the residential municipality. Depending on the location, the `municipality` value may differ from the commonly known name of a city or town. For the commonly known name of the city or town, it’s suggested that the `localName` value be used instead of the `municipality` value. - `municipalitySubdivision` string — Sub / Super City - `countrySubdivision` string — State or Province - `countrySubdivisionCode` string — `countrySubdivisionCode` prefixed by `countryCode` ( countryCode-countrySubdivisionCode ) and the hyphen forms the ISO 3166-2 code. Examples: TX for Texas, SCT for Scotland and ON for Ontario. - `countryTertiarySubdivision` string — Named Area - `countrySecondarySubdivision` string — County - `postalCode` string — Postal Code / Zip Code - `extendedPostalCode` string — Extended postal code (availability is dependent on the region). - `countryCode` string — Country (Note: This is a two-letter code, not a country/region name.) - `country` string — country/region name - `countryCodeISO3` string — ISO alpha-3 country code - `freeformAddress` string — An address line formatted according to the formatting rules of a Result's country/region of origin, or in the case of a country/region, its full country/region name. - `countrySubdivisionName` string — The full name of a first level of country/region administrative hierarchy. This field appears only in case countrySubdivision is presented in an abbreviated form. Only supported for USA, Canada, and United Kingdom. - `localName` string — An address component that represents the name of a geographic area or locality that groups multiple addressable objects for addressing purposes, without being an administrative unit. This field is used to build the `freeformAddress` property. `localName` represents the postal municipality. Depending on the location, `localName` is the commonly known name of a city or town. For the commonly known name of a city or town, use `localName` instead of `municipality`. - `boundingBox` BoundingBoxCompassNotation — The bounding box of the location. - `northEast` string — North-east latitude,longitude coordinate of the bounding box as comma-separated floats - `southWest` string — South-west latitude,longitude coordinate of the bounding box as comma-separated floats - `entity` 'position' — Entity type source of the bounding box. For reverse-geocoding this is always equal to position. - `position` LatLongPairAbbreviated — unresolved $ref - `viewport` BoundingBox — The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport. - `topLeftPoint` LatLongPairAbbreviated — unresolved $ref - `btmRightPoint` LatLongPairAbbreviated — unresolved $ref - `entryPoints` EntryPoint[] — Array of EntryPoints. Those describe the types of entrances available at the location. The type can be "main" for main entrances such as a front door, or a lobby, and "minor", for side and back doors. - `type` 'main' | 'minor' — The type of entry point. Value can be either _main_ or _minor_. - `position` LatLongPairAbbreviated — unresolved $ref - `addressRanges` AddressRanges — Describes the address range on both sides of the street for a search result. Coordinates for the start and end locations of the address range are included. - `rangeLeft` string — Address range on the left side of the street. - `rangeRight` string — Address range on the right side of the street. - `from` LatLongPairAbbreviated — unresolved $ref - `to` LatLongPairAbbreviated — unresolved $ref - `dataSources` DataSources — Optional section. Reference ids for use with the [Get Search Polygon](/rest/api/maps/search/get-search-polygon?view=rest-maps-1.0) API. - `geometry` Geometry — Information about the geometric shape of the result. Only present if type == Geography. - `id` string — Pass this as geometryId to the [Get Search Polygon](/rest/api/maps/search/get-search-polygon?view=rest-maps-1.0) API to fetch geometry information for this result. - `matchType` 'AddressPoint' | 'HouseNumberRange' | 'Street' — Types of match for a reverse address search operation. - `detourTime` integer — Detour time in seconds. Only returned for calls to the Search Along Route API. ## Other responses - `default` — unresolved $ref ## Changes - **2025-10-15** (1.0) `69718fe8c37a` — 1 info - endpoint added [Change history](https://skmtc.dev/azure/apis/maps-search/changes/search/geometry/:format/post.md) --- [API](https://skmtc.dev/azure/apis/maps-search.md) · [All operations](https://skmtc.dev/azure/apis/maps-search/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/azure/maps-search/revisions/1e2d1fda19da/schema)