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

28 lines
705 B
Markdown
Raw Normal View History

2018-09-26 00:19:54 +02:00
---
title: Search
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 01:43:37 +02:00
## GET /api/v2/search
Search for content in accounts, statuses and hashtags.
Returns [Results]({{< relref "entities.md#results" >}})
### Resource information
{{< api_method_info auth="Yes" user="Yes" scope="read read:search" version="2.4.1" >}}
2018-10-05 01:43:37 +02:00
### Parameters
|Name|Description|Required|Default|
|----|-----------|:------:|:-----:|
| `q` | The search query | Required ||
2018-10-06 00:42:15 +02:00
| `resolve` | Attempt WebFinger look-up | Optional |false|
| `limit` | Maximum number of results | Optional | 40 |
| `offset` | Offset in the search results | Optional | 0 |
| `following` | Only include accounts the user is following | Optional | false |