Geolocation API
Introduction
Address geolocation, 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.
How to call the API
You must first login before sending the request. The authorization header in the request must include the access token obtained from the login API call.
API Input Guidelines
Need to pass the following information
- Address
Sample Curl
curl --location --request POST 'https://api.signzy.app/api/v3/matcher/geocode-premium' \
--header 'Authorization: <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"address": "<address>",
"latitude": "<lattitude>",
"longitude": "<longitude>"
}'
Input Parameters
PARAMETER NAME | REQUIRED/OPTIONAL | DESCRIPTION |
|---|---|---|
Content-Type | Required | application/json |
Authorization | Required | Authorization token |
address | Required | Address in which geoocoding is done |
latitude | Optional | Latitude |
longitude | Optional | Longitude |
Sample Response
{
"result": {
"address": "WASHINGTON, DC, USA",
"latitude": "38.9071923",
"longitude": "-77.0368707",
"confidenceScore": 0.5,
"city": "WASHINGTON",
"state": "DISTRICT OF COLUMBIA",
"stateCode": "DC",
"country": "UNITED STATES",
"countryCode": "US",
"zipcode": "",
"distanceInKms": "1.35"
}
}
Response Parameter
Parameters Name | Data Type | Description |
|---|---|---|
result.address | String | Address for which geocoding needs to be done |
result.latitude | String | Latitude |
result.longitude | String | Longitude |
result.confidenceScore | String | Confidence score |
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 |
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].