diff options
Diffstat (limited to 'docs/Using-the-API/API.md')
| -rw-r--r-- | docs/Using-the-API/API.md | 47 |
1 files changed, 40 insertions, 7 deletions
diff --git a/docs/Using-the-API/API.md b/docs/Using-the-API/API.md index 07c1b25a9..54de0c0c0 100644 --- a/docs/Using-the-API/API.md +++ b/docs/Using-the-API/API.md @@ -19,6 +19,7 @@ API overview - Who reblogged/favourited a status - Following/unfollowing accounts - Blocking/unblocking accounts + - Getting instance information - Creating OAuth apps - [Entities](#entities) - Status @@ -64,8 +65,8 @@ Returns a media object with an ID that can be attached when creating a status (s ### Retrieving a timeline -**GET /api/v1/timelines/home** -**GET /api/v1/timelines/public** +**GET /api/v1/timelines/home** +**GET /api/v1/timelines/public** **GET /api/v1/timelines/tag/:hashtag** Returns statuses, most recent ones first. Home timeline is statuses from people you follow, mentions timeline is all statuses that mention you. Public timeline is "whole known network", and the last is the hashtag timeline. @@ -75,6 +76,10 @@ Query parameters: - `max_id` (optional): Skip statuses younger than ID (e.g. navigate backwards in time) - `since_id` (optional): Skip statuses older than ID (e.g. check for updates) +Query parameters for public and tag timelines only: + +- `local` (optional): Only return statuses originating from this instance + ### Notifications **GET /api/v1/notifications** @@ -115,7 +120,14 @@ Returns authenticated user's account. **GET /api/v1/accounts/:id/statuses** -Returns statuses by user. Same options as timeline are permitted. +Returns statuses by user. + +Query parameters: + +- `max_id` (optional): Skip statuses younger than ID (e.g. navigate backwards in time) +- `since_id` (optional): Skip statuses older than ID (e.g. check for updates) +- `only_media` (optional): Only return statuses that have media attachments +- `exclude_replies` (optional): Skip statuses that reply to other statuses **GET /api/v1/accounts/:id/following** @@ -127,7 +139,7 @@ Returns users the given user is followed by. **GET /api/v1/accounts/relationships** -Returns relationships (`following`, `followed_by`, `blocking`) of the current user to a list of given accounts. +Returns relationships (`following`, `followed_by`, `blocking`, `muting`, `requested`) of the current user to a list of given accounts. Query parameters: @@ -146,6 +158,14 @@ Query parameters: Returns accounts blocked by authenticated user. +**GET /api/v1/mutes** + +Returns accounts muted by authenticated user. + +**GET /api/v1/follow_requests** + +Returns accounts that want to follow the authenticated user but are waiting for approval. + **GET /api/v1/favourites** Returns statuses favourited by authenticated user. @@ -188,25 +208,38 @@ Returns `ancestors` and `descendants` of the status. ### Who reblogged/favourited a status -**GET /api/v1/statuses/:id/reblogged_by** +**GET /api/v1/statuses/:id/reblogged_by** **GET /api/v1/statuses/:id/favourited_by** Returns list of accounts. ### Following and unfollowing users -**POST /api/v1/accounts/:id/follow** +**POST /api/v1/accounts/:id/follow** **POST /api/v1/accounts/:id/unfollow** Returns the updated relationship to the user. ### Blocking and unblocking users -**POST /api/v1/accounts/:id/block** +**POST /api/v1/accounts/:id/block** **POST /api/v1/accounts/:id/unblock** Returns the updated relationship to the user. +### Getting instance information + +**GET /api/v1/instance** + +Returns an object containing the `title`, `description`, `email` and `uri` of the instance. Does not require authentication. + +# Muting and unmuting users + +**POST /api/v1/accounts/:id/mute** +**POST /api/v1/accounts/:id/unmute** + +Returns the updated relationship to the user. + ### OAuth apps **POST /api/v1/apps** |