/mastodon/statuses/search

POST /api/mastodon/statuses/search

Price: 5 credits

Search Mastodon Statuses by Hashtag

How to use it

Search Mastodon posts by hashtag on the host instance. Combine with all/any/none for extra hashtags and only_media to require attachments. This is the public way to find posts (free-text post search is not available without an account).

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• instance string — Host instance domain to query (default: "mastodon.social"; examples: "mastodon.social", "fosstodon.org")
• hashtag string required — Hashtag to search posts for (with or without leading #) (examples: "art"; minLength: 1)
• count integer required — Max result count (examples: 40; min: 1)
• all array nullable — Additionally require every one of these hashtags (examples: ["photography"])
• any array nullable — Additionally include any of these hashtags (examples: ["painting"])
• none array nullable — Exclude posts with any of these hashtags (examples: ["ai"])
• only_media boolean — Only posts with media attachments (default: false)
• local boolean — Only posts authored on the host instance (default: false)
• remote boolean — Only posts federated from other instances (default: false)

Response

• @type string (default: "MastodonStatus")
• id string required
• created_at string nullable
• edited_at string nullable
• in_reply_to_id string nullable
• in_reply_to_account_id string nullable
• text string nullable
• spoiler_text string nullable
• is_sensitive boolean (default: false)
• visibility string nullable
• language string nullable
• uri string nullable
• url string nullable
• reply_count integer nullable
• reblog_count integer nullable
• favourite_count integer nullable
• quote_count integer nullable
• account object nullable
  • @type string (default: "MastodonAccount")
  • id string required
  • username string nullable
  • acct string nullable
  • display_name string nullable
  • note string nullable
  • url string nullable
  • uri string nullable
  • image string nullable
  • avatar_static string nullable
  • avatar_description string nullable
  • header string nullable
  • header_static string nullable
  • header_description string nullable
  • created_at string nullable
  • last_status_at string nullable
  • follower_count integer nullable
  • following_count integer nullable
  • status_count integer nullable
  • is_locked boolean (default: false)
  • is_bot boolean (default: false)
  • is_group boolean (default: false)
  • is_discoverable boolean (default: false)
  • is_indexable boolean (default: false)
  • noindex boolean (default: false)
  • hide_collections boolean (default: false)
  • fields array (default: [])
    • @type string (default: "MastodonField")
    • name string nullable
    • value string nullable
    • verified_at string nullable
  • emojis array (default: [])
    • @type string (default: "MastodonEmoji")
    • shortcode string nullable
    • url string nullable
    • static_url string nullable
    • visible_in_picker boolean (default: false)
  • roles array (default: [])
    • @type string (default: "MastodonRole")
    • id string nullable
    • name string nullable
    • color string nullable
• reblog object nullable (see schema MastodonStatus)
• quote object nullable (see schema MastodonStatus)
• application object nullable
  • @type string (default: "MastodonApplication")
  • name string nullable
  • website string nullable
• card object nullable
  • @type string (default: "MastodonPreviewCard")
  • url string nullable
  • description string nullable
  • language string nullable
  • type string nullable
  • author_name string nullable
  • author_url string nullable
  • provider_name string nullable
  • provider_url string nullable
  • html string nullable
  • width integer nullable
  • height integer nullable
  • image string nullable
  • image_description string nullable
  • embed_url string nullable
  • blurhash string nullable
  • published_at string nullable
  • history array (default: [])
    • @type string (default: "MastodonHistory")
    • day string nullable
    • accounts integer nullable
    • uses integer nullable
• poll object nullable
  • @type string (default: "MastodonPoll")
  • id string nullable
  • expires_at string nullable
  • expired boolean (default: false)
  • multiple boolean (default: false)
  • vote_count integer nullable
  • voter_count integer nullable
  • options array (default: [])
    • @type string (default: "MastodonPollOption")
    • vote_count integer nullable
  • emojis array (default: [])
    • @type string (default: "MastodonEmoji")
    • shortcode string nullable
    • url string nullable
    • static_url string nullable
    • visible_in_picker boolean (default: false)
• media_attachments array (default: [])
  • @type string (default: "MastodonMediaAttachment")
  • id string nullable
  • type string nullable
  • url string nullable
  • preview_url string nullable
  • remote_url string nullable
  • description string nullable
  • blurhash string nullable
  • width integer nullable
  • height integer nullable
  • duration number nullable
• mentions array (default: [])
  • @type string (default: "MastodonMention")
  • id string nullable
  • username string nullable
  • acct string nullable
  • url string nullable
• tags array (default: [])
  • @type string (default: "MastodonTag")
  • id string nullable
  • name string nullable
  • url string nullable
  • history array (default: [])
    • @type string (default: "MastodonHistory")
    • day string nullable
    • accounts integer nullable
    • uses integer nullable
• emojis array (default: [])
  • @type string (default: "MastodonEmoji")
  • shortcode string nullable
  • url string nullable
  • static_url string nullable
  • visible_in_picker boolean (default: false)

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.