/wikimedia_commons/files/search

POST /api/wikimedia_commons/files/search

Price: 1 credit

Search Wikimedia Commons media files by full-text query

How to use it

Search Wikimedia Commons media files by a full-text query. Optionally narrow by a depicted Wikidata concept, by MIME type, or by media type (image, drawing, audio, video, document), and choose the ordering. Returns for each match the file id and name, the media and thumbnail URLs, dimensions, byte size, MIME and media type, the uploader and upload timestamp, the description and the short license name.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string required — Full-text search query (examples: "domestic cat"; minLength: 1)
• count integer required — Number of files to return (min: 1)
• depicts string nullable — Wikidata item id of a depicted concept to filter by (examples: "Q146")
• mime string nullable — Filter by MIME type (examples: "image/jpeg", "image/png")
• file_type string nullable — Filter by media type (one of: "bitmap", "drawing", "audio", "video", "office", "pdf")
• sort string — Result ordering (default: "relevance"; one of: "relevance", "last_edit_desc", "last_edit_asc", "create_timestamp_desc", "create_timestamp_asc")

Response

• @type string (default: "WikimediaCommonsSearchResult")
• id integer required
• image string (default: "")
• thumbnail string nullable
• description_url string (default: "")
• web_url string (default: "")
• width integer nullable
• height integer nullable
• size integer nullable
• mime string nullable
• media_type string nullable
• uploaded_by string nullable
• uploaded_at string nullable
• description string nullable
• license_short_name 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.