Module: Mastodon::REST::Search

Includes:
Utils
Included in:
API
Defined in:
lib/mastodon/rest/search.rb

Instance Method Summary collapse

Methods included from Utils

#array_param, #perform_request, #perform_request_with_collection, #perform_request_with_object

Instance Method Details

#search(query, options = {}) ⇒ Mastodon::Results

Search for content

Parameters:

  • options (Hash) (defaults to: {})

Options Hash (options):

  • :q (String) —

    The search query

  • :resolve (Boolean) —

    Whether to resolve non-local accounts

Returns:

  • (Mastodon::Results) —

    If q is a URL, Mastodon will attempt to fetch the provided account or status. Otherwise, it will do a local account and hashtag search.



18
19
20
21
22
23
24
25
 
# File 'lib/mastodon/rest/search.rb', line 18

def search(query, options = {})
  opts = {
    q: query
  }.merge(options)

  perform_request_with_object(:get, '/api/v1/search', opts,
                              Mastodon::Results)
end