Functions
	request (query, params)

	response (resp)

Variables
dict	about

list	categories = ['social media']

str	base_url = "https://mastodon.social"

str	mastodon_type = "accounts"

int	page_size = 40

Detailed Description

Mastodon_ is an open source alternative to large social media platforms like
Twitter/X, Facebook, ...

Since it's federated and self-hostable, there's a large amount of available
instances, which can be chosen instead by modifying ``base_url``.

We use their official API_ for searching, but unfortunately, their Search API_
forbids pagination without OAuth.

That's why we use tootfinder.ch for finding posts, which doesn't support searching
for users, accounts or other types of content on Mastodon however.

.. _Mastodon: https://mastodon.social
.. _API: https://docs.joinmastodon.org/api/

Function Documentation

◆ request()

searx.engines.mastodon.request	(		query,
			params )

Definition at line 39 of file mastodon.py.

def request(query, params):
    args = {
        'q': query,
        'resolve': 'false',
        'type': mastodon_type,
        'limit': page_size,
    }
    params['url'] = f"{base_url}/api/v2/search?{urlencode(args)}"
    return params
 
 

◆ response()

searx.engines.mastodon.response ( resp )

Definition at line 50 of file mastodon.py.

def response(resp):
    results = []
 
    json = resp.json()
 
    for result in json[mastodon_type]:
        if mastodon_type == "accounts":
            results.append(
                {
                    'url': result['uri'],
                    'title': result['username'] + f" ({result['followers_count']} followers)",
                    'content': result['note'],
                    'thumbnail': result.get('avatar'),
                    'publishedDate': datetime.strptime(result['created_at'][:10], "%Y-%m-%d"),
                }
            )
        elif mastodon_type == "hashtags":
            uses_count = sum(int(entry['uses']) for entry in result['history'])
            user_count = sum(int(entry['accounts']) for entry in result['history'])
            results.append(
                {
                    'url': result['url'],
                    'title': result['name'],
                    'content': f"Hashtag has been used {uses_count} times by {user_count} different users",
                }
            )
        else:
            raise ValueError(f"Unsupported mastodon type: {mastodon_type}")
 
    return results

Variable Documentation

◆ about

dict searx.engines.mastodon.about

Initial value:

=  {
    "website": 'https://joinmastodon.org/',
    "wikidata_id": 'Q27986619',
    "official_api_documentation": 'https://docs.joinmastodon.org/api/',
    "use_official_api": True,
    "require_api_key": False,
    "results": 'JSON',
}

Definition at line 22 of file mastodon.py.

◆ base_url

str searx.engines.mastodon.base_url = "https://mastodon.social"

Definition at line 32 of file mastodon.py.

◆ categories

list searx.engines.mastodon.categories = ['social media']

Definition at line 30 of file mastodon.py.

◆ mastodon_type

str searx.engines.mastodon.mastodon_type = "accounts"

Definition at line 33 of file mastodon.py.

◆ page_size

int searx.engines.mastodon.page_size = 40

Definition at line 36 of file mastodon.py.

Functions

Variables