mirror of
https://github.com/mastodon/documentation
synced 2025-04-11 22:56:17 +02:00
3628b6d434
* add rules * join date on profiles * deprecate follow scope * deprecate identity proofs * familiar followers * use definition lists instead of tables for defining activitypub properties * reformat notifications page into markdown * fix broken links to publicKey header * Application website is now nullable * update environment variables added and removed * fix typo * fix heading level * min_id and max_id can be used at the same time (3.3) * fix typo * new tootctl options * reformat tootctl page to use definition lists for params * add rules and configuration to Instance * fix typo * refactor instance api page * 3.3.0 duration on mutes * 3.3.0 mute_expires_at * improve section headings * 3.4.0 resend email confirmation api * 3.4.0 policy on push subscriptions * 3.4.0 add details to account registration error * refactor accounts api page and start adding relrefs to entity pages * 3.4.0 accounts/lookup api * add see also to accounts methods * add more see-also links * 3.5.0 appeal mod decisions * 3.5.0 reformat reports and add category/rule_ids params * document report entity and missing responses * fix typos * fix relrefs and url schema, add aliases to old urls * add archetypes for new methods/entities * update archetypes with see-also stubs * clearer presentation of rate limits * announcements api methods * refactor apps methods * refactor bookmarks methods + some anchors * refactor conversations methods * custom_emojis methods refactor * anchors * refactor directory methods * refactor domain_blocks methods * add see also to emails methods * fix page relref shortcodes to specific methods + refactor endorsements methods * min_id max_id * refactor favourites methods * refactor featured_tags methods * refactor filters methods, make path params consistent, i18n required shortcode * follow_requests methods * lists methods * markers methods * forgot to add entity links * media methods, also fix formatting of some json errors * mutes methods, add more see-also links * oembed methods * preferences methods * proofs methods * push methods * suggestions methods * 3.5.0 add new trend types, fix formatting * refactor streaming methods * refactor oauth methods * note that streaming api casts payload to string * refactor search methods * refactor polls methods * remove unnecessary link * reformat scheduled_statuses methods * reformat timelines methods * reformat statuses methods * 3.5.0 editing statuses * consistent use of array brackets in form data parameters * update dev setup guide, add vagrant and clean up text * add admin/accounts methods * 3.6 role entity * admin/accounts methods v2 * minor fix * stub admin/reports methods * document admin reports * add 403 example to methods archetype * cleanup entities for admin reports and add new attrs * 3.6.0 domain allows methods + normalize admin entity namespace * fix search-and-replace error * add aliases for admin entities * 3.6.0 canonical email blocks entity * 3.5.0 admin/retention api * 3.5.0 add admin::ip doc * 3.5.0 admin/reports * 3.6.0 admin/domain_allows * 3.5.0 admin/dimensions * 3.6.0 permissions and roles * minor formatting fix * add anchor link to headings * checkpoint * add update commands to dev env setup guide * change mentions of v3.6 to v4.0 * tootctl now uses custom roles * fix formatting * v2 instance api * update frontmatter, add better titles to pages * minor wording change * consistency * add more aliases * add placeholders and WIP notices * explain link pagination and stub out todos * switch baseURL to https * 422 on reports with rules but category!=violation * document bug fixes * fix typo * remove duplicate API method definition * s/tootsuite/mastodon for github links * remove unnecessary escaping * s/tootsuite/mastodon in Entity archetype * add missing nullable shortcode * clarify oauth scope when requesting a user token * api/v2/media now synchronous for images * DISALLOW_UNAUTHENTICATED_API_ACCESS * add undocumented env variables * add instance domain blocks and extended description api * add SMTP_ENABLE_STARTTLS * add description to SMTP_ENABLE_STARTTLS * take suggestions from open PRs * normalize links and flavour language * Fully document streaming API based on source code * Add mention of MIME types * bump to ruby 3.0.4 * clarify how to check on async media processing * validation of replies_policy * remove TODOs on admin account action * EmailDomainBlocks * IpBlocks * Admin::DomainBlock * remove TODOs * following hashtags * followed_tags * remove reference to unused parameter * add new oauth scopes for admin blocks and allows * fix command signature for i18n-tasks normalize * reformat code structure page * document fixes for following tags (assume 4.0.3) * Add warning about pre-4.0 hardcoded roles * add note about case sensitivity * remove use of 'simply' from docs * remove reference to silencing * add reference to IDN normalization for verified links * add lang parameter
438 lines
10 KiB
Markdown
438 lines
10 KiB
Markdown
---
|
|
title: timelines API methods
|
|
description: Read and view timelines of statuses.
|
|
menu:
|
|
docs:
|
|
weight: 40
|
|
name: timelines
|
|
parent: methods
|
|
identifier: methods-timelines
|
|
aliases: [
|
|
"/methods/timelines",
|
|
"/api/methods/timelines",
|
|
]
|
|
---
|
|
|
|
<style>
|
|
#TableOfContents ul ul ul {display: none}
|
|
</style>
|
|
|
|
## View public timeline {#public}
|
|
|
|
```http
|
|
GET https://mastodon.example/api/v1/timelines/public HTTP/1.1
|
|
```
|
|
|
|
**Returns:** Array of [Status]({{<relref "entities/status">}})\
|
|
**OAuth:** Public. Requires app token + `read:statuses` if the instance has disabled public preview.\
|
|
**Version history:**\
|
|
0.0.0 - added\
|
|
2.3.0 - added `only_media`\
|
|
2.6.0 - add `min_id`\
|
|
3.0.0 - auth is required if public preview is disabled\
|
|
3.1.4 - added `remote`\
|
|
3.3.0 - both `min_id` and `max_id` can be used at the same time now
|
|
|
|
#### Request
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
##### Query parameters
|
|
|
|
local
|
|
: Boolean. Show only local statuses? Defaults to false.
|
|
|
|
remote
|
|
: Boolean. Show only remote statuses? Defaults to false.
|
|
|
|
only_media
|
|
: Boolean. Show only statuses with media attached? Defaults to false.
|
|
|
|
max_id
|
|
: String. Return results older than ID.
|
|
|
|
since_id
|
|
: String. Return results newer than ID.
|
|
|
|
min_id
|
|
: String. Return results immediately newer than ID.
|
|
|
|
limit
|
|
: Integer. Maximum number of results to return. Defaults to 20. Max 40.
|
|
|
|
#### Response
|
|
##### 200: OK
|
|
|
|
Sample API call with limit=2
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": "103206804533200177",
|
|
"created_at": "2019-11-26T23:27:31.000Z",
|
|
// ...
|
|
"visibility": "public",
|
|
// ...
|
|
},
|
|
{
|
|
"id": "103206804086086361",
|
|
"created_at": "2019-11-26T23:27:32.000Z",
|
|
// ...
|
|
"visibility": "public",
|
|
// ...
|
|
}
|
|
]
|
|
```
|
|
|
|
---
|
|
|
|
## View hashtag timeline {#tag}
|
|
|
|
```http
|
|
GET https://mastodon.example/api/v1/timelines/tag/:hashtag HTTP/1.1
|
|
```
|
|
|
|
View public statuses containing the given hashtag.
|
|
|
|
**Returns:** Array of [Status]({{<relref "entities/status">}})\
|
|
**OAuth:** Public. Requires app token + `read:statuses` if the instance has disabled public preview.\
|
|
**Version history:**\
|
|
0.0.0 - added\
|
|
2.3.0 - added `only_media`\
|
|
2.6.0 - add `min_id`\
|
|
3.0.0 - auth is required if public preview is disabled\
|
|
3.3.0 - both `min_id` and `max_id` can be used at the same time now
|
|
|
|
#### Request
|
|
|
|
##### Path parameters
|
|
|
|
:hashtag
|
|
: {{<required>}} String. The name of the hashtag (not including the \# symbol).
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
##### Query parameters
|
|
|
|
local
|
|
: Boolean. Return only local statuses? Defaults to false.
|
|
|
|
only_media
|
|
: Boolean. Return only statuses with media attachments? Defaults to false.
|
|
|
|
max_id
|
|
: String. Return results older than ID.
|
|
|
|
since_id
|
|
: String. Return results newer than ID.
|
|
|
|
min_id
|
|
: String. Return results immediately newer than ID.
|
|
|
|
limit
|
|
: Integer. Maximum number of results to return. Defaults to 20. Max 40.
|
|
|
|
#### Response
|
|
##### 200: OK
|
|
|
|
Sample timeline for the hashtag \#cats and limit=2
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": "103206185588894565",
|
|
"created_at": "2019-11-26T20:50:15.866Z",
|
|
// ...
|
|
"visibility": "public",
|
|
// ...
|
|
"content": "<p><a href=\"https://mastodon.social/tags/cats\" class=\"mention hashtag\" rel=\"tag\">#<span>cats</span></a></p>",
|
|
// ...
|
|
"tags": [
|
|
{
|
|
"name": "cats",
|
|
"url": "https://mastodon.social/tags/cats"
|
|
}
|
|
],
|
|
// ...
|
|
},
|
|
{
|
|
"id": "103203659567597966",
|
|
"created_at": "2019-11-26T10:07:49.000Z",
|
|
// ...
|
|
"visibility": "public",
|
|
// ...
|
|
"content": "<p>Caught on the hop. 😺 </p><p><a href=\"https://chaos.social/tags/Qualit%C3%A4tskatzen\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>Qualitätskatzen</span></a> <a href=\"https://chaos.social/tags/cats\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>cats</span></a> <a href=\"https://chaos.social/tags/mastocats\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>mastocats</span></a> <a href=\"https://chaos.social/tags/catsofmastodon\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>catsofmastodon</span></a> <a href=\"https://chaos.social/tags/Greece\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>Greece</span></a> <a href=\"https://chaos.social/tags/Agistri\" class=\"mention hashtag\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">#<span>Agistri</span></a><br>(photo: <span class=\"h-card\"><a href=\"https://chaos.social/@kernpanik\" class=\"u-url mention\" rel=\"nofollow noopener noreferrer\" target=\"_blank\">@<span>kernpanik</span></a></span> | license: CC BY-NC-SA 4.0)</p>",
|
|
// ...
|
|
"tags": [
|
|
{
|
|
"name": "qualitätskatzen",
|
|
"url": "https://mastodon.social/tags/qualit%C3%A4tskatzen"
|
|
},
|
|
{
|
|
"name": "cats",
|
|
"url": "https://mastodon.social/tags/cats"
|
|
},
|
|
{
|
|
"name": "mastocats",
|
|
"url": "https://mastodon.social/tags/mastocats"
|
|
},
|
|
{
|
|
"name": "catsofmastodon",
|
|
"url": "https://mastodon.social/tags/catsofmastodon"
|
|
},
|
|
{
|
|
"name": "greece",
|
|
"url": "https://mastodon.social/tags/greece"
|
|
},
|
|
{
|
|
"name": "agistri",
|
|
"url": "https://mastodon.social/tags/agistri"
|
|
}
|
|
],
|
|
// ...
|
|
}
|
|
]
|
|
```
|
|
|
|
##### 404: Not found
|
|
|
|
Hashtag does not exist
|
|
|
|
```json
|
|
{
|
|
"error": "Record not found"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## View home timeline {#home}
|
|
|
|
```http
|
|
GET https://mastodon.example/api/v1/timelines/home HTTP/1.1
|
|
```
|
|
|
|
View statuses from followed users.
|
|
|
|
**Returns:** Array of [Status]({{<relref "entities/status">}})\
|
|
**OAuth:** User + `read:statuses`\
|
|
**Version history:**\
|
|
0.0.0 - added\
|
|
2.6.0 - add `min_id`\
|
|
3.3.0 - both `min_id` and `max_id` can be used at the same time now
|
|
|
|
#### Request
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
##### Query parameters
|
|
|
|
max_id
|
|
: String. Return results older than ID.
|
|
|
|
since_id
|
|
: String. Return results newer than ID.
|
|
|
|
min_id
|
|
: String. Return results immediately newer than ID.
|
|
|
|
limit
|
|
: Integer. Maximum number of results to return. Defaults to 20. Max 40.
|
|
|
|
#### Response
|
|
##### 200: OK
|
|
|
|
Statuses in your home timeline will be returned
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": "103206791453397862",
|
|
"created_at": "2019-11-26T23:24:13.113Z",
|
|
// ...
|
|
},
|
|
// ...
|
|
]
|
|
```
|
|
|
|
##### 206: Partial content
|
|
|
|
Home feed is regenerating
|
|
|
|
```text
|
|
```
|
|
|
|
##### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## View list timeline {#list}
|
|
|
|
```http
|
|
GET https://mastodon.example/api/v1/timelines/list/:list_id HTTP/1.1
|
|
```
|
|
|
|
View statuses in the given list timeline.
|
|
|
|
**Returns:** Array of [Status]({{<relref "entities/status">}})\
|
|
**OAuth:** User token + `read:lists`\
|
|
**Version history:**\
|
|
2.1.0 - added\
|
|
2.6.0 - add `min_id`\
|
|
3.3.0 - both `min_id` and `max_id` can be used at the same time now
|
|
|
|
#### Request
|
|
|
|
##### Path parameters
|
|
|
|
:list_id
|
|
: {{<required>}} String. Local ID of the List in the database.
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
##### Query parameters
|
|
|
|
max_id
|
|
: String. Return results older than ID.
|
|
|
|
since_id
|
|
: String. Return results newer than ID.
|
|
|
|
min_id
|
|
: String. Return results immediately newer than ID.
|
|
|
|
limit
|
|
: Integer. Maximum number of results to return. Defaults to 20. Max 40.
|
|
|
|
#### Response
|
|
##### 200: OK
|
|
|
|
Statuses in this list will be returned.
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": "103206791453397862",
|
|
"created_at": "2019-11-26T23:24:13.113Z",
|
|
// ...
|
|
},
|
|
// ...
|
|
]
|
|
```
|
|
|
|
##### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|
|
|
|
##### 404: Not found
|
|
|
|
List is not owned by you or does not exist
|
|
|
|
```json
|
|
{
|
|
"error": "Record not found"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## (DEPRECATED) View direct timeline {#direct}
|
|
|
|
```http
|
|
GET https://mastodon.example/api/v1/timelines/direct HTTP/1.1
|
|
```
|
|
|
|
View statuses with a "direct" privacy, from your account or in your notifications.
|
|
|
|
**Returns:** Array of [Status]({{<relref "entities/status">}})\
|
|
**OAuth:** User token + `read:statuses`\
|
|
**Version history:**\
|
|
x.x.x - added\
|
|
2.6.0 - add `min_id`. deprecated in favor of [Conversations API]({{<relref "methods/conversations">}})\
|
|
3.0.0 - removed
|
|
|
|
#### Request
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
##### Query parameters
|
|
|
|
max_id
|
|
: String. Return results older than ID.
|
|
|
|
since_id
|
|
: String. Return results newer than ID.
|
|
|
|
min_id
|
|
: String. Return results immediately newer than ID.
|
|
|
|
limit
|
|
: Integer. Maximum number of results to return. Defaults to 20. Max 40.
|
|
|
|
#### Response
|
|
##### 200: OK
|
|
|
|
Statuses with direct visibility, authored by you or mentioning you. Statuses are not grouped by conversation, but are returned in chronological order.
|
|
|
|
```json
|
|
[
|
|
{
|
|
"id": "103206185588894565",
|
|
"created_at": "2019-11-26T20:50:15.866Z",
|
|
// ...
|
|
"visibility": "direct",
|
|
// ...
|
|
},
|
|
// ...
|
|
]
|
|
```
|
|
|
|
##### 401: Unauthorized
|
|
|
|
Invalid or missing Authorization header.
|
|
|
|
```json
|
|
{
|
|
"error": "The access token is invalid"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## See also
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/timelines/home_controller.rb" caption="app/controllers/api/v1/timelines/home_controller.rb" >}}
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/timelines/list_controller.rb" caption="app/controllers/api/v1/timelines/list_controller.rb" >}}
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/timelines/public_controller.rb" caption="app/controllers/api/v1/timelines/public_controller.rb" >}}
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/timelines/tag_controller.rb" caption="app/controllers/api/v1/timelines/tag_controller.rb" >}} |