2020-01-01 22:37:59 +01:00
---
2022-11-20 07:34:38 +01:00
title: search API methods
description: Search for content in accounts, statuses and hashtags.
2020-01-01 22:37:59 +01:00
menu:
docs:
weight: 60
2022-11-20 07:34:38 +01:00
name: search
2020-01-01 22:37:59 +01:00
parent: methods
2022-11-20 07:34:38 +01:00
identifier: methods-search
aliases: [
"/methods/search",
"/api/methods/search",
]
2020-01-01 22:37:59 +01:00
---
2022-11-20 07:34:38 +01:00
< style >
#TableOfContents ul ul ul {display: none}
< / style >
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
## Perform a search {#v2}
```http
2022-12-14 22:55:30 +01:00
GET /api/v2/search HTTP/1.1
2022-11-20 07:34:38 +01:00
```
**Returns:** [Search ]({{< relref "entities/Search" >}} )\
**OAuth:** Public (without `resolve` or `offset` ), or User token + `read:search` \
2020-12-27 07:03:55 +01:00
**Version history:**\
2.4.1 - added, limit hardcoded to 5\
2022-11-20 07:34:38 +01:00
2.8.0 - add `type` , `limit` , `offset` , `min_id` , `max_id` , `account_id` \
3.0.0 - add `exclude_unreviewed` param\
3.3.0 - `min_id` and `max_id` can be used together\
4.0.0 - no longer requires a user token. Without a valid user token, you cannot use the `resolve` or `offset` parameters.
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
#### Request
##### Headers
Authorization
: {{< required > }} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
##### Query parameters
q
: {{< required > }} String. The search query.
type
: String. Specify whether to search for only `accounts` , `hashtags` , `statuses`
resolve
: Boolean. Attempt WebFinger lookup? Defaults to false.
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
following
: Boolean. Only include accounts that the user is following? Defaults to false.
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
account_id
: String. If provided, will only return statuses authored by this account.
exclude_unreviewed
: Boolean. Filter out unreviewed tags? Defaults to false. Use true when trying to find trending tags.
2023-08-21 16:40:12 +02:00
max_id
: String. All results returned will be lesser than this ID. In effect, sets an upper bound on results.
2022-11-20 07:34:38 +01:00
min_id
2023-08-21 16:40:12 +02:00
: String. Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward.
2022-11-20 07:34:38 +01:00
limit
2022-12-14 22:55:30 +01:00
: Integer. Maximum number of results to return, per type. Defaults to 20 results per category. Max 40 results per category.
2022-11-20 07:34:38 +01:00
offset
2022-12-14 22:55:30 +01:00
: Integer. Skip the first n results.
2022-11-20 07:34:38 +01:00
#### Response
##### 200: OK
Truncated results of a sample search for "cats" with limit=2.
```json
2020-01-01 22:37:59 +01:00
{
"accounts": [
{
"id": "180744",
"username": "catstar",
"acct": "catstar@catgram.jp",
"display_name": "catstar",
2022-11-20 07:34:38 +01:00
// ...
2020-01-01 22:37:59 +01:00
},
{
"id": "214293",
"username": "catsareweird",
"acct": "catsareweird",
"display_name": "Cats Are Weird",
2022-11-20 07:34:38 +01:00
// ...
2020-01-01 22:37:59 +01:00
}
],
"statuses": [
{
"id": "103085519055545958",
"created_at": "2019-11-05T13:23:09.000Z",
2022-11-20 07:34:38 +01:00
// ...
2020-01-01 22:37:59 +01:00
"content": "< p > cats< br > cats never change< / p > ",
2022-11-20 07:34:38 +01:00
// ...
2020-01-01 22:37:59 +01:00
},
{
"id": "101068121469614510",
"created_at": "2018-11-14T06:31:48.000Z",
2022-11-20 07:34:38 +01:00
// ...
2020-01-01 22:37:59 +01:00
"spoiler_text": "Cats",
2022-11-20 07:34:38 +01:00
// ...
2020-01-01 22:37:59 +01:00
"content": "< p > Cats are inherently good at self-care. </ p >< p >< a href = \"https://mspsocial.net/tags/cats \" class = \"mention hashtag \" rel = \"nofollow noopener noreferrer \" target = \"_blank \"> #< span > cats</ span ></ a ></ p > ",
2022-11-20 07:34:38 +01:00
// ...
2020-01-01 22:37:59 +01:00
],
"hashtags": [
{
"name": "cats",
"url": "https://mastodon.social/tags/cats",
"history": [
{
"day": "1574553600",
"uses": "10",
"accounts": "9"
},
2022-11-20 07:34:38 +01:00
// ...
2020-01-01 22:37:59 +01:00
]
},
{
"name": "catsofmastodon",
"url": "https://mastodon.social/tags/catsofmastodon",
"history": [
{
"day": "1574553600",
"uses": "6",
"accounts": "5"
},
2022-11-20 07:34:38 +01:00
// ...
2020-01-01 22:37:59 +01:00
]
}
]
}
```
2022-11-20 07:34:38 +01:00
##### 401: Unauthorized
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
Invalid or missing Authorization header.
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
```json
2020-01-01 22:37:59 +01:00
{
"error": "The access token is invalid"
}
```
2022-11-20 07:34:38 +01:00
---
## (REMOVED) Search results (v1) {#v1}
```http
2022-12-14 22:55:30 +01:00
GET /api/v1/search HTTP/1.1
2022-11-20 07:34:38 +01:00
```
**Returns:** [Search ]({{< relref "entities/Search" >}} ), but `hashtags` is an array of strings instead of an array of Tag.\
2020-01-01 22:37:59 +01:00
**OAuth:** User token + `read:search` \
**Version history:**\
2020-12-27 07:03:55 +01:00
1.1 - added, limit hardcoded to 5\
1.5.0 - now requires authentication\
2022-11-20 07:34:38 +01:00
2.4.1 - deprecated in favor of [v2 search ](#v2 )\
2.8.0 - added `limit` , pagination, and account options\
3.0.0 - removed; use [v2 search ](#v2 ) instead
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
#### Request
##### Headers
Authorization
: {{< required > }} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
##### Query parameters
q
: {{< required > }} String. The search query.
type
: String. Specify whether to search for only `accounts` , `hashtags` , `statuses`
resolve
: Boolean. Attempt WebFinger lookup? Defaults to false.
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
account_id
: String. If provided, will only return statuses authored by this account.
2020-01-01 22:37:59 +01:00
2023-08-21 16:40:12 +02:00
max_id
: String. All results returned will be lesser than this ID. In effect, sets an upper bound on results.
2022-11-20 07:34:38 +01:00
min_id
2023-08-21 16:40:12 +02:00
: String. Returns results immediately newer than this ID. In effect, sets a cursor at this ID and paginates forward.
2022-11-20 07:34:38 +01:00
limit
2022-12-14 22:55:30 +01:00
: Integer. Maximum number of results to return, per type. Defaults to 20 results per category. Max 40 results per category.
2022-11-20 07:34:38 +01:00
offset
: Integer. Offset in search results, used for pagination. Defaults to 0.
#### Response
##### 200: OK
v1 search was deprecated because hashtags were returned as strings instead of as Tag entities.
```json
2020-01-01 22:37:59 +01:00
{
"accounts": [...],
"statuses": [...],
"hashtags": ["cats","catsofmastodon"]
}
```
2022-11-20 07:34:38 +01:00
##### 401: Unauthorized
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
Invalid or missing Authorization header.
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
```json
2020-01-01 22:37:59 +01:00
{
"error": "The access token is invalid"
}
```
2022-11-20 07:34:38 +01:00
---
## See also
{{< page-relref ref = "methods/accounts#search" caption = "GET /api/v1/accounts/search" > }}
{{< page-relref ref = "methods/accounts#lookup" caption = "GET /api/v1/accounts/lookup" > }}
2020-01-01 22:37:59 +01:00
2022-11-20 07:34:38 +01:00
{{< caption-link url = "https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v2/search_controller.rb" caption = "app/controllers/api/v2/search_controller.rb" > }}