diff --git a/API.md b/API.md index 2d672f3..47de81a 100644 --- a/API.md +++ b/API.md @@ -16,7 +16,7 @@ Form data: - file: Image to be uploaded -Returns a media object with an ID that can be attached when creating a status (see above) +Returns a media object with an ID that can be attached when creating a status (see above). ## Retrieving a timeline @@ -27,7 +27,7 @@ Returns statuses, most recent ones first. Home timeline is statuses from people Query parameters: -- offset (optional, default 0): Skip this many statuses +- max_id (optional, default none): Skip statuses up to ID - limit (optional, default 20): Return this many statuses ## Following a remote user @@ -40,6 +40,28 @@ Form data: Returns the local representation of the followed account. +## Fetching data + +**GET /api/statuses/:id** + +Returns status. + +**GET /api/accounts/:id** + +Returns account. + +**GET /api/accounts/:id/statuses** + +Returns statuses by user. + +**GET /api/accounts/:id/following** + +Returns users the given user is following. + +**GET /api/accounts/:id/followers** + +Returns users the given user is followed by. + ## Reblogging and favouriting a status **POST /api/statuses/:id/reblog** @@ -51,7 +73,7 @@ Returns the target status. **GET /api/statuses/:id/context** -Returns ancestors and descendants of the status +Returns ancestors and descendants of the status. ## Following and unfollowing users