Merge pull request #105 from 178inaba/max_since_limit
Add max_id, since_id, limit to API
This commit is contained in:
Eugen
GitHub
commit
8dcc19f5d3
1 changed files with 66 additions and 0 deletions
|
|
@ -123,6 +123,14 @@ Returns an array of [Accounts](#account).
|
|||
|
||||
GET /api/v1/accounts/:id/following
|
||||
|
||||
Query parameters:
|
||||
|
||||
- `max_id` (optional): Get a list of followings with ID less than or equal this value
|
||||
- `since_id` (optional): Get a list of followings with ID greater than this value
|
||||
- `limit` (optional): Maximum number of accounts to get (Default 40, Max 80)
|
||||
|
||||
`max_id` and `since_id` are usually get from the `Link` header.
|
||||
|
||||
Returns an array of [Accounts](#account).
|
||||
|
||||
#### Getting an account's statuses:
|
||||
|
|
@ -133,6 +141,11 @@ Query parameters:
|
|||
|
||||
- `only_media` (optional): Only return statuses that have media attachments
|
||||
- `exclude_replies` (optional): Skip statuses that reply to other statuses
|
||||
- `max_id` (optional): Get a list of statuses with ID less than or equal this value
|
||||
- `since_id` (optional): Get a list of statuses with ID greater than this value
|
||||
- `limit` (optional): Maximum number of accounts to get (Default 20, Max 40)
|
||||
|
||||
`max_id` and `since_id` are usually get from the `Link` header.
|
||||
|
||||
Returns an array of [Statuses](#status).
|
||||
|
||||
|
|
@ -203,6 +216,14 @@ These values should be requested in the app itself from the API for each new app
|
|||
|
||||
GET /api/v1/blocks
|
||||
|
||||
Query parameters:
|
||||
|
||||
- `max_id` (optional): Get a list of blocks with ID less than or equal this value
|
||||
- `since_id` (optional): Get a list of blocks with ID greater than this value
|
||||
- `limit` (optional): Maximum number of accounts to get (Default 40, Max 80)
|
||||
|
||||
`max_id` and `since_id` are usually get from the `Link` header.
|
||||
|
||||
Returns an array of [Accounts](#account) blocked by the authenticated user.
|
||||
|
||||
### Favourites
|
||||
|
|
@ -211,6 +232,14 @@ Returns an array of [Accounts](#account) blocked by the authenticated user.
|
|||
|
||||
GET /api/v1/favourites
|
||||
|
||||
Query parameters:
|
||||
|
||||
- `max_id` (optional): Get a list of favourites with ID less than or equal this value
|
||||
- `since_id` (optional): Get a list of favourites with ID greater than this value
|
||||
- `limit` (optional): Maximum number of accounts to get (Default 20, Max 40)
|
||||
|
||||
`max_id` and `since_id` are usually get from the `Link` header.
|
||||
|
||||
Returns an array of [Statuses](#status) favourited by the authenticated user.
|
||||
|
||||
### Follow Requests
|
||||
|
|
@ -219,6 +248,14 @@ Returns an array of [Statuses](#status) favourited by the authenticated user.
|
|||
|
||||
GET /api/v1/follow_requests
|
||||
|
||||
Query parameters:
|
||||
|
||||
- `max_id` (optional): Get a list of follow requests with ID less than or equal this value
|
||||
- `since_id` (optional): Get a list of follow requests with ID greater than this value
|
||||
- `limit` (optional): Maximum number of accounts to get (Default 40, Max 80)
|
||||
|
||||
`max_id` and `since_id` are usually get from the `Link` header.
|
||||
|
||||
Returns an array of [Accounts](#account) which have requested to follow the authenticated user.
|
||||
|
||||
#### Authorizing or rejecting follow requests:
|
||||
|
|
@ -271,6 +308,14 @@ Returns an [Attachment](#attachment) that can be used when creating a status.
|
|||
|
||||
GET /api/v1/mutes
|
||||
|
||||
Query parameters:
|
||||
|
||||
- `max_id` (optional): Get a list of mutes with ID less than or equal this value
|
||||
- `since_id` (optional): Get a list of mutes with ID greater than this value
|
||||
- `limit` (optional): Maximum number of accounts to get (Default 40, Max 80)
|
||||
|
||||
`max_id` and `since_id` are usually get from the `Link` header.
|
||||
|
||||
Returns an array of [Accounts](#account) muted by the authenticated user.
|
||||
|
||||
### Notifications
|
||||
|
|
@ -279,6 +324,14 @@ Returns an array of [Accounts](#account) muted by the authenticated user.
|
|||
|
||||
GET /api/v1/notifications
|
||||
|
||||
Query parameters:
|
||||
|
||||
- `max_id` (optional): Get a list of notifications with ID less than or equal this value
|
||||
- `since_id` (optional): Get a list of notifications with ID greater than this value
|
||||
- `limit` (optional): Maximum number of accounts to get (Default 15, Max 30)
|
||||
|
||||
`max_id` and `since_id` are usually get from the `Link` header.
|
||||
|
||||
Returns a list of [Notifications](#notification) for the authenticated user.
|
||||
|
||||
#### Getting a single notification:
|
||||
|
|
@ -354,6 +407,14 @@ Returns a [Card](#card).
|
|||
GET /api/v1/statuses/:id/reblogged_by
|
||||
GET /api/v1/statuses/:id/favourited_by
|
||||
|
||||
Query parameters:
|
||||
|
||||
- `max_id` (optional): Get a list of reblogged/favourited with ID less than or equal this value
|
||||
- `since_id` (optional): Get a list of reblogged/favourited with ID greater than this value
|
||||
- `limit` (optional): Maximum number of accounts to get (Default 40, Max 80)
|
||||
|
||||
`max_id` and `since_id` are usually get from the `Link` header.
|
||||
|
||||
Returns an array of [Accounts](#account).
|
||||
|
||||
#### Posting a new status:
|
||||
|
|
@ -402,6 +463,11 @@ Returns the target [Status](#status).
|
|||
Query parameters:
|
||||
|
||||
- `local` (optional; public and tag timelines only): Only return statuses originating from this instance
|
||||
- `max_id` (optional): Get a list of timelines with ID less than or equal this value
|
||||
- `since_id` (optional): Get a list of timelines with ID greater than this value
|
||||
- `limit` (optional): Maximum number of accounts to get (Default 20, Max 40)
|
||||
|
||||
`max_id` and `since_id` are usually get from the `Link` header.
|
||||
|
||||
Returns an array of [Statuses](#status), most recent ones first.
|
||||
___
|
||||
|
|
|
|||
Loading…
Reference in a new issue