timelines.md 3.37 KB
Newer Older
Eugen Rochko's avatar
Eugen Rochko committed
1
---
2
title: Timelines
Eugen Rochko's avatar
Eugen Rochko committed
3 4
menu:
  docs:
5
    parent: rest-api
Eugen Rochko's avatar
Eugen Rochko committed
6 7
    weight: 10
---
8 9 10

## GET /api/v1/timelines/home

Eugen Rochko's avatar
Eugen Rochko committed
11 12
Statuses from accounts the user follows.

13 14 15 16 17 18 19 20 21 22 23 24
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 ||
Eugen Rochko's avatar
Eugen Rochko committed
25
| `min_id` | Return results immediately newer than ID | Optional ||
26 27
| `limit` | Maximum number of results | Optional | 20 |

28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47

## 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 |

48 49 50 51 52 53
### Pagination

{{< api_dynamic_pagination >}}

## GET /api/v1/timelines/public

Eugen Rochko's avatar
Eugen Rochko committed
54 55
Public statuses known to the server.

56 57 58 59 60 61 62 63 64 65
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|
|----|-----------|:------:|:-----:|
Eugen Rochko's avatar
Eugen Rochko committed
66 67
| `local` | Only local statuses | Optional |false|
| `only_media` | Only statuses with media attachments | Optional |false|
68 69
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
Eugen Rochko's avatar
Eugen Rochko committed
70
| `min_id` | Return results immediately newer than ID | Optional ||
71 72 73 74 75 76 77 78
| `limit` | Maximum number of results | Optional | 20 |

### Pagination

{{< api_dynamic_pagination >}}

## GET /api/v1/timelines/tag/:hashtag

Eugen Rochko's avatar
Eugen Rochko committed
79 80
Public statuses known to the server marked with a given hashtag.

81 82 83 84 85 86 87 88 89 90
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|
|----|-----------|:------:|:-----:|
Eugen Rochko's avatar
Eugen Rochko committed
91 92
| `local` | Only local statuses | Optional |false|
| `only_media` | Only statuses with media attachments | Optional |false|
93 94
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
Eugen Rochko's avatar
Eugen Rochko committed
95
| `min_id` | Return results immediately newer than ID | Optional ||
96 97 98 99 100 101 102 103
| `limit` | Maximum number of results | Optional | 20 |

### Pagination

{{< api_dynamic_pagination >}}

## GET /api/v1/timelines/list/:list_id

Eugen Rochko's avatar
Eugen Rochko committed
104 105
Statuses from accounts on a given list.

106 107 108 109
Returns array of [Status]({{< relref "entities.md#status" >}})

### Resource information

110
{{< api_method_info auth="Yes" user="Yes" scope="read read:statuses" version="2.1.0" >}}
111 112 113 114 115

### Parameters

|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
Eugen Rochko's avatar
Eugen Rochko committed
116 117 118 119
| `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 |
120 121 122 123

### Pagination

{{< api_dynamic_pagination >}}