Geocoder

14 min

Introduction

Address geocoding, or simply geocoding, is the process of taking a text-based description of a location, such as an address or the name of a place, and returning geographic coordinates, frequently latitude/longitude pair, to identify a location on the Earth's surface. The Address Geocoder product takes address and returns back latitude / longitude and vice versa.

How to call the API

You will need to login before sending search request. You are required to pass the access token received from the login call, as authorization header in the Address Geocoder request.

API Input Guidelines

Select type Task to be performed

Address Geocoding

Reverse Geocoding

If task is Address Geocoding, input required is

Address

Latitude / Longitude if distance is required from the given address (Optional)

If the task is Reverse Geocoding, input required is

Latitude and Longitude

Address Geocoder

Sample Curl

curl --location 'https://api.signzy.app/api/v3/geocoder-api' \
--header 'Authorization: <Auth Token>' \
--header 'Content-Type: application/json' \
--data '{
    "task": "geocode",
    "address": "<Address>",
    "latitude": "<Latitude>",
    "longitude": "<Longitude>"
}'

Input Parameters

PARAMETER	DESCRIPTION	REQUIRED/OPTIONAL
Content-Type	Contains the id parameter returned from the login step	REQUIRED
Authorization	application/json	REQUIRED
task	Type of geocoder for address geocode - "geocode"	REQUIRED
address	Address of place whose information has to be retrieved	REQUIRED
latitude	Latitude of the place	OPTIONAL
longitude	Longitude of the place	OPTIONAL

Sample Response

{
    "task": "geocode"
    "address": "<Address>",
    "latitude": "<Latitude> ",
    "longitude": "<Longitude>",
    "id": 50,
    "result": {
        "address": "<Address>",
        "latitude": "<Latitude>",
        "longitude": "<Longitude>",
        "confidenceScore": 0.7,
        "city": "BENGALURU",
        "state": "KARNATAKA",
        "stateCode": "KA",
        "country": "INDIA",
        "countryCode": "IN",
        "zipcode": "560095",
        "distanceInKms": "1488.02"
    }
}

Response Parameters

Parameters Name	Data Type	Description
task	String	Type of geocoder
address	String	Address of place whose information has to be retrieved
latitude	String	Latitude of the place
longitude	String	Longitude of the place
id	Number	Unique id of identity
result.address	String	Address for which geocoding needs to be done
result.latitude	String	Latitude of the place
result.longitude	String	Longitude of the place
result.confidenceScore	Number	Tells the accuracy of the address detected
result.city	String	Name of the of the address provided
result.state	String	State name
result.stateCode	String	State code
result.country	String	Name of the country for the address
result.countryCode	String	Country code
result.zipcode	String	Zip code for the address
result.distanceInKms	String	Distance of the enquired latitude and logitude from the address provided

Status Codes

CODE	MESSAGE
404	Lat/Lon not found for given Address
500	Internal Server Error

Reverse Geocoder

Sample Curl

curl --location 'https://api.signzy.app/api/v3/geocoder-api' \
--header 'Authorization: <Auth Token>' \
--header 'Content-Type: application/json' \
--data '{
    "task": "reversegeocode",
    "latitude": "<Latitude>",
    "longitude": "<Longitude>"
}'

Input Parameters

PARAMETER	DESCRIPTION	REQUIRED/OPTIONAL
Content-Type	Contains the id parameter returned from the login step	REQUIRED
Authorization	application/json	REQUIRED
task	Type of geocoder for reverse geocode - "reversegeocode"	REQUIRED
latitude	Latitude of the place	REQUIRED
longitude	Longitude of the place	REQUIRED

Sample Response

{
    "task": "reversegeocode"
    "latitude": "<Latitude>",
    "longitude": "<Longitue> ",
    "id": 50,
    "result": {
        "address": "<Address>",
        "latitude": "<Latitude>",
        "longitude": "<Longitue>",
        "confidenceScore": 0.7,
        "city": "BENGALURU",
        "state": "KARNATAKA",
        "stateCode": "KA",
        "country": "INDIA",
        "countryCode": "IN",
        "zipcode": "560095",
        "distanceInKms": "1488.02"
    }
}

Response Parameters

Parameters Name	Data Type	Description
task	String	Type of geocoder
latitude	String	Latitude of the place
longitude	String	Longitude of the place
id	Number	Unique id of user
result.address	String	Address for which geocoding needs to be done
result.latitude	String	Latitude of the place
result.longitude	String	Longitude of the place
result.confidenceScore	Number	Tells the accuracy of the address detected
result.city	String	Name of the of the address provided
result.state	String	State name
result.stateCode	String	State code
result.country	String	Name of the country for the address
result.countryCode	String	Country code
result.zipcode	String	Zip code for the address
result.distanceInKms	String	Distance of the enquired latitude and logitude from the address provided

Status Codes

CODE	MESSAGE
404	Address not found for given Lat/Lon
500	Internal Server Error

Getting help

Please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better.

You can reach out to us at [email protected].