grumbulon/fedifeed
1
0
Fork 0
forked from sam/fedifeed
Code Issues Pull requests Projects Releases Wiki Activity

document v2 API

Browse source
This commit is contained in:
fenwick67 2019-08-02 13:33:03 -04:00
parent d5631f54a3
commit 18ef0e4a56
1 changed files with 22 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -10,7 +10,28 @@ The homepage has a tool for generating iframe code for you, with a sensible `san
## API
### GET `/api/feed`
### V2
#### GET `/apiv2/feed`
> example: `/api/feed?userurl=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67&scale=90&theme=light`
Returns a html page which displays a mastodon feed for a user URL. Note that URLs must be URI encoded (i.e. `encodeURIComponent('https://octodon.social/users/fenwick67')` ).
Querystring options:
| option | required | description |
| ------ | -------- | ----------- |
| `userurl` | **yes** | Mastodon/ActivityPub account URL (usually `https://${instance}/users/${username}`) |
| `feedurl` | no | a URL to a page of an ActivityPub post collection. Only used for pages beyond the first. |
| `theme` | no | either `dark` or `light`, to select the UI theme (default is `dark`). |
| `boosts` | no | whether to show boosts or not |
| `replies` | no | whether to show replies or not |
| `size` | no | the scale of the UI in percent. |
### V1 (deprecated, will now just redirect you to the v2 API)
#### GET `/api/feed`
> example: `/api/feed?url=https%3A%2F%2Foctodon.social%2Fusers%2Ffenwick67.atom&scale=90&theme=light`