/fandom/pages/search

POST /api/fandom/pages/search

Price: 1 credit

Search a Fandom wiki by full-text query

How to use it

Search a Fandom (Wikia) wiki by a full-text query. Pick the wiki with its subdomain or URL and an optional language path segment. Filter by page kind (articles, categories, templates, user blogs, forums, ...) and choose the result ordering (relevance, creation or last-edit time, incoming link count). Returns for each match the page id, title, namespace, the byte size, word count, last-edit timestamp and the page URL.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• wiki string required — Wiki subdomain (e.g. harrypotter, minecraft) or a full wiki URL (examples: "harrypotter", "minecraft", "https://elderscrolls.fandom.com"; minLength: 1)
• lang string — Language path segment for multilingual wikis (e.g. de, es, pl); empty for the default (default: ""; maxLength: 8)
• keyword string required — Full-text search query (examples: "quidditch"; minLength: 1)
• namespace string — Which kind of page to search (article namespace by default) (default: "article"; one of: "article", "talk", "user", "project", "file", "template", "help", "category", "forum", "user_blog", "blog")
• sort string — Ordering of the results (default: "relevance"; one of: "relevance", "create_timestamp_asc", "create_timestamp_desc", "last_edit_asc", "last_edit_desc", "incoming_links_asc", "incoming_links_desc", "just_match")
• count integer required — Number of pages to return (min: 1)

Response

• @type string (default: "FandomSearchResult")
• id integer required
• alias string (default: "")
• namespace integer nullable
• size integer nullable
• word_count integer nullable
• updated_at string nullable
• web_url string (default: "")

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.