API Documentation

Area

GET /api/1/areas/:id.json ー Get an area
GET /api/1/areas.json ー List areas
GET /api/1/areas/name.json ー Search areas by name

Comment

DELETE /api/1/items/:item_id/comments/:id.json ー Delete a comment
GET /api/1/items/:item_id/comments.json ー Get post index
POST /api/1/items/:item_id/comments.json ー Post new comment

Following

POST /api/1/streams/:stream_id/followings.json ー Follow a tab
POST /api/1/users/:user_id/followings.json ー Follow a user
GET /api/1/users/:user_id/followings.json ー List users which is followed by the user
GET /api/1/users/:user_id/followers.json ー List users which is following the user
DELETE /api/1/streams/:stream_id/followings.json ー Unfollow a tab
DELETE /api/1/users/:user_id/followings.json ー Unfollow a user

HealthCheck

GET /api/1/ping.json ー Get API status - NG
GET /api/1/ping.json ー Get API status - OK

Item

POST /api/1/items.json ー Create new item
DELETE /api/1/items/:id.json ー Delete an item
GET /api/1/items/:id.json ー Get an item
GET /api/1/items/counts.json ー Get total and recent count of item creations
GET /api/1/users/:user_id/items.json ー List following items
GET /api/1/streams/:stream_id/items.json ー List items in a tab
GET /api/1/areas/:area_id/items.json ー List items in an area
GET /api/1/items/:item_id/reclips.json ー List items in other tabs
GET /api/1/items/:item_id/similar.json ー List items similar to an item
GET /api/1/items/latest.json ー List latest items
GET /api/1/items/nearby.json ー List nearby items
GET /api/1/users/:user_id/items/nearby.json ー List nearby items in a user's tabs
GET /api/1/items/pickup.json ー List pickup items
GET /api/1/items/popular.json ー List popular items
GET /api/1/items/search.json ー Search items
PUT /api/1/items/:id.json ー Update an item
POST /api/1/items.json ー put an item to tab

Mvps

GET /api/1/mvps/:id/awards.json ー Get awards of a mvp
GET /api/1/mvps.json ー Get mvps

OAuth2

POST /api/1/oauth2/token ー Retrieve access token by authorization code
POST /api/1/oauth2/token ー Retrieve access token by refresh token

Spot

POST /api/1/places.json ー Create new spot
GET /api/1/places/:id.json ー Get a spot
GET /api/1/places/nearby.json ー List nearby spots
GET /api/1/places/search.json ー Search spots by name or address

Tab

POST /api/1/streams.json ー Create new tab
DELETE /api/1/streams/:stream_id.json ー Delete a tab
GET /api/1/users/:user_id/streams.json ー List tabs owned by a user
GET /api/1/users/:user_id/following/streams.json ー List tabs which is followed by a user
GET /api/1/streams/:stream_id/followers.json ー List users who follows a tab
PUT /api/1/streams/:stream_id.json ー Update a tab

TimelineEvents

GET /api/1/timeline_events.json ー List timelines
PUT /api/1/timeline_events/:id/mark_as_read.json ー Mark an timeline as read
PUT /api/1/timeline_events/mark_as_read_until.json ー Mark timelines as read until an timeline

User

GET /api/1/users/me.json ー Get my information
GET /api/1/users/:id.json ー Get user info
GET /api/1/users/search.json ー Search users by screen name
PUT /api/1/users/me.json ー Update my information