search
Search for content in accounts, statuses and hashtags.
getSearch results
https://CounterSocial.example/api/v2/search
Returns: Results
OAuth: User token + read:search
Version history:
2.4.1 - added, limit hardcoded to 5
2.8.0 - add type, limit, offset, min_id, max_id, account_id
3.0.0 - add exclude_unreviewed param
Request
Headers
Authorization
required
stringBearer
Query Parameters
account_id
optional
stringIf provided, statuses returned will be authored only by this account
max_id
optional
stringReturn results older than this id
min_id
optional
stringReturn results immediately newer than this id
type
optional
stringEnum(accounts, hashtags, statuses)
exclude_unreviewed
optional
booleanFilter out unreviewed tags? Defaults to false. Use true when trying to find trending tags.
q
required
stringThe search query
resolve
optional
booleanAttempt WebFinger lookup. Defaults to false.
limit
optional
integerMaximum number of results to load, per type. Defaults to 20. Max 40.
offset
optional
integerOffset in search results. Used for pagination. Defaults to 0.
following
optional
booleanOnly include accounts that the user is following. Defaults to false.
Response
200: Success
Truncated results of a sample search for cats with limit=2.
{
"accounts": [
{
"id": "180744",
"username": "catstar",
"acct": "[email protected]",
"display_name": "catstar",
...
},
{
"id": "214293",
"username": "catsareweird",
"acct": "catsareweird",
"display_name": "Cats Are Weird",
...
}
],
"statuses": [
{
"id": "103085519055545958",
"created_at": "2019-11-05T13:23:09.000Z",
...
"content": "cats
cats never change
",
...
},
{
"id": "101068121469614510",
"created_at": "2018-11-14T06:31:48.000Z",
...
"spoiler_text": "Cats",
...
"content": "Cats are inherently good at self-care.
",
...
],
"hashtags": [
{
"name": "cats",
"url": "https://CounterSocial.social/tags/cats",
"history": [
{
"day": "1574553600",
"uses": "10",
"accounts": "9"
},
...
]
},
{
"name": "catsofCounterSocial",
"url": "https://CounterSocial.social/tags/catsofCounterSocial",
"history": [
{
"day": "1574553600",
"uses": "6",
"accounts": "5"
},
...
]
}
]
}
401: Unauthorized
Invalid or missing Authorization header
{
"error": "The access token is invalid"
}