Overview Access Person API Graph API Usage Agreement

Social Graph API Documentation

This resource retrieves friend information about a person identified by an email address. Only email addresses in your set will be returned. In other words, we will not share any email addresses with a client who does not already know that email address. An email address gets added to your set automatically when you search it.
Resource URL
http://api.rapleaf.com/v2/graph/{email|Rapleaf ID}?[n=1|n=2]
GET Request
Example Request
GET http://api.rapleaf.com/v2/graph/dummy@rapleaf.com HTTP/1.1
Authorization: 25234823472
See the "Help" section at the bottom of this page for instructions on how to send the Authorization header from your browser for testing purposes
Parameter Descriptions
Parameter Value Description
Authorization Header API Key (Required) The API key is the unique key assigned to you by Rapleaf. You can find your API Key here.
For testing (or if circumstances require it) you can send the API key in the query string using 'api_key='
Email Address or Rapleaf ID An email address or Rapleaf ID (Required) This is the email address or Rapleaf ID you are searching. The example above shows "dummy@rapleaf.com".

Note: Email addresses containing special characters such as "+" or "=" must be URL-encoded so that they are communicated correctly. For example, the address "dum+my@rapleaf.com" would be encoded as "dum%2Bmy%40rapleaf.com".

n (Rapleaf ID) 1 or 2 (Optional) Set this parameter to 1 if you want a list of Rapleaf IDs returned. If you want to query by Rapleaf ID instead of email, set the value to 2.
GET Response
HTTP Status Codes
Status Code Description
200 OK Request processed successfully. A comma-separated list of friends in your set is returned.
202 Accepted This email is being processed.
400 Bad Request Invalid email address.
401 Unauthorized API key was not provided or is invalid.
403 Forbidden Your query limit has been exceeded. Contact developer@rapleaf.com if you would like to increase your limit.
500 Internal Server Error There was an unexpected error on our server. This should be very rare and if you see it please contact developer@rapleaf.com.
Note: This list does not cover all possible HTTP Status Codes that could be returned, only those returned specifically from our API. For example, if the request cannot make it to our API you will likely get a "503 Service Unavailable" response. With this in mind do not code exclusively to handle the response codes listed above.
Response Body

For a 200 OK email response, the body will be a comma-delimited list of the subject's friends' emails within your set. For a 200 OK Rapleaf ID response, the body will be a list of the subject's friends' Rapleaf IDs, one per line. The first line will contain the Rapleaf ID of the subject. For all other responses, the body will be an English description of the response.

Example Responses

Email Response: 
HTTP/1.1 200 OK
Date: Wed, 26 Mar 2008 18:08:08 GMT
Server: Mongrel 1.0.1
Status: 200 OK

dummy-friend-alpha@rapleaf.com,dummy-friend-beta@rapleaf.com,dummy-friend-gamma@rapleaf.com

Rapleaf ID Response: 
HTTP/1.1 200 OK
Date: Wed, 26 Mar 2008 18:08:08 GMT
Server: Mongrel 1.0.1
Status: 200 OK

0600000000000000
00e1e692420913e3
e954ed68303f041004cfb900afc7a1c5
9b044f8f1237e9d279256dd859577a98
12a0d2c9a5ac8b35

Help
For testing we recommend using a helpful Firefox Add-on called Modify Headers which lets you set the HTTP headers of your web requests. By setting the Authorization header to your API Key you can experiment with API requests within your browser.

You can learn more about the basic principles of REST on Wikipedia.
For a more in depth understanding we recommend RESTful Web Services by Leonard Richardson and Sam Ruby.

Please email questions to Rapleaf Developer Support.