Snapshot API Documentation

Our Snapshot API provides you the entirety of a Wikimedia project (examples: English Wikipedia or French Wiktionary) in a compressed file format. These project files include all articles (pages) with all data fields in NDJSON format updated twice-monthly and are provided free with an account.

Use our metadata endpoints to find the project snapshot(s) you need and make use of parallel downloading headers or chunking to break up large files. Feel free to reference our Data Dictionary for information about the fields in the payload.

If you require snapshots updated daily and/or access to the new Structured Contents snapshots, please contact our sales team for access.

Available Snapshots

Returns a list of available project snapshots by namespace. Includes identifiers, file sizes and other relevant metadata.

GET https://api.enterprise.wikimedia.com/v2/snapshots
Parameters
Query parameters
fields
array
Optional
Allows to select what fields you receive in your response.
filters
array
Optional
Allows you to filter the response payload.
Response
  • application/json
    [ { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" } ]
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
POST https://api.enterprise.wikimedia.com/v2/snapshots
Request Body
fields
array
filters
array
application/json
{ "fields": "[\"name\",\"identifier\"]\n", "filters": "[{\"field\": \"namespace.identifier\", \"value\": 0}]\n" }
Response
  • application/json
    [ { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" } ]
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }

Snapshot Bundle Info

Information on a specific Snapshot bundle. Includes identifiers, file sizes and other relevant metadata.

GET https://api.enterprise.wikimedia.com/v2/snapshots/{identifier}
Parameters
Path parameters
identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
Query parameters
fields
array
Optional
Allows to select what fields you receive in your response.
Response
  • application/json
    { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
POST https://api.enterprise.wikimedia.com/v2/snapshots/{identifier}
Parameters
Path parameters
identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
Request Body
fields
array
application/json
{ "fields": "[\"name\",\"identifier\"]\n" }
Response
  • application/json
    { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }

Project Snapshot

Downloadable bundle of all current revisions in a specified project and namespace. Updated daily at 12:00 UTC.

GET https://api.enterprise.wikimedia.com/v2/snapshots/{identifier}/download
Parameters
Path parameters
identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
Header parameters
Range
string
Optional
The Range HTTP request header indicates the part of a document that the server should return.
Response
  • application/gzip
    {}
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
HEAD https://api.enterprise.wikimedia.com/v2/snapshots/{identifier}/download

Set of headers that describe the snapshot download.

Parameters
Path parameters
identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
Response
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }

Available Snapshot Chunks

Returns a list of available chunks for a specific snapshot. Includes chunk identifiers and other relevant metadata.

GET https://api.enterprise.wikimedia.com/v2/snapshots/{snapshot_identifier}/chunks
Parameters
Path parameters
snapshot_identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
Query parameters
fields
array
Optional
Allows to select what fields you receive in your response.
filters
array
Optional
Allows you to filter the response payload.
Response
  • application/json
    { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
POST https://api.enterprise.wikimedia.com/v2/snapshots/{snapshot_identifier}/chunks
Parameters
Path parameters
snapshot_identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
Request Body
fields
array
filters
array
application/json
{ "fields": "[\"name\",\"identifier\"]\n", "filters": "[{\"field\": \"identifier\",\"value\": \"hiwiki_namespace_0_chunk_0\"}]\n" }
Response
  • application/json
    { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }

Snapshot Chunk Info

Information on a specific chunk of a snapshot. Includes chunk identifier, size, and other relevant metadata.

GET https://api.enterprise.wikimedia.com/v2/snapshots/{snapshot_identifier}/chunks/{identifier}
Parameters
Path parameters
snapshot_identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
identifier
string
Required
Chunk identifier or index.
Query parameters
fields
array
Optional
Allows to select what fields you receive in your response.
Response
  • application/json
    { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
POST https://api.enterprise.wikimedia.com/v2/snapshots/{snapshot_identifier}/chunks/{identifier}
Parameters
Path parameters
snapshot_identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
identifier
string
Required
Chunk identifier or index.
Request Body
fields
array
application/json
{ "fields": "[\"name\",\"identifier\"]\n" }
Response
  • application/json
    { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }

Download Snapshot Chunk

Downloadable bundle of a specific chunk from a snapshot. Returns a zipped tar file.

GET https://api.enterprise.wikimedia.com/v2/snapshots/{snapshot_identifier}/chunks/{identifier}/download
Parameters
Path parameters
snapshot_identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
identifier
string
Required
Chunk identifier or index.
Header parameters
Range
string
Optional
The Range HTTP request header indicates the part of a document that the server should return.
Response
  • application/gzip
    {}
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
HEAD https://api.enterprise.wikimedia.com/v2/snapshots/{snapshot_identifier}/chunks/{identifier}/download

Set of headers that describe the snapshot chunk download.

Parameters
Path parameters
snapshot_identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
identifier
string
Required
Chunk identifier or index.
Response
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }

Available Structured Contents Snapshots (BETA)

Returns a list of available project structured contents snapshots.

GET https://api.enterprise.wikimedia.com/v2/snapshots/structured-contents
Parameters
Query parameters
fields
array
Optional
Allows to select what fields you receive in your response.
filters
array
Optional
Allows you to filter the response payload.
Response
  • application/json
    [ { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" } ]
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
POST https://api.enterprise.wikimedia.com/v2/snapshots/structured-contents
Request Body
fields
array
filters
array
application/json
{ "fields": "[\"name\",\"identifier\"]\n", "filters": "[{\"field\": \"is_part_of.identifier\",\"value\": \"enwiki\"}]\n" }
Response
  • application/json
    [ { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" } ]
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }

Structured Contents Snapshot Bundle Info (BETA)

Information on a specific structured contents snapshot bundle.

GET https://api.enterprise.wikimedia.com/v2/snapshots/structured-contents/{identifier}
Parameters
Path parameters
identifier
string
Required
Structured Contents Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_0 downloads structured_contents used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org. Note: We only have 6 projects in the Structured Contents Beta: enwiki_namespace_0, dewiki_namespace_0, frwiki_namespace_0, eswiki_namespace_0, ptwiki_namespace_0, itwiki_namespace_0.
Query parameters
fields
array
Optional
Allows to select what fields you receive in your response.
Response
  • application/json
    { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
POST https://api.enterprise.wikimedia.com/v2/snapshots/structured-contents/{identifier}
Parameters
Path parameters
identifier
string
Required
Structured Contents Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_0 downloads structured_contents used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org. Note: We only have 6 projects in the Structured Contents Beta: enwiki_namespace_0, dewiki_namespace_0, frwiki_namespace_0, eswiki_namespace_0, ptwiki_namespace_0, itwiki_namespace_0.
Request Body
fields
array
application/json
{ "fields": "[\"name\",\"identifier\"]\n" }
Response
  • application/json
    { "identifier": "string", "version": "string", "date_modified": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" }, "is_part_of": { "identifier": "string", "code": "string", "name": "string", "url": "string", "in_language": { "identifier": "string", "name": "string", "alternate_name": "string", "direction": "string" } }, "namespace": { "identifier": "number", "name": "string", "description": "string" }, "size": { "unit_text": "string", "value": "number" }, "chunks": "array" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }

Project Structured Contents Snapshot (BETA)

Downloadable bundle of structured contents of all current revisions in a specified project and namespace. Updated daily at 12:00 UTC.

GET https://api.enterprise.wikimedia.com/v2/snapshots/structured-contents/{identifier}/download
Parameters
Path parameters
identifier
string
Required
Structured Contents Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_0 downloads structured_contents used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org. Note: We only have 6 projects in the Structured Contents Beta: enwiki_namespace_0, dewiki_namespace_0, frwiki_namespace_0, eswiki_namespace_0, ptwiki_namespace_0, itwiki_namespace_0.
Header parameters
Range
string
Optional
The Range HTTP request header indicates the part of a document that the server should return.
Response
  • application/gzip
    {}
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
HEAD https://api.enterprise.wikimedia.com/v2/snapshots/structured-contents/{identifier}/download

Set of headers that describe the structured contents snapshot download.

Parameters
Path parameters
identifier
string
Required
Snapshot identifier looks like <language><project_name>_namespace_<number>, examples: dewiki_namespace_14 downloads categories used in de.wikipedia.org, enwiki_namespace_0 downloads articles used in en.wikipedia.org, frwikivoyage_namespace_10 downloads wikitext templates used in fr.wikivoyage.org. See our Metadata Endpoints for language, projects, and namespaces available for configuration.
Response
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }
  • application/json
    { "message": "string", "status": "integer" }