Geocode address

Get the latitude and longitude of an address

POST /api/location/geoCode

Geocode address

cURL

curl --request POST \
  --url https://api2.rhombussystems.com/api/location/geoCode \
  --header 'Content-Type: application/json' \
  --header 'x-auth-apikey: <api-key>' \
  --header 'x-auth-scheme: <x-auth-scheme>' \
  --data '
{
  "address": "1600 Pennsylvania Avenue NW, Washington, DC"
}
'

200

{
  "error": true,
  "errorMsg": "<string>",
  "latitude": 38.8977,
  "longitude": -77.0365,
  "warningMsg": "<string>"
}

Authorizations

x-auth-apikey · string · header · required

Your Rhombus API key. Must be accompanied by the x-auth-scheme header set to api-token (or partner-api-token for partner endpoints).

Headers

x-auth-scheme · enum<string> · default: api-token · required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Available options: api-token, api, partner-api-token, partner-api

Body

application/json

Request object for getting the latitude and longitude of an address.

address · string | null

Address to geocode

Example:

"1600 Pennsylvania Avenue NW, Washington, DC"

Response

200 - application/json

OK

Response object containing the latitude and longitude of an address.

error · boolean | null

errorMsg · string | null

latitude · number<double> | null

Latitude coordinate of the address

Example:

38.8977

longitude · number<double> | null

Longitude coordinate of the address

Example:

-77.0365

warningMsg · string | null