Landmark API Documentation

Version 1.1, 2012-05-16

Change history


© Gecko Landmarks 2013-2015

Contents

  1. General
  2. Fetching landmark data
  3. Adding User points
  4. Deleting User points
  5. Android Example code
  6. List of subclasses

General

API key

All API calls require an API key, which is used to identify the source of all requests.

Contact us at api@geckolandmarks.com to get your own API key. You can use the rate-limited example key (EXAMPLE_KEY_3edaba1953abf86) for kicking the tires.

Responses

HTTP response code is used for signaling errors.

Fetching landmark data

URL

GET: api.geckolandmarks.com/json

Get the N nearest landmarks for a given location. May also include user points.

Parameters

Response

GET: http://api.geckolandmarks.com/json?lat=6.4304&lon=3.4293&user_id=TEST_USER&api_key=EXAMPLE_KEY_3edaba1953abf86

=>

{
    "count": 10,
    "landmarks": [{
        "ccode": "NG",
        "dist": 0.0,
        "id": "xyz12ds23"
        "lat": 6.4304,
        "lon": 3.4293,
        "name1": "My Own Point",
        "name2": "Victoria Island",
        "name3": "Lagos City",
        "class": "U_mod",
        "subclass": "" },
    }, {
        "ccode": "NG",
        "dist": 0.0112840759427,
        "id": "4lfew4sd"
        "lat": 6.43047809601,
        "lon": 3.42936515808,
        "name1": "Protea Victoria Island Hotel",
        "name2": "Victoria Island",
        "name3": "Lagos City",
        "class": "P",
        "subclass": "AC-h",
    }, {
    { ...

The response includes closest N points to given coordinates, also public user added points added by your users. If user_id is used, the response will also include private/in-moderation points by this user if applicable.

Adding User points

URL

POST: api.geckolandmarks.com/userpoints

Parameters

These should be included in the POST body, in JSON format.

Parameters example

{
   "user_id":"TEST_USER",
   "lat":6.4304,
   "lon":3.4293,
   "api_key":"EXAMPLE_KEY_3edaba1953abf86",
   "name":"My own point",
   "public":true
}

Example using curl

curl -d '{ "user_id": "TEST_USER", "lat": 6.4304,
"lon": 3.4293, "api_key": "EXAMPLE_KEY_3edaba1953abf86", "name": "My own point",
"public": true }' http://api.geckolandmarks.com/userpoints

(Note: The command should be ran as a single line)

Response

Returns the newly added point data in similar format as landmarks in GET: /json.

{
    "ccode": "NG",
    "dist": 0.0,
    "lat": 6.4304,
    "lon": 3.4293,
    "name1": "My Own Point",
    "name2": "Victoria Island",
    "name3": "Lagos City",
    "class": "U_mod",
    "id": "xyz12ds23",
    "subclass": ""
}

Deleting User points

URL

DELETE: api.geckolandmarks.com/userpoints/{user_point_id}?api_key=EXAMPLE_KEY_3edaba1953abf86

Deletes a private user point

Parameters

Response

There is no data in the response, check the HTTP response code for results:

Example using curl

curl -XDELETE http://api.geckolandmarks.com/userpoints/xyz12ds23?api_key=EXAMPLE_KEY_3edaba1953abf86

Android Example code

An example Android client that uses the Landmark API is available on GitHub:

List of subclasses

Note: These are only valid when class is 'P'

Example: all hotels are listed as 'AC-h': Accommodations that do not fit into any of the subclasses 'AC-?' have plain 'AC' subclass.

None  
AC Accommodation  
AC-a Accommodation, Apartelle  
AC-h Accommodation, Hotel  
AC-l Accommodation, Lodge  
AC-m Accommodation, Motel  
AC-p Accommodation, Pension  
AC-r Accommodation, Resort  
BA Bank  
BR Bridge  
BU Building  
CA Cafeteria  
CE Cemetery & Memorial Park  
CI Cinema & Theater  
CO Convenience Store  
CS Car Service  
DR Drugstore  
ED Education  
ED-c Education, College  
ED-e Education, Elementary  
ED-h Education, High School  
ED-p Education, Pre-School  
ED-u Education, University  
EM Embassy & Consulate  
EN Entertainment  
EN-b Entertainment, Bar  
EN-c Entertainment, Club  
EN-d Entertainment, Disco  
EN-p Entertainment, Pub  
FA Fast Food  
GA Gas Station  
GO Government  
HE Health  
MA Market  
MP Manufacturing & production  
MU Museum & Library  
PI Place of Interest  
PL Plaza & Square  
PO Post Office  
PR Park  
RE Religion  
RE-c Religion, Christian  
RE-i Religion, Islamic  
RS Restaurant  
RS-a Restaurant, International  
RS-c Restaurant, Chinese  
RS-d Restaurant, Indian  
RS-e Restaurant, Seafood  
RS-f Restaurant, French  
RS-i Restaurant, Italian  
RS-j Restaurant, Japanese  
RS-k Restaurant, Korean  
RS-m Restaurant, Mexican  
RS-n Restaurant, Vietnamese  
RS-s Restaurant, Spanish  
RS-t Restaurant, Thai  
RS-v Restaurant, Vegetarian  
RT Restriction  
RT-c Check Point  
RT-g Gate  
RT-t Tollgate  
SA Safety  
SA-f Safety, Fire  
SA-m Safety, Military  
SA-p Safety, Police  
SD Subdivision  
SH Shopping Center  
SH-m Shopping Center, Mall  
SH-s Shopping Center, Department Store  
SP Sport  
ST Street & Road  
SU Supermarket  
TR Transportation  
TR-a Transportation, Airport  
TR-b Transportation, Bus  
TR-h Transportation, Harbor  
TR-m Transportation, Metro  



© Gecko Landmarks 2013-2015 - http://www.geckolandmarks.com