Geo API: Geocoder

1. Geocode Address

Curl request

$ curl 'https://utils.limosys.net/geo/geocoder?key=YOUR_GEO_API_KEY&address=ADDRESS' -i -X GET \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json'

HTTP request

GET /geo/geocoder?key=YOUR_GEO_API_KEY&address=ADDRESS HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Host: utils.limosys.net

HTTP response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: origin, content-type, accept, authorization
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Set-Cookie
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 502

{"type":"building","typeDetail":"building","addressString":"ADDRESS","osmPlaceId":"WPLACE_ID","coord":{"lat":25.0,"lon":-25.0},"boundsSW":{"lat":-25.0,"lon":-25.0},"boundsNE":{"lat":25.0,"lon":25.0},"town":"SAMPLE_CITY","country":"SAMPLE_COUNTRY","countryCd":"SCC","building":"555","state":"New York","stateCd":"NY","zip":"10001","suburb":"SAMPLE_SUBURB","district":"SAMPLE_DISTRICT","neighbourhood":"SAMPLE_HOOD","publicBuilding":"10000","details":true,"sourceStr":"LS_API","geocodeSourceStr":"LOCAL"}

HTTPie request

$ http GET 'https://utils.limosys.net/geo/geocoder?key=YOUR_GEO_API_KEY&address=ADDRESS' \
    'Content-Type:application/json;charset=UTF-8' \
    'Accept:application/json'

Request body

Request parameters

Parameter Description

Parameter	Description
`address`	Address string to geocode
`key`	Limosys API Key
`geocodeSource`	Geocoding source
`language`	Language code of response (Optional)
`countries`	Array of contry codes - comma separated (Optional)
`proximity`	Search Proximity Lat,Lon (Optional)
`bounds`	Array of coordinates for search bounds: SW Lat, Lon, NE Lat, Lon (Optional)
`forcebounds`	Whether bounds should be forced or preferred "yes" to force (Optional)
`fetch`	Force fetch from thirdparty "yes" or "no" - default: server decides

address

Address string to geocode

key

Limosys API Key

geocodeSource

Geocoding source

language

Language code of response (Optional)

countries

Array of contry codes - comma separated (Optional)

proximity

Search Proximity Lat,Lon (Optional)

bounds

Array of coordinates for search bounds: SW Lat, Lon, NE Lat, Lon (Optional)

forcebounds

Whether bounds should be forced or preferred "yes" to force (Optional)

fetch

Force fetch from thirdparty "yes" or "no" - default: server decides

Response body

{"type":"building","typeDetail":"building","addressString":"ADDRESS","osmPlaceId":"WPLACE_ID","coord":{"lat":25.0,"lon":-25.0},"boundsSW":{"lat":-25.0,"lon":-25.0},"boundsNE":{"lat":25.0,"lon":25.0},"town":"SAMPLE_CITY","country":"SAMPLE_COUNTRY","countryCd":"SCC","building":"555","state":"New York","stateCd":"NY","zip":"10001","suburb":"SAMPLE_SUBURB","district":"SAMPLE_DISTRICT","neighbourhood":"SAMPLE_HOOD","publicBuilding":"10000","details":true,"sourceStr":"LS_API","geocodeSourceStr":"LOCAL"}

Response fields

Path Type Description

Path	Type	Description
`type`	`String`	Address Type
`typeDetail`	`String`	Address Detailed Type
`addressString`	`String`	Address display string
`osmPlaceId`	`String`	OSM Place ID
`coord`	`Object`	Coordinate LatLng
`boundsSW`	`Object`	Place bounds SW LatLng
`boundsNE`	`Object`	Place bounds NE LatLng
`airportCd`	`String`	Airport Code - if any (Optional)
`town`	`String`	Town
`country`	`String`	Country
`countryCd`	`String`	Country Code
`building`	`String`	Building Number
`state`	`String`	State
`stateCd`	`String`	Two-Letter State Code
`zip`	`String`	Zip Code
`district`	`String`	District
`neighbourhood`	`String`	Neighborhood
`suburb`	`String`	Suburb
`publicBuilding`	`String`	Public Building
`source`	`String`	(Deprecated) Source of data (enum)
`sourceStr`	`String`	Source of data
`geocodeSource`	`String`	(Deprecated) Source of gps coordinates (enum)
`geocodeSourceStr`	`String`	Source of gps coordinates
`details`	`Boolean`	Address contains details - true or false

type

String

Address Type

typeDetail

String

Address Detailed Type

addressString

String

Address display string

osmPlaceId

String

OSM Place ID

coord

Object

Coordinate LatLng

boundsSW

Object

Place bounds SW LatLng

boundsNE

Object

Place bounds NE LatLng

airportCd

String

Airport Code - if any (Optional)

town

String

Town

country

String

Country

countryCd

String

Country Code

building

String

Building Number

state

String

State

stateCd

String

Two-Letter State Code

zip

String

Zip Code

district

String

District

neighbourhood

String

Neighborhood

suburb

String

Suburb

publicBuilding

String

Public Building

source

String

(Deprecated) Source of data (enum)

sourceStr

String

Source of data

geocodeSource

String

(Deprecated) Source of gps coordinates (enum)

geocodeSourceStr

String

Source of gps coordinates

details

Boolean

Address contains details - true or false

2. Geocode Coordinates

Curl request

$ curl 'https://utils.limosys.net/geo/geocoder?key=YOUR_GEO_API_KEY&lat=25.0&lon=-25.0' -i -X GET \
    -H 'Content-Type: application/json;charset=UTF-8' \
    -H 'Accept: application/json'

HTTP request

GET /geo/geocoder?key=YOUR_GEO_API_KEY&lat=25.0&lon=-25.0 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Accept: application/json
Host: utils.limosys.net

HTTP response

HTTP/1.1 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Methods: POST, GET, PUT, OPTIONS, DELETE
Access-Control-Max-Age: 3600
Access-Control-Allow-Headers: origin, content-type, accept, authorization
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Set-Cookie
Content-Type: application/json
X-Content-Type-Options: nosniff
X-XSS-Protection: 1; mode=block
Cache-Control: no-cache, no-store, max-age=0, must-revalidate
Pragma: no-cache
Expires: 0
Strict-Transport-Security: max-age=31536000 ; includeSubDomains
X-Frame-Options: DENY
Content-Length: 502

{"type":"building","typeDetail":"building","addressString":"ADDRESS","osmPlaceId":"WPLACE_ID","coord":{"lat":25.0,"lon":-25.0},"boundsSW":{"lat":-25.0,"lon":-25.0},"boundsNE":{"lat":25.0,"lon":25.0},"town":"SAMPLE_CITY","country":"SAMPLE_COUNTRY","countryCd":"SCC","building":"555","state":"New York","stateCd":"NY","zip":"10001","suburb":"SAMPLE_SUBURB","district":"SAMPLE_DISTRICT","neighbourhood":"SAMPLE_HOOD","publicBuilding":"10000","details":true,"sourceStr":"LS_API","geocodeSourceStr":"LOCAL"}

HTTPie request

$ http GET 'https://utils.limosys.net/geo/geocoder?key=YOUR_GEO_API_KEY&lat=25.0&lon=-25.0' \
    'Content-Type:application/json;charset=UTF-8' \
    'Accept:application/json'

Request body

Request parameters

Parameter Description

Parameter	Description
`lat`	Latitude to geocode
`lon`	Longitude to geocode
`key`	Limosys API Key
`fetch`	Force fetch from thirdparty "yes" or "no" - default: server decides

lat

Latitude to geocode

lon

Longitude to geocode

key

Limosys API Key

fetch

Force fetch from thirdparty "yes" or "no" - default: server decides

Response body

{"type":"building","typeDetail":"building","addressString":"ADDRESS","osmPlaceId":"WPLACE_ID","coord":{"lat":25.0,"lon":-25.0},"boundsSW":{"lat":-25.0,"lon":-25.0},"boundsNE":{"lat":25.0,"lon":25.0},"town":"SAMPLE_CITY","country":"SAMPLE_COUNTRY","countryCd":"SCC","building":"555","state":"New York","stateCd":"NY","zip":"10001","suburb":"SAMPLE_SUBURB","district":"SAMPLE_DISTRICT","neighbourhood":"SAMPLE_HOOD","publicBuilding":"10000","details":true,"sourceStr":"LS_API","geocodeSourceStr":"LOCAL"}

Response fields

Path Type Description

Path	Type	Description
`type`	`String`	Address Type
`typeDetail`	`String`	Address Detailed Type
`addressString`	`String`	Address display string
`osmPlaceId`	`String`	OSM Place ID
`coord`	`Object`	Coordinate LatLng
`boundsSW`	`Object`	Place bounds SW LatLng
`boundsNE`	`Object`	Place bounds NE LatLng
`airportCd`	`String`	Airport Code - if any (Optional)
`town`	`String`	Town
`country`	`String`	Country
`countryCd`	`String`	Country Code
`building`	`String`	Building Number
`state`	`String`	State
`stateCd`	`String`	Two-Letter State Code
`zip`	`String`	Zip Code
`district`	`String`	District
`neighbourhood`	`String`	Neighborhood
`suburb`	`String`	Suburb
`publicBuilding`	`String`	Public Building
`source`	`String`	(Deprecated) Source of data (enum)
`sourceStr`	`String`	Source of data
`geocodeSource`	`String`	(Deprecated) Source of gps coordinates (enum)
`geocodeSourceStr`	`String`	Source of gps coordinates
`details`	`Boolean`	Address contains details - true or false

type

String

Address Type

typeDetail

String

Address Detailed Type

addressString

String

Address display string

osmPlaceId

String

OSM Place ID

coord

Object

Coordinate LatLng

boundsSW

Object

Place bounds SW LatLng

boundsNE

Object

Place bounds NE LatLng

airportCd

String

Airport Code - if any (Optional)

town

String

Town

country

String

Country

countryCd

String

Country Code

building

String

Building Number

state

String

State

stateCd

String

Two-Letter State Code

zip

String

Zip Code

district

String

District

neighbourhood

String

Neighborhood

suburb

String

Suburb

publicBuilding

String

Public Building

source

String

(Deprecated) Source of data (enum)

sourceStr

String

Source of data

geocodeSource

String

(Deprecated) Source of gps coordinates (enum)

geocodeSourceStr

String

Source of gps coordinates

details

Boolean

Address contains details - true or false