Search - Get Search Address Reverse

Service:

Maps

API Version:

1.0

Use para obtener una dirección postal y la información de ubicación de las coordenadas de latitud y longitud.
La Get Search Address Reverse API es y la solicitud HTTP GET que devuelve una dirección o ubicación de calle cuando se proporcionan coordenadas de latitud y longitud.

Puede haber ocasiones en las que necesite traducir una coordenada (ejemplo: 37.786505, -122.3862) en una dirección postal comprensible. Por lo general, esta conversión es necesaria en las aplicaciones de seguimiento, donde recibe una fuente GPS del dispositivo o recurso y desea saber en qué dirección se encuentra en la coordenada. Este punto de conexión devolverá información de dirección para una coordenada determinada.

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}

With optional parameters:

GET https://atlas.microsoft.com/search/address/reverse/{format}?api-version=1.0&query={query}&language={language}&returnSpeedLimit={returnSpeedLimit}&heading={heading}&radius={radius}&number={number}&returnRoadUse={returnRoadUse}&roadUse={roadUse}&allowFreeformNewline={allowFreeformNewline}&returnMatchType={returnMatchType}&entityType={entityType}&view={view}

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
format	path	True	ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
api-version	query	True	string	Número de versión de la API de Azure Maps.
query	query	True	number[]	La consulta aplicable especificada como una cadena separada por comas compuesta por latitud seguida de longitud, por ejemplo, "47.641268,-122.125679".
allowFreeformNewline	query		boolean	Formato de nuevas líneas en la dirección con formato. Si es true, la dirección contendrá nuevas líneas. Si es false, las líneas nuevas se convertirán en comas.
entityType	query		GeographicEntityType	Especifica el nivel de filtrado realizado en zonas geográficas. Limita la búsqueda de tipos de entidad geography especificados, por ejemplo, devolver solo municipio. La respuesta resultante contendrá el identificador geográfico, así como el tipo de entidad coincidente. Si proporciona más de una entidad como una lista separada por comas, el punto de conexión devolverá la "entidad más pequeña disponible". El identificador de geometría devuelto se puede usar para obtener la geometría de esa geografía a través de Get Búsqueda Polygon API. Los parámetros siguientes se omiten cuando se establece entityType: encabezado number returnRoadUse returnSpeedLimit roadUse returnMatchType
heading	query		integer	El rumbo direccional del vehículo en grados, para viajar a lo largo de un segmento de carretera. 0 es Norte, 90 es Este y así sucesivamente, los valores van de -360 a 360. La precisión puede incluir hasta un decimal
language	query		string	Idioma en el que se deben devolver los resultados de búsqueda. Debe ser una de las etiquetas de idioma IETF admitidas, sin distinción entre mayúsculas y minúsculas. Cuando los datos del idioma especificado no están disponibles para un campo específico, se usa el idioma predeterminado. Consulte Idiomas admitidos para obtener más información.
number	query		string	Número de calle como una cadena. Si se envía un número junto con la solicitud, la respuesta puede incluir el lado de la calle (izquierda/derecha) y también una posición de desplazamiento para ese número.
radius	query		integer	Radio en metros a para que los resultados se restrinjan al área definida.
returnMatchType	query		boolean	Incluya información sobre el tipo de coincidencia con el geocodificador obtenido en la respuesta.
returnRoadUse	query		boolean	booleano. Para habilitar el retorno de la matriz de uso de carreteras para geocódigos inversos en el nivel de calle
returnSpeedLimit	query		boolean	booleano. Para habilitar la devolución del límite de velocidad publicado
roadUse	query		RoadUseType[]	Para restringir los códigos geográficos inversos a un determinado tipo de uso de carreteras. La matriz de uso de carreteras para geocódigos inversos puede ser uno o varios de LimitedAccess, Arterial, Terminal, Rampa, Rotary, LocalStreet
view	query		LocalizedMapView	El parámetro View (también denominado parámetro "región de usuario") le permite mostrar los mapas correctos para un determinado país o región para regiones controvertidas geopolíticamente. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unificado", incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado a acceder a través de Azure Maps. Ejemplo: view=IN. Consulte Vistas admitidas para obtener más información y para ver las vistas disponibles.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-id		string	Especifica qué cuenta está pensada para su uso junto con el modelo de seguridad de Microsoft Entra ID. Representa un identificador único para la cuenta de Azure Maps y se puede recuperar de la API de cuenta del plano de administración de Azure Maps. Para usar Microsoft Entra ID seguridad en Azure Maps consulte los siguientes artículos para obtener instrucciones.

Respuestas

Nombre	Tipo	Description
200 OK	ReverseSearchAddressResult	Aceptar
Other Status Codes	ErrorResponse	Se ha producido un error inesperado.

Seguridad

AADToken

Estos son los flujos de OAuth 2.0 de Microsoft Entra. Cuando se empareja con el control de acceso basado en rol de Azure, se puede usar para controlar el acceso a Azure Maps API REST. Los controles de acceso basados en roles de Azure se usan para designar el acceso a una o varias Azure Maps cuenta de recursos o subrecursos. A cualquier usuario, grupo o entidad de servicio se le puede conceder acceso a través de un rol integrado o un rol personalizado compuesto por uno o varios permisos para Azure Maps API REST.

Para implementar escenarios, se recomienda ver los conceptos de autenticación. En resumen, esta definición de seguridad proporciona una solución para el modelado de aplicaciones a través de objetos capaces de controlar el acceso en determinadas API y ámbitos.

Nota

• Esta definición de seguridad requiere el uso del x-ms-client-id encabezado para indicar a qué recurso Azure Maps la aplicación solicita acceso. Esto se puede adquirir desde la API de administración de Maps .
• Authorization URL es específico de la instancia de nube pública de Azure. Las nubes soberanas tienen direcciones URL de autorización únicas y configuraciones de Microsoft Entra ID.
• El control de acceso basado en rol de Azure se configura desde el plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.
• El uso del SDK web de Azure Maps permite la configuración basada en la configuración de una aplicación para varios casos de uso.
• Para obtener más información sobre Plataforma de identidad de Microsoft, consulte Plataforma de identidad de Microsoft información general.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
https://atlas.microsoft.com/.default	https://atlas.microsoft.com/.default

subscription-key

Se trata de una clave compartida que se aprovisiona al crear una cuenta de Azure Maps en el Azure Portal o mediante PowerShell, la CLI, los SDK de Azure o la API REST.

Con esta clave, cualquier aplicación puede acceder a todas las API REST. En otras palabras, esta clave se puede usar como clave maestra en la cuenta en la que se emiten.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es usar el enfoque de aplicaciones cliente confidenciales para acceder a Azure Maps API REST para que la clave se pueda almacenar de forma segura.

Type: apiKey
In: query

SAS Token

Se trata de un token de firma de acceso compartido que se crea a partir de la operación List SAS en el recurso de Azure Maps a través del plano de administración de Azure a través de Azure Portal, PowerShell, CLI, SDK de Azure o API REST.

Con este token, cualquier aplicación está autorizada para acceder a los controles de acceso basado en roles de Azure y al control específico de la expiración, la tasa y las regiones de uso para el token determinado. Es decir, el token de SAS se puede usar para permitir que las aplicaciones controlen el acceso de forma más segura que la clave compartida.

En el caso de las aplicaciones expuestas públicamente, nuestra recomendación es configurar una lista específica de orígenes permitidos en el recurso de la cuenta de mapa para limitar la representación de abusos y renovar periódicamente el token de SAS.

Type: apiKey
In: header

Ejemplos

Searches addresses for coordinates 37.337,-121.89

Sample Request

HTTP

GET https://atlas.microsoft.com/search/address/reverse/json?api-version=1.0&query=37.337,-121.89

Sample Response

Status code:

200

{
  "summary": {
    "queryTime": 5,
    "numResults": 1
  },
  "addresses": [
    {
      "address": {
        "streetNumber": "31",
        "routeNumbers": [],
        "streetName": "N 2nd St",
        "streetNameAndNumber": "31 N 2nd St",
        "countryCode": "US",
        "countrySubdivisionCode": "CA",
        "countrySubdivisionName": "California",
        "municipality": "San Jose",
        "postalCode": "95113",
        "country": "United States of America",
        "countryCodeISO3": "USA",
        "freeformAddress": "31 N 2nd St, San Jose CA 95113",
        "extendedPostalCode": "951131217"
      },
      "position": "37.337090,-121.889820"
    }
  ]
}

Definiciones

Nombre	Description
Address	Dirección del resultado
BoundingBoxCompassNotation	Cuadro de límite de la ubicación.
Entity	Origen del tipo de entidad del rectángulo de selección. Para la geocodificación inversa, siempre es igual a la posición.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
GeographicEntityType	Tipo de entidad Geography. Solo está presente cuando se solicitó entityType y está disponible.
LatLongPairAbbreviated	Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".
LocalizedMapView	El parámetro View (también denominado parámetro "región de usuario") le permite mostrar los mapas correctos para un determinado país o región para regiones controvertidas geopolíticamente. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unificado", incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado a acceder a través de Azure Maps. Ejemplo: view=IN. Consulte Vistas admitidas para obtener más información y para ver las vistas disponibles.
MatchType	Tipos de coincidencias para una operación de búsqueda de direcciones inversas.
QueryType	Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
ResponseFormat	Formato deseado de la respuesta. El valor puede ser json o xml.
ReverseSearchAddressResult	Este objeto se devuelve de una llamada inversa de dirección Búsqueda correcta.
ReverseSearchAddressResultItem	Objeto Result para una respuesta inversa de dirección Búsqueda
RoadUseType	Describe los posibles usos de una carretera.
SearchSummary	Objeto de resumen de una respuesta de API de Búsqueda.

Address

Dirección del resultado

Nombre	Tipo	Description
boundingBox	BoundingBoxCompassNotation	Cuadro de límite de la ubicación.
buildingNumber	string	Número de edificio en la calle. EN DESUSO, use streetNumber en su lugar.
country	string	nombre de país o región
countryCode	string	País (Nota: Se trata de un código de dos letras, no un nombre de país o región).
countryCodeISO3	string	Código de país ISO alfa-3
countrySecondarySubdivision	string	County
countrySubdivision	string	Estado o provincia
countrySubdivisionCode	string	countrySubdivisionCode prefijo por countryCode ( countryCode-countrySubdivisionCode ) y el guión forma el código ISO 3166-2. Ejemplos: TX para Texas, SCT para Escocia y ON para Ontario.
countrySubdivisionName	string	Nombre completo de un primer nivel de jerarquía administrativa de país o región. Este campo solo aparece en caso de que countrySubdivision se presente en forma abreviada. Solo se admite para ESTADOS UNIDOS, Canadá y Reino Unido.
countryTertiarySubdivision	string	Área con nombre
crossStreet	string	Nombre de la calle que se cruza.
extendedPostalCode	string	Código postal extendido (la disponibilidad depende de la región).
freeformAddress	string	Una línea de direcciones con formato según las reglas de formato del país o región de origen de un resultado, o en el caso de un país o región, su nombre completo de país o región.
localName	string	Componente de dirección que representa el nombre de un área geográfica o localidad que agrupa varios objetos direccionables con fines de direccionamiento, sin ser una unidad administrativa. Este campo se usa para compilar la freeformAddress propiedad . localName representa el municipio postal. Dependiendo de la ubicación, localName es el nombre comúnmente conocido de una ciudad o ciudad. Para el nombre conocido habitualmente de una ciudad o ciudad, use localName en lugar de municipality.
municipality	string	Ciudad/Ciudad Nota: municipality representa el municipio residencial. Dependiendo de la ubicación, el municipality valor puede diferir del nombre comúnmente conocido de una ciudad o ciudad. Para el nombre comúnmente conocido de la ciudad o ciudad, se sugiere que el localName valor se use en lugar del municipality valor .
municipalitySubdivision	string	Sub/Super City
neighbourhood	string	Un barrio es una zona geográficamente localizada dentro de una ciudad o ciudad con características distintivas e interacciones sociales entre los habitantes.
postalCode	string	Código postal/código postal
routeNumbers	string[]	Los códigos usados para identificar inequívocamente la calle
street	string	Nombre de la calle. EN DESUSO, use streetName en su lugar.
streetName	string	Nombre de la calle.
streetNameAndNumber	string	Nombre y número de la calle.
streetNumber	string	Número de edificio en la calle.

BoundingBoxCompassNotation

Cuadro de límite de la ubicación.

Nombre	Tipo	Description
entity	Entity	Origen del tipo de entidad del rectángulo de selección. Para la geocodificación inversa, siempre es igual a la posición.
northEast	string	Latitud norte-este,coordenada de longitud del rectángulo delimitador como floats separados por comas
southWest	string	Latitud sur-oeste, coordenada de longitud del rectángulo delimitador como floats separados por comas

Entity

Origen del tipo de entidad del rectángulo de selección. Para la geocodificación inversa, siempre es igual a la posición.

Nombre	Tipo	Description
position	string	Entidad position

ErrorAdditionalInfo

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

GeographicEntityType

Tipo de entidad Geography. Solo está presente cuando se solicitó entityType y está disponible.

Nombre	Tipo	Description
Country	string	nombre de país o región
CountrySecondarySubdivision	string	County
CountrySubdivision	string	Estado o provincia
CountryTertiarySubdivision	string	Área con nombre
Municipality	string	Ciudad/Ciudad
MunicipalitySubdivision	string	Sub/Super City
Neighbourhood	string	Barrio
PostalCodeArea	string	Código postal/código postal

LatLongPairAbbreviated

Una ubicación representada como latitud y longitud con nombres cortos "lat" & "lon".

Nombre	Tipo	Description
lat	number	Propiedad Latitude
lon	number	Longitud (propiedad)

LocalizedMapView

El parámetro View (también denominado parámetro "región de usuario") le permite mostrar los mapas correctos para un determinado país o región para regiones controvertidas geopolíticamente. Los distintos países o regiones tienen vistas diferentes de estas regiones y el parámetro View permite que la aplicación cumpla con la vista requerida por el país o región que la aplicación va a atender. De forma predeterminada, el parámetro View se establece en "Unificado", incluso si no lo ha definido en la solicitud. Es su responsabilidad determinar la ubicación de sus usuarios y luego establecer el parámetro Vista correctamente para esa ubicación. Como alternativa, tiene la opción de establecer "View=Auto", que devolverá los datos del mapa según la dirección IP de la solicitud. El parámetro View de Azure Maps debe usarse de conformidad con las leyes aplicables, incluidas las relativas a la asignación, del país o región en el que están disponibles mapas, imágenes y otros datos y contenido de terceros a los que está autorizado a acceder a través de Azure Maps. Ejemplo: view=IN.

Consulte Vistas admitidas para obtener más información y para ver las vistas disponibles.

Nombre	Tipo	Description
AE	string	Emiratos Árabes Unidos (vista árabe)
AR	string	Argentina (vista argentina)
Auto	string	Devuelva los datos del mapa según la dirección IP de la solicitud.
BH	string	Baréin (vista árabe)
IN	string	India (vista india)
IQ	string	Irak (vista árabe)
JO	string	Jordania (vista árabe)
KW	string	Kuwait (vista árabe)
LB	string	Líbano (vista árabe)
MA	string	Marruecos (vista marroquí)
OM	string	Omán (vista árabe)
PK	string	Pakistán (vista pakistaní)
PS	string	Autoridad Nacional Palestina (vista árabe)
QA	string	Catar (vista árabe)
SA	string	Arabia Saudí (vista árabe)
SY	string	Siria (vista árabe)
Unified	string	Vista unificada (otros)
YE	string	Yemen (vista árabe)

MatchType

Tipos de coincidencias para una operación de búsqueda de direcciones inversas.

Nombre	Tipo	Description
AddressPoint	string
HouseNumberRange	string
Street	string

QueryType

Tipo de consulta que se devuelve: NEARBY o NON_NEAR.

Nombre	Tipo	Description
NEARBY	string	Búsqueda se realizó alrededor de una determinada latitud y longitud con un radio definido
NON_NEAR	string	Búsqueda se realizó globalmente, sin sesgo en una determinada latitud y longitud, y ningún radio definido

ResponseFormat

Formato deseado de la respuesta. El valor puede ser json o xml.

Nombre	Tipo	Description
json	string	Formato de intercambio de datos de notación de objetos JavaScript
xml	string	Lenguaje de marcado extensible

ReverseSearchAddressResult

Este objeto se devuelve de una llamada inversa de dirección Búsqueda correcta.

Nombre	Tipo	Description
addresses	ReverseSearchAddressResultItem[]	Matriz de direcciones
summary	SearchSummary	Objeto Summary para una respuesta inversa de dirección Búsqueda

ReverseSearchAddressResultItem

Objeto Result para una respuesta inversa de dirección Búsqueda

Nombre	Tipo	Description
address	Address	Dirección del resultado
matchType	MatchType	Información sobre el tipo de coincidencia. Uno de los valores siguientes: AddressPoint HouseNumberRange Calle
position	string	Propiedad Position en forma de "{latitud},{longitud}"
roadUse	RoadUseType[]	Describe los posibles usos de una carretera.

RoadUseType

Describe los posibles usos de una carretera.

Nombre	Tipo	Description
Arterial	string
LimitedAccess	string
LocalStreet	string
Ramp	string
Rotary	string
Terminal	string

SearchSummary

Objeto de resumen de una respuesta de API de Búsqueda.

Nombre	Tipo	Description
fuzzyLevel	integer	Nivel máximo aproximado necesario para proporcionar resultados.
geoBias	LatLongPairAbbreviated	Indicación cuando el motor de búsqueda interno ha aplicado un sesgo geoespacial para mejorar la clasificación de los resultados. En algunos métodos, esto puede verse afectado estableciendo los parámetros lat y lon cuando están disponibles. En otros casos es puramente interno.
limit	integer	Número máximo de respuestas que se devolverán
numResults	integer	Número de resultados en la respuesta.
offset	integer	Desplazamiento inicial de los resultados devueltos dentro del conjunto de resultados completo.
query	string	Parámetro de consulta que se usó para generar estos resultados de búsqueda.
queryTime	integer	Tiempo dedicado a resolver la consulta, en milisegundos.
queryType	QueryType	Tipo de consulta que se devuelve: NEARBY o NON_NEAR.
totalResults	integer	Número total de resultados encontrados.