Snapshot API Documentation

Our Snapshot API provides you the entirety of a Wikimedia project (English Wikipedia for example) in a compressed file format. These files include all articles and all the data fields for every article in the project and they are updated monthly and provided free with an account. If you prefer Snapshots updated daily, please contact our sales team for access. Use our metadata endpoints to find the project snapshot(s) you need and make use of parallel downloading headers to break up large files. Feel free to reference our Data Dictionary for information about the fields in the payload.

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

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

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",
    "name": "string",
    "version": "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"
    }
  }
]
  • 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

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

Request Body
fields
array
filters
array
application/json
{
  "fields": "[\"name\",\"identifier\"]\n",
  "filters": "[{\"field\":\"namespace.identifier\",\"value\":0}]\n"
}
Response 
  • application/json
    [
  {
    "identifier": "string",
    "name": "string",
    "version": "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"
    }
  }
]
  • 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}

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

Parameters
Path parameters
identifier
string
Required
Snapshot identifier.
Query parameters
fields
array
Optional
Allows to select what fields you receive in your response.
Response 
  • application/json
    {
  "identifier": "string",
  "name": "string",
  "version": "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"
  }
}
  • 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}

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

Parameters
Path parameters
identifier
string
Required
Snapshot identifier.
Request Body
fields
array
application/json
{
  "fields": "[\"name\",\"identifier\"]\n"
}
Response 
  • application/json
    {
  "identifier": "string",
  "name": "string",
  "version": "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"
  }
}
  • 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

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

Parameters
Path parameters
identifier
string
Required
Snapshot identifier.
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 hourly download.

Parameters
Path parameters
identifier
string
Required
Snapshot identifier.
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"
}