This is an auto-generated MediaWiki API documentation page.
Documentation and examples:
https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
Mo đun chinh
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
.
Testing:
For ease of testing API requests, see
Special:ApiSandbox
.
Cac tham s?:
- action
Tac v? đ? th?c hi?n.
- abusefiltercheckmatch
- Ki?m tra xem li?u m?t b? l?c l?m d?ng co kh?p v?i m?t t?p h?p cac bi?n, m?t ch?nh s?a ho?c m?t s? ki?n l?m d?ng đa ghi hay khong.
- abusefilterchecksyntax
- Ki?m tra cu phap c?a B? l?c l?m d?ng.
- abusefilterevalexpression
- đanh gia m?t bi?u th?c AbuseFilter.
- abusefilterunblockautopromote
- B? ch?n ng??i dung nh?n qu?ng cao t? đ?ng do h?u qu? c?a b? l?c l?m d?ng.
- abuselogprivatedetails
- View private details of an AbuseLog entry.
- acquiretempusername
- Acquire a temporary user username and stash it in the current session, if temp account creation is enabled and the current user is logged out. If a name has already been stashed, returns the same name.
- antispoof
- Ki?m tra xem ten ng??i dung qua qua trinh ki?m tra tieu chu?n c?a AntiSpoof.
- block
- C?m ng??i dung.
- centralauthtoken
- Fetch a centralauthtoken for making an authenticated request to an attached wiki.
- centralnoticecdncacheupdatebanner
- Request the purge of banner content stored in the CDN (front-end) cache for anonymous users, for the requested banner and language
- centralnoticechoicedata
- Get data needed to choose a banner for a given project and language
- centralnoticequerycampaign
- Get all configuration settings for a campaign.
- changeauthenticationdata
- Change authentication data for the current user.
- changecontentmodel
- Change the content model of a page
- checktoken
- Check the validity of a token from
action=query&meta=tokens
.
- cirrus-config-dump
- Dump of CirrusSearch configuration.
- cirrus-mapping-dump
- Dump of CirrusSearch mapping for this wiki.
- cirrus-profiles-dump
- Dump of CirrusSearch profiles for this wiki.
- cirrus-settings-dump
- Dump of CirrusSearch settings for this wiki.
- clearhasmsg
- Xoa c?
hasmsg
cho ng??i dung hi?n t?i.
- clientlogin
- Log in to the wiki using the interactive flow.
- compare
- Get the difference between two pages.
- createaccount
- M? tai kho?n m?i.
- createlocalaccount
- Forcibly create a local account. The central account must exist.
- cxdelete
- Delete a draft translation created using the Content Translation extension.
- cxsuggestionlist
- Manage the suggestion lists. Add suggestions to lists and remove them.
- cxtoken
- Get JWT tokens to authenticate with cxserver.
- delete
- Xoa trang.
- deleteglobalaccount
- Delete a global user.
- discussiontoolsedit
- đ?ng l?i binh lu?n tren m?t trang th?o lu?n.
- discussiontoolsfindcomment
- Find a comment by its ID or name.
- discussiontoolsgetsubscriptions
- Nh?n tr?ng thai theo doi c?a cac ch? đ? nh?t đ?nh.
- discussiontoolssubscribe
- Theo doi (ho?c ng?ng theo doi) đ? nh?n thong bao v? m?t ch? đ?.
- discussiontoolsthank
- Send a public thank-you notification for a comment.
- echocreateevent
- Manually trigger a notification to a user
- echomarkread
- Mark notifications as read for the current user.
- echomarkseen
- Mark notifications as seen for the current user.
- echomute
- Mute or unmute notifications from certain users or pages.
- edit
- T?o va s?a trang.
- editmassmessagelist
- Edit a mass message delivery list.
- emailuser
- G?i th? cho ng??i dung.
- expandtemplates
- Bung t?t c? b?n m?u trong ma wiki.
- featuredfeed
- Returns a featured content feed.
- feedcontributions
- Tr? v? ngu?n c?p đong gop ng??i dung.
- feedrecentchanges
- Tr? v? ngu?n c?p thay đ?i g?n đay.
- feedwatchlist
- Tr? v? ngu?n c?p danh sach theo doi.
- filerevert
- Ph?c h?i m?t t?p tin sang m?t phien b?n c?.
- globalblock
- Globally block or unblock a user.
- globalpreferenceoverrides
- Change local overrides for global preferences for the current user.
- globalpreferences
- Change global preferences of the current user.
- globaluserrights
- Add/remove a user to/from global groups.
- growthmanagementorlist
- Manage information in the structured mentor list (usually stored in
MediaWiki:GrowthMentors.json
). This module can be used by both current and future mentors (to add themselves or change their details) and administrators (for all users).
- growthmentordashboardupdatedata
- Schedule an extraordinary update of the mentee overview module in the mentor dashboard. You can only schedule one update per two hours for performance reasons.
- growthsetmenteestatus
- Set mentee's status (allows mentees to enable/disable mentorship module, or to opt-out entirely, which deletes the mentee/mentor relationship)
- growthsetmentor
- đ?t c? v?n c?a ng??i dung. Thay đ?i s? đ??c ghi l?i m?t cach cong khai.
- growthstarmentee
- đanh d?u ho?c b? đanh d?u sao m?t ng??i đ??c c? v?n b?i ng??i dung hi?n t?i (l?u tr? rieng t? va khong đ??c ghi l?i)
- help
- Hi?n th? tr? giup cho cac mo-đun xac đ?nh.
- homepagequestionstore
- L?y cac cau h?i đ??c đ?nh d?ng đ??c đ?ng qua cac mo-đun trang ch?
- imagerotate
- Mo đun nay đa b? vo hi?u hoa.
- import
- Import a page from another wiki, or from an XML file.
- jsonconfig
- Allows direct access to JsonConfig subsystem.
- languagesearch
- Tim ki?m ten ngon ng? trong b?t k? t?p l?nh nao.
- linkaccount
- Link an account from a third-party provider to the current user.
- login
- Log in and get authentication cookies.
- logout
- Thoat ra va xoa d? li?u phien lam vi?c.
- managetags
- Perform management tasks relating to change tags.
- massmessage
- Send a message to a list of pages.
- mergehistory
- H?p nh?t l?ch s? trang.
- move
- Di chuy?n trang.
- opensearch
- Tim ki?m trong wiki qua giao th?c OpenSearch.
- options
- Change preferences of the current user.
- paraminfo
- L?y thong tin v? cac module API.
- parse
- Parses content and returns parser output.
- patrol
- Patrol a page or revision.
- protect
- Change the protection level of a page.
- 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.
- revisiondelete
- Delete and undelete revisions.
- rollback
- Lui l?i s?a đ?i cu?i cung c?a trang nay.
- rsd
- Export an RSD (Really Simple Discovery) schema.
- setglobalaccountstatus
- Hide or lock (or unhide or unlock) a global user account.
- setnotificationtimestamp
- Update the notification timestamp for watched pages.
- setpagelanguage
- Change the language of a page.
- shortenurl
- Shorten a long URL into a shorter one.
- sitematrix
- Get Wikimedia sites list.
- spamblacklist
- Validate one or more URLs against the spam block list.
- streamconfigs
- Exposes event stream config. Returns only format=json with formatversion=2.
- strikevote
- Allows admins to strike or unstrike a vote.
- sxdelete
- Delete the draft section translation and its parallel corpora from database.
- tag
- Add or remove change tags from individual revisions or log entries.
- templatedata
- Fetch data stored by the TemplateData extension.
- thank
- G?i thong bao c?m ?n đ?n m?t bien t?p vien.
- titleblacklist
- Validate a page title, filename, or username against the TitleBlacklist.
- torblock
- Check if an IP address is blocked as a Tor exit node.
- transcodereset
- Users with the 'transcode-reset' right can reset and re-run a transcode job.
- unblock
- Unblock a user.
- undelete
- Undelete 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.
- webapp-manifest
- Tr? v? b?ng ke khai ?ng d?ng web.
- webauthn
- API Module to communicate between server and client during registration/authentication process.
- wikilove
- Give WikiLove to another user.
- bouncehandler
- Internal.
Receive a bounce email and process it to handle the failing recipient.
- categorytree
- Internal.
Internal module for the CategoryTree extension.
- cirrus-check-sanity
- Internal.
Reports on the correctness of a range of page ids in the search index
- collection
- Internal.
API module for performing various operations on a wiki user's collection.
- cspreport
- Internal.
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.
- cxcheckunreviewed
- Internal.
Check if any fast, unreviewed translation has been published recently for the current user.
- cxpublish
- Internal.
Save a page created using the Content Translation extension.
- cxpublishsection
- Internal.
Save a section created using the Content Translation extension's section translation feature.
- cxsave
- Internal.
This module allows to save draft translations by section to save bandwidth and to collect parallel corpora.
- cxsplit
- Internal.
Create and save a section translation to database, for every translated section of the given article translation
- discussiontoolscompare
- Internal.
Nh?n thong tin v? cac thay đ?i binh lu?n gi?a hai l?n s?a đ?i trang.
- discussiontoolspageinfo
- Internal.
Tr? v? sieu d? li?u c?n thi?t đ? kh?i t?o cong c? th?o lu?n.
- discussiontoolspreview
- Internal.
Preview a message on a discussion page.
- echopushsubscriptions
- Internal.
Manage push subscriptions for the current user.
- editcheckreferenceurl
- Internal.
Check the status of a URL for use as a reference.
- fancycaptchareload
- Internal.
Get a new FancyCaptcha.
- growthinvalidateimagerecommendation
- Internal.
Invalidate an image recommendation.
- growthinvalidatepersonalizedpraisesuggestion
- Internal.
Invalidates a suggestion of a praiseworthy mentee in the Personalized praise module on the Mentor dashboard
- helppanelquestionposter
- Internal.
X? ly cac cau h?i đ??c đ?ng qua c?a s? tr? giup cho ng??i dung hi?n t?i.
- jsondata
- Internal.
Retrieve localized JSON data.
- oathvalidate
- Internal.
Validate a two-factor authentication (OATH) token.
- parser-migration
- Internal.
Parse a page with two different parser configurations.
- readinglists
- Internal.
Reading list write operations.
- sanitize-mapdata
- Internal.
Performs data validation for Kartographer extension
- scribunto-console
- Internal.
Internal module for servicing XHR requests from the Scribunto console.
- securepollauth
- Internal.
Allows a remote wiki to authenticate users before granting access to vote in the election.
- stashedit
- Internal.
Prepare an edit in shared cache.
- sxsave
- Internal.
Save the draft section translation and store the parallel corpora
- timedtext
- Internal.
Provides timed text content for usage by <track> elements
- ulslocalization
- Internal.
Get the localization of ULS in the given language.
- ulssetlang
- Internal.
C?p nh?t ngon ng? giao di?n ?a thich c?a ng??i dung.
- visualeditor
- Internal.
Returns HTML5 for a page from the Parsoid service.
- visualeditoredit
- Internal.
Save an HTML5 page to MediaWiki (converted to wikitext via the Parsoid service).
- wikimediaeventsblockededit
- Internal.
Log information about blocked edit attempts
- M?t trong cac gia tr?:
abusefiltercheckmatch
,
abusefilterchecksyntax
,
abusefilterevalexpression
,
abusefilterunblockautopromote
,
abuselogprivatedetails
,
acquiretempusername
,
antispoof
,
block
,
centralauthtoken
,
centralnoticecdncacheupdatebanner
,
centralnoticechoicedata
,
centralnoticequerycampaign
,
changeauthenticationdata
,
changecontentmodel
,
checktoken
,
cirrus-config-dump
,
cirrus-mapping-dump
,
cirrus-profiles-dump
,
cirrus-settings-dump
,
clearhasmsg
,
clientlogin
,
compare
,
createaccount
,
createlocalaccount
,
cxdelete
,
cxsuggestionlist
,
cxtoken
,
delete
,
deleteglobalaccount
,
discussiontoolsedit
,
discussiontoolsfindcomment
,
discussiontoolsgetsubscriptions
,
discussiontoolssubscribe
,
discussiontoolsthank
,
echocreateevent
,
echomarkread
,
echomarkseen
,
echomute
,
edit
,
editmassmessagelist
,
emailuser
,
expandtemplates
,
featuredfeed
,
feedcontributions
,
feedrecentchanges
,
feedwatchlist
,
filerevert
,
globalblock
,
globalpreferenceoverrides
,
globalpreferences
,
globaluserrights
,
growthmanagementorlist
,
growthmentordashboardupdatedata
,
growthsetmenteestatus
,
growthsetmentor
,
growthstarmentee
,
help
,
homepagequestionstore
,
imagerotate
,
import
,
jsonconfig
,
languagesearch
,
linkaccount
,
login
,
logout
,
managetags
,
massmessage
,
mergehistory
,
move
,
opensearch
,
options
,
paraminfo
,
parse
,
patrol
,
protect
,
purge
,
query
,
removeauthenticationdata
,
resetpassword
,
revisiondelete
,
rollback
,
rsd
,
setglobalaccountstatus
,
setnotificationtimestamp
,
setpagelanguage
,
shortenurl
,
sitematrix
,
spamblacklist
,
streamconfigs
,
strikevote
,
sxdelete
,
tag
,
templatedata
,
thank
,
titleblacklist
,
torblock
,
transcodereset
,
unblock
,
undelete
,
unlinkaccount
,
upload
,
userrights
,
validatepassword
,
watch
,
webapp-manifest
,
webauthn
,
wikilove
,
bouncehandler
,
categorytree
,
cirrus-check-sanity
,
collection
,
cspreport
,
cxcheckunreviewed
,
cxpublish
,
cxpublishsection
,
cxsave
,
cxsplit
,
discussiontoolscompare
,
discussiontoolspageinfo
,
discussiontoolspreview
,
echopushsubscriptions
,
editcheckreferenceurl
,
fancycaptchareload
,
growthinvalidateimagerecommendation
,
growthinvalidatepersonalizedpraisesuggestion
,
helppanelquestionposter
,
jsondata
,
oathvalidate
,
parser-migration
,
readinglists
,
sanitize-mapdata
,
scribunto-console
,
securepollauth
,
stashedit
,
sxsave
,
timedtext
,
ulslocalization
,
ulssetlang
,
visualeditor
,
visualeditoredit
,
wikimediaeventsblockededit
- Default: help
- format
đ?nh d?ng c?a d? li?u đ??c cho ra.
- json
- Cho ra d? li?u d??i d?ng JSON.
- jsonfm
- Cho ra d? li?u d??i d?ng JSON (đ?nh d?ng b?ng HTML).
- none
- Khong cho ra gi.
- php
- Output data in serialized PHP format.
- phpfm
- Output data in serialized PHP format (pretty-print in HTML).
- rawfm
- Cho ra d? li?u bao g?m cac ph?n t? g? l?i d??i d?ng JSON (đ?nh d?ng b?ng HTML).
- xml
- Cho ra d? li?u d??i d?ng XML.
- xmlfm
- Cho ra d? li?u d??i d?ng XML (đ?nh d?ng b?ng HTML).
- M?t trong cac gia tr?:
json
,
jsonfm
,
none
,
php
,
phpfm
,
rawfm
,
xml
,
xmlfm
- Default: 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.
- Type: integer
- smaxage
Set the
s-maxage
HTTP cache control header to this many seconds. Errors are never cached.
- Type: integer
- The value must be no less than 0.
- Default: 0
- maxage
Set the
max-age
HTTP cache control header to this many seconds. Errors are never cached.
- Type: integer
- The value must be no less than 0.
- Default: 0
- assert
Verify that the user is logged in (including possibly as a temporary user) if set to
user
,
not
logged in if set to
anon
, or has the bot user right if
bot
.
- M?t trong cac gia tr?: anon, bot, user
- assertuser
Verify the current user is the named user.
- Ki?u: ng??i dung, b?ng m?t gia tr? b?t k? trong ten ng??i dung va Ng??i dung t?m th?i
- requestid
Any value given here will be included in the response. May be used to distinguish requests.
- servedby
Include the hostname that served the request in the results.
- Type: boolean (
details
)
- curtimestamp
Include the current timestamp in the result.
- Type: boolean (
details
)
- responselanginfo
Include the languages used for
uselang
and
errorlang
in the result.
- Type: boolean (
details
)
- 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 allowed, 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
Ngon ng? đ? s? d?ng cho cac b?n d?ch thong đi?p.
action=query&meta=siteinfo
v?i
siprop=languages
tr? v? m?t danh sach cac ma ngon ng?, ho?c đ?nh ro
user
đ? s? d?ng ngon ng? c?a ng??i dung hi?n t?i, ho?c đ?nh ro
content
đ? s? d?ng ngon ng? n?i dung c?a wiki nay.
- Default: user
- variant
Variant of the language. Only works if the base language supports variant conversion.
- 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.
- M?t trong cac gia tr?: bc, html, none, plaintext, raw, wikitext
- Default: bc
- errorlang
Language to use for warnings and errors.
action=query&meta=siteinfo&siprop=languages
returns a list of language codes. Specify
content
to use this wiki's content language or
uselang
to use the same value as the
uselang
parameter.
- Default: uselang
- errorsuselocal
If given, error texts will use locally-customized messages from the MediaWiki namespace.
- Type: boolean (
details
)
- centralauthtoken
When accessing the API using a cross-domain AJAX request (CORS), use this to authenticate as the current SUL user. Use
action=centralauthtoken
on this wiki to retrieve the token, before making the CORS request. Each token may only be used once, and expires after 10 seconds. This should be included in any pre-flight request, and therefore should be included in the request URI (not the POST body).
Cac quy?n h?n:
- writeapi
- S? d?ng API đ? vi?t
- C?p cho: all, user va bot
- apihighlimits
- Use higher limits in API queries (slow queries: 500; fast queries: 5000). The limits for slow queries also apply to multivalue parameters.
- C?p cho: bot va sysop
Data types
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.
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
.
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.
- expiry
Expiry values may be relative (e.g.
5 months
or
2 weeks
) or absolute (e.g.
2014-09-18T12:34:56Z
). For no expiry, use
infinite
,
indefinite
,
infinity
or
never
.
- 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
-
15
T
14
:
56
:
00
Z
. Additionally, the string
now
may be used to specify the current timestamp.
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
.
Ghi cong
API developers:
- Yuri Astrakhan (creator, lead developer Sep 2006?Sep 2007)
- Roan Kattouw (lead developer Sep 2007?2009)
- Victor Vasiliev
- Bryan Tong Minh
- Sam Reed
- Brad Jorsch (lead developer 2013?2020)
Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org
or file a bug report at
https://phabricator.wikimedia.org/
.