/wikimedia_commons/files/list

POST /api/wikimedia_commons/files/list

Price: 1 credit

Browse Wikimedia Commons media files, optionally filtered by uploader, MIME or size

How to use it

Browse Wikimedia Commons media files. Optionally return only files uploaded by a given user, filter by MIME type or by a byte-size range, and order by name or by upload time. Returns each file's name, media and description URLs, dimensions, byte size, MIME and media type, sha1, uploader and upload timestamp.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Number of files to return (min: 1)
• user string nullable — Return only files uploaded by this user (examples: "Fir0002")
• sort string — Result ordering (default: "timestamp"; one of: "name", "timestamp")
• mime string nullable — Filter by MIME type (examples: "image/jpeg")
• min_size integer nullable — Minimum file size in bytes (min: 0)
• max_size integer nullable — Maximum file size in bytes (min: 0)

Response

• @type string (default: "WikimediaCommonsListItem")
• image string (default: "")
• description_url string (default: "")
• web_url string (default: "")
• width integer nullable
• height integer nullable
• size integer nullable
• mime string nullable
• media_type string nullable
• sha1 string nullable
• uploaded_by string nullable
• uploaded_at 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.