MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/API

Modulu nagusia

Status: The MediaWiki API is a mature and stable interface that is actively supported and improved. While we try to avoid it, we may occasionally need to make breaking changes; subscribe to the mediawiki-api-announce mailing list for notice of updates.

Erroneous requests: When erroneous requests are sent to the API, an HTTP header will be sent with the key "MediaWiki-API-Error" and then both the value of the header and the error code sent back will be set to the same value. For more information see API: Errors and warnings.

Parametroak:
action

Zein ekintza burutuko da.

block
Blokeatu erabiltzaile bat.
changeauthenticationdata
Aldatu autentifikazio datuak uneko erabiltzailearentzat.
checktoken
Check the validity of a token from action=query&meta=tokens.
clearhasmsg
Clears the hasmsg flag for the current user.
clientlogin
Hasi saioa wikiera fluxu interaktiboa erabiliz.
compare
Bi orrien arteko ezberdintasuna jaso.
createaccount
Erabiltzaile kontu berria sortu.
cspreport
Used by browsers to report violations of the Content Security Policy. This module should never be used, except when used automatically by a CSP compliant web browser.
delete
Orrialde bat ezabatu.
edit
Orrialdeak sortu eta aldatu.
emailuser
Erabiltzaileari e-maila bidali
expandtemplates
Wikitesturako txantiloi guztiak zabaldu.
feedcontributions
Returns a user contributions feed.
feedrecentchanges
Returns a recent changes feed.
feedwatchlist
Returns a watchlist feed.
filerevert
Artxibo bat bertsio zaharrera bueltatu.
flagconfig
Get basic information about review flag configuration for this site.
help
Display help for the specified modules.
imagerotate
Irudi bat edo gehiago biratu.
import
Import a page from another wiki, or from an XML file.
linkaccount
Link an account from a third-party provider to the current user.
login
Log in and get authentication cookies.
logout
Saioa itxi eta saioko datuak garbitu.
managetags
Perform management tasks relating to change tags.
mergehistory
Orrialdeen historiak erakutsi.
move
Orrialde bat mugitu
opensearch
Search the wiki using the OpenSearch protocol.
options
Change preferences of the current user.
paraminfo
API moduluei buruzko informazioa eskuratu.
parse
Parses content and returns parser output.
patrol
Orri edo berrikusketa bat patruilatu.
protect
Aldatu orri baten segurtasun maila.
purge
Purge the cache for the given titles.
query
Fetch data from and about MediaWiki.
removeauthenticationdata
Remove authentication data for the current user.
resetpassword
Send a password reset email to a user.
review
Review a revision by approving or de-approving it.
reviewactivity
Advertise or de-advertise yourself as reviewing an unreviewed page or unreviewed changes.
revisiondelete
Delete and undelete revisions.
rollback
Undo the last edit to the page.
rsd
Export an RSD (Really Simple Discovery) schema.
setnotificationtimestamp
Update the notification timestamp for watched pages.
setpagelanguage
Change the language of a page.
stabilize
Change page stability settings.
stashedit
Prepare an edit in shared cache.
tag
Add or remove change tags from individual revisions or log entries.
unblock
Unblock a user.
undelete
Restore revisions of a deleted page.
unlinkaccount
Remove a linked third-party account from the current user.
upload
Upload a file, or get the status of pending uploads.
userrights
Change a user's group membership.
validatepassword
Validate a password against the wiki's password policies.
watch
Add or remove pages from the current user's watchlist.
tokens
Zaharkitua. Get tokens for data-modifying actions.
One of the following values: block, changeauthenticationdata, checktoken, clearhasmsg, clientlogin, compare, createaccount, cspreport, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, flagconfig, help, imagerotate, import, linkaccount, login, logout, managetags, mergehistory, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, removeauthenticationdata, resetpassword, review, reviewactivity, revisiondelete, rollback, rsd, setnotificationtimestamp, setpagelanguage, stabilize, stashedit, tag, unblock, undelete, unlinkaccount, upload, userrights, validatepassword, watch, tokens
Lehenetsia: help
format

Irteerako formatua.

json
Output data in JSON format.
jsonfm
Output data in JSON format (pretty-print in HTML).
none
Output nothing.
php
Output data in serialized PHP format.
phpfm
Output data in serialized PHP format (pretty-print in HTML).
rawfm
Output data, including debugging elements, in JSON format (pretty-print in HTML).
xml
Output data in XML format.
xmlfm
Output data in XML format (pretty-print in HTML).
One of the following values: json, jsonfm, none, php, phpfm, rawfm, xml, xmlfm
Lehenetsia: jsonfm
maxlag

Maximum lag can be used when MediaWiki is installed on a database replicated cluster. To save actions causing any more site replication lag, this parameter can make the client wait until the replication lag is less than the specified value. In case of excessive lag, error code maxlag is returned with a message like Waiting for $host: $lag seconds lagged.
See Manual: Maxlag parameter for more information.

Mota: osokoa
smaxage

Set the s-maxage HTTP cache control header to this many seconds. Errors are never cached.

Mota: osokoa
Lehenetsia: 0
maxage

Set the max-age HTTP cache control header to this many seconds. Errors are never cached.

Mota: osokoa
Lehenetsia: 0
assert

Verify the user is logged in if set to user, or has the bot user right if bot.

One of the following values: user, bot
assertuser

Egiaztatu erabiltzaile hau izendatutakoa dela.

Mota: erabiltzaile-izena
requestid

Hemen emandako edozein balio erantzunean kontuan hartuko da. Eskaerak ezberdintzeko erabili ahalko da.

servedby

Sartu eskaera emaitzetan zerbitzariaren izena.

Mota: boolearra (xehetasunak)
curtimestamp

Emaitzan oraingo denbora-zigilua jarri.

Mota: boolearra (xehetasunak)
responselanginfo

Include the languages used for uselang and errorlang in the result.

Mota: boolearra (xehetasunak)
origin

When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain. This must be included in any pre-flight request, and therefore must be part of the request URI (not the POST body).

For authenticated requests, this must match one of the origins in the Origin header exactly, so it has to be set to something like https://en.wikipedia.org or https://meta.wikimedia.org. If this parameter does not match the Origin header, a 403 response will be returned. If this parameter matches the Origin header and the origin is whitelisted, the Access-Control-Allow-Origin and Access-Control-Allow-Credentials headers will be set.

For non-authenticated requests, specify the value *. This will cause the Access-Control-Allow-Origin header to be set, but Access-Control-Allow-Credentials will be false and all user-specific data will be restricted.

uselang

Language to use for message translations. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify user to use the current user's language preference, or specify content to use this wiki's content language.

Lehenetsia: user
errorformat

Format to use for warning and error text output.

plaintext
Wikitext with HTML tags removed and entities replaced.
wikitext
Unparsed wikitext.
html
HTML.
raw
Message key and parameters.
none
No text output, only the error codes.
bc
Format used prior to MediaWiki 1.29. errorlang and errorsuselocal are ignored.
One of the following values: plaintext, wikitext, html, raw, none, bc
Lehenetsia: bc
errorlang

Language to use for warnings and errors. action=query&meta=siteinfo with siprop=languages returns a list of language codes, or specify content to use this wiki's content language, or specify uselang to use the same value as the uselang parameter.

Lehenetsia: uselang
errorsuselocal

If given, error texts will use locally-customized messages from the MediaWiki namespace.

Mota: boolearra (xehetasunak)
Adibideak:
Modulu nagusirako laguntza.
api.php?action=help [open in sandbox]
Laguntza guztia orrialde batean.
api.php?action=help&recursivesubmodules=1 [open in sandbox]
Baimenak:
writeapi
API idaztekoa erabili
Granted to: all, user eta bot
apihighlimits
Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
Granted to: bot eta sysop

Datu-motak

Input to MediaWiki should be NFC-normalized UTF-8. MediaWiki may attempt to convert other input, but this may cause some operations (such as edits with MD5 checks) to fail.

Some parameter types in API requests need further explanation:

boolean
Boolean parameters work like HTML checkboxes: if the parameter is specified, regardless of value, it is considered true. For a false value, omit the parameter entirely.
timestamp
Timestamps may be specified in several formats, see the Timestamp library input formats documented on mediawiki.org for details. ISO 8601 date and time is recommended: 2001-01-15T14:56:00Z. Additionally, the string now may be used to specify the current timestamp.
alternative multiple-value separator
Parameters that take multiple values are normally submitted with the values separated using the pipe character, e.g. param=value1|value2 or param=value1%7Cvalue2. If a value must contain the pipe character, use U+001F (Unit Separator) as the separator and prefix the value with U+001F, e.g. param=%1Fvalue1%1Fvalue2.

Templated parameters

Templated parameters support cases where an API module needs a value for each value of some other parameter. For example, if there were an API module to request fruit, it might have a parameter fruits to specify which fruits are being requested and a templated parameter {fruit}-quantity to specify how many of each fruit to request. An API client that wants 1 apple, 5 bananas, and 20 strawberries could then make a request like fruits=apples|bananas|strawberries&apples-quantity=1&bananas-quantity=5&strawberries-quantity=20.

Kredituak

API garatzaileak:

  • Roan Kattouw (garatzaile nagusia, 2007ko ira.–2009)
  • Victor Vasiliev
  • Bryan Tong Minh
  • Sam Reed
  • Yuri Astrakhan (sortzailea, garatzaile nagusia, 2006ko ira.–2007ko ira.)
  • Brad Jorsch (garatzaile nagusia 2013–gaur egun)

Mesedez, bidal iezazkiguzu zure iruzkinak, iradokizunak eta galderak mediawiki-api@lists.wikimedia.org helbidera edo bete ezazu errore-txostena https://phabricator.wikimedia.org/ helbidean.