MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

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

Main module

Status: All features shown on this page should be working, but the API is still in active development, and may change at any time. 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.

Parameters:
action

أي فعل للعمل.

antispoof
تحقق من اسم مستخم ضد عمليات التحقق الخاصة بAntiSpoof.
block
منع مستخدم.
changeauthenticationdata
تغيير بيانات المصادقة للمستخدم الحالي.
checktoken
تحقق من صحة رمز من action=query&meta=tokens.
clearhasmsg
مسح hasmsg العلم للمستخدم الحالي.
clientlogin
تسجيل الدخول إلى ويكي باستخدام التدفق التفاعلي.
compare
الحصول على الفرق بين صفحتين.
createaccount
انشاء حساب مستخدم جديد
cspreport
مستخدمة من قبل المتصفحات للإبلاغ عن انتهاكات سياسة أمن المحتوى. لا ينبغي أبدا أن تستخدم هذه الوحدة، إلا عند استخدامها تلقائيا باستخدام متصفح ويب CSP متوافق.
delete
حذف صفحة.
edit
إنشاء وتعديل الصفحات.
emailuser
مراسلة المستخدم
expandtemplates
يوسع كافة القوالب ضمن نصوص الويكي.
feedcontributions
إرجاع تغذية مساهمات المستخدم.
feedrecentchanges
Returns a recent changes feed.
feedwatchlist
إرجاع تغذية قائمة المراقبة.
filerevert
استرجع الملف لنسخة قديمة.
help
عرض مساعدة لوحدات محددة.
imagerotate
تدوير صورة واحدة أو أكثر.
import
Import a page from another wiki, or from an XML file.
linkaccount
ربط حساب من موفر طرف ثالث للمستخدم الحالي.
login
سجل دخولك الآن واحصل على مصادقة الكوكيز.
logout
تسجيل الخروج ومسح بيانات الجلسة.
managetags
أداء المهام الإدارية المتعلقة بتغيير الوسوم.
mergehistory
ادمج تاريخ الصفحة.
mobileview
يرجع البيانات المطلوبة لمشاهدات المحمول.
move
نقل صفحة.
opensearch
بحث الويكي باستخدام بروتوكول أوبن سيرش OpenSearch.
options
Change preferences of the current user.
paraminfo
الحصول على معلومات حول وحدات API.
parse
Parses content and returns parser output.
patrol
مراجعة صفحة أو مراجعة.
protect
غير مستوى الحماية لصفحة.
purge
مسح ذاكرة التخزين المؤقت للعناوين المعطاة
query
جلب البيانات من وعن ميدياويكي.
removeauthenticationdata
Remove authentication data for the current user.
resetpassword
Send a password reset email to a user.
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.
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.
webapp-manifest
يرجع webapp manifest.
tokens
Deprecated. Get tokens for data-modifying actions.
One of the following values: antispoof، block، changeauthenticationdata، checktoken، clearhasmsg، clientlogin، compare، createaccount، cspreport، delete، edit، emailuser، expandtemplates، feedcontributions، feedrecentchanges، feedwatchlist، filerevert، help، imagerotate، import، linkaccount، login، logout، managetags، mergehistory، mobileview، move، opensearch، options، paraminfo، parse، patrol، protect، purge، query، removeauthenticationdata، resetpassword، revisiondelete، rollback، rsd، setnotificationtimestamp، setpagelanguage، stashedit، tag، unblock، undelete، unlinkaccount، upload، userrights، validatepassword، watch، webapp-manifest، tokens
Default: help
format

صيغة الخرج.

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
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
Default: 0
maxage

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

Type: integer
Default: 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

التحقق من أن المستخدم الحالي هو المستخدم المسمى.

Type: user name
requestid

سيتم إدراج أي قيمة معينة هنا في الاستجابة. يمكن أن تُستخدَم لتمييز الطلبات.

servedby

تتضمن اسم المضيف الذي الخدم طلب في النتائج.

Type: boolean (details)
curtimestamp

تشمل الطابع الزمني الحالي في النتيجة.

Type: boolean (details)
responselanginfo

تشمل اللغات المستخدمة لأجل uselang and errorlang في النتيجة.

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 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.

Default: 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
Default: 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.

Default: uselang
errorsuselocal

إذا ما أعطيت، النصوص الخطأ ستستخدم الرسائل المخصصة محليا من نطاق ميدياويكي.

Type: boolean (details)
Examples:
مساعدة للوحدة الرئيسية.
api.php?action=help [open in sandbox]
كل المساعدة في صفحة واحدة.
api.php?action=help&recursivesubmodules=1 [open in sandbox]
Permissions:
writeapi
استخدام API للكتابة
Granted to: all، user و 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 و 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.

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. ISO 8601 date and time is recommended. All times are in UTC, any included timezone is ignored.
  • ISO 8601 date and time, 2001-01-15T14:56:00Z (punctuation and Z are optional)
  • ISO 8601 date and time with (ignored) fractional seconds, 2001-01-15T14:56:00.00001Z (dashes, colons, and Z are optional)
  • MediaWiki format, 20010115145600
  • Generic numeric format, 2001-01-15 14:56:00 (optional timezone of GMT, +##, or -## is ignored)
  • EXIF format, 2001:01:15 14:56:00
  • RFC 2822 format (timezone may be omitted), Mon, 15 Jan 2001 14:56:00
  • RFC 850 format (timezone may be omitted), Monday, 15-Jan-2001 14:56:00
  • C ctime format, Mon Jan 15 14:56:00 2001
  • Seconds since 1970-01-01T00:00:00Z as a 1 to 13 digit integer (excluding 0)
  • The string now
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.

Credits

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–present)

Please send your comments, suggestions and questions to mediawiki-api@lists.wikimedia.org or file a bug report at https://phabricator.wikimedia.org/.