< Prev   Next >
API Endpoints

places

Places returns specific lists of places. The place data returned is a summary. Use the place id and the info endpoint to return detailed place information. The type parameter of the places endpoint determines the category of places returned. Current types are:

  • user - user's places ordered by most visited
  • recent - user's places ordered by most recently visited
  • friends - places visited by user's friends ordered by most visited
  • regular - places where user is a regular ordered by most visited
  • top - most visited places across all users ordered by most visited
  • trending - most visited places in the last month across all users ordered by most visited
offset (0 based) and limit are optional parameters that allow the user to retrieve a subset of the places requested. Currently, regular and trending types do not support these parameters. Calls without offset and limit parameters will return a default of 15 places from offset = 0.

Method Description
/me/places?type=user{&offset=OFFSET&limit=LIMIT} return places of user sorted by most often pinpointed
/me/places?type=recent{&offset=OFFSET&limit=LIMIT} return user's places ordered by most recently visited
/me/places?type=friends{&offset=OFFSET&limit=LIMIT} return places visited by user's friends ordered by most visited
/me/places?type=regular return places where user is a regular ordered by most visited
/me/places?type=top{&offset=OFFSET&limit=LIMIT} returns most visited places across all HipGeo users ordered by most visited
/me/places?type=trending returns most visited places in the last month across all users ordered by most visited

Example1: me/places?type=user

GET http://api.hipgeo.com/me/places?type=user&access_token=TOKENVALUE

Returns:
{
  "places":{
    "count":15,
    "data":[
      {
        "id":"p_6261",
        "name":"St Denis Church",
        "title":"St Denis Church, Diamond Bar, CA",
        "privacy":0,
        "shareable":1,
        "pinpoints":"37"
      },
      {
        "id":"p_31463",
        "name":"Hipgeo Cosmic Headquarters",
        "title":"Hipgeo Cosmic Headquarters",
        "privacy":0,
        "shareable":1,
        "pinpoints":"14"
      },
      {
        "id":"p_6373",
        "name":"Lorbeer Middle School",
        "title":"Lorbeer Middle School, Diamond Bar, CA",
        "privacy":0,
        "shareable":1,
        "pinpoints":"12"
      },

== some items removed == 

      {
        "id":"p_6480",
        "name":"Maple Hill Elementary School",
        "title":"Maple Hill Elementary School, Diamond Bar, CA",
        "privacy":0,
        "shareable":1,
        "pinpoints":"4"
      },
      {
        "id":"p_30457",
        "name":"Albertsons",
        "title":"Albertsons",
        "privacy":0,
        "shareable":1,
        "pinpoints":"3"
      },
      {
        "id":"p_25890",
        "name":"Shell Carwash",
        "title":"Shell Carwash",
        "privacy":0,
        "shareable":1,
        "pinpoints":"3"
      }
    ]
  },
  "mapdata":{
    "markers":[
      {
        "type":0,
        "label":"c",
        "title":"St Denis Church",
        "desc":"Diamond Bar, CA.",
        "points":[
          [
            33.985802,
            -117.825996
          ]
        ]
      },
      {
        "type":0,
        "label":"e",
        "title":"Hipgeo Cosmic Headquarters",
        "desc":".",
        "points":[
          [
            33.871089,
            -117.924041
          ]
        ]
      },
      {
        "type":0,
        "label":"g",
        "title":"Lorbeer Middle School",
        "desc":"Diamond Bar, CA.",
        "points":[
          [
            34.017899,
            -117.807999
          ]
        ]
      },

== some items removed ==

      {
        "type":0,
        "label":"m",
        "title":"Maple Hill Elementary School",
        "desc":"Diamond Bar, CA.",
        "points":[
          [
            33.995602,
            -117.823997
          ]
        ]
      },
      {
        "type":0,
        "label":"n",
        "title":"Albertsons",
        "desc":".",
        "points":[
          [
            34.000121,
            -117.812686
          ]
        ]
      },
      {
        "type":0,
        "label":"o",
        "title":"Shell Carwash",
        "desc":".",
        "points":[
          [
            33.968423,
            -117.847547
          ]
        ]
      }
    ],
    "lines":[
      
    ],
    "circles":[
      
    ],
    "zoom":null,
    "center":null
  },
  "result":"success"
}
Error Code Possible Errors
400
  1. Requires and ID
  2. Limit of 0 is not allowed
  3. Limit of [xxxx] is too large. The maximum is XXXX.
401
  1. Authentication failed
  2. Token expired
  3. 'me' requires authentication
404
  1. Bad ID
405
  1. Target is not a user

Example2: me/paces?type=top&offset=OFFSET&limit=LIMIT

http://api.hipgeo.com//me/places?type=top&offset=1&limit=4&access_token=TOKENVALUE

Returns:
{
  "places":{
    "count":4,
    "data":[
      {
        "id":"p_15708",
        "name":"Beach House",
        "title":"Beach House, Del Mar, CA",
        "privacy":0,
        "shareable":1,
        "pinpoints":"152"
      },
      {
        "id":"p_9698",
        "name":"Synergy",
        "title":"Synergy, Tustin, CA",
        "privacy":0,
        "shareable":1,
        "pinpoints":"141"
      },
      {
        "id":"p_303",
        "name":"Jones Coffee",
        "title":"Jones Coffee, Pasadena, ca",
        "privacy":0,
        "shareable":1,
        "photo":"http:\/\/img.hipgeo.com\/4ff0a25744c5b3be529735d6754a0785_m?52",
        "pinpoints":"115"
      },
      {
        "id":"p_14512",
        "name":"My House",
        "title":"My House",
        "privacy":0,
        "shareable":1,
        "pinpoints":"88"
      }
    ]
  },
  "mapdata":{
    "markers":[
      {
        "type":0,
        "label":"a",
        "title":"Beach House",
        "desc":"Del Mar, CA. home is home",
        "points":[
          [
            32.955297,
            -117.265906
          ]
        ]
      },
      {
        "type":0,
        "label":"b",
        "title":"Synergy",
        "desc":"Tustin, CA.",
        "points":[
          [
            33.742839,
            -117.824009
          ]
        ]
      },
      {
        "type":0,
        "label":"c",
        "title":"Jones Coffee",
        "desc":"Pasadena, ca.",
        "points":[
          [
            34.1339,
            -118.149002
          ]
        ]
      },
      {
        "type":0,
        "label":"d",
        "title":"My House",
        "desc":".",
        "points":[
          [
            33.997026,
            -118.472859
          ]
        ]
      }
    ],
    "lines":[
      
    ],
    "circles":[
      
    ],
    "zoom":null,
    "center":null
  },
  "result":"success"
}
Error Code Possible Errors
400
  1. Requires and ID
  2. Limit of 0 is not allowed
  3. Limit of [xxxx] is too large. The maximum is XXXX.
401
  1. Authentication failed
  2. Token expired
  3. 'me' requires authentication
404
  1. Bad ID
405
  1. Target is not a user
HipGeo Icon