-->

Applies to: S0 and S1 pricing tiers.

Free IP Lookup Geolocation API.

This service will return the ISO country code for the provided IP address. Developers can use this information to block or alter certain content based on geographical locations where the application is being viewed from.

Note: This service returns results from IANA and does not necessarily reflect the views of Microsoft Corporation.

URI Parameters

NameInRequiredTypeDescription
format
path True

Desired format of the response. Only json format is supported.

query
  • string

One of the Azure Maps keys provided from an Azure Map Account. Please refer to this article for details on how to manage authentication.

api-version
query True
  • string

Version number of Azure Maps API. Current version is 1.0

query True
  • string

The IP address. Both IPv4 and IPv6 are allowed.

Request Header

NameRequiredTypeDescription
x-ms-client-id
  • string

Specifies which account is intended for usage in conjunction with the Azure AD security model. It represents a unique ID for the Azure Maps account and can be retrieved from Azure Maps management plane Account API. To use Azure AD security in Azure Maps see the following articles for guidance.

Responses

Where
NameTypeDescription
200 OK

OK

400 Bad Request

Bad request: one or more parameters were incorrectly specified or are mutually exclusive.

401 Unauthorized

Access denied due to invalid subscription key or invalid Azure Active Directory bearer token. Make sure to provide a valid key for an active Azure subscription and Maps resource. Otherwise, verify the WWW-Authenticate header for error code and description of the provided AAD bearer token.

Headers

  • WWW-Authenticate: string
403 Forbidden

Permission, capacity, or authentication issues.

404 Not Found

Not Found: the requested resource could not be found, but it may be available again in the future.

500 Internal Server Error

An error occurred while processing the request. Please try again later.

Security

azure_auth

These are the Azure Active Directory OAuth2 Flows. When paired with Azure Role Based Access control it can be used to control access to Azure Maps REST APIs. Azure Role based access controls are used to designate access to one or more Azure Maps resource account or sub-resources. Any user, group, or service principal can be granted access via a built in role or a custom role composed of one or more permissions to Azure Maps REST APIs.

To implement scenarios we recommend viewing authentication concepts. In summary, this security definition provides a solution for modeling application(s) via objects capable of access control on specific APIs and scopes.

Note

  • This security definition requires the use of the x-ms-client-id header to indicate which Azure Maps resource the application is requesting access to. This can be acquired from the Maps management API.
  • The Authorization URL is specific to the Azure public cloud instance. Sovereign clouds have unique Authorization URLs and Azure Active directory configurations.
  • The Azure role based access control is configured from the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs.
  • Usage of the Azure Maps Web SDK allows for configuration based setup of an application for multiple use cases.
  • Currently Azure Active Directory v1.0 tokens are supported.

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

subscription-key

This is a shared key which is provisioned when creating an Azure Maps resource through the Azure management plane via Azure portal, Powershell, CLI, Azure SDKs, or REST APIs. With this key, any application is authorized to access all REST APIs. In other words, these can currently be treated as master keys to the account which they are issued for. For publicly exposed applications our recommendation is to use server to server access of Azure Maps REST APIs where this key can be securely stored.

Type: apiKey
In: query

Examples

GetLocationByIpAddress

Sample Request

Definitions

CountryRegion

The object containing the country/region information.

Error

This object is returned when an error occurs in the Maps API

ErrorResponse

This response object is returned when an error occurs in the Maps API

IpAddressToLocationResult

This object is returned from a successful call to IP Address to country/region API

JsonFormat

Desired format of the response. Only json format is supported.

CountryRegion

The object containing the country/region information.

NameTypeDescription
isoCode
  • string

The IP Address's 2-character code (ISO 3166-1) of the country or region as assigned by IANA and regional internet authorities. Please note, IP address in ranges reserved for special purpose will return Null for country/region.

Error

This object is returned when an error occurs in the Maps API

Differences Between the LP & LP Z BizfluentAlso shop in Also shop in. Labels measuring 4 inches wide and 22 inches long can be used with the LP An exciting new addition to the Zebra Desktop Series, the dynamic Z features a powerful combination of zebra lp 2844-z Zebra attributes. White, Zebra lp 2844-z for 1 Rolls. She holds an associate degree in liberal arts from Rochester Community College in Minnesota. Zebra lp2844 specs.

NameTypeDescription
code
  • string

The HTTP status code.

message
  • string

If available, a human readable description of the error.

ErrorResponse

This response object is returned when an error occurs in the Maps API

NameTypeDescription
error

This object is returned when an error occurs in the Maps API

IpAddressToLocationResult

This object is returned from a successful call to IP Address to country/region API

NameTypeDescription
countryRegion

The object containing the country/region information.

ipAddress
  • string

The IP Address of the request.

JsonFormat

Desired format of the response. Only json format is supported.

NameTypeDescription
json
  • string