wholetrans/docs-mastodon
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve API documentation

Browse source
This commit is contained in:
Eugen Rochko 2018-10-06 01:28:20 +02:00
parent b2023264a2
commit 320d51a4d9
5 changed files with 32 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

15
content/en/api/streaming.md
View file

@ -13,32 +13,31 @@ Alternatively, a WebSocket connection can also be established.
## Server-sent events (HTTP)
### Endpoints
GET /api/v1/streaming/user
#### GET /api/v1/streaming/user
Returns events that are relevant to the authorized user, i.e. home timeline and notifications
GET /api/v1/streaming/public
#### GET /api/v1/streaming/public
Returns all public statuses
GET /api/v1/streaming/public/local
#### GET /api/v1/streaming/public/local
Returns all local statuses
GET /api/v1/streaming/hashtag?tag={id}
#### GET /api/v1/streaming/hashtag?tag=:hashtag
Returns all public statuses for a particular hashtag
GET /api/v1/streaming/hashtag/local?tag={id}
#### GET /api/v1/streaming/hashtag/local?tag=:hashtag
Returns all local statuses for a particular hashtag
GET /api/v1/streaming/list?list={id}
#### GET /api/v1/streaming/list?list=:list_id
Returns statuses for a list
GET /api/v1/streaming/direct
#### GET /api/v1/streaming/direct
Returns all direct messages