/mastodon/accounts/search

POST /api/mastodon/accounts/search

Price: 5 credits

Search Mastodon Accounts

How to use it

Search for Mastodon accounts by handle, display name, or keyword on the host instance. Returns accounts the instance already knows about (local and federated), ranked by relevance.

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")
• q string required — Search query (handle, display name, or keyword) (examples: "climate"; minLength: 1)
• count integer required — Max result count (examples: 20; min: 1; max: 40)

Response

• @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

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.