< Prev   Next >
API Endpoints

following

The following endpoint supports GET and POST methods used to get following lists and modify a following list, respectively.

GET

Get a list of users that a particular user is following. Returned data is a short summary of each user. Default sort order is alphanumeric. Use "order=recent" parameter to sort by most recently visited. The full user object can be retrieved using the info endpoint. The follower field can be used to determine the relationship between the users (only provided for /me):

  • 1 follower(full follower)
  • 6 invited(specified user invited this user)
  • 7 blocked(specified user blocked this user)

Method Description
/me/following GET list of users 'me' is following
/USERID/following GET list of following for specified USERID.
Note: friend, follower and following status returned are relative to the Authenticated User, not the USERID.

Example1: GET list that Authenticated User is Following

GET http://api.hipgeo.com/me/following?access_token=TOKENVALUE

Returns:
{
  "following":{
    "count":3,
    "data":[
      {
        "who":{
          "id":"u_999",
          "name":"abby",
          "shareable":1,
          "pingable":1,
          "fullname":"Abby Johnson",
          "avatar":{
            "id":"m_2442",
            "shareable":0,
            "privacy":0,
            "type":0,
            "when":"2011-10-17 21:23:50",
            "icon":"http:\/\/img.hipgeo.com\/42d0ab814bfdd5822ac57be01300e_m?7322",
            "icon_l":"http:\/\/img.hipgeo.com\/42d0ab814bfdd5822ac57be01300e_l?7322",
            "icon_b":"http:\/\/img.hipgeo.com\/42d0ab814bfdd5822ac57be01300e_b?7322",
            "full":"http:\/\/img.hipgeo.com\/42d0ab814bfdd5822ac57be01300e_d?7322",
            "height":600,
            "width":450
          },
          "photo":"http:\/\/img.hipgeo.com\/42d0ab814bfdd5822ac57be01300e_b?7322",
          "friend":1,
          "follower":1,
          "following":1
        }
      }, 
      {
        "who":{
          "id":"u_1010",
          "name":"Samson",
          "shareable":1,
          "pingable":0,
          "fullname":"Samson Kim",
          "avatar":{
            "id":"m_7333",
            "shareable":0,
            "privacy":0,
            "type":0,
            "when":"2011-10-31 23:51:17",
            "icon":"http:\/\/img.hipgeo.com\/4f6ade64340b1714e8c147c5231cdad_m?7960",
            "icon_l":"http:\/\/img.hipgeo.com\/4f6ade64340b1714e8c147c5231cdad_l?7960",
            "icon_b":"http:\/\/img.hipgeo.com\/4f6ade64340b1714e8c147c5231cdad_b?7960",
            "full":"http:\/\/img.hipgeo.com\/4f6ade64340b1714e8c147c5231cdad_d?7960",
            "height":"368",
            "width":"350"
          },
          "photo":"http:\/\/img.hipgeo.com\/4f6ade64340b1714e8c147c5231cdad_b?7960",
          "friend":1,
          "following":1
        }
      },
      {
        "who":{
          "id":"u_244",
          "name":"jeff3gs",
          "shareable":1,
          "pingable":0,
          "fullname":"jeff3gs",
          "avatar":{
            "id":"m_55433",
            "shareable":0,
            "privacy":0,
            "type":0,
            "when":"2011-05-25 21:41:46",
            "icon":"http:\/\/img.hipgeo.com\/26af0f41d6b895587a5f1e57ca57d8_m?1553",
            "icon_l":"http:\/\/img.hipgeo.com\/26af0f41d6b895587a5f1e57ca57d8_l?1553",
            "icon_b":"http:\/\/img.hipgeo.com\/26af0f41d6b895587a5f1e57ca57d8_b?1553",
            "full":"http:\/\/img.hipgeo.com\/26af0f41d6b895587a5f1e57ca57d8_d?1553",
            "height":600,
            "width":450
          },
          "photo":"http:\/\/img.hipgeo.com\/26af0f41d6b895587a5f1e57ca57d8_b?1553",
          "friend":1,
          "following":1
        }
      }
    ]
  },
  "result":"success"
}
Error Code Possible Errors
5
  1. You are not allowed to see this user's followers
401
  1. Authentication failed
  2. Token expired
  3. 'me' requires authentication
404
  1. Target ID not found
405
  1. Must be GET or POST
  2. Target is not a user ID

Example2: GET list that USERID is Following

GET http://api.hipgeo.com/USERID/following?access_token=TOKENVALUE

Returns:
{
  "following":{
    "count":3,
    "data":[
      {
        "who":{
          "id":"u_555",
          "name":"hgtest1",
          "shareable":1,
          "pingable":0,
          "fullname":"Hip Geo",
          "avatar":{
            "id":"m_3455",
            "shareable":0,
            "privacy":0,
            "type":0,
            "when":"2011-07-24 22:56:13",
            "icon":"http:\/\/img.hipgeo.com\/484cace24539b94655f104c5148e_m?3213",
            "icon_l":"http:\/\/img.hipgeo.com\/484cace24539b94655f104c5148e_l?3213",
            "icon_b":"http:\/\/img.hipgeo.com\/484cace24539b94655f104c5148e_b?3213",
            "full":"http:\/\/img.hipgeo.com\/484cace24539b94655f104c5148e_d?3213",
            "height":600,
            "width":450
          },
          "photo":"http:\/\/img.hipgeo.com\/484cace24539b94655f104c5148e_b?3213"
        }
      },
      {
        "who":{
          "id":"u_892",
          "name":"michel",
          "shareable":1,
          "pingable":0,
          "fullname":"Michel Largo",
          "avatar":{
            "id":"m_8444",
            "shareable":0,
            "privacy":0,
            "type":0,
            "when":"2011-11-02 01:22:18",
            "icon":"http:\/\/img.hipgeo.com\/24a8db4fc5b3875d9b0f847f05843c_m?8077",
            "icon_l":"http:\/\/img.hipgeo.com\/24a8db4fc5b3875d9b0f847f05843c_l?8077",
            "icon_b":"http:\/\/img.hipgeo.com\/24a8db4fc5b3875d9b0f847f05843c_b?8077",
            "full":"http:\/\/img.hipgeo.com\/24a8db4fc5b3875d9b0f847f05843c_d?8077",
            "height":600,
            "width":450
          },
          "photo":"http:\/\/img.hipgeo.com\/24a8db4fc5b3875d9b0f847f05843c_b?8077",
          "friend":1
        }
      },
      {
        "who":{
          "id":"u_899",
          "name":"randy",
          "shareable":1,
          "pingable":0,
          "fullname":"randy"
        }
      }
    ]
  },
  "result":"success"
}
Error Code Possible Errors
5
  1. You are not allowed to see this user's followers
401
  1. Authentication failed
  2. Token expired
  3. 'me' requires authentication
404
  1. Target ID not found
405
  1. Must be GET or POST
  2. Target is not a user ID

POST

The POST following endpoint enables a user to Add or Delete users he is following. Each POST data block can contain single or multiple user Ids for each action.

Method Description
/me/following Modify following list for authenticate user (see examples below)

add:List of USERIDs to start following.

delete:List of USERIDs to stop following.

Note: Errors are NOT aggregated at this time. If an error occurs, processing will stop where the error occurred, and subsequent operations will not be performed. Work in progress is a scheme to return multiple failures.

Example3: Manage Authenticated User Following list

POST http://api.hipgeo.com/me/following?access_token=TOKENVALUE

Data:
{
   "add":[
      "u_15",
      "u_44"
   ],
   "delete":[
      "u_429",
      "u_226",
      "u_2",
      "u_219"
   ]
}

Returns:
{
  "added":2,
  "deleted":4,
  "result":"success"
}
Error Code Possible Errors
400
  1. Empty Data
401
  1. Authentication failed
  2. Token expired
  3. 'me' requires authentication
403
  1. You cannot modify this use's followers list
404
  1. Target ID not found
405
  1. Must be GET or POST
  2. Target is not a user ID
HipGeo Icon