Microsoft Azure Search API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Search. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.
This API exposes
18 operations
across 18 paths,
and defines 83 schemas.
It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.
The identity and technical contract details declared by the specification.
AtlasErrorResponse
object
An error response from the service
3 properties
SearchResultValue
object
The value item of the search result.
22 properties
SearchAddressStructuredResult
object
9 properties
SearchFuzzySummary
object
Summary object for a Search Fuzzy response
7 properties
SearchFacetSort
object
The sorting criteria
2 properties
DataSources
object
Optional section. Reference ids for use with the [Get Search Polygon](https://docs.microsoft.com/rest/api/maps/search/getsearchpolygon) API.
1 property
TermSearchResultValue
object
The context.
3 properties
SearchAddressResponse
object
This object is returned from a successful Search Address call
2 properties
AutoCompleteOptions
object
The payload of autocomplete request.
3 properties
SearchAlongRouteResult
object
This type represents the Search Along Route result object.
12 properties
SearchGeometryResponse
object
This object is returned from a successful Search By Geometry call
2 properties
SearchAddressReverseCrossStreetResult
object
2 properties
SearchResultEntryPoint
object
The entry point for the POI being returned.
2 properties
SearchAddressSummary
object
Summary object for a Search Address response
7 properties
SearchResultViewport
object
The viewport that covers the result represented by the top-left and bottom-right coordinates of the viewport.
2 properties
SearchAddressReverseResult
object
3 properties
AutoCompleteResult
object
The result of the autocomplete request.
1 property
SearchAddressReverseSummary
object
Summary object for a Search Address Reverse response
2 properties
SearchPoiCategoryResponse
object
This object is returned from a successful Search POI Category call
2 properties
Azure.Core.uuid
string
Universally Unique Identifier
SearchAddressReverseResponse
object
This object is returned from a successful Search Address Reverse call
2 properties
QueryResult
object
The result of the search result.
5 properties
SearchAddressReverseCrossStreetResponse
object
This object is returned from a successful Search Address Reverse CrossStreet call
2 properties
SearchPoiResponse
object
This object is returned from a successful Search POI call
2 properties
SearchNearbyResult
object
10 properties
SearchFacetItemValue
object
The content of a search facet result item.
2 properties
SearchNearbyResponse
object
This object is returned from a successful Search Nearby call
2 properties
SearchResultPoiOpeningHoursTimeRangeTime
object
Represents a date and time
3 properties
SearchSortOrder
string
Search sort order
SearchFacetItem
object
The content of a search facet result item.
3 properties
BatchResponse
object
This object is returned from a successful Batch service call
2 properties
DataSourcesGeometry
object
Information about the geometric shape of the result. Only present if type == Geography.
1 property
SearchResultAddress
object
The address of the result
20 properties
SearchResultScore
number
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…
SearchResultPoiBrand
object
The name of the brand for the POI being returned
1 property
SearchAddressReverseCrossStreetSummary
object
Summary object for a Search Address Reverse Cross Street response
2 properties
SearchResultPoiOpeningHours
object
Opening hours for a POI (Points of Interest).
2 properties
SuggestOptions
object
The payload of suggest request.
3 properties
SearchAlongRouteResponse
object
This object is returned from a successful Search Along Route call.
2 properties
GeoJSONGeometry
object
A valid GeoJSON geometry object. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946section-3.1) for details.
1 property
1 required
AutoCompleteResultValue
object
The value item of the autocomplete suggest.
2 properties
SearchPolygonResult
object
3 properties
SearchFuzzyResponse
object
This object is returned from a successful Search Fuzzy call
2 properties
SearchResultPoiCategorySet
object
POI category
1 property
SearchResultPoi
object
Details of the returned POI including information such as the name, phone, url address, and classifications.
8 properties
Geometry
object
This represents the geometry for one or more geographical features (parks, state boundary etc.) and should be a GeoJSON compliant type. Please refer to [RFC 79…
SearchResultDistance
number
Straight line distance between the result and geobias location in meters.
SearchAlongRouteSummary
object
Summary object for a Search Along Route response
7 properties
SearchGeometrySummary
object
Summary object for a Search Geometry response
7 properties
GeoJSONPosition
array
A valid GeoJSON Position geometry type. A Position is an array of numbers with two or more elements. The first two elements are longitude and latitude, precise…
LineString
object
A valid GeoJSON LineString geometry type. Please refer to [RFC 7946](https://tools.ietf.org/html/rfc7946section-3.1.4) for details.
SearchGeometryResult
object
This type represents the Search Inside Geometry result object.
10 properties
SearchResultPoiClassification
object
The classification for the POI being returned
2 properties
SearchHighlights
object
A highlight list that consists of index fields id ,qualifiedName, name, description, entityType. When the keyword appears in those fields, the value of the fie…
5 properties
SearchAddressStructuredSummary
object
Summary object for a Search Address Structured response
9 properties
EntityType
string
Geography entity type. Present only when entityType was requested and is available.
QueryOptions
object
The search query of advanced search request.
7 properties
SearchInsideGeometryRequestBody
object
This type represents the request body for the Search Inside Geometry service.
1 property
SearchNearbySummary
object
Summary object for a Search Nearby response
7 properties
SearchSummaryGeoBias
object
Indication when the internal search engine has applied a geospatial bias to improve the ranking of results. In some methods, this can be affected by setting th…
2 properties
SearchPoiCategorySummary
object
Summary object for a Search POI Category response
8 properties
SearchFacetResultValue
object
A facet list that consists of index fields assetType ,classification, contactId, and label. When the facet is specified in the request, the value of the facet…
10 properties
SearchAlongRouteRequestBody
object
This type represents the request body for the Search Along Route service.
1 property
ContactSearchResultValue
object
The contact in the search and suggest result.
3 properties
CoordinateAbbreviated
object
A location represented as a latitude and longitude.
2 properties
BatchRequestBody
object
This type represents the request body for the Batch service.
1 property
SearchPoiResult
object
11 properties
SuggestResult
object
The result item of the search suggest.
1 property
SearchFuzzyResult
object
12 properties
SearchPoiCategoryResult
object
11 properties
SearchPoiSummary
object
Summary object for a Search POI response
8 properties
SearchResultPoiOpeningHoursTimeRange
object
Open time range for a day
2 properties
ODataErrorResponse
object
This response object is returned when an error occurs in the Azure Maps API.
1 property
PoiCategoryResult
object
POI category result
4 properties
SuggestResultValue
object
The value item of the search suggest.
22 properties
SearchAddressStructuredResponse
object
This object is returned from a successful Search Address Structured call
2 properties
SearchResultPoiClassificationName
object
Name for the classification
2 properties
SearchTaxonomySetting
object
Taxonomy setting for search request
2 properties
SearchResultAddressRanges
object
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.
4 properties
SearchPolygonResponse
object
This object is returned from a successful Search Polygon call
1 property
ODataError
object
This object is returned when an error occurs in the Azure Maps API.
4 properties
SearchAddressResult
object
8 properties
PoiCategoryResponse
object
This object is returned from a successful POI Category Tree call
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Microsoft Azure publishes across the network.
