API

Overview

Developers are invited to build apps using our API. The Neighborland API uses SSL, RESTful resources, JSON, and UTF-8 encoding. Read-only access to the API does not require an account or authentication.

Resources

Neighbors

Show detailed information about the neighbor with the given id.
List friends of the neighbor with the given id.
List followers of the neighbor with the given id.

Cities

Show detailed information about the city with the given id.
List cities. Optionally list cities near a point location.

Neighborhoods

Show detailed information about the neighborhood with the given id.
List all the neighborhoods in the city with the given id.

Questions

Show detailed information about the question with the given id.
List all the questions in the city with the given id.

Topics

Show detailed information about the topic with the given id.
List all topics.

Ideas

Show detailed information about the idea with the given id.
List ideas nearest a point location or within a specified radius of a point location.
List ideas in the city with the given id.
List ideas in the neighborhood with the given id.
List ideas for the question with the given id.
List ideas created by the neighbor with the given id.
List ideas in the topic with the given id.

Actions

Show detailed information about all actions for an idea with the given id.
Show detailed information about all actions by the neighbor with the given id.

Comments

Show detailed information about all comments about an idea with the given id.
Show detailed information about all comments made by the neighbor with the given id.

MeToos

Show detailed information about all MeToos for an idea with the given id.
Show detailed information about all MeToos by the neighbor with the given id.

Errors

Errors are returned using standard HTTP error codes. Additional information is returned in the JSON body of the response.

Sample Error Response:

{ "errors" :
  [ { "message" : "Something bad happened because of reasons." } ]
}

HTTP Response Codes

200
OK
It worked!
400
Bad Request
Your request failed because it was not formed properly. You may be missing a required value. Check the response body for details.
404
Not Found
The resource referenced by the ID in the request was not found.
500
Internal Server Error
An internal error occurred. There may be more information in the response body. We will be notified of the error.