Geocode an address

Returns the latitude and longitude of the address you specify.

URL

GET https://maps-api.apple.com/v1/geocode

Name	Type	Description
`q` Required	string	The address to geocode. For example: `q=1 Apple Park, Cupertino, CA`
`limitToCountries` Optional	[string]	A comma-separated list of two-letter ISO 3166-1 codes to limit the results to. For example: `limitToCountries=US,CA`. If you specify two or more countries, the results reflect the best available results for some or all of the countries rather than everything related to the query for those countries.
`lang` Optional	`Lang`	The language the server should use when returning the response, specified using a BCP 47 language code. For example, for English use `lang=en-US`.
`searchLocation` Optional	`SearchLocation`	A location defined by the application as a hint. Specify the location as a comma-separated string containing the latitude and longitude. For example, `searchLocation=37.78,-122.42`.
`searchRegion` Optional	`SearchRegion`	A region the app defines as a hint. Specify the region specified as a comma-separated string that describes the region in the form north-latitude, east-longitude, south-latitude, west-longitude. For example, `searchRegion=38,-122.1,37.5,-122.5`.
`userLocation` Optional	`UserLocation`	The location of the user, specified as a comma-separated string that contains the latitude and longitude. For example: `userLocation=37.78,-122.42`. Certain APIs, such as Searching, may opt to use the `userLocation`, if specified, as a fallback for the `searchLocation`.

Status	Reason	Type	Description
200	OK Content-Type: application/json	`PlaceResults`	An array of Place objects.
400	Bad Request Content-Type: application/json	`ErrorResponse`	An ErrorResponse object that contains an error message and an array of strings that contains additional details.
401	Unauthorized Content-Type: application/json	`ErrorResponse`	An ErrorResponse object that contains an error message that indicates the Maps access token was missing or invalid and an array of strings that contains additional details about the error.
429	Content-Type: application/json	`ErrorResponse`	An ErrorResponse object that indicates the call exceeds the daily service call quota for the authorization token presented. The app should try again later. If your app requires a larger daily quota, submit a quota increase request form.
500	Internal Server Error Content-Type: application/json	`ErrorResponse`	An ErrorResponse object that contains a server error message and an array of strings that describe additional details about the error.