/wikimedia_commons/files

POST /api/wikimedia_commons/files

Price: 1 credit

Get a Wikimedia Commons media file by name, page id or URL

How to use it

Get a Wikimedia Commons media file (image, video, audio or document) by its file name, numeric page id, or file URL. Returns the full-resolution media URL, dimensions, byte size, MIME and media type, sha1, the uploader and upload timestamp, the description, author and credit, the license and usage terms, copyright status, whether attribution is required, capture date, categories, any quality/featured assessments and GPS coordinates. Set thumb_width to also get a scaled thumbnail URL, and history to include the file's upload revision history.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• file string required — File name, numeric page id, or a Wikimedia Commons file URL (examples: "File:Felis catus-cat on snow.jpg", "9437797", "https://commons.wikimedia.org/wiki/File:Felis_catus-cat_on_snow.jpg"; minLength: 1)
• thumb_width integer nullable — Width in pixels of an additional scaled thumbnail URL (min: 1; max: 10000)
• history boolean — Include the file's upload revision history (default: false)

Response

• @type string (default: "WikimediaCommonsFile")
• 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
• sha1 string nullable
• uploaded_by string nullable
• uploaded_at string nullable
• description string nullable
• object_name string nullable
• author string nullable
• credit string nullable
• license string nullable
• license_short_name string nullable
• license_url string nullable
• usage_terms string nullable
• is_copyrighted boolean nullable
• attribution_required boolean nullable
• restrictions string nullable
• date string nullable
• categories array (default: [])
• assessments array (default: [])
• latitude number nullable
• longitude number nullable
• gps_map_datum string nullable
• revisions array (default: [])
  • @type string (default: "WikimediaCommonsFileRevision")
  • timestamp string nullable
  • user string nullable
  • size integer nullable
  • width integer nullable
  • height integer nullable
  • comment string nullable
  • image 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 — File not found 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.