documentation/content/en/api/rest/timelines.md

124 lines
3.4 KiB
Markdown
Raw Normal View History

2018-09-26 00:19:54 +02:00
---
title: Timelines
2018-09-26 00:19:54 +02:00
menu:
docs:
parent: rest-api
2018-09-26 00:19:54 +02:00
weight: 10
---
2018-10-05 00:59:57 +02:00
## GET /api/v1/timelines/home
2018-10-05 01:37:50 +02:00
Statuses from accounts the user follows.
2018-10-05 00:59:57 +02:00
Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="read read:statuses" version="0.0.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
2018-10-06 01:28:20 +02:00
| `min_id` | Return results immediately newer than ID | Optional ||
2018-10-05 00:59:57 +02:00
| `limit` | Maximum number of results | Optional | 20 |
## GET /api/v1/conversations
Conversations for an account
Returns array of [Conversation]({{< relref "entities.md#conversation" >}})
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="read read:statuses" version="2.6.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
| `min_id` | Return results immediately newer than ID | Optional ||
| `limit` | Maximum number of results | Optional | 20 |
2018-10-05 00:59:57 +02:00
### Pagination
{{< api_dynamic_pagination >}}
## GET /api/v1/timelines/public
2018-10-05 01:37:50 +02:00
Public statuses known to the server.
2018-10-05 00:59:57 +02:00
Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information
{{< api_method_info auth="No" user="No" scope="read read:statuses" version="0.0.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
2018-10-06 00:42:15 +02:00
| `local` | Only local statuses | Optional |false|
| `only_media` | Only statuses with media attachments | Optional |false|
2018-10-05 00:59:57 +02:00
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
2018-10-06 01:28:20 +02:00
| `min_id` | Return results immediately newer than ID | Optional ||
2018-10-05 00:59:57 +02:00
| `limit` | Maximum number of results | Optional | 20 |
### Pagination
{{< api_dynamic_pagination >}}
## GET /api/v1/timelines/tag/:hashtag
2018-10-05 01:37:50 +02:00
Public statuses known to the server marked with a given hashtag.
2018-10-05 00:59:57 +02:00
Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information
{{< api_method_info auth="No" user="No" scope="read read:statuses" version="0.0.0" >}}
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
2018-10-06 00:42:15 +02:00
| `local` | Only local statuses | Optional |false|
| `only_media` | Only statuses with media attachments | Optional |false|
2018-10-05 00:59:57 +02:00
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
2018-10-06 01:28:20 +02:00
| `min_id` | Return results immediately newer than ID | Optional ||
2018-10-05 00:59:57 +02:00
| `limit` | Maximum number of results | Optional | 20 |
### Pagination
{{< api_dynamic_pagination >}}
## GET /api/v1/timelines/list/:list_id
2018-10-05 01:37:50 +02:00
Statuses from accounts on a given list.
2018-10-05 00:59:57 +02:00
Returns array of [Status]({{< relref "entities.md#status" >}})
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="read read:statuses" version="2.1.0" >}}
2018-10-05 00:59:57 +02:00
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
2018-10-06 01:28:20 +02:00
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
| `min_id` | Return results immediately newer than ID | Optional ||
| `limit` | Maximum number of results | Optional | 20 |
2018-10-05 00:59:57 +02:00
### Pagination
{{< api_dynamic_pagination >}}