timelines.md 2.58 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 25 26 27 28 29 30 31 32
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 ||
| `limit` | Maximum number of results | Optional | 20 |

### Pagination

{{< api_dynamic_pagination >}}

## GET /api/v1/timelines/public

Eugen Rochko's avatar
Eugen Rochko committed
33 34
Public statuses known to the server.

35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56
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|
|----|-----------|:------:|:-----:|
| `local` | Only local statuses | Optional ||
| `only_media` | Only statuses with media attachments | Optional ||
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
| `limit` | Maximum number of results | Optional | 20 |

### Pagination

{{< api_dynamic_pagination >}}

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

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

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
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|
|----|-----------|:------:|:-----:|
| `local` | Only local statuses | Optional ||
| `only_media` | Only statuses with media attachments | Optional ||
| `max_id` | Return results older than ID | Optional ||
| `since_id` | Return results newer than ID | Optional ||
| `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
81 82
Statuses from accounts on a given list.

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99
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` | Get a list of statuses with ID less than this value | Optional ||
| `since_id` | Get a list of statuses with ID greater than this value | Optional ||
| `limit` | Maximum number of statuses to return | Optional | 20 |

### Pagination

{{< api_dynamic_pagination >}}