API:Query

This page is a translated version of the page API:Query and the translation is 89% complete.
Other languages:
Deutsch • ‎English • ‎Türkçe • ‎español • ‎français • ‎polski • ‎português • ‎русский • ‎עברית • ‎中文 • ‎日本語 • ‎한국어

El módulo action=query te permite obtener información sobre un wiki y los datos almacenados en él, como el wikitext de una página en particular, los enlaces y categorías de un conjunto de páginas, o el token que necesitas para change wiki content .

API Documentación


action=query

(main | query)

Fetch data from and about MediaWiki.

All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.

Parameters:
prop

Which properties to get for the queried pages.

categories
List all categories the pages belong to.
categoryinfo
Returns information about the given categories.
cirrusbuilddoc
Dump of a CirrusSearch article document from the database servers
cirruscompsuggestbuilddoc
Dump of the document used by the completion suggester
cirrusdoc
Dump of a CirrusSearch article document from the search servers
contributors
Get the list of logged-in contributors and the count of anonymous contributors to a page.
deletedrevisions
Get deleted revision information.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
extlinks
Returns all external URLs (not interwikis) from the given pages.
extracts
Returns plain-text or limited HTML extracts of the given pages.
fileusage
Find all pages that use the given files.
globalusage
Returns global image usage for a certain image.
imageinfo
Returns file information and upload history.
images
Returns all files contained on the given pages.
info
Get basic page information.
iwlinks
Returns all interwiki links from the given pages.
langlinks
Returns all interlanguage links from the given pages.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
pageimages
Returns information about images on the page, such as thumbnail and presence of photos.
pageprops
Get various page properties defined in the page content.
pageterms
Get the Wikidata terms (typically labels, descriptions and aliases) associated with a page via a sitelink. On the entity page itself, the terms are used directly. Caveat: On a repo wiki, this module only works directly on entity pages, not on pages connected to an entity via a sitelink. This may change in the future.
pageviews
Shows per-page pageview data (the number of daily pageviews for each of the last pvipdays days).
redirects
Returns all redirects to the given pages.
revisions
Get revision information.
stashimageinfo
Returns file information for stashed files.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
transcodestatus
Get transcode status for a given file page.
videoinfo
Extends imageinfo to include video source (derivatives) information
wbentityusage
Returns all entity IDs used in the given pages.
flowinfo
Deprecated. Get basic Structured Discussions information about a page.
description
Internal. Get a short description a.k.a. subtitle explaining what the target page is about.
mapdata
Internal. Request all Kartographer map data for the given pages
Values (separate with | or alternative): categories, categoryinfo, cirrusbuilddoc, cirruscompsuggestbuilddoc, cirrusdoc, contributors, deletedrevisions, duplicatefiles, extlinks, extracts, fileusage, globalusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageimages, pageprops, pageterms, pageviews, redirects, revisions, stashimageinfo, templates, transcludedin, transcodestatus, videoinfo, wbentityusage, flowinfo, description, mapdata
list

Which lists to get.

abusefilters
Show details of the abuse filters.
abuselog
Show events that were caught by one of the abuse filters.
allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
allusers
Enumerate all registered users.
backlinks
Find all pages that link to the given page.
betafeatures
List all BetaFeatures
blocks
List all blocked users and IP addresses.
categorymembers
List all pages in a given category.
centralnoticeactivecampaigns
Get a list of currently active campaigns with start and end dates and associated banners.
centralnoticelogs
Get a log of campaign configuration changes.
checkuser
Check which IP addresses are used by a given username or which usernames are used by a given IP address.
checkuserlog
Get entries from the CheckUser log.
codecomments
List comments on revisions in CodeReview.
codepaths
Get a list of 10 paths in a given repository, based on the input path prefix.
coderevisions
List revisions in CodeReview.
codetags
Get a list of tags applied to revisions in a given repository.
embeddedin
Find all pages that embed (transclude) the given title.
extdistrepos
Returns the list of repositories supported by ExtensionDistributor
exturlusage
Enumerate pages that contain a given URL.
filearchive
Enumerate all deleted files sequentially.
gadgetcategories
Returns a list of gadget categories.
gadgets
Returns a list of gadgets used on this wiki.
globalallusers
Enumerate all global users.
globalblocks
List all globally blocked IP addresses.
globalgroups
Enumerate all global groups.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
linterrors
Get a list of lint errors
logevents
Get events from logs.
messagecollection
Query MessageCollection about translations.
mostviewed
Lists the most viewed pages (based on last day's pageview count).
mystashedfiles
Get a list of files in the current user's upload stash.
pagepropnames
List all page property names in use on the wiki.
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
recentchanges
Enumerate recent changes.
search
Perform a full text search.
tags
List change tags.
threads
Show details of LiquidThreads threads.
usercontribs
Get all edits by a user.
users
Get information about a list of users.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
wblistentityusage
Returns all pages that use the given entity IDs.
wikisets
Enumerate all wiki sets.
deletedrevs
Deprecated. List deleted revisions.
extdistbranches
Internal. Returns the list of branches for a repository supported by ExtensionDistributor
mmsites
Internal. Serve autocomplete requests for the site field in MassMessage.
readinglistentries
Internal. List the pages of a certain list.
Values (separate with | or alternative): abusefilters, abuselog, allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, betafeatures, blocks, categorymembers, centralnoticeactivecampaigns, centralnoticelogs, checkuser, checkuserlog, codecomments, codepaths, coderevisions, codetags, embeddedin, extdistrepos, exturlusage, filearchive, gadgetcategories, gadgets, globalallusers, globalblocks, globalgroups, imageusage, iwbacklinks, langbacklinks, linterrors, logevents, messagecollection, mostviewed, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, threads, usercontribs, users, watchlist, watchlistraw, wblistentityusage, wikisets, deletedrevs, extdistbranches, mmsites, readinglistentries
Maximum number of values is 50 (500 for clients allowed higher limits).
meta

Which metadata to get.

allmessages
Return messages from this site.
authmanagerinfo
Retrieve information about the current authentication status.
babel
Get information about what languages the user knows
featureusage
Get a summary of logged API feature usages for a user agent.
filerepoinfo
Return meta information about image repositories configured on the wiki.
globalpreferences
Retrieve global preferences for the current user.
globalrenamestatus
Show information about global renames that are in progress.
globaluserinfo
Show information about a global user.
languageinfo
Return information about available languages.
languagestats
Query language stats.
linterstats
Get number of lint errors in each category
managemessagegroups
Fetch possible renames for a message in a group during imports
messagegroups
Return information about message groups.
messagegroupstats
Query message group stats.
messagetranslations
Query all translations for a single message.
notifications
Get notifications waiting for the current user.
siteinfo
Return general information about the site.
siteviews
Shows sitewide pageview data (daily pageview totals for each of the last pvisdays days).
tokens
Gets tokens for data-modifying actions.
unreadnotificationpages
Get pages for which there are unread notifications for the current user.
userinfo
Get information about the current user.
wikibase
Get information about the Wikibase client and the associated Wikibase repository.
oath
Internal. Check to see if two-factor authentication (OATH) is enabled for a user.
readinglists
Internal. List or filter the user's reading lists and show metadata about them.
Values (separate with | or alternative): allmessages, authmanagerinfo, babel, featureusage, filerepoinfo, globalpreferences, globalrenamestatus, globaluserinfo, languageinfo, languagestats, linterstats, managemessagegroups, messagegroups, messagegroupstats, messagetranslations, notifications, siteinfo, siteviews, tokens, unreadnotificationpages, userinfo, wikibase, oath, readinglists
indexpageids

Include an additional pageids section listing all returned page IDs.

Type: boolean (details)
export

Export the current revisions of all given or generated pages.

Type: boolean (details)
exportnowrap

Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with query+export.

Type: boolean (details)
exportschema

Target the given version of the XML dump format when exporting. Can only be used with query+export.

One of the following values: 0.10, 0.11
Default: 0.10
iwurl

Whether to get the full URL if the title is an interwiki link.

Type: boolean (details)
continue

When more results are available, use this to continue.

rawcontinue

Return raw query-continue data for continuation.

Type: boolean (details)
titles

A list of titles to work on.

Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
pageids

A list of page IDs to work on.

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
revids

A list of revision IDs to work on.

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
generator

Get the list of pages to work on by executing the specified query module.

Note: Generator parameter names must be prefixed with a "g", see examples.

allcategories
Enumerate all categories.
alldeletedrevisions
List all deleted revisions by a user or in a namespace.
allfileusages
List all file usages, including non-existing.
allimages
Enumerate all images sequentially.
alllinks
Enumerate all links that point to a given namespace.
allpages
Enumerate all pages sequentially in a given namespace.
allredirects
List all redirects to a namespace.
allrevisions
List all revisions.
alltransclusions
List all transclusions (pages embedded using {{x}}), including non-existing.
backlinks
Find all pages that link to the given page.
categories
List all categories the pages belong to.
categorymembers
List all pages in a given category.
deletedrevisions
Get deleted revision information.
duplicatefiles
List all files that are duplicates of the given files based on hash values.
embeddedin
Find all pages that embed (transclude) the given title.
exturlusage
Enumerate pages that contain a given URL.
fileusage
Find all pages that use the given files.
images
Returns all files contained on the given pages.
imageusage
Find all pages that use the given image title.
iwbacklinks
Find all pages that link to the given interwiki link.
langbacklinks
Find all pages that link to the given language link.
links
Returns all links from the given pages.
linkshere
Find all pages that link to the given pages.
messagecollection
Query MessageCollection about translations.
mostviewed
Lists the most viewed pages (based on last day's pageview count).
pageswithprop
List all pages using a given page property.
prefixsearch
Perform a prefix search for page titles.
protectedtitles
List all titles protected from creation.
querypage
Get a list provided by a QueryPage-based special page.
random
Get a set of random pages.
recentchanges
Enumerate recent changes.
redirects
Returns all redirects to the given pages.
revisions
Get revision information.
search
Perform a full text search.
templates
Returns all pages transcluded on the given pages.
transcludedin
Find all pages that transclude the given pages.
watchlist
Get recent changes to pages in the current user's watchlist.
watchlistraw
Get all pages on the current user's watchlist.
wblistentityusage
Returns all pages that use the given entity IDs.
readinglistentries
Internal. List the pages of a certain list.
One of the following values: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, messagecollection, mostviewed, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw, wblistentityusage, readinglistentries
redirects

Automatically resolve redirects in query+titles, query+pageids, and query+revids, and in pages returned by query+generator.

Type: boolean (details)
converttitles

Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include en, crh, gan, iu, kk, ku, shi, sr, tg, uz and zh.

Type: boolean (details)

Módulos de consulta

El módulo de consulta tiene tres tipos de submódulos (también llamados módulos de consulta):

  • Metainformation sobre la wiki y el usuario conectado.
  • Properties de páginas, incluidas las revisiones de página y el contenido.
  • Lists de páginas que coinciden con ciertos criterios.

Ejemplos

Ejemplo 1: Especificando páginas

A diferencia de los módulos de consulta meta y lista, todos los módulos de consulta de propiedades funcionan en un conjunto de páginas que se pueden especificar de una de las siguientes maneras:

  • Por nombre usando el parámetro titles, p.ej., titles=Foo|Bar|Main_Page.
  • Por ID de página usando el parámetro pageids, p.ej., pageids=123|456|75915.
  • Por ID de revisión utilizando el parámetro revids, p.ej., revids=478198|54872|54894545. La mayoría de los módulos de consulta convertirán la ID de revisión a la ID de página correspondiente. Solo prop=revisions usa actualmente la ID de revisión en sí.
  • Utilizando un generator.

Solicitud GET

Respuesta

{
    "batchcomplete": true,
    "query": {
        "pages": [
            {
                "pageid": 1130,
                "ns": 0,
                "title": "Avicenna"
            },
            {
                "pageid": 17412,
                "ns": 0,
                "title": "Klein bottle"
            },
            {
                "pageid": 33642,
                "ns": 0,
                "title": "Warrant"
            }
        ]
    }
}

Ejemplo 2: Normalización de título

Normalización de títulos convierte títulos de páginas a su forma canónica.

Esto significa poner en mayúscula el primer carácter, reemplazar los guiones bajos con espacios y cambiar el espacio de nombres a la forma localizada definida para esa wiki.

Cualquier salto de línea final en los títulos de la página (\n) causará un comportamiento extraño y deben ser eliminados primero.

Solicitud GET

Respuesta

Ejemplo 3: títulos Desaparecidos y nulos

Los títulos que no existan o que no sean válidos tendrán un atributo de missing o invalid establecido en la respuesta.

En formatos de salida que admitan claves de matriz numéricas, los títulos faltantes e inválidos tendrán IDs de página negativas.

Solicitud GET

Respuesta

Ejemplo 4: consultas continuas

Cuando todo el dato no se devuelva en la respuesta de una consulta, habrá un atributo continue para indicar que hay más dato.

Para obtener más datos, agregue sus valores a la solicitud original.

Solicitud GET

Respuesta

Ejemplo 5: Batchcomplete

La API devuelve un elemento batchcomplete para indicar que todo el dato para el lote actual de artículos ha sido devuelto. MW 1.25+

En la respuesta de la consulta de muestra anterior, se ha incluido batchcomplete para indicar que se ha devuelto todo el dato de cada una de las tres imágenes.

La próxima continuación comenzará devolver dato para el siguiente conjunto de 3 imágenes.

Solicitud GET

Respuesta

Ejemplo 6: Generators

Usa generadores si deseas obtener datos sobre un conjunto de páginas

Por ejemplo, para obtener datos sobre páginas en una determinada categoría, en lugar de consultar list=categorymembers y luego consultar nuevamente con pageids configurado en todas las páginas devueltas, combine las dos llamadas API en una utilizando generator=categorymembers.

Cuando utilices un módulo de lista como un generador, no necesitas especificar las páginas.

Sin embargo, para un módulo de propiedades, debes specify the pages en las que trabajará el generador.

Por ejemplo, para cargar todas las páginas que estén vinculadas desde la página principal, usa generator=links&titles=Main%20Page.

Los parámetros pasados ​​a un generador deben tener el prefijo g. Por ejemplo, cuando uses generator=backlinks, usa gbllimit en lugar de bllimit.

La consulta de muestra abajo, obtiene enlaces y categorías para las primeras tres páginas en el espacio de nombres principal que comiencen con "Ba".

Solicitud GET

Respuesta

Avisos posibles

Mensaje de aviso Causa
No se ha implementado soporte para páginas especiales. Si se lanza un título en el Especial: o Media: el espacio de nombres está dado. Las páginas en estos espacios de nombres no se pueden consultar.
Redirect resolution cannot be used together with the revids parameter. Any redirects the revids point to have not been resolved. Se genera si el parámetro redirect se usa en una consulta que especifica páginas que usan revids.

Historial de parámetros

  • v1.21: Introducido continue
  • v1.24: Introducido rawcontinue (nota raw continuation era el comportamiento por defecto hasta v1.26)

Notas adicionales

  • Especificar títulos a través de titles o pageids está limitado a 50 títulos por consulta, o 500 para aquellos con el derecho apihighlimits.
  • Usa múltiples módulos de consulta juntos para obtener lo que necesites en una solicitud, p.ej., prop=info|revisions&list=backlinks|embeddedin|allimages&meta=userinfo.
  • Los generadores solo pasan los títulos de las páginas al módulo de consulta y no generan ninguna información por sí mismos. Establecer parámetros como gcmprop, por lo tanto, no tendrá ningún efecto.

Resolviendo redirecciones

Redirects can be resolved automatically, so that the target of a redirect is returned instead of the given title. When present, they will always contain from and to attributes and may contain a tofragment attribute for those redirects that point to specific sections.

Normalización y redirección, ambas pueden tener lugar. En el caso de múltiple redirecciones, todas serán resueltas, y en caso de una redirección circular, no podría haber una página en la sección de 'pages' sección (ve también below). Redirect resolution cannot be used in combination with the revids= parameter or with a generator generating revids; doing that will produce a warning and will not resolve redirects for the specified revids.

The examples below show how the redirects parameter works.

Using "redirects" parameter. "Main page" is a redirect to "Main Page"

Same request but without the "redirects" parameter.

Without "redirects" you may want to use prop=info to obtain redirect status.

Request with a section link. "Wikipedia:!--" redirecciona a "Wikipedia:Manual of Style#Invisible comments"

Este es un caso de redirección circular: Page1 → Page2 → Page3 → Page1. Also, in this example a non-normalized name 'page1' is used.

Ver también