Geo API: Places

1. Places suggestions

Curl request

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

HTTP request

GET /geo/places?query=QUERY_STRING&key=YOUR_GEO_API_KEY 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: 821

[{"addressString":"PREDICTION 1","osmPlaceId":"PLACE_ID_1","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}},{"addressString":"PREDICTION 2","osmPlaceId":"PLACE_ID_2","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}},{"addressString":"PREDICTION 3","osmPlaceId":"PLACE_ID_3","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}},{"addressString":"PREDICTION 4","osmPlaceId":"PLACE_ID_4","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}},{"addressString":"PREDICTION 5","osmPlaceId":"PLACE_ID_5","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}}]

HTTPie request

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

Request body

Request parameters

Parameter Description

Parameter	Description
`query`	Query string
`key`	Limosys API Key
`language`	Language code of response (Optional)
`countries`	Array of contry codes - comma separated (Optional)
`proximity`	Search Proximity Lat,Lon (Optional)
`lat`	[DEPRECATED] Search Proximity Latitude (Optional)
`lon`	[DEPRECATED] Search Proximity Longitude (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

query

Query string

key

Limosys API Key

language

Language code of response (Optional)

countries

Array of contry codes - comma separated (Optional)

proximity

Search Proximity Lat,Lon (Optional)

lat

[DEPRECATED] Search Proximity Latitude (Optional)

lon

[DEPRECATED] Search Proximity Longitude (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

[{"addressString":"PREDICTION 1","osmPlaceId":"PLACE_ID_1","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}},{"addressString":"PREDICTION 2","osmPlaceId":"PLACE_ID_2","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}},{"addressString":"PREDICTION 3","osmPlaceId":"PLACE_ID_3","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}},{"addressString":"PREDICTION 4","osmPlaceId":"PLACE_ID_4","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}},{"addressString":"PREDICTION 5","osmPlaceId":"PLACE_ID_5","coord":{"lat":-25.0,"lon":25.0},"boundsSW":{"lat":-25.0,"lon":25.0},"boundsNE":{"lat":-25.0,"lon":25.0}}]

Response fields

Path Type Description

Path	Type	Description
`[]`	`Array`	Array of suggestions - Address object with less details
`[].addressString`	`String`	Address display string
`[].osmPlaceId`	`String`	OSM Place ID (Optional) - if not present, object should already contain all details
`[].coord`	`Object`	Coordinate LatLng
`[].boundsSW`	`Object`	Place bounds SW LatLng
`[].boundsNE`	`Object`	Place bounds NE LatLng
`[].details`	`Boolean`	If true then all details are present and no need to call details by place id (Optional)
`[].airportCd`	`String`	Airport Code - if any (Optional)
`[].town`	`String`	Town (Optional)
`[].country`	`String`	Country (Optional)
`[].countryCd`	`String`	Country Code (Optional)
`[].building`	`String`	Building Number (Optional)
`[].state`	`String`	State (Optional)
`[].stateCd`	`String`	Two-Letter State Code (Optional)
`[].zip`	`String`	Zip Code (Optional)
`[].district`	`String`	District (Optional)
`[].neighbourhood`	`String`	Neighborhood (Optional)
`[].suburb`	`String`	Suburb (Optional)
`[].publicBuilding`	`String`	Public Building (Optional)

[]

Array

Array of suggestions - Address object with less details

[].addressString

String

Address display string

[].osmPlaceId

String

OSM Place ID (Optional) - if not present, object should already contain all details

[].coord

Object

Coordinate LatLng

[].boundsSW

Object

Place bounds SW LatLng

[].boundsNE

Object

Place bounds NE LatLng

[].details

Boolean

If true then all details are present and no need to call details by place id (Optional)

[].airportCd

String

Airport Code - if any (Optional)

[].town

String

Town (Optional)

[].country

String

Country (Optional)

[].countryCd

String

Country Code (Optional)

[].building

String

Building Number (Optional)

[].state

String

State (Optional)

[].stateCd

String

Two-Letter State Code (Optional)

[].zip

String

Zip Code (Optional)

[].district

String

District (Optional)

[].neighbourhood

String

Neighborhood (Optional)

[].suburb

String

Suburb (Optional)

[].publicBuilding

String

Public Building (Optional)

2. Place details

Curl request

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

HTTP request

GET /geo/places/WPLACE_ID?key=YOUR_GEO_API_KEY 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/places/WPLACE_ID?key=YOUR_GEO_API_KEY' \
    'Content-Type:application/json;charset=UTF-8' \
    'Accept:application/json'

Path parameters

Table 1. /geo/places/{PLACE_ID}
Parameter	Description
`PLACE_ID`	OSM Place ID

Request body

Request parameters

Parameter Description

Parameter	Description
`key`	Limosys API Key
`language`	Language code of response (Optional)

key

Limosys API Key

language

Language code of response (Optional)

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