1.0
OAS 3.0.1

RoutiGo Geocoding REST API

Download OpenAPI Spec
Base URL
https://api.routigo.com/api
Client Libraries
Shell
Ruby
Ruby
Node.js
PHP
Python
C
More
Shell cURL
Authentication
X-API-KEY (API Key)

Geocoding​

This API provides the following functionality: Geocode Addresses: A solution to convert addresses into accurate longitudes and latitudes.

Reverse Geocoding: Transform geographic coordinates into human-readable addresses effortlessly.

Endpoints
get/v1/geocoding/geocodeget/v1/geocoding/reverseGeocode

Convert addresses into accurate longitudes and latitudes.​

Obtain geographic coordinates for a given address or perform a free-format search. Choose between providing a free-text address using the 'address' query parameter or use structured parameters for more granular control.

Query Parameters
  • address
    required

    Free-text address for a free-format search.

  • streetName
    required

    Name of the street.

  • houseNumber
    required

    Number of the building or house.

  • houseNumberAddition
    required

    Additional information for the house number, if applicable (e.g., apartment number or building section).

  • postcode
    required

    Postal code of the area.

  • cityName
    required

    Name of the city or locality.

  • countryCode
    required

    ISO 3166-1 alpha-2 country code.

Responses
  • 200

    Successful response with geocoded coordinates or address details.

  • 400

    There was a problem with the request itself. See the response for a more detailed error description.

  • 401

    Authentication information is missing or invalid. See the response for more detailed error description.

  • 403

    The user (or API key) does not have enough permissions to execute the request. See the response for more detailed error description.

  • 500

    Unexpected error. Please contact RoutiGo for more details.

get/v1/geocoding/geocode
Shell cURL
curl --request GET \
--url 'https://api.routigo.com/api/v1/geocoding/geocode?address=RoutiGo%2C+maarssen%2C+utrecht&streetName=Bisonspoor&houseNumber=3002&houseNumberAddition=A+901&postcode=3605&cityName=Maarssen&countryCode=NL' \
--header 'X-Api-Key: YOUR_TOKEN'
{
"results": [
{
"results": [
{
"confidence": 9,
"formattedAddress": "Athens Tower, 8th floor Bisonspoor 3002, A901, 3605 LT Maarssen, Netherlands",
"geocode": {
"latitude": 52.13435459,
"longitude": 5.031216
},
"address": {
"streetName": "Bisonspoor",
"houseNumber": "3002",
"houseNumberAddition": "A901",
"postalCode": "3605LT",
"city": "Maarssen",
"country": "NL"
},
"proposedDeliveryLocation": null
}
]
}
]
}

Successful response with geocoded coordinates or address details.

Transform geographic coordinates into human-readable addresses.​

Perform reverse geocoding by providing latitude and longitude coordinates. The API will return a human-readable address corresponding to the specified location.

Query Parameters
  • lat
    required

    A numeric representation of a location's north-south position on the Earth's surface. This value typically ranges from -90 (representing the South Pole) to 90 (representing the North Pole). Positive values indicate positions north of the equator, while negative values indicate positions south of the equator.

  • lng
    required

    A numeric representation of a location's east-west position on the Earth's surface. This value typically ranges from -180 (representing the International Date Line in the Pacific Ocean) to 180 (representing the same meridian in the Atlantic Ocean). Positive values indicate positions east of the Prime Meridian, while negative values indicate positions west of the Prime Meridian.

Responses
  • 200

    Successful response with the reverse geocoded address.

  • 400

    There was a problem with the request itself. See the response for a more detailed error description.

  • 401

    Authentication information is missing or invalid. See the response for more detailed error description.

  • 403

    The user (or API key) does not have enough permissions to execute the request. See the response for more detailed error description.

  • 500

    Unexpected error. Please contact RoutiGo for more details.

get/v1/geocoding/reverseGeocode
Shell cURL
curl --request GET \
--url 'https://api.routigo.com/api/v1/geocoding/reverseGeocode?lat=52.13905&lng=5.03968' \
--header 'X-Api-Key: YOUR_TOKEN'
{
"results": [
{
"results": [
{
"confidence": 9,
"formattedAddress": "Athens Tower, 8th floor Bisonspoor 3002, A901, 3605 LT Maarssen, Netherlands",
"geocode": {
"latitude": 52.13435459,
"longitude": 5.031216
},
"address": {
"streetName": "Bisonspoor",
"houseNumber": "3002",
"houseNumberAddition": "A901",
"postalCode": "3605LT",
"city": "Maarssen",
"country": "NL"
},
"proposedDeliveryLocation": null
}
]
}
]
}

Successful response with the reverse geocoded address.

Address​

{} Address
streetName
required
string
example: Bisonspoor

Name of the street.

houseNumber
required
string
example: 3002

Number of the building or house.

houseNumberAddition
required
string
example: A 901

Additional information for the house number, if applicable (e.g., apartment number or building section).

postcode
required
string
example: 3605 LT

Postal code of the area.

cityName
required
string
example: Maarssen

Name of the city or locality.

countryCode
required
string
example: NL

ISO 3166-1 alpha-2 country code.

Geocode​

{} Geocode
latitude
required
number · double
example: 52.13905

The latitude of the location. Must be a valid numeric value.

longitude
required
number · double
example: 5.03968

The longitude of the location. Must be a valid numeric value.

GeocodingResult​

{} GeocodingResult
confidence
required
integer · int32
example: 9

The confidence level of the geocoding result. Higher values indicate higher confidence.

formattedAddress
required
string
example: Athens Tower, 8th floor Bisonspoor 3002, A901, 3605 LT Maarssen

The formatted human-readable address corresponding to the geocoding result.

geocode
required
object

Geocode information representing latitude and longitude coordinates.

{} object
latitude
required
number · double
example: 52.13905

The latitude of the location. Must be a valid numeric value.

longitude
required
number · double
example: 5.03968

The longitude of the location. Must be a valid numeric value.

address
required
object

Represents an address with structured components.

{} object
streetName
required
string
example: Bisonspoor

Name of the street.

houseNumber
required
string
example: 3002

Number of the building or house.

houseNumberAddition
required
string
example: A 901

Additional information for the house number, if applicable (e.g., apartment number or building section).

postcode
required
string
example: 3605 LT

Postal code of the area.

cityName
required
string
example: Maarssen

Name of the city or locality.

countryCode
required
string
example: NL

ISO 3166-1 alpha-2 country code.

proposedDeliveryLocation
required
object

Geocode information representing latitude and longitude coordinates.

{} object
latitude
required
number · double
example: 52.13905

The latitude of the location. Must be a valid numeric value.

longitude
required
number · double
example: 5.03968

The longitude of the location. Must be a valid numeric value.