MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/API
Main module
- Source: MediaWiki
- License: GPL-2.0+
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.
- action
أي فعل للعمل.
- One of the following values: block، categorytree، changeauthenticationdata، checktoken، clearhasmsg، clientlogin، compare، createaccount، cspreport، delete، edit، emailuser، expandtemplates، feedcontributions، feedrecentchanges، feedwatchlist، filerevert، help، imagerotate، import، linkaccount، login، logout، managetags، mergehistory، move، opensearch، options، paraminfo، parse، patrol، protect، purge، query، removeauthenticationdata، resetpassword، revisiondelete، rollback، rsd، setnotificationtimestamp، setpagelanguage، stashedit، tag، tokens، unblock، undelete، unlinkaccount، upload، userrights، validatepassword، watch
- Default: help
- format
صيغة الخرج.
- 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 theOrigin
header, a 403 response will be returned. If this parameter matches theOrigin
header and the origin is whitelisted, theAccess-Control-Allow-Origin
andAccess-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, butAccess-Control-Allow-Credentials
will befalse
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)
- مساعدة للوحدة الرئيسية.
- api.php?action=help [open in sandbox]
- كل المساعدة في صفحة واحدة.
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
action=block
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
منع مستخدم.
- user
اسم المستخدم، أو عنوان IP أو نطاق عنوان IP لمنعه. لا يمكن أن يُستخدَم جنبا إلى جنب مع userid
- Type: user name
- userid
معرف المستخدم لمنعه، لا يمكن أن يُستخدَم جنبا إلى جنب مع user
- Type: integer
- expiry
Expiry time. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If set to infinite, indefinite, or never, the block will never expire.
- Default: never
- reason
السبب للمنع.
- Default: (empty)
- anononly
منع المستخدمين المجهولين فقط (أي تعطيل تعديلات المجهولين من عنوان IP هذا).
- Type: boolean (details)
- nocreate
امنع إنشاء الحسابات.
- Type: boolean (details)
- autoblock
منع آخر عنوان IP مستخدم تلقائيا، وأية عناوين IP لاحقة حاولت الدخول من خلاله.
- Type: boolean (details)
- noemail
منع المستخدم من إرسال البريد الإلكتروني من خلال الويكي. (يتطلب صلاحية
blockemail
).- Type: boolean (details)
- hidename
إخفاء اسم المستخدم من سجل المنع. (يتطلب صلاحية
hideuser
).- Type: boolean (details)
- allowusertalk
تسمح للمستخدم لتحرير صفحة النقاش الخاصة (يعتمد على $wgBlockAllowsUTEdit).
- Type: boolean (details)
- reblock
If the user is already blocked, overwrite the existing block.
- Type: boolean (details)
- watchuser
مشاهدة صفحة المستخدم ونقاش IP.
- Type: boolean (details)
- tags
Change tags to apply to the entry in the block log.
- Values (separate with | or alternative):
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- منع عنوان IP 192.0.2.5 لمدة ثلاثة أيام بسبب >المخالفة الأولى</kbd>.
- api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC [open in sandbox]
- منع المستخدم المخرب لأجل غير مسمى بسبب التخريب، ومنع إنشاء حساب جديد وإرسال بريد إلكتروني.
- api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC [open in sandbox]
action=categorytree
- This module is internal or unstable. Its operation may change without notice.
- This module requires read rights.
- Source: CategoryTree
- License: GPL-2.0+
الوحدة لداخلية للتصنيفات الصحيحة.
- category
العنوان في مساحة اسم الفئة. يتم تجاهل البادئة إذا كان محدد.
- This parameter is required.
- options
الخيارات لمنشيء CategoryTree ككائن JSON object. خيار depth القيمة الافتراضية له هي 1.
action=changeauthenticationdata (changeauth)
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
تغيير بيانات المصادقة للمستخدم الحالي.
- changeauthrequest
Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=change.
- This parameter is required.
- changeauthtoken
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- *
- This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=change (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.
- محاولة تغيير كلمة المرور للمستخدم الحالي إلى ExamplePassword.
- api.php?action=changeauthenticationdata&changeauthrequest=MediaWiki%5CAuth%5CPasswordAuthenticationRequest&password=ExamplePassword&retype=ExamplePassword&changeauthtoken=123ABC [open in sandbox]
action=checktoken
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
تحقق من صحة رمز من action=query&meta=tokens.
- type
نوع من الرموز يجري اختبارها.
- This parameter is required.
- One of the following values: createaccount، csrf، login، patrol، rollback، userrights، watch
- token
اختبار الرموز.
- This parameter is required.
- maxtokenage
أقصى عمر للرمز يسمح، في ثوان.
- Type: integer
- اختبار صلاحية رمز csrf.
- api.php?action=checktoken&type=csrf&token=123ABC [open in sandbox]
action=clearhasmsg
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
مسح hasmsg
العلم للمستخدم الحالي.
- مسح
hasmsg
العلم للمستخدم الحالي. - api.php?action=clearhasmsg [open in sandbox]
action=clientlogin (login)
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
تسجيل الدخول إلى ويكي باستخدام التدفق التفاعلي.
The general procedure to use this module is:
- Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=login, and a login token from action=query&meta=tokens.
- Present the fields to the user, and obtain their submission.
- Post to this module, supplying loginreturnurl and any relevant fields.
- Check the status in the response.
- If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
- If you received UI, present the new fields to the user and obtain their submission. Then post to this module with logincontinue and the relevant fields set, and repeat step 4.
- If you received REDIRECT, direct the user to the redirecttarget and wait for the return to loginreturnurl. Then post to this module with logincontinue and any fields passed to the return URL, and repeat step 4.
- If you received RESTART, that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
- loginrequests
Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=login or from a previous response from this module.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- loginmessageformat
Format to use for returning messages.
- One of the following values: html، wikitext، raw، none
- Default: wikitext
- loginmergerequestfields
Merge field information for all authentication requests into one array.
- Type: boolean (details)
- loginpreservestate
Preserve state from a previous failed login attempt, if possible.
- Type: boolean (details)
- loginreturnurl
Return URL for third-party authentication flows, must be absolute. Either this or logincontinue is required.
Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a logincontinue request to this API module.
- logincontinue
This request is a continuation after an earlier UI or REDIRECT response. Either this or loginreturnurl is required.
- Type: boolean (details)
- logintoken
A "login" token retrieved from action=query&meta=tokens
- This parameter is required.
- *
- This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=login (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.
- بدء عملية تسجيل الدخول إلى الويكي كمستخدم Example بكلمة المرور ExamplePassword.
- api.php?action=clientlogin&username=Example&password=ExamplePassword&loginreturnurl=http://example.org/&logintoken=123ABC [open in sandbox]
- واصلة تسجيل الدخول بعد استجابة UI لعاملي الصادقة، إمداد OATHToken ل987654.
- api.php?action=clientlogin&logincontinue=1&OATHToken=987654&logintoken=123ABC [open in sandbox]
action=compare
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
الحصول على الفرق بين صفحتين. يجب تمرير عنوان الصفحة أو رقم المراجعة أو معرف الصفحة لكل من "من" و"إلى".
- fromtitle
العنوان الأول للمقارنة.
- fromid
رقم الصفحة الأول للمقارنة.
- Type: integer
- fromrev
أول مراجعة للمقارنة.
- Type: integer
- totitle
العنوان الثاني للمقارنة.
- toid
رقم الصفحة الثاني للمقارنة.
- Type: integer
- torev
المراجعة الثانية للمقارنة.
- Type: integer
- إنشاء فرق بين المراجعة 1 و2.
- api.php?action=compare&fromrev=1&torev=2 [open in sandbox]
action=createaccount (create)
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
انشاء حساب مستخدم جديد
The general procedure to use this module is:
- Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=create, and a createaccount token from action=query&meta=tokens.
- Present the fields to the user, and obtain their submission.
- Post to this module, supplying createreturnurl and any relevant fields.
- Check the status in the response.
- If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
- If you received UI, present the new fields to the user and obtain their submission. Then post to this module with createcontinue and the relevant fields set, and repeat step 4.
- If you received REDIRECT, direct the user to the redirecttarget and wait for the return to createreturnurl. Then post to this module with createcontinue and any fields passed to the return URL, and repeat step 4.
- If you received RESTART, that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
- createrequests
Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=create or from a previous response from this module.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- createmessageformat
Format to use for returning messages.
- One of the following values: html، wikitext، raw، none
- Default: wikitext
- createmergerequestfields
Merge field information for all authentication requests into one array.
- Type: boolean (details)
- createpreservestate
Preserve state from a previous failed login attempt, if possible.
If action=query&meta=authmanagerinfo returned true for hasprimarypreservedstate, requests marked as primary-required should be omitted. If it returned a non-empty value for preservedusername, that username must be used for the username parameter.
- Type: boolean (details)
- createreturnurl
Return URL for third-party authentication flows, must be absolute. Either this or createcontinue is required.
Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a createcontinue request to this API module.
- createcontinue
This request is a continuation after an earlier UI or REDIRECT response. Either this or createreturnurl is required.
- Type: boolean (details)
- createtoken
A "createaccount" token retrieved from action=query&meta=tokens
- This parameter is required.
- *
- This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=create (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.
- بدء عملية إنشاء المستخدم Example بكلمة المرور ExamplePassword.
- api.php?action=createaccount&username=Example&password=ExamplePassword&retype=ExamplePassword&createreturnurl=http://example.org/&createtoken=123ABC [open in sandbox]
action=cspreport
- This module is internal or unstable. Its operation may change without notice.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
مستخدمة من قبل المتصفحات للإبلاغ عن انتهاكات سياسة أمن المحتوى. لا ينبغي أبدا أن تستخدم هذه الوحدة، إلا عند استخدامها تلقائيا باستخدام متصفح ويب CSP متوافق.
- reportonly
علم على أنه تقرير عن سياسة الرصد، وليس فرض سياسة
- Type: boolean (details)
- source
What generated the CSP header that triggered this report
- Default: internal
action=delete
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
حذف صفحة.
- title
عنوان الصفحة للحذف. لا يمكن أن يُستخدَم جنبا إلى جنب مع pageid</var
- pageid
معرف الصفحة للحذف. لا يمكن أن يُستخدَم جنبا إلى جنب مع pageid</var
- Type: integer
- reason
سبب الحذف. إذا لم يُحدَّد، سوف تُستخدَم أحد الأسباب التي تنشأ تلقائيا.
- tags
تغيير وسوم لتطبيق الإدخال في سجل الحذف.
- Values (separate with | or alternative):
- watch
- Deprecated.
أضف الصفحة إلى لائحة مراقبة المستعمل الحالي
- Type: boolean (details)
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
- One of the following values: watch، unwatch، preferences، nochange
- Default: preferences
- unwatch
- Deprecated.
إزالة الصفحة من قائمة المراقبة للمستخدم الحالي.
- Type: boolean (details)
- oldimage
اسم الصورة القديمة لحذفها كما هو منصوص عليه action=query&prop=imageinfo&iiprop=archivename.
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- حذف Main Page.
- api.php?action=delete&title=Main%20Page&token=123ABC [open in sandbox]
- حذف Main Page بسبب Preparing for move.
- api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move [open in sandbox]
action=edit
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
إنشاء وتعديل الصفحات.
- title
عنوان الصفحة للحذف. لا يمكن أن يُستخدَم جنبا إلى جنب مع pageid</var
- pageid
معرف الصفحة لتحريرها. لا يمكن أن يُستخدَم جنبا إلى جنب مع pageid</var
- Type: integer
- section
رقم القسم. 0 للقسم العلوي، new لقسم جديد.
- sectiontitle
عنوان لقسم جديد.
- text
محتوى الصفحة
- summary
ملخص التعديل. أيضا عنوان القسم عند عدم تعيين section=new and sectiontitle.
- tags
عدل الوسوم لتطبيق المراجعة.
- Values (separate with | or alternative):
- minor
تعديل طفيف
- Type: boolean (details)
- notminor
تعديل غير طفيف.
- Type: boolean (details)
- bot
علم على هذا التعديل كتعديل بوت.
- Type: boolean (details)
- basetimestamp
الطابع الزمني للمراجعة الأساسية، ويُستخدَم للكشف عن الحروب التحريرية، ويمكن الحصول عليها من خلال action=query&prop=revisions&rvprop=timestamp.
- Type: timestamp (allowed formats)
- starttimestamp
الطابع الزمني عند بدء عملية التحرير، ويُستخدَم للكشف عن الحروب التحريرية، ويمكن الحصول عليها من خلال curtimestamp when beginning the edit process (e.g. when loading the page content to edit).
- Type: timestamp (allowed formats)
- recreate
تجاوز أية أخطاء حول الصفحة التي تم حذفها في هذه الأثناء.
- Type: boolean (details)
- createonly
لا تحرر الصفحة إذا كان موجودا بالفعل.
- Type: boolean (details)
- nocreate
يحدث خطأ إذا كانت الصفحة غير موجودة.
- Type: boolean (details)
- watch
- Deprecated.
أضف الصفحة إلى لائحة مراقبة المستعمل الحالي
- Type: boolean (details)
- unwatch
- Deprecated.
إزالة الصفحة من قائمة المراقبة للمستخدم الحالي.
- Type: boolean (details)
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
- One of the following values: watch، unwatch، preferences، nochange
- Default: preferences
- md5
The MD5 hash of the text parameter, or the prependtext and appendtext parameters concatenated. If set, the edit won't be done unless the hash is correct.
- prependtext
إضافة هذا النص إلى بداية الصفحة. تجاوز text.
- appendtext
إضافة هذا النص إلى بداية الصفحة. تجاوز text.
استخدم section=جديد لحاق القسم الجديد، بدلا من هذا الوسيط.
- undo
التراجع عن هذه المراجعة. تجاوز text, prependtext وappendtext.
- Type: integer
- undoafter
التراجع عن جميع المراجعات من undo لهذه. إذا لم يتم التغيير، تراجع عن تعديل واحد فقط.
- Type: integer
- redirect
حل التحويلات تلقائيا.
- Type: boolean (details)
- contentformat
Content serialization format used for the input text.
- One of the following values: text/x-wiki، text/javascript، application/json، text/css، text/plain
- contentmodel
نموذج المحتوى للمحتوى الجديد.
- One of the following values: wikitext، javascript، json، css، text
- token
A "csrf" token retrieved from action=query&meta=tokens
ينبغي دائما أن يُرسَل الرمز كوسيط أخير، أو على الأقل بعد الوسيط text.
- This parameter is required.
- عدل صفحة.
- api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [open in sandbox]
- إضافة البادئة __NOTOC__ إلى الصفحة.
- api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [open in sandbox]
- التراجع عن التعديلات 13579 خلال 13585 بملخص تلقائي.
- api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC [open in sandbox]
action=emailuser
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
مراسلة المستخدم
- target
مستخدم لإرسال بريد إلكتروني له.
- This parameter is required.
- subject
رأس الموضوع
- text
جسم البريد الإلكتروني
- This parameter is required.
- ccme
إرسال نسخة من هذه الرسالة لي.
- Type: boolean (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- أرسل بريدا إلكترونيا للمستخدم WikiSysop بالنص Content.
- api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC [open in sandbox]
action=expandtemplates
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
يوسع كافة القوالب ضمن نصوص الويكي.
- title
عنوان الصفحة.
- Default: API
- text
نص ويكي للتحويل.
- This parameter is required.
- revid
معرف المراجعة، ل{{REVISIONID}} والمتغيرات مماثلة.
- Type: integer
- prop
Which pieces of information to get.
Note that if no values are selected, the result will contain the wikitext, but the output will be in a deprecated format.
- wikitext
- نص الويكي الموسع
- categories
- Any categories present in the input that are not represented in the wikitext output.
- properties
- خصائص الصفحة التي تحددها الكلمات السحرية الموسعة في نص الويكي.
- volatile
- إذا كان الإخراج سريع التأثر، ينبغي عدم استخدامه في أي مكان آخر داخل الصفحة.
- ttl
- The maximum time after which caches of the result should be invalidated.
- modules
- Any ResourceLoader modules that parser functions have requested be added to the output. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules.
- jsconfigvars
- يعطي متغيرات تكوين جافا سكريبت الخاصة بهذه الصفحة.
- encodedjsconfigvars
- يعطي متغيرات تكوين جافا سكريبت الخاصة بهذه الصفحة كسلسلة JSON.
- parsetree
- شجرة تحليل XML للمدخلات.
- Values (separate with | or alternative): wikitext، categories، properties، volatile، ttl، modules، jsconfigvars، encodedjsconfigvars، parsetree
- includecomments
إدراج أو عدم إدراج تعليقات HTML في الإخراج.
- Type: boolean (details)
- generatexml
- Deprecated.
ولد شجرة تحليل XML (حل محلها prop=parsetree).
- Type: boolean (details)
- توسيع نص الويكي {{Project:Sandbox}}.
- api.php?action=expandtemplates&text={{Project:Sandbox}} [open in sandbox]
action=feedcontributions
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
إرجاع تغذية مساهمات المستخدم.
- feedformat
هيئة التلقيم.
- One of the following values: rss، atom
- Default: rss
- user
أي المستخدمين سيتم الحصول على تبرعات لهم.
- This parameter is required.
- Type: user name
- namespace
أي نطاق ستتم تصفية المساهمات حسبه.
- One of the following values: 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- year
من سنة (وأقدم).
- Type: integer
- month
من شهر (وأقدم).
- Type: integer
- tagfilter
تصفية المساهمات التي بها هذه الوسوم.
- Values (separate with | or alternative): mw-contentmodelchange
- Default: (empty)
- deletedonly
اعرض المساهمات المحذوفة فقط.
- Type: boolean (details)
- toponly
تظهر فقط التعديلات التي هي أحدث المراجعات.
- Type: boolean (details)
- newonly
أظهر إنشاء الصفحات فقط
- Type: boolean (details)
- hideminor
إخفاء التعديلات الطفيفة.
- Type: boolean (details)
- showsizediff
عرض حجم الفرق بين النسخ.
- Type: boolean (details)
- Return contributions for user Example.
- api.php?action=feedcontributions&user=Example [open in sandbox]
action=feedrecentchanges
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Returns a recent changes feed.
- feedformat
هيئة التلقيم.
- One of the following values: rss، atom
- Default: rss
- namespace
نطاق لتقييد النتائج.
- One of the following values: 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- invert
جميع النطاقات عدا المختار.
- Type: boolean (details)
- associated
تشمل النطاق المرتبط (نقاش أو الرئيسي).
- Type: boolean (details)
- days
أيام لتقييد النتائج.
- The value must be no less than ١.
- Type: integer
- Default: 7
- limit
الحد الأقصى للنتائج المُرجعة
- The value must be between ١ and ٥٠.
- Type: integer
- Default: 50
- from
أظهر التغييرات منذ
- Type: timestamp (allowed formats)
- hideminor
إخفاء التعديلات الطفيفة.
- Type: boolean (details)
- hidebots
إخفاء التغييرات التي أجرتها بوتات.
- Type: boolean (details)
- hideanons
إخفاء التغييرات التي أجراها مستخدمون مجهولون.
- Type: boolean (details)
- hideliu
إخفاء التغييرات التي أجراها مستخدمون مسجلون.
- Type: boolean (details)
- hidepatrolled
إخفاء التغييرات المراجعة.
- Type: boolean (details)
- hidemyself
إخفاء التغييرات التي قام بها المستخدم الحالي.
- Type: boolean (details)
- hidecategorization
إخفاء تغيير عضوية التصنيف.
- Type: boolean (details)
- tagfilter
فلتر بالوسم.
- target
أحدث التغييرات في الصفحات الموصولة من هذه الصفحة فقط
- showlinkedto
أظهر التغييرات للصفحات الموصولة للصفحة المعطاة عوضا عن ذلك
- Type: boolean (details)
اظهر التغييرات الحديثة
- api.php?action=feedrecentchanges [open in sandbox]
- أظهر التغييرات الأخيرة في 30 يوم.
- api.php?action=feedrecentchanges&days=30 [open in sandbox]
action=feedwatchlist
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
إرجاع تغذية قائمة المراقبة.
- feedformat
هيئة التلقيم.
- One of the following values: rss، atom
- Default: rss
- hours
صفحات قائمة معدلة ضمن عدة ساعات من الآن.
- The value must be between ١ and ٧٢.
- Type: integer
- Default: 24
- linktosections
Link directly to changed sections if possible.
- Type: boolean (details)
- allrev
Include multiple revisions of the same page within given timeframe.
- Type: boolean (details)
- wlowner
Used along with token to access a different user's watchlist.
- Type: user name
- wltoken
A security token (available in the user's preferences) to allow access to another user's watchlist.
- wlshow
Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set show=minor|!anon.
- Values (separate with | or alternative): minor، !minor، bot، !bot، anon، !anon، patrolled، !patrolled، unread، !unread
- wltype
Which types of changes to show:
- edit
- Regular page edits.
- new
- Page creations.
- log
- Log entries.
- external
- External changes.
- categorize
- Category membership changes.
- Values (separate with | or alternative): edit، new، log، external، categorize
- Default: edit|new|log|categorize
- wlexcludeuser
Don't list changes by this user.
- Type: user name
- عرض تغذية قائمة المراقبة.
- api.php?action=feedwatchlist [open in sandbox]
- اظهر كل التغييرات في اخر 6 ساعات
- api.php?action=feedwatchlist&allrev=&hours=6 [open in sandbox]
action=filerevert
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
استرجع الملف لنسخة قديمة.
- filename
اسم الملف المستهدف، دون البادئة ملف:.
- This parameter is required.
- comment
تعليق الرفع.
- Default: (empty)
- archivename
Archive name of the revision to revert to.
- This parameter is required.
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- استرجاع Wiki.png لنسحة 2011-03-05T15:27:40Z.
- api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC [open in sandbox]
action=help
- Source: MediaWiki
- License: GPL-2.0+
عرض مساعدة لوحدات محددة.
- modules
وحدات لعرض مساعدة لها (قيم وسائط action وformat أوmain). يمكن تحديد الوحدات الفرعية ب +.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- Default: main
- submodules
تشمل المساعدة للوحدات الفرعية من الوحدة المسماة.
- Type: boolean (details)
- recursivesubmodules
تشمل المساعدة للوحدات الفرعية بشكل متكرر.
- Type: boolean (details)
- wrap
التفاف المخرجات في بنية استجابة API القياسية.
- Type: boolean (details)
- toc
يتضمن جدول المحتويات في مخرجات HTML.
- Type: boolean (details)
- مساعدة للوحدة الرئيسية.
- api.php?action=help [open in sandbox]
- مساعدة لaction=query وجميع الوحدات الفرعية لها.
- api.php?action=help&modules=query&submodules=1 [open in sandbox]
- كل المساعدة في صفحة واحدة.
- api.php?action=help&recursivesubmodules=1 [open in sandbox]
- مساعدة لوحدة المساعدة نفسها.
- api.php?action=help&modules=help [open in sandbox]
- مساعدة لوحدتي استعلام فرعيتين.
- api.php?action=help&modules=query+info|query+categorymembers [open in sandbox]
action=imagerotate
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
تدوير صورة واحدة أو أكثر.
- rotation
درجة تدوير الصورة في اتجاه عقارب الساعة.
- This parameter is required.
- One of the following values: 90، 180، 270
- continue
When more results are available, use this to continue.
- tags
Tags to apply to the entry in the upload log.
- Values (separate with | or alternative):
- titles
A list of titles to work on.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- pageids
A list of page IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- revids
A list of revision IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- 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.
- 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، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، redirects، revisions، search، templates، transcludedin، watchlist، watchlistraw
- redirects
Automatically resolve redirects in titles, pageids, and revids, and in pages returned by 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 gan، iu، kk، ku، shi، sr، tg، uz و zh.
- Type: boolean (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- تدوير File:Example.png بمقدار 90 درجة.
- api.php?action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC [open in sandbox]
- تدوير جميع الصور في Category:Flip بمقدار 180 درجة.
- api.php?action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&rotation=180&token=123ABC [open in sandbox]
action=import
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Import a page from another wiki, or from an XML file.
Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data) when sending a file for the xml parameter.
- summary
ملخص إدخال سجل الاستيراد.
- xml
ملف XML مرفوع.
- Must be posted as a file upload using multipart/form-data.
- interwikisource
بالنسبة لواردات الإنترويكي: ويكي للاستيراد منه.
- One of the following values:
- interwikipage
بالنسبة لواردات الإنترويكي: صفحة لاستيرادها.
- fullhistory
بالنسبة لواردات الإنترويكي: استيراد التاريخ كاملا، وليست النسخة الحالية فقط.
- Type: boolean (details)
- templates
بالنسبة لواردات الإنترويكي: الإستيراد شمل كافة القوالب كذلك.
- Type: boolean (details)
- namespace
استيراد إلى هذا النطاق. لا يمكن أن يُستخدَم إلى جانب rootpage.
- One of the following values: 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- rootpage
استيراد كصفحة فرعية لهذه الصفحة. لا يمكن أن يُستخدَم إلى جانب rootpage.
- tags
Change tags to apply to the entry in the import log and to the null revision on the imported pages.
- Values (separate with | or alternative):
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
action=linkaccount (link)
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
ربط حساب من موفر طرف ثالث للمستخدم الحالي.
The general procedure to use this module is:
- Fetch the fields available from action=query&meta=authmanagerinfo with amirequestsfor=link, and a csrf token from action=query&meta=tokens.
- Present the fields to the user, and obtain their submission.
- Post to this module, supplying linkreturnurl and any relevant fields.
- Check the status in the response.
- If you received PASS or FAIL, you're done. The operation either succeeded or it didn't.
- If you received UI, present the new fields to the user and obtain their submission. Then post to this module with linkcontinue and the relevant fields set, and repeat step 4.
- If you received REDIRECT, direct the user to the redirecttarget and wait for the return to linkreturnurl. Then post to this module with linkcontinue and any fields passed to the return URL, and repeat step 4.
- If you received RESTART, that means the authentication worked but we don't have a linked user account. You might treat this as UI or as FAIL.
- linkrequests
Only use these authentication requests, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=link or from a previous response from this module.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- linkmessageformat
Format to use for returning messages.
- One of the following values: html، wikitext، raw، none
- Default: wikitext
- linkmergerequestfields
Merge field information for all authentication requests into one array.
- Type: boolean (details)
- linkreturnurl
Return URL for third-party authentication flows, must be absolute. Either this or linkcontinue is required.
Upon receiving a REDIRECT response, you will typically open a browser or web view to the specified redirecttarget URL for a third-party authentication flow. When that completes, the third party will send the browser or web view to this URL. You should extract any query or POST parameters from the URL and pass them as a linkcontinue request to this API module.
- linkcontinue
This request is a continuation after an earlier UI or REDIRECT response. Either this or linkreturnurl is required.
- Type: boolean (details)
- linktoken
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- *
- This module accepts additional parameters depending on the available authentication requests. Use action=query&meta=authmanagerinfo with amirequestsfor=link (or a previous response from this module, if applicable) to determine the requests available and the fields that they use.
- بدء عملية ربط حساب من Example.
- api.php?action=linkaccount&provider=Example&linkreturnurl=http://example.org/&linktoken=123ABC [open in sandbox]
action=login (lg)
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
سجل دخولك الآن واحصل على مصادقة الكوكيز، وينبغي استخدام هذا الإجراء فقط في تركيبة مع خاص:كلمات مرور البوت. تم إهمال استخدام لتسجيل الدخول للحساب الرئيسي وقد يفشل دون سابق إنذار. لتسجيل الدخول بأمان إلى الحساب الرئيسي; استخدم action=clientlogin.
- lgname
اسم المستخدم.
- lgpassword
كلمة السر
- lgdomain
النطاق (اختياري).
- lgtoken
A "login" token retrieved from action=query&meta=tokens
- استرداد رمز تسجيل الدخول.
- api.php?action=login&lgname=user&lgpassword=password [open in sandbox]
- تسجيل الدخول
- api.php?action=login&lgname=user&lgpassword=password&lgtoken=123ABC [open in sandbox]
action=logout
- Source: MediaWiki
- License: GPL-2.0+
تسجيل الخروج ومسح بيانات الجلسة.
- تسجيل خروج المستخدم الحالي.
- api.php?action=logout [open in sandbox]
action=managetags
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
أداء المهام الإدارية المتعلقة بتغيير الوسوم.
- operation
أي الإجراءات ستنفذ: ؛ إنشاء: إنشاء وسم التغيير جديدة للاستخدام اليدوي. ؛ حذف: إزالة وسم التغيير من قاعدة البيانات، بما في ذلك إزالة الوسم من كافة المراجعات، وإدخالات التغيير الأخيرة، وإدخالات السجل المستخدم. ؛ تنشيط: تنشيط وسم التغيير، مما يسمح للمستخدمين بتطبيقه يدويا.
- إلغاء
- إلغاء تنشيط وسم التغيير، ومنع المستخدمين من تطبيقه يدويا.
- This parameter is required.
- One of the following values: create، delete، activate، deactivate
- tag
Tag to create, delete, activate or deactivate. For tag creation, the tag must not exist. For tag deletion, the tag must exist. For tag activation, the tag must exist and not be in use by an extension. For tag deactivation, the tag must be currently active and manually defined.
- This parameter is required.
- reason
سبب اختياري لإنشاء، وحذف، وتفعيل أو تعطيل الوسم.
- ignorewarnings
إذا كان سيتم تجاهل أي تحذيرات تصدر خلال العملية.
- Type: boolean (details)
- tags
Change tags to apply to the entry in the tag management log.
- Values (separate with | or alternative):
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- إنشاء وسم مسمى spam بسبب For use in edit patrolling
- api.php?action=managetags&operation=create&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [open in sandbox]
- حذف vandlaism وسم بسبب Misspelt
- api.php?action=managetags&operation=delete&tag=vandlaism&reason=Misspelt&token=123ABC [open in sandbox]
- تنشيط الوسم المسمى spam بسبب For use in edit patrolling
- api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC [open in sandbox]
- تعطيل الوسم المسمى spam بسبب No longer required
- api.php?action=managetags&operation=deactivate&tag=spam&reason=No+longer+required&token=123ABC [open in sandbox]
action=mergehistory
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
ادمج تاريخ الصفحة.
- from
عنوان الصفحة التي سيتم دمج تاريخها. لا يمكن أن تُستخدَم بجانب fromid.
- fromid
معرف الصفحة التي سيتم دمج تاريخها. لا يمكن أن تُستخدَم بجانب from.
- Type: integer
- to
عنوان الصفحة التي سيتم دمج تاريخها. لا يمكن أن تُستخدَم بجانب toid.
- toid
معرف الصفحة التي سيتم دمج تاريخها. لا يمكن أن تُستخدَم بجانب to.
- Type: integer
- timestamp
الطابع الزمني للمراجعات التي سيتم نقلها من تاريخ صفحة المصدر إلى تاريخ صفحة الوجهة. إذا تم حذفها، سيتم دمج تاريخ الصفحة كاملا من صفحة المصدر إلى صفحة الوجهة.
- Type: timestamp (allowed formats)
- reason
سبب دمج التاريخ.
- Default: (empty)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- دمج تاريخ Oldpage كاملا إلى Newpage.
- api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason [open in sandbox]
- دمج مراجعات الصفحة Oldpage dating up to 2015-12-31T04:37:41Z إلى Newpage.
- api.php?action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&reason=Reason×tamp=2015-12-31T04%3A37%3A41Z [open in sandbox]
action=move
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
نقل صفحة.
- from
عنوان الصفحة للنقل. لا يمكن أن تُستخدَم بجانب pageid</var
- fromid
معرف الصفحة للنقل. لا يمكن أن تُستخدَم بجانب pageid</var
- Type: integer
- to
عنوان لإعادة تسمية الصفحة له.
- This parameter is required.
- reason
السبب لإعادة التسمية.
- Default: (empty)
- movetalk
إعادة تسمية صفحة النقاش، إن وُجِدت.
- Type: boolean (details)
- movesubpages
إعادة تسمية الصفحات الفرعية، إن وُجِدت.
- Type: boolean (details)
- noredirect
لا تنشئ تحويلة.
- Type: boolean (details)
- watch
- Deprecated.
إضافة الصفحة والتحويلة إلى قائمة مراقبة المستخدم الحالي.
- Type: boolean (details)
- unwatch
- Deprecated.
إزالة الصفحة والتحويلة إلى قائمة مراقبة المستخدم الحالي.
- Type: boolean (details)
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
- One of the following values: watch، unwatch، preferences، nochange
- Default: preferences
- ignorewarnings
تجاهل أي تحذيرات.
- Type: boolean (details)
- tags
Change tags to apply to the entry in the move log and to the null revision on the destination page.
- Values (separate with | or alternative):
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- انقل Badtitle إلى Goodtitle دون ترك تحويلة.
- api.php?action=move&from=Badtitle&to=Goodtitle&token=123ABC&reason=Misspelled%20title&movetalk=&noredirect= [open in sandbox]
action=opensearch
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
بحث الويكي باستخدام بروتوكول أوبن سيرش OpenSearch.
- search
سطر البحث
- This parameter is required.
- namespace
النطاقات للبحث.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- Default: 0
- limit
الحد الأقصى للنتائج المُرجعة
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- suggest
لا تفعل شيئا إذا كان $wgEnableOpenSearchSuggest خاطئا.
- Type: boolean (details)
- redirects
How to handle redirects:
- return
- Return the redirect itself.
- resolve
- Return the target page. May return fewer than limit results.
For historical reasons, the default is "return" for format=json and "resolve" for other formats.
- One of the following values: return، resolve
- format
شكل الإخراج.
- One of the following values: json، jsonfm، xml، xmlfm
- Default: json
- warningsaserror
إذا تم رفع التحذيرات بformat=json, أعد أخطاء API بدلا من تجاهلها.
- Type: boolean (details)
- العثور على صفحات تبدأ بTe.
- api.php?action=opensearch&search=Te [open in sandbox]
action=options
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Change preferences of the current user.
Only options which are registered in core or in one of installed extensions, or options with keys prefixed with userjs-
(intended to be used by user scripts), can be set.
- reset
إعادة تعيين التفضيلات إلى إعدادات الموقع الإفتراضية.
- Type: boolean (details)
- resetkinds
قائمة أنواع الخيارات لإعادة ضبطها عندما يتم تعيين خيار reset.
- Values (separate with | or alternative): registered، registered-multiselect، registered-checkmatrix، userjs، special، unused، all
- Default: all
- change
List of changes, formatted name=value (e.g. skin=vector). If no value is given (not even an equals sign), e.g., optionname|otheroption|..., the option will be reset to its default value. If any value passed contains the pipe character (|), use the alternative multiple-value separator for correct operation.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- optionname
اسم الخيار الذي ينبغي ضبطه إلى القيمة التي قدمها optionvalue.
- optionvalue
قيمة للخيار المحدد من قبل optionname.
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- إعادة تعيين كل التفضيلات.
- api.php?action=options&reset=&token=123ABC [open in sandbox]
- غير تفضيلات skin وhideminor.
- api.php?action=options&change=skin=vector|hideminor=1&token=123ABC [open in sandbox]
- إعادة تعيين جميع تفضيلات، ثم تعيين skin وnickname.
- api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC [open in sandbox]
action=paraminfo
- Source: MediaWiki
- License: GPL-2.0+
الحصول على معلومات حول وحدات API.
- modules
List of module names (values of the action and format parameters, or main). Can specify submodules with a +, or all submodules with +*, or all submodules recursively with +**.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- helpformat
شكل سلاسل المساعدة.
- One of the following values: html، wikitext، raw، none
- Default: none
- querymodules
- Deprecated.
List of query module names (value of prop, meta or list parameter). Use modules=query+foo instead of querymodules=foo.
- Values (separate with | or alternative): allcategories، alldeletedrevisions، allfileusages، allimages، alllinks، allmessages، allpages، allredirects، allrevisions، alltransclusions، allusers، authmanagerinfo، backlinks، blocks، categories، categoryinfo، categorymembers، contributors، deletedrevisions، deletedrevs، duplicatefiles، embeddedin، extlinks، exturlusage، filearchive، filerepoinfo، fileusage، imageinfo، images، imageusage، info، iwbacklinks، iwlinks، langbacklinks، langlinks، links، linkshere، logevents، mystashedfiles، pagepropnames، pageprops، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، redirects، revisions، search، siteinfo، stashimageinfo، tags، templates، tokens، transcludedin، usercontribs، userinfo، users، watchlist، watchlistraw
- Maximum number of values is ٥٠ (٥٠٠ for bots).
- mainmodule
- Deprecated.
الحصول على معلومات عن وحدة (المستوى الأعلى) الرئيسية أيضا. استخدم modules=main بدلا من ذلك.
- pagesetmodule
- Deprecated.
Get information about the pageset module (providing titles= and friends) as well.
- formatmodules
- Deprecated.
قائمة بأسماء أشكال الوحدات (قيم الوسيط format). استخدم modules بدلا من ذلك.
- Values (separate with | or alternative): json، jsonfm، none، php، phpfm، rawfm، xml، xmlfm
- عرض معلومات عن action=parse وformat=jsonfm وaction=query&list=allpages وaction=query&meta=siteinfo.
- api.php?action=paraminfo&modules=parse|phpfm|query%2Ballpages|query%2Bsiteinfo [open in sandbox]
- أظهر المعلومات لجميع الوحدات الفرعية لaction=query.
- api.php?action=paraminfo&modules=query%2B* [open in sandbox]
action=parse
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Parses content and returns parser output.
See the various prop-modules of action=query to get information from the current version of a page.
There are several ways to specify the text to parse:
- Specify a page or revision, using page, pageid, or oldid.
- Specify content explicitly, using text, title, and contentmodel.
- Specify only a summary to parse. prop should be given an empty value.
- title
عنوان الصفحة التي ينتمي النص إليها.إذا تم حذفها، contentmodel يجب أن تكون محددة، وAPI سيتم استخدامه كعنوان.
- text
نص للتحليل. استخدم title أو contentmodel للتحكم في نموذج المحتوى.
- summary
ملخص للتحليل.
- page
تحليل محتوى هذه الصفحة. لا يمكن أن تُستخدَم بجانب text and title.
- pageid
حلل محتوى هذه الصفحة. تجاوز page.
- Type: integer
- redirects
لو page أو pageid is تم تعيينها للتحويل، حلها.
- Type: boolean (details)
- oldid
تحليل مضمون هذا التعديل. تجاوز page وpageid.
- Type: integer
- prop
أي قطعة من المعلومات تريد الحصول عليها:
- text
- Gives the parsed text of the wikitext.
- langlinks
- يعطي وصلات اللغات في تحليل نصوص الويكي.
- categories
- يعطي التصنيفات في تحليل نصوص الويكي.
- categorieshtml
- يعطي إصدار HTML للتصنيفات.
- links
- يعطي الوصلات الداخلية في تحليل نصوص الويكي.
- templates
- يعطي القوالب في تحليل نصوص الويكي.
- images
- يعطي الصور في تحليل نصوص الويكي.
- externallinks
- يعطي الوصلات الخارجية في تحليل نصوص الويكي.
- sections
- يعطي الأقسام في تحليل نصوص الويكي.
- revid
- Adds the revision ID of the parsed page.
- displaytitle
- يضيف العنوان في تحليل نصوص الويكي.
- headitems
- Deprecated. يعطي عناصر لوضعها في
<head>
الصفحة. - headhtml
- يعطي تحليل
<head>
الصفحة. - modules
- Gives the ResourceLoader modules used on the page. To load, use
mw.loader.using()
. Either jsconfigvars or encodedjsconfigvars must be requested jointly with modules. - jsconfigvars
- يعطي متغيرات تكوين جافا سكريبت الخاصة بهذه الصفحة. للتطبيق; استخدم
mw.config.set()
. - encodedjsconfigvars
- يعطي متغيرات تكوين جافا سكريبت الخاصة بهذه الصفحة كسلسلة JSON.
- indicators
- يعطي HTML مؤشرات حالة الصفحة المستخدمة في الصفحة.
- iwlinks
- يعطي وصلات اللغات في تحليل نصوص الويكي.
- wikitext
- يعطي نصوص الويكي الأصلية التي تم تحليلها.
- properties
- يعطي الخصائص المختلفة المحددة في تحليل نصوص الويكي.
- limitreportdata
- يعطي تقرير الحد بطريقة منظمة. لا يعطي أية بيانات، عندما يتم تعيين disablelimitreport.
- limitreporthtml
- يعطي إصدار HTML لتقرير الحد. لا يعطي أية بيانات، عندما يتم تعيينdisablelimitreport.
- parsetree
- شجرة تحليل XML لمحتويات المراجعة (يتطلب نموذج محتوى
wikitext
) - parsewarnings
- Gives the warnings that occurred while parsing content.
- Values (separate with | or alternative): text، langlinks، categories، categorieshtml، links، templates، images، externallinks، sections، revid، displaytitle، headitems، headhtml، modules، jsconfigvars، encodedjsconfigvars، indicators، iwlinks، wikitext، properties، limitreportdata، limitreporthtml، parsetree، parsewarnings
- Default: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties|parsewarnings
- pst
قم بتحويل قبل الحفظ على المدخلات قبل تحليل ذلك. صالح فقط عند استخدامه مع النص.
- Type: boolean (details)
- onlypst
Do a pre-save transform (PST) on the input, but don't parse it. Returns the same wikitext, after a PST has been applied. Only valid when used with text.
- Type: boolean (details)
- effectivelanglinks
يشمل وصلات لغة المقدمة بواسطة ملحقات (للاستخدام مع prop=langlinks).
- Type: boolean (details)
- section
Only parse the content of this section number.
When new, parse text and sectiontitle as if adding a new section to the page.
new is allowed only when specifying text.
- sectiontitle
New section title when section is new.
Unlike page editing, this does not fall back to summary when omitted or empty.
- disablepp
- Deprecated.
استخدم disablelimitreport بدلا من ذلك.
- Type: boolean (details)
- disablelimitreport
تجاهل تقرير الحد ("NewPP limit report") من مخرجات المحلل.
- Type: boolean (details)
- disableeditsection
تجاهل روابط تحرير الأقسام من مخرجات المحلل.
- Type: boolean (details)
- disabletidy
لا تشغل تنظيف HTML (على سبيل المثال مرتبة) على مخرجات المحلل.
- Type: boolean (details)
- generatexml
- Deprecated.
توليد شجرة تحليل XML (يتطلب نموذج المحتوى
wikitext
; حل محلها prop=parsetree).- Type: boolean (details)
- preview
تحليل في وضع المعاينة.
- Type: boolean (details)
- sectionpreview
تحليل في وضع معاينة القسم (يمكن وضع المعاينة أيضا).
- Type: boolean (details)
- disabletoc
تجاهل جدول المحتويات في المخرجات.
- Type: boolean (details)
- contentformat
نموذج المحتوى المسلسل يُستخدَم للنص المدخل. صالح فقط عند استخدامه مع text.
- One of the following values: text/x-wiki، text/javascript، application/json، text/css، text/plain
- contentmodel
Content model of the input text. If omitted, title must be specified, and default will be the model of the specified title. Only valid when used with text.
- One of the following values: wikitext، javascript، json، css، text
- تحليل صفحة.
- api.php?action=parse&page=Project:Sandbox [open in sandbox]
- تحليل نصوص ويكي
- api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext [open in sandbox]
- تحليل نصوص ويكي، تحديد عنوان الصفحة.
- api.php?action=parse&text={{PAGENAME}}&title=Test [open in sandbox]
- تحليل الملخص.
- api.php?action=parse&summary=Some+[[link]]&prop= [open in sandbox]
action=patrol
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
مراجعة صفحة أو مراجعة.
- rcid
معرف أحدث التغييرات للمراجعة
- Type: integer
- revid
معرف مراجعة للمراجعة
- Type: integer
- tags
تغيير وسوم لتطبيق الإدخال في سجل المراجعة.
- Values (separate with | or alternative):
- token
A "patrol" token retrieved from action=query&meta=tokens
- This parameter is required.
action=protect
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
غير مستوى الحماية لصفحة.
- title
عنوان الصفحة ل (إزالة) الحماية. لا يمكن أن تُستخدَم بجانب pageid.
- pageid
معرف الصفحة ل (إزالة) الحماية. لا يمكن أن تُستخدَم بجانب pageid.
- Type: integer
- protections
List of protection levels, formatted action=level (e.g. edit=sysop). A level of all means everyone is allowed to take the action, i.e. no restriction.
Note: Any actions not listed will have restrictions removed.
- This parameter is required.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- expiry
Expiry timestamps. If only one timestamp is set, it'll be used for all protections. Use infinite, indefinite, infinity, or never, for a never-expiring protection.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- Default: infinite
- reason
سبب (إزالة) الحماية.
- Default: (empty)
- tags
تغيير وسوم لتطبيق الإدخال في سجل الحماية.
- Values (separate with | or alternative):
- cascade
Enable cascading protection (i.e. protect transcluded templates and images used in this page). Ignored if none of the given protection levels support cascading.
- Type: boolean (details)
- watch
- Deprecated.
إذا تم الضبط، أضف الصفحة (غير) المحمية لقائمة مراقبة المستخدم الحالي.
- Type: boolean (details)
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
- One of the following values: watch، unwatch، preferences، nochange
- Default: preferences
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- حماية صفحة.
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never [open in sandbox]
- إلغاء حماية الصفحة من خلال وضع قيود لall (أي يُسمَح أي شخص باتخاذ الإجراءات).
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions [open in sandbox]
- إلغاء حماية الصفحة عن طريق عدم وضع أية قيود.
- api.php?action=protect&title=Main%20Page&token=123ABC&protections=&reason=Lifting%20restrictions [open in sandbox]
action=purge
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
مسح ذاكرة التخزين المؤقت للعناوين المعطاة
- forcelinkupdate
تحديث جداول الروابط.
- Type: boolean (details)
- forcerecursivelinkupdate
تحديث جدول الروابط، وتحديث جداول الروابط لأية صفحة تستخدم هذه الصفحة كقالب.
- Type: boolean (details)
- continue
When more results are available, use this to continue.
- titles
A list of titles to work on.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- pageids
A list of page IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- revids
A list of revision IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- 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.
- 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، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، redirects، revisions، search، templates، transcludedin، watchlist، watchlistraw
- redirects
Automatically resolve redirects in titles, pageids, and revids, and in pages returned by 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 gan، iu، kk، ku، shi، sr، tg، uz و zh.
- Type: boolean (details)
- إفراغ كاش Main Page وصفحة API.
- api.php?action=purge&titles=Main_Page|API [open in sandbox]
- إفراغ كاش أول 10 صفحات في النطاق الرئيسي.
- api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10 [open in sandbox]
action=query
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
جلب البيانات من وعن ميدياويكي. يجب على جميع تعديلات البيانات أولا استخدام استعلام للحصول على رمز لمنع الاعتداء من المواقع الخبيثة.
- prop
أي الخصائص تريد الحصول على صفحات استعلام عنها.
- Values (separate with | or alternative): categories، categoryinfo، contributors، deletedrevisions، duplicatefiles، extlinks، fileusage، imageinfo، images، info، iwlinks، langlinks، links، linkshere، pageprops، redirects، revisions، stashimageinfo، templates، transcludedin
- list
أي القوائم تريد الحصول عليها.
- Values (separate with | or alternative): allcategories، alldeletedrevisions، allfileusages، allimages، alllinks، allpages، allredirects، allrevisions، alltransclusions، allusers، backlinks، blocks، categorymembers، deletedrevs، embeddedin، exturlusage، filearchive، imageusage، iwbacklinks، langbacklinks، logevents، mystashedfiles، pagepropnames، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، search، tags، usercontribs، users، watchlist، watchlistraw
- meta
أي البيانات الوصفية تريد الحصول عليها.
- Values (separate with | or alternative): allmessages، authmanagerinfo، filerepoinfo، siteinfo، tokens، userinfo
- indexpageids
Include an additional pageids section listing all returned page IDs.
- Type: boolean (details)
- export
تصدير المراجعات الحالية لجميع الصفحات المعينة أو المولدة.
- Type: boolean (details)
- exportnowrap
إعادة تصدير XML دون التفاف عليه في نتيجة XML (نفس شكل خاص:تصدير). يمكن استخدامها فقط مع export.
- Type: boolean (details)
- 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
إرجاع query-continue بيانات خام للاستمرار.
- Type: boolean (details)
- titles
A list of titles to work on.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- pageids
A list of page IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- revids
A list of revision IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- 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.
- 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، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، redirects، revisions، search، templates، transcludedin، watchlist، watchlistraw
- redirects
Automatically resolve redirects in titles, pageids, and revids, and in pages returned by 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 gan، iu، kk، ku، shi، sr، tg، uz و zh.
- Type: boolean (details)
prop=categories (cl)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
List all categories the pages belong to.
- clprop
Which additional properties to get for each category:
- sortkey
- Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category.
- timestamp
- Adds timestamp of when the category was added.
- hidden
- Tags categories that are hidden with
__HIDDENCAT__
.
- Values (separate with | or alternative): sortkey، timestamp، hidden
- clshow
Which kind of categories to show.
- Values (separate with | or alternative): hidden، !hidden
- cllimit
How many categories to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- clcontinue
When more results are available, use this to continue.
- clcategories
Only list these categories. Useful for checking whether a certain page is in a certain category.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- cldir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- Get a list of categories the page Albert Einstein belongs to.
- api.php?action=query&prop=categories&titles=Albert%20Einstein [open in sandbox]
- Get information about all categories used in the page Albert Einstein.
- api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info [open in sandbox]
prop=categoryinfo (ci)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Returns information about the given categories.
- cicontinue
When more results are available, use this to continue.
- Get information about Category:Foo and Category:Bar.
- api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar [open in sandbox]
prop=contributors (pc)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Get the list of logged-in contributors and the count of anonymous contributors to a page.
- pcgroup
Only include users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.
- Values (separate with | or alternative): bot، sysop، bureaucrat
- pcexcludegroup
Exclude users in the given groups. Does not include implicit or auto-promoted groups like *, user, or autoconfirmed.
- Values (separate with | or alternative): bot، sysop، bureaucrat
- pcrights
Only include users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.
- Values (separate with | or alternative): apihighlimits، applychangetags، autoconfirmed، autocreateaccount، autopatrol، bigdelete، block، blockemail، bot، browsearchive، changetags، createaccount، createpage، createtalk، delete، deletechangetags، deletedhistory، deletedtext، deletelogentry، deleterevision، edit، editcontentmodel، editinterface، editprotected، editmyoptions، editmyprivateinfo، editmyusercss، editmyuserjs، editmywatchlist، editsemiprotected، editusercss، edituserjs، hideuser، import، importupload، ipblock-exempt، managechangetags، markbotedits، mergehistory، minoredit، move، movefile، move-categorypages، move-rootuserpages، move-subpages، nominornewtalk، noratelimit، override-export-depth، pagelang، patrol، patrolmarks، protect، purge، read، reupload، reupload-own، reupload-shared، rollback، sendemail، siteadmin، suppressionlog، suppressredirect، suppressrevision، unblockself، undelete، unwatchedpages، upload، upload_by_url، userrights، userrights-interwiki، viewmyprivateinfo، viewmywatchlist، viewsuppressed، writeapi
- Maximum number of values is ٥٠ (٥٠٠ for bots).
- pcexcluderights
Exclude users having the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.
- Values (separate with | or alternative): apihighlimits، applychangetags، autoconfirmed، autocreateaccount، autopatrol، bigdelete، block، blockemail، bot، browsearchive، changetags، createaccount، createpage، createtalk، delete، deletechangetags، deletedhistory، deletedtext، deletelogentry، deleterevision، edit، editcontentmodel، editinterface، editprotected، editmyoptions، editmyprivateinfo، editmyusercss، editmyuserjs، editmywatchlist، editsemiprotected، editusercss، edituserjs، hideuser، import، importupload، ipblock-exempt، managechangetags، markbotedits، mergehistory، minoredit، move، movefile، move-categorypages، move-rootuserpages، move-subpages، nominornewtalk، noratelimit، override-export-depth، pagelang، patrol، patrolmarks، protect، purge، read، reupload، reupload-own، reupload-shared، rollback، sendemail، siteadmin، suppressionlog، suppressredirect، suppressrevision، unblockself، undelete، unwatchedpages، upload، upload_by_url، userrights، userrights-interwiki، viewmyprivateinfo، viewmywatchlist، viewsuppressed، writeapi
- Maximum number of values is ٥٠ (٥٠٠ for bots).
- pclimit
How many contributors to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- pccontinue
When more results are available, use this to continue.
- Show contributors to the page Main Page.
- api.php?action=query&prop=contributors&titles=Main_Page [open in sandbox]
prop=deletedrevisions (drv)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Get deleted revision information.
May be used in several ways:
- Get deleted revisions for a set of pages, by setting titles or pageids. Ordered by title and timestamp.
- Get data about a set of deleted revisions by setting their IDs with revids. Ordered by revision ID.
- drvprop
Which properties to get for each revision:
- ids
- The ID of the revision.
- flags
- Revision flags (minor).
- timestamp
- The timestamp of the revision.
- user
- User that made the revision.
- userid
- User ID of the revision creator.
- size
- Length (bytes) of the revision.
- sha1
- SHA-1 (base 16) of the revision.
- contentmodel
- Content model ID of the revision.
- comment
- Comment by the user for the revision.
- parsedcomment
- Parsed comment by the user for the revision.
- content
- Text of the revision.
- tags
- Tags for the revision.
- parsetree
- The XML parse tree of revision content (requires content model
wikitext
).
- Values (separate with | or alternative): ids، flags، timestamp، user، userid، size، sha1، contentmodel، comment، parsedcomment، content، tags، parsetree
- Default: ids|timestamp|flags|comment|user
- drvlimit
Limit how many revisions will be returned.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- drvexpandtemplates
Expand templates in revision content (requires drvprop=content).
- Type: boolean (details)
- drvgeneratexml
- Deprecated.
Generate XML parse tree for revision content (requires drvprop=content; replaced by drvprop=parsetree).
- Type: boolean (details)
- drvparse
Parse revision content (requires drvprop=content). For performance reasons, if this option is used, drvlimit is enforced to 1.
- Type: boolean (details)
- drvsection
Only retrieve the content of this section number.
- drvdiffto
Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
- drvdifftotext
Text to diff each revision to. Only diffs a limited number of revisions. Overrides drvdiffto. If drvsection is set, only that section will be diffed against this text.
- drvdifftotextpst
Perform a pre-save transform on the text before diffing it. Only valid when used with drvdifftotext.
- Type: boolean (details)
- drvcontentformat
Serialization format used for drvdifftotext and expected for output of content.
- One of the following values: text/x-wiki، text/javascript، application/json، text/css، text/plain
- drvstart
The timestamp to start enumerating from. Ignored when processing a list of revision IDs.
- Type: timestamp (allowed formats)
- drvend
The timestamp to stop enumerating at. Ignored when processing a list of revision IDs.
- Type: timestamp (allowed formats)
- drvdir
In which direction to enumerate:
- newer
- List oldest first. Note: drvstart has to be before drvend.
- older
- List newest first (default). Note: drvstart has to be later than drvend.
- One of the following values: newer، older
- Default: older
- drvtag
Only list revisions tagged with this tag.
- drvuser
Only list revisions by this user.
- Type: user name
- drvexcludeuser
Don't list revisions by this user.
- Type: user name
- drvcontinue
When more results are available, use this to continue.
- List the deleted revisions of the pages Main Page and Talk:Main Page, with content.
- api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvprop=user|comment|content [open in sandbox]
- List the information for deleted revision 123456.
- api.php?action=query&prop=deletedrevisions&revids=123456 [open in sandbox]
prop=duplicatefiles (df)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
List all files that are duplicates of the given files based on hash values.
- dflimit
How many duplicate files to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- dfcontinue
When more results are available, use this to continue.
- dfdir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- dflocalonly
Look only for files in the local repository.
- Type: boolean (details)
- Look for duplicates of File:Albert Einstein Head.jpg.
- api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles [open in sandbox]
- Look for duplicates of all files.
- api.php?action=query&generator=allimages&prop=duplicatefiles [open in sandbox]
prop=extlinks (el)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Returns all external URLs (not interwikis) from the given pages.
- ellimit
How many links to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- eloffset
When more results are available, use this to continue.
- Type: integer
- elprotocol
Protocol of the URL. If empty and elquery is set, the protocol is http. Leave both this and elquery empty to list all external links.
- One of the following values: Can be empty, or bitcoin، ftp، ftps، geo، git، gopher، http، https، irc، ircs، magnet، mailto، mms، news، nntp، redis، sftp، sip، sips، sms، ssh، svn، tel، telnet، urn، worldwind، xmpp
- Default: (empty)
- elquery
Search string without protocol. Useful for checking whether a certain page contains a certain external url.
- elexpandurl
Expand protocol-relative URLs with the canonical protocol.
- Type: boolean (details)
- Get a list of external links on Main Page.
- api.php?action=query&prop=extlinks&titles=Main%20Page [open in sandbox]
prop=fileusage (fu)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Find all pages that use the given files.
- fuprop
Which properties to get:
- pageid
- Page ID of each page.
- title
- Title of each page.
- redirect
- Flag if the page is a redirect.
- Values (separate with | or alternative): pageid، title، redirect
- Default: pageid|title|redirect
- funamespace
Only include pages in these namespaces.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- fushow
Show only items that meet these criteria:
- redirect
- Only show redirects.
- !redirect
- Only show non-redirects.
- Values (separate with | or alternative): redirect، !redirect
- fulimit
How many to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- fucontinue
When more results are available, use this to continue.
- Get a list of pages using File:Example.jpg.
- api.php?action=query&prop=fileusage&titles=File%3AExample.jpg [open in sandbox]
- Get information about pages using File:Example.jpg.
- api.php?action=query&generator=fileusage&titles=File%3AExample.jpg&prop=info [open in sandbox]
prop=imageinfo (ii)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Returns file information and upload history.
- iiprop
Which file information to get:
- timestamp
- Adds timestamp for the uploaded version.
- user
- Adds the user who uploaded each file version.
- userid
- إضافة هوية المستخدم الذي قام بتحميل كل إصدار ملف.
- comment
- Comment on the version.
- parsedcomment
- Parse the comment on the version.
- canonicaltitle
- Adds the canonical title of the file.
- url
- Gives URL to the file and the description page.
- size
- Adds the size of the file in bytes and the height, width and page count (if applicable).
- dimensions
- Alias for size.
- sha1
- Adds SHA-1 hash for the file.
- mime
- Adds MIME type of the file.
- thumbmime
- Adds MIME type of the image thumbnail (requires url and param iiurlwidth).
- mediatype
- Adds the media type of the file.
- metadata
- Lists Exif metadata for the version of the file.
- commonmetadata
- Lists file format generic metadata for the version of the file.
- extmetadata
- Lists formatted metadata combined from multiple sources. Results are HTML formatted.
- archivename
- Adds the filename of the archive version for non-latest versions.
- bitdepth
- Adds the bit depth of the version.
- uploadwarning
- Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
- badfile
- Adds whether the file is on the MediaWiki:Bad image list
- Values (separate with | or alternative): timestamp، user، userid، comment، parsedcomment، canonicaltitle، url، size، dimensions، sha1، mime، thumbmime، mediatype، metadata، commonmetadata، extmetadata، archivename، bitdepth، uploadwarning، badfile
- Default: timestamp|user
- iilimit
How many file revisions to return per file.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 1
- iistart
Timestamp to start listing from.
- Type: timestamp (allowed formats)
- iiend
Timestamp to stop listing at.
- Type: timestamp (allowed formats)
- iiurlwidth
If iiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.
- Type: integer
- Default: -1
- iiurlheight
Similar to iiurlwidth.
- Type: integer
- Default: -1
- iimetadataversion
Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.
- Default: 1
- iiextmetadatalanguage
What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted.
- Default: ar
- iiextmetadatamultilang
If translations for extmetadata property are available, fetch all of them.
- Type: boolean (details)
- iiextmetadatafilter
If specified and non-empty, only these keys will be returned for iiprop=extmetadata.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- iiurlparam
A handler specific parameter string. For example, PDFs might use page15-100px. iiurlwidth must be used and be consistent with iiurlparam.
- Default: (empty)
- iibadfilecontexttitle
If badfilecontexttitleprop=badfile is set, this is the page title used when evaluating the MediaWiki:Bad image list
- iicontinue
When more results are available, use this to continue.
- iilocalonly
Look only for files in the local repository.
- Type: boolean (details)
- Fetch information about the current version of File:Albert Einstein Head.jpg.
- api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo [open in sandbox]
- Fetch information about versions of File:Test.jpg from 2008 and later.
- api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url [open in sandbox]
prop=images (im)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Returns all files contained on the given pages.
- imlimit
How many files to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- imcontinue
When more results are available, use this to continue.
- imimages
Only list these files. Useful for checking whether a certain page has a certain file.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- imdir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- Get a list of files used in the Main Page.
- api.php?action=query&prop=images&titles=Main%20Page [open in sandbox]
- Get information about all files used in the Main Page.
- api.php?action=query&generator=images&titles=Main%20Page&prop=info [open in sandbox]
prop=info (in)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Get basic page information.
- inprop
Which additional properties to get:
- protection
- List the protection level of each page.
- talkid
- The page ID of the talk page for each non-talk page.
- watched
- List the watched status of each page.
- watchers
- The number of watchers, if allowed.
- visitingwatchers
- The number of watchers of each page who have visited recent edits to that page, if allowed.
- notificationtimestamp
- The watchlist notification timestamp of each page.
- subjectid
- The page ID of the parent page for each talk page.
- url
- Gives a full URL, an edit URL, and the canonical URL for each page.
- readable
- Whether the user can read this page.
- preload
- Gives the text returned by EditFormPreloadText.
- displaytitle
- Gives the manner in which the page title is actually displayed.
- Values (separate with | or alternative): protection، talkid، watched، watchers، visitingwatchers، notificationtimestamp، subjectid، url، readable، preload، displaytitle
- intestactions
Test whether the current user can perform certain actions on the page.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- intoken
- Deprecated.
Use action=query&meta=tokens instead.
- Values (separate with | or alternative): edit، delete، protect، move، block، unblock، email، import، watch
- incontinue
When more results are available, use this to continue.
- Get information about the page Main Page.
- api.php?action=query&prop=info&titles=Main%20Page [open in sandbox]
- Get general and protection information about the page Main Page.
- api.php?action=query&prop=info&inprop=protection&titles=Main%20Page [open in sandbox]
prop=iwlinks (iw)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Returns all interwiki links from the given pages.
- iwprop
Which additional properties to get for each interlanguage link:
- url
- Adds the full URL.
- Values (separate with | or alternative): url
- iwprefix
Only return interwiki links with this prefix.
- iwtitle
Interwiki link to search for. Must be used with iwprefix.
- iwdir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- iwlimit
How many interwiki links to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- iwcontinue
When more results are available, use this to continue.
- iwurl
- Deprecated.
Whether to get the full URL (cannot be used with iwprop).
- Type: boolean (details)
- Get interwiki links from the page Main Page.
- api.php?action=query&prop=iwlinks&titles=Main%20Page [open in sandbox]
prop=langlinks (ll)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Returns all interlanguage links from the given pages.
- llprop
Which additional properties to get for each interlanguage link:
- url
- Adds the full URL.
- langname
- Adds the localised language name (best effort). Use llinlanguagecode to control the language.
- autonym
- Adds the native language name.
- Values (separate with | or alternative): url، langname، autonym
- lllang
Only return language links with this language code.
- lltitle
Link to search for. Must be used with lllang.
- lldir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- llinlanguagecode
Language code for localised language names.
- Default: ar
- lllimit
How many langlinks to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- llcontinue
When more results are available, use this to continue.
- llurl
- Deprecated.
Whether to get the full URL (cannot be used with llprop).
- Type: boolean (details)
- Get interlanguage links from the page Main Page.
- api.php?action=query&prop=langlinks&titles=Main%20Page&redirects= [open in sandbox]
prop=links (pl)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Returns all links from the given pages.
- plnamespace
Show links in these namespaces only.
- Values (separate with | or alternative): -2، -1، 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- pllimit
How many links to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- plcontinue
When more results are available, use this to continue.
- pltitles
Only list links to these titles. Useful for checking whether a certain page links to a certain title.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- pldir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- Get links from the page Main Page
- api.php?action=query&prop=links&titles=Main%20Page [open in sandbox]
- Get information about the link pages in the page Main Page.
- api.php?action=query&generator=links&titles=Main%20Page&prop=info [open in sandbox]
- Get links from the page Main Page in the مستخدم and قالب namespaces.
- api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10 [open in sandbox]
prop=linkshere (lh)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Find all pages that link to the given pages.
- lhprop
Which properties to get:
- pageid
- Page ID of each page.
- title
- Title of each page.
- redirect
- Flag if the page is a redirect.
- Values (separate with | or alternative): pageid، title، redirect
- Default: pageid|title|redirect
- lhnamespace
Only include pages in these namespaces.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- lhshow
Show only items that meet these criteria:
- redirect
- Only show redirects.
- !redirect
- Only show non-redirects.
- Values (separate with | or alternative): redirect، !redirect
- lhlimit
How many to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- lhcontinue
When more results are available, use this to continue.
- Get a list of pages linking to the Main Page.
- api.php?action=query&prop=linkshere&titles=Main%20Page [open in sandbox]
- Get information about pages linking to the Main Page.
- api.php?action=query&generator=linkshere&titles=Main%20Page&prop=info [open in sandbox]
prop=pageprops (pp)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Get various page properties defined in the page content.
- ppcontinue
When more results are available, use this to continue.
- ppprop
Only list these page properties (action=query&list=pagepropnames returns page property names in use). Useful for checking whether pages use a certain page property.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- Get properties for the pages Main Page and MediaWiki.
- api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki [open in sandbox]
prop=redirects (rd)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Returns all redirects to the given pages.
- rdprop
Which properties to get:
- pageid
- Page ID of each redirect.
- title
- Title of each redirect.
- fragment
- Fragment of each redirect, if any.
- Values (separate with | or alternative): pageid، title، fragment
- Default: pageid|title
- rdnamespace
Only include pages in these namespaces.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- rdshow
Show only items that meet these criteria:
- fragment
- Only show redirects with a fragment.
- !fragment
- Only show redirects without a fragment.
- Values (separate with | or alternative): fragment، !fragment
- rdlimit
How many redirects to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- rdcontinue
When more results are available, use this to continue.
- Get a list of redirects to the Main Page.
- api.php?action=query&prop=redirects&titles=Main%20Page [open in sandbox]
- Get information about all redirects to the Main Page.
- api.php?action=query&generator=redirects&titles=Main%20Page&prop=info [open in sandbox]
prop=revisions (rv)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Get revision information.
May be used in several ways:
- Get data about a set of pages (last revision), by setting titles or pageids.
- Get revisions for one given page, by using titles or pageids with start, end, or limit.
- Get data about a set of revisions by setting their IDs with revids.
- rvprop
Which properties to get for each revision:
- ids
- The ID of the revision.
- flags
- Revision flags (minor).
- timestamp
- The timestamp of the revision.
- user
- User that made the revision.
- userid
- User ID of the revision creator.
- size
- Length (bytes) of the revision.
- sha1
- SHA-1 (base 16) of the revision.
- contentmodel
- Content model ID of the revision.
- comment
- Comment by the user for the revision.
- parsedcomment
- Parsed comment by the user for the revision.
- content
- Text of the revision.
- tags
- Tags for the revision.
- parsetree
- The XML parse tree of revision content (requires content model
wikitext
).
- Values (separate with | or alternative): ids، flags، timestamp، user، userid، size، sha1، contentmodel، comment، parsedcomment، content، tags، parsetree
- Default: ids|timestamp|flags|comment|user
- rvlimit
Limit how many revisions will be returned.
- May only be used with a single page (mode #2).
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- rvexpandtemplates
Expand templates in revision content (requires rvprop=content).
- Type: boolean (details)
- rvgeneratexml
- Deprecated.
Generate XML parse tree for revision content (requires rvprop=content; replaced by rvprop=parsetree).
- Type: boolean (details)
- rvparse
Parse revision content (requires rvprop=content). For performance reasons, if this option is used, rvlimit is enforced to 1.
- Type: boolean (details)
- rvsection
Only retrieve the content of this section number.
- rvdiffto
Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
- rvdifftotext
Text to diff each revision to. Only diffs a limited number of revisions. Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text.
- rvdifftotextpst
Perform a pre-save transform on the text before diffing it. Only valid when used with rvdifftotext.
- Type: boolean (details)
- rvcontentformat
Serialization format used for rvdifftotext and expected for output of content.
- One of the following values: text/x-wiki، text/javascript، application/json، text/css، text/plain
- rvstartid
From which revision ID to start enumeration.
- May only be used with a single page (mode #2).
- Type: integer
- rvendid
Stop revision enumeration on this revision ID.
- May only be used with a single page (mode #2).
- Type: integer
- rvstart
From which revision timestamp to start enumeration.
- May only be used with a single page (mode #2).
- Type: timestamp (allowed formats)
- rvend
Enumerate up to this timestamp.
- May only be used with a single page (mode #2).
- Type: timestamp (allowed formats)
- rvdir
In which direction to enumerate:
- newer
- List oldest first. Note: rvstart has to be before rvend.
- older
- List newest first (default). Note: rvstart has to be later than rvend.
- May only be used with a single page (mode #2).
- One of the following values: newer، older
- Default: older
- rvuser
Only include revisions made by user.
- May only be used with a single page (mode #2).
- Type: user name
- rvexcludeuser
Exclude revisions made by user.
- May only be used with a single page (mode #2).
- Type: user name
- rvtag
Only list revisions tagged with this tag.
- rvtoken
- Deprecated.
Which tokens to obtain for each revision.
- Values (separate with | or alternative): rollback
- rvcontinue
When more results are available, use this to continue.
- Get data with content for the last revision of titles API and Main Page.
- api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content [open in sandbox]
- Get last 5 revisions of the Main Page.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment [open in sandbox]
- Get first 5 revisions of the Main Page.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer [open in sandbox]
- Get first 5 revisions of the Main Page made after 2006-05-01.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=2006-05-01T00:00:00Z [open in sandbox]
- Get first 5 revisions of the Main Page that were not made by anonymous user 127.0.0.1.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1 [open in sandbox]
- Get first 5 revisions of the Main Page that were made by the user MediaWiki default.
- api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default [open in sandbox]
prop=stashimageinfo (sii)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Returns file information for stashed files.
- siifilekey
Key that identifies a previous upload that was stashed temporarily.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- siisessionkey
- Deprecated.
Alias for siifilekey, for backward compatibility.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- siiprop
Which file information to get:
- timestamp
- Adds timestamp for the uploaded version.
- canonicaltitle
- Adds the canonical title of the file.
- url
- Gives URL to the file and the description page.
- size
- Adds the size of the file in bytes and the height, width and page count (if applicable).
- dimensions
- Alias for size.
- sha1
- Adds SHA-1 hash for the file.
- mime
- Adds MIME type of the file.
- thumbmime
- Adds MIME type of the image thumbnail (requires url and param siiurlwidth).
- metadata
- Lists Exif metadata for the version of the file.
- commonmetadata
- Lists file format generic metadata for the version of the file.
- extmetadata
- Lists formatted metadata combined from multiple sources. Results are HTML formatted.
- bitdepth
- Adds the bit depth of the version.
- badfile
- Adds whether the file is on the MediaWiki:Bad image list
- Values (separate with | or alternative): timestamp، canonicaltitle، url، size، dimensions، sha1، mime، thumbmime، metadata، commonmetadata، extmetadata، bitdepth، badfile
- Default: timestamp|url
- siiurlwidth
If siiprop=url is set, a URL to an image scaled to this width will be returned. For performance reasons if this option is used, no more than 50 scaled images will be returned.
- Type: integer
- Default: -1
- siiurlheight
Similar to siiurlwidth.
- Type: integer
- Default: -1
- siiurlparam
A handler specific parameter string. For example, PDFs might use page15-100px. siiurlwidth must be used and be consistent with siiurlparam.
- Default: (empty)
- Returns information for a stashed file.
- api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567 [open in sandbox]
- Returns thumbnails for two stashed files.
- api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url [open in sandbox]
prop=templates (tl)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Returns all pages transcluded on the given pages.
- tlnamespace
Show templates in this namespaces only.
- Values (separate with | or alternative): -2، -1، 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- tllimit
How many templates to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- tlcontinue
When more results are available, use this to continue.
- tltemplates
Only list these templates. Useful for checking whether a certain page uses a certain template.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- tldir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- Get the templates used on the page Main Page.
- api.php?action=query&prop=templates&titles=Main%20Page [open in sandbox]
- Get information about the template pages used on Main Page.
- api.php?action=query&generator=templates&titles=Main%20Page&prop=info [open in sandbox]
- Get pages in the مستخدم and قالب namespaces that are transcluded on the page Main Page.
- api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10 [open in sandbox]
prop=transcludedin (ti)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Find all pages that transclude the given pages.
- tiprop
Which properties to get:
- pageid
- Page ID of each page.
- title
- Title of each page.
- redirect
- Flag if the page is a redirect.
- Values (separate with | or alternative): pageid، title، redirect
- Default: pageid|title|redirect
- tinamespace
Only include pages in these namespaces.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- tishow
Show only items that meet these criteria:
- redirect
- Only show redirects.
- !redirect
- Only show non-redirects.
- Values (separate with | or alternative): redirect، !redirect
- tilimit
How many to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- ticontinue
When more results are available, use this to continue.
- Get a list of pages transcluding Main Page.
- api.php?action=query&prop=transcludedin&titles=Main%20Page [open in sandbox]
- Get information about pages transcluding Main Page.
- api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info [open in sandbox]
list=allcategories (ac)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
تعداد جميع التصنيفات.
- acfrom
التصنيف الذي يبدأ التعداد منه.
- accontinue
When more results are available, use this to continue.
- acto
التصنيف الذي يقف التعداد عنده.
- acprefix
ابحث عن جميع التصنيفات التي تبدأ أسماؤها بهذه القيمة.
- acdir
اتجاه الفرز.
- One of the following values: ascending، descending
- Default: ascending
- acmin
Only return categories with at least this many members.
- Type: integer
- acmax
Only return categories with at most this many members.
- Type: integer
- aclimit
كم عدد الفئات في الإرجاع.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- acprop
أي الخصائص تريد الحصول عليها:
- size
- أضف عدد الصفحات في هذا التصنيف.
- hidden
- Tags categories that are hidden with
__HIDDENCAT__
.
- Values (separate with | or alternative): size، hidden
- Default: (empty)
- List categories with information on the number of pages in each.
- api.php?action=query&list=allcategories&acprop=size [open in sandbox]
- استرداد المعلومات حول صفحة التصنيف نفسها للتصنيفات التي تبدأ بList.
- api.php?action=query&generator=allcategories&gacprefix=List&prop=info [open in sandbox]
list=alldeletedrevisions (adr)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
قائمة جميع المراجعات المحذوفة بواسطة المستخدم أو في نطاق.
- adrprop
Which properties to get for each revision:
- ids
- The ID of the revision.
- flags
- Revision flags (minor).
- timestamp
- The timestamp of the revision.
- user
- User that made the revision.
- userid
- User ID of the revision creator.
- size
- Length (bytes) of the revision.
- sha1
- SHA-1 (base 16) of the revision.
- contentmodel
- Content model ID of the revision.
- comment
- Comment by the user for the revision.
- parsedcomment
- Parsed comment by the user for the revision.
- content
- Text of the revision.
- tags
- Tags for the revision.
- parsetree
- The XML parse tree of revision content (requires content model
wikitext
).
- Values (separate with | or alternative): ids، flags، timestamp، user، userid، size، sha1، contentmodel، comment، parsedcomment، content، tags، parsetree
- Default: ids|timestamp|flags|comment|user
- adrlimit
Limit how many revisions will be returned.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- adrexpandtemplates
Expand templates in revision content (requires adrprop=content).
- Type: boolean (details)
- adrgeneratexml
- Deprecated.
Generate XML parse tree for revision content (requires adrprop=content; replaced by adrprop=parsetree).
- Type: boolean (details)
- adrparse
Parse revision content (requires adrprop=content). For performance reasons, if this option is used, adrlimit is enforced to 1.
- Type: boolean (details)
- adrsection
Only retrieve the content of this section number.
- adrdiffto
Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
- adrdifftotext
Text to diff each revision to. Only diffs a limited number of revisions. Overrides adrdiffto. If adrsection is set, only that section will be diffed against this text.
- adrdifftotextpst
Perform a pre-save transform on the text before diffing it. Only valid when used with adrdifftotext.
- Type: boolean (details)
- adrcontentformat
Serialization format used for adrdifftotext and expected for output of content.
- One of the following values: text/x-wiki، text/javascript، application/json، text/css، text/plain
- adruser
أدرج المراجعات التي كتبها هذا المستخدم فقط.
- Type: user name
- adrnamespace
أدرج الصفحات في هذا النطاق فقط.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- adrstart
The timestamp to start enumerating from.
- يمكن أن تُستخدَم فقط مع adruser.
- Type: timestamp (allowed formats)
- adrend
الطابع الزمني الذي يقف التعداد منه.
- يمكن أن تُستخدَم فقط مع adruser.
- Type: timestamp (allowed formats)
- adrdir
In which direction to enumerate:
- newer
- List oldest first. Note: adrstart has to be before adrend.
- older
- List newest first (default). Note: adrstart has to be later than adrend.
- One of the following values: newer، older
- Default: older
- adrfrom
بدء الإدراج في القائمة من هذا العنوان.
- لا يمكن أن تُستخدَم مع adruser.
- adrto
وقف الإدراج في القائمة من هذا العنوان.
- لا يمكن أن تُستخدَم مع adruser.
- adrprefix
ابحث عن جميع عناوين الصفحات التي تبدأ أسماؤها بهذه القيمة.
- لا يمكن أن تُستخدَم مع adruser.
- adrexcludeuser
لا تدرج المراجعات التي كتبها هذا المستخدم.
- لا يمكن أن تُستخدَم مع adruser.
- Type: user name
- adrtag
مراجعات القائمة فقط تم وسمها بهذ الوسم.
- adrcontinue
When more results are available, use this to continue.
- adrgeneratetitles
عندما يُستخدَم كمولد، ولد عناوين بدلا من معرفات المراجعات.
- Type: boolean (details)
- List the last 50 deleted contributions by user Example.
- api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50 [open in sandbox]
- List the first 50 deleted revisions in the main namespace.
- api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrnamespace=0&adrlimit=50 [open in sandbox]
list=allfileusages (af)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
قائمة جميع استخدامات الملفات، بما في ذلك غير الموجودة.
- afcontinue
When more results are available, use this to continue.
- affrom
عنوان الملف لبدء التعداد منه.
- afto
عنوان الملف لوقف التعداد منه.
- afprefix
البحث عن كل عناوين الملفات التي تبدأ بهذه القيمة.
- afunique
Only show distinct file titles. Cannot be used with afprop=ids. When used as a generator, yields target pages instead of source pages.
- Type: boolean (details)
- afprop
أي قطعة من المعلومات تريد تضمينها:
- ids
- تضيف معرفات استخدام الصفحات (لا يمكن استخدامها مع afunique).
- title
- تضيف عنوان الملف.
- Values (separate with | or alternative): ids، title
- Default: title
- aflimit
كم عدد مجموع البنود للعودة.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- afdir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- List file titles, including missing ones, with page IDs they are from, starting at B.
- api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title [open in sandbox]
- List unique file titles.
- api.php?action=query&list=allfileusages&afunique=&affrom=B [open in sandbox]
- Gets all file titles, marking the missing ones.
- api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B [open in sandbox]
- Gets pages containing the files.
- api.php?action=query&generator=allfileusages&gaffrom=B [open in sandbox]
list=allimages (ai)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
تعداد كافة الصور بشكل متتالي.
- aisort
خاصية للفرز وفقًا لها.
- One of the following values: name، timestamp
- Default: name
- aidir
The direction in which to list.
- One of the following values: ascending، descending، newer، older
- Default: ascending
- aifrom
عنوان الصورة لبدء التعداد منه. يمكن استخدامها مع aisort=name فقط.
- aito
عنوان الصورة لوقف التعداد منه. يمكن استخدامها مع aisort=name فقط.
- aicontinue
When more results are available, use this to continue.
- aistart
طابع زمني لبدء التعداد منه. يمكن استخدامه مع aisort فقط.
- Type: timestamp (allowed formats)
- aiend
طابع زمني لإنهاء التعداد منه. يمكن استخدامه مع aisort فقط.
- Type: timestamp (allowed formats)
- aiprop
Which file information to get:
- timestamp
- Adds timestamp for the uploaded version.
- user
- Adds the user who uploaded each file version.
- userid
- إضافة هوية المستخدم الذي قام بتحميل كل إصدار ملف.
- comment
- Comment on the version.
- parsedcomment
- Parse the comment on the version.
- canonicaltitle
- Adds the canonical title of the file.
- url
- Gives URL to the file and the description page.
- size
- Adds the size of the file in bytes and the height, width and page count (if applicable).
- dimensions
- Alias for size.
- sha1
- Adds SHA-1 hash for the file.
- mime
- Adds MIME type of the file.
- mediatype
- Adds the media type of the file.
- metadata
- Lists Exif metadata for the version of the file.
- commonmetadata
- Lists file format generic metadata for the version of the file.
- extmetadata
- Lists formatted metadata combined from multiple sources. Results are HTML formatted.
- bitdepth
- Adds the bit depth of the version.
- badfile
- Adds whether the file is on the MediaWiki:Bad image list
- Values (separate with | or alternative): timestamp، user، userid، comment، parsedcomment، canonicaltitle، url، size، dimensions، sha1، mime، mediatype، metadata، commonmetadata، extmetadata، bitdepth، badfile
- Default: timestamp|url
- aiprefix
البحث عن كل عناوين الصور التي تبدأ بهذه القيمة. يمكن استخدامها مع aisort فقط.
- aiminsize
Limit to images with at least this many bytes.
- Type: integer
- aimaxsize
Limit to images with at most this many bytes.
- Type: integer
- aisha1
SHA1 تجزئة الصورة. تجاوز aisha1base36.
- aisha1base36
SHA1 تجزئة الصورة في قاعدة 36 (تُستخدَم في ميدياويكي).
- aiuser
Only return files uploaded by this user. Can only be used with aisort=timestamp. Cannot be used together with aifilterbots.
- Type: user name
- aifilterbots
كيفية تصفية الملفات التي تم تحميلها بواسطة بوتات. يمكن استخدامها مع aisort=timestamp فقط. لا يمكن أن تُستخدَم بجانب aiuser.
- One of the following values: all، bots، nobots
- Default: all
- aimime
عن أي أنواع MIME تبحث، على سبيل المثال image/jpeg.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- ailimit
How many images in total to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- أظهر قائمة الملفات التي تبدأ بB.
- api.php?action=query&list=allimages&aifrom=B [open in sandbox]
- أظهر قائمة الملفات التي تم تحميلها مؤخرا، على غرار خاص:ملفات جديدة.
- api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older [open in sandbox]
- أظهر قائمة الملفات من نوع MIME image/png أو image/gif
- api.php?action=query&list=allimages&aimime=image/png|image/gif [open in sandbox]
- عرض معلومات حول 4 ملفات تبدأ بالحرف T.
- api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo [open in sandbox]
list=alllinks (al)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
تعداد كافة الروابط التي تشير إلى نطاق معين.
- alcontinue
When more results are available, use this to continue.
- alfrom
عنوان الرابط لبدء التعداد منه.
- alto
عنوان الرابط لوقف التعداد منه.
- alprefix
البحث عن كل العناوين المرتبطة التي تبدأ بهذه القيمة.
- alunique
Only show distinct linked titles. Cannot be used with alprop=ids. When used as a generator, yields target pages instead of source pages.
- Type: boolean (details)
- alprop
أي قطعة من المعلومات تريد تضمينها:
- ids
- تضيف معرف الصفحة للصفحة المرتبطة (لا يمكن استخدامها مع alunique).
- title
- تضيف عنوان الرابط.
- Values (separate with | or alternative): ids، title
- Default: title
- alnamespace
نطاق للتعداد.
- One of the following values: -2، -1، 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- Default: 0
- allimit
كم عدد مجموع البنود للعودة.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- aldir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- List linked titles, including missing ones, with page IDs they are from, starting at B.
- api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title [open in sandbox]
- List unique linked titles.
- api.php?action=query&list=alllinks&alunique=&alfrom=B [open in sandbox]
- Gets all linked titles, marking the missing ones.
- api.php?action=query&generator=alllinks&galunique=&galfrom=B [open in sandbox]
- يحصل على الصفحات التي تحتوي على وصلات.
- api.php?action=query&generator=alllinks&galfrom=B [open in sandbox]
list=allpages (ap)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
تعداد كافة الصفحات بشكل متتالي في نطاق معين.
- apfrom
The page title to start enumerating from.
- apcontinue
When more results are available, use this to continue.
- apto
عنوان الصفحة لإيقاف التعداد منه.
- apprefix
البحث عن كل عناوين الصفحات التي تبدأ بهذه القيمة.
- apnamespace
نطاق للتعداد.
- One of the following values: 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- Default: 0
- apfilterredir
أي الصفحات للعرض.
- One of the following values: all، redirects، nonredirects
- Default: all
- apminsize
Limit to pages with at least this many bytes.
- Type: integer
- apmaxsize
Limit to pages with at most this many bytes.
- Type: integer
- apprtype
Limit to protected pages only.
- Values (separate with | or alternative): edit، move، upload
- apprlevel
Filter protections based on protection level (must be used with apprtype= parameter).
- Values (separate with | or alternative): Can be empty, or autoconfirmed، sysop
- apprfiltercascade
Filter protections based on cascadingness (ignored when apprtype isn't set).
- One of the following values: cascading، noncascading، all
- Default: all
- aplimit
كم عدد مجموع الصفحات للعودة.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- apdir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- apfilterlanglinks
Filter based on whether a page has langlinks. Note that this may not consider langlinks added by extensions.
- One of the following values: withlanglinks، withoutlanglinks، all
- Default: all
- apprexpiry
Which protection expiry to filter the page on:
- indefinite
- Get only pages with indefinite protection expiry.
- definite
- Get only pages with a definite (specific) protection expiry.
- all
- Get pages with any protections expiry.
- One of the following values: indefinite، definite، all
- Default: all
- عرض قائمة من الصفحات التي تبدأ بالحرف B.
- api.php?action=query&list=allpages&apfrom=B [open in sandbox]
- عرض معلومات حول 4 صفحات تبدأ بالحرف T.
- api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info [open in sandbox]
- Show content of first 2 non-redirect pages beginning at Re.
- api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content [open in sandbox]
list=allredirects (ar)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
List all redirects to a namespace.
- arcontinue
When more results are available, use this to continue.
- arfrom
عنوان التحويلة لبدء التعداد منه.
- arto
عنوان التحويلة لإيقاف التعداد منه.
- arprefix
ابحث عن جميع عناوين الصفحات المستهدفة التي تبدأ بهذه القيمة.
- arunique
Only show distinct target pages. Cannot be used with arprop=ids|fragment|interwiki. When used as a generator, yields target pages instead of source pages.
- Type: boolean (details)
- arprop
أي قطعة من المعلومات تريد تضمينها:
- ids
- تضيف معرف الصفحة لصفحة التحويل (لا يمكن استخدامها مع arunique).
- title
- تضيف عنوان التحويلة.
- fragment
- Adds the fragment from the redirect, if any (cannot be used with arunique).
- interwiki
- Adds the interwiki prefix from the redirect, if any (cannot be used with arunique).
- Values (separate with | or alternative): ids، title، fragment، interwiki
- Default: title
- arnamespace
نطاق للتعداد.
- One of the following values: -2، -1، 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- Default: 0
- arlimit
كم عدد مجموع البنود للعودة.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- ardir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- List target pages, including missing ones, with page IDs they are from, starting at B.
- api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title [open in sandbox]
- List unique target pages.
- api.php?action=query&list=allredirects&arunique=&arfrom=B [open in sandbox]
- Gets all target pages, marking the missing ones.
- api.php?action=query&generator=allredirects&garunique=&garfrom=B [open in sandbox]
- يحصل على الصفحات التي تحتوي على تحويلات.
- api.php?action=query&generator=allredirects&garfrom=B [open in sandbox]
list=allrevisions (arv)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
اعرض كل المراجعات.
- arvprop
Which properties to get for each revision:
- ids
- The ID of the revision.
- flags
- Revision flags (minor).
- timestamp
- The timestamp of the revision.
- user
- User that made the revision.
- userid
- User ID of the revision creator.
- size
- Length (bytes) of the revision.
- sha1
- SHA-1 (base 16) of the revision.
- contentmodel
- Content model ID of the revision.
- comment
- Comment by the user for the revision.
- parsedcomment
- Parsed comment by the user for the revision.
- content
- Text of the revision.
- tags
- Tags for the revision.
- parsetree
- The XML parse tree of revision content (requires content model
wikitext
).
- Values (separate with | or alternative): ids، flags، timestamp، user، userid، size، sha1، contentmodel، comment، parsedcomment، content، tags، parsetree
- Default: ids|timestamp|flags|comment|user
- arvlimit
Limit how many revisions will be returned.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- arvexpandtemplates
Expand templates in revision content (requires arvprop=content).
- Type: boolean (details)
- arvgeneratexml
- Deprecated.
Generate XML parse tree for revision content (requires arvprop=content; replaced by arvprop=parsetree).
- Type: boolean (details)
- arvparse
Parse revision content (requires arvprop=content). For performance reasons, if this option is used, arvlimit is enforced to 1.
- Type: boolean (details)
- arvsection
Only retrieve the content of this section number.
- arvdiffto
Revision ID to diff each revision to. Use prev, next and cur for the previous, next and current revision respectively.
- arvdifftotext
Text to diff each revision to. Only diffs a limited number of revisions. Overrides arvdiffto. If arvsection is set, only that section will be diffed against this text.
- arvdifftotextpst
Perform a pre-save transform on the text before diffing it. Only valid when used with arvdifftotext.
- Type: boolean (details)
- arvcontentformat
Serialization format used for arvdifftotext and expected for output of content.
- One of the following values: text/x-wiki، text/javascript، application/json، text/css، text/plain
- arvuser
Only list revisions by this user.
- Type: user name
- arvnamespace
Only list pages in this namespace.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- arvstart
التصنيف الذي يبدأ التعداد منه.
- Type: timestamp (allowed formats)
- arvend
الطابع الزمني الذي يقف التعداد منه.
- Type: timestamp (allowed formats)
- arvdir
In which direction to enumerate:
- newer
- List oldest first. Note: arvstart has to be before arvend.
- older
- List newest first (default). Note: arvstart has to be later than arvend.
- One of the following values: newer، older
- Default: older
- arvexcludeuser
Don't list revisions by this user.
- Type: user name
- arvcontinue
When more results are available, use this to continue.
- arvgeneratetitles
عندما يُستخدَم كمولد، ولد عناوين بدلا من معرفات المراجعات.
- Type: boolean (details)
- List the last 50 contributions by user Example.
- api.php?action=query&list=allrevisions&arvuser=Example&arvlimit=50 [open in sandbox]
- List the first 50 revisions in the main namespace.
- api.php?action=query&list=allrevisions&arvdir=newer&arvlimit=50 [open in sandbox]
list=alltransclusions (at)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
List all transclusions (pages embedded using {{x}}), including non-existing.
- atcontinue
When more results are available, use this to continue.
- atfrom
The title of the transclusion to start enumerating from.
- atto
The title of the transclusion to stop enumerating at.
- atprefix
Search for all transcluded titles that begin with this value.
- atunique
Only show distinct transcluded titles. Cannot be used with atprop=ids. When used as a generator, yields target pages instead of source pages.
- Type: boolean (details)
- atprop
Which pieces of information to include:
- ids
- Adds the page ID of the transcluding page (cannot be used with atunique).
- title
- Adds the title of the transclusion.
- Values (separate with | or alternative): ids، title
- Default: title
- atnamespace
The namespace to enumerate.
- One of the following values: -2، -1، 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- Default: 10
- atlimit
How many total items to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- atdir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- List transcluded titles, including missing ones, with page IDs they are from, starting at B.
- api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title [open in sandbox]
- List unique transcluded titles.
- api.php?action=query&list=alltransclusions&atunique=&atfrom=B [open in sandbox]
- Gets all transcluded titles, marking the missing ones.
- api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B [open in sandbox]
- Gets pages containing the transclusions.
- api.php?action=query&generator=alltransclusions&gatfrom=B [open in sandbox]
list=allusers (au)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Enumerate all registered users.
- aufrom
The user name to start enumerating from.
- auto
The user name to stop enumerating at.
- auprefix
Search for all users that begin with this value.
- audir
Direction to sort in.
- One of the following values: ascending، descending
- Default: ascending
- augroup
Only include users in the given groups.
- Values (separate with | or alternative): bot، sysop، bureaucrat
- auexcludegroup
Exclude users in the given groups.
- Values (separate with | or alternative): bot، sysop، bureaucrat
- aurights
Only include users with the given rights. Does not include rights granted by implicit or auto-promoted groups like *, user, or autoconfirmed.
- Values (separate with | or alternative): apihighlimits، applychangetags، autoconfirmed، autocreateaccount، autopatrol، bigdelete، block، blockemail، bot، browsearchive، changetags، createaccount، createpage، createtalk، delete، deletechangetags، deletedhistory، deletedtext، deletelogentry، deleterevision، edit، editcontentmodel، editinterface، editprotected، editmyoptions، editmyprivateinfo، editmyusercss، editmyuserjs، editmywatchlist، editsemiprotected، editusercss، edituserjs، hideuser، import، importupload، ipblock-exempt، managechangetags، markbotedits، mergehistory، minoredit، move، movefile، move-categorypages، move-rootuserpages، move-subpages، nominornewtalk، noratelimit، override-export-depth، pagelang، patrol، patrolmarks، protect، purge، read، reupload، reupload-own، reupload-shared، rollback، sendemail، siteadmin، suppressionlog، suppressredirect، suppressrevision، unblockself، undelete، unwatchedpages، upload، upload_by_url، userrights، userrights-interwiki، viewmyprivateinfo، viewmywatchlist، viewsuppressed، writeapi
- Maximum number of values is ٥٠ (٥٠٠ for bots).
- auprop
Which pieces of information to include:
- blockinfo
- Adds the information about a current block on the user.
- groups
- Lists groups that the user is in. This uses more server resources and may return fewer results than the limit.
- implicitgroups
- Lists all the groups the user is automatically in.
- rights
- Lists rights that the user has.
- editcount
- Adds the edit count of the user.
- registration
- Adds the timestamp of when the user registered if available (may be blank).
- centralids
- Adds the central IDs and attachment status for the user.
- Values (separate with | or alternative): blockinfo، groups، implicitgroups، rights، editcount، registration، centralids
- aulimit
How many total user names to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- auwitheditsonly
Only list users who have made edits.
- Type: boolean (details)
- auactiveusers
Only list users active in the last 30 days.
- Type: boolean (details)
- auattachedwiki
With auprop=centralids, also indicate whether the user is attached with the wiki identified by this ID.
- List users starting at Y.
- api.php?action=query&list=allusers&aufrom=Y [open in sandbox]
list=backlinks (bl)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Find all pages that link to the given page.
- bltitle
Title to search. Cannot be used together with blpageid.
- blpageid
Page ID to search. Cannot be used together with bltitle.
- Type: integer
- blcontinue
When more results are available, use this to continue.
- blnamespace
The namespace to enumerate.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- bldir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- blfilterredir
How to filter for redirects. If set to nonredirects when blredirect is enabled, this is only applied to the second level.
- One of the following values: all، redirects، nonredirects
- Default: all
- bllimit
How many total pages to return. If blredirect is enabled, the limit applies to each level separately (which means up to 2 * bllimit results may be returned).
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- blredirect
If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.
- Type: boolean (details)
- Show links to Main page.
- api.php?action=query&list=backlinks&bltitle=Main%20Page [open in sandbox]
- Get information about pages linking to Main page.
- api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info [open in sandbox]
list=blocks (bk)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
List all blocked users and IP addresses.
- bkstart
The timestamp to start enumerating from.
- Type: timestamp (allowed formats)
- bkend
The timestamp to stop enumerating at.
- Type: timestamp (allowed formats)
- bkdir
In which direction to enumerate:
- newer
- List oldest first. Note: bkstart has to be before bkend.
- older
- List newest first (default). Note: bkstart has to be later than bkend.
- One of the following values: newer، older
- Default: older
- bkids
List of block IDs to list (optional).
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- bkusers
List of users to search for (optional).
- Type: list of user names
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- bkip
Get all blocks applying to this IP address or CIDR range, including range blocks. Cannot be used together with bkusers. CIDR ranges broader than IPv4/16 or IPv6/19 are not accepted.
- bklimit
The maximum number of blocks to list.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- bkprop
Which properties to get:
- id
- Adds the ID of the block.
- user
- Adds the username of the blocked user.
- userid
- Adds the user ID of the blocked user.
- by
- Adds the username of the blocking user.
- byid
- Adds the user ID of the blocking user.
- timestamp
- Adds the timestamp of when the block was given.
- expiry
- Adds the timestamp of when the block expires.
- reason
- Adds the reason given for the block.
- range
- Adds the range of IP addresses affected by the block.
- flags
- Tags the ban with (autoblock, anononly, etc.).
- Values (separate with | or alternative): id، user، userid، by، byid، timestamp، expiry، reason، range، flags
- Default: id|user|by|timestamp|expiry|reason|flags
- bkshow
Show only items that meet these criteria. For example, to see only indefinite blocks on IP addresses, set bkshow=ip|!temp.
- Values (separate with | or alternative): account، !account، temp، !temp، ip، !ip، range، !range
- bkcontinue
When more results are available, use this to continue.
- قائمة المنع.
- api.php?action=query&list=blocks [open in sandbox]
- List blocks of users Alice and Bob.
- api.php?action=query&list=blocks&bkusers=Alice|Bob [open in sandbox]
list=categorymembers (cm)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
List all pages in a given category.
- cmtitle
Which category to enumerate (required). Must include the تصنيف: prefix. Cannot be used together with cmpageid.
- cmpageid
Page ID of the category to enumerate. Cannot be used together with cmtitle.
- Type: integer
- cmprop
Which pieces of information to include:
- ids
- Adds the page ID.
- title
- Adds the title and namespace ID of the page.
- sortkey
- Adds the sortkey used for sorting in the category (hexadecimal string).
- sortkeyprefix
- Adds the sortkey prefix used for sorting in the category (human-readable part of the sortkey).
- type
- Adds the type that the page has been categorised as (page, subcat or file).
- timestamp
- Adds the timestamp of when the page was included.
- Values (separate with | or alternative): ids، title، sortkey، sortkeyprefix، type، timestamp
- Default: ids|title
- cmnamespace
Only include pages in these namespaces. Note that cmtype=subcat or cmtype=file may be used instead of cmnamespace=14 or 6.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- cmtype
Which type of category members to include. Ignored when cmsort=timestamp is set.
- Values (separate with | or alternative): page، subcat، file
- Default: page|subcat|file
- cmcontinue
When more results are available, use this to continue.
- cmlimit
The maximum number of pages to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- cmsort
Property to sort by.
- One of the following values: sortkey، timestamp
- Default: sortkey
- cmdir
In which direction to sort.
- One of the following values: asc، desc، ascending، descending، newer، older
- Default: ascending
- cmstart
Timestamp to start listing from. Can only be used with cmsort=timestamp.
- Type: timestamp (allowed formats)
- cmend
Timestamp to end listing at. Can only be used with cmsort=timestamp.
- Type: timestamp (allowed formats)
- cmstarthexsortkey
Sortkey to start listing from, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.
- cmendhexsortkey
Sortkey to end listing at, as returned by cmprop=sortkey. Can only be used with cmsort=sortkey.
- cmstartsortkeyprefix
Sortkey prefix to start listing from. Can only be used with cmsort=sortkey. Overrides cmstarthexsortkey.
- cmendsortkeyprefix
Sortkey prefix to end listing before (not at; if this value occurs it will not be included!). Can only be used with cmsort=sortkey. Overrides cmendhexsortkey.
- cmstartsortkey
- Deprecated.
Use cmstarthexsortkey instead.
- cmendsortkey
- Deprecated.
Use cmendhexsortkey instead.
- Get first 10 pages in Category:Physics.
- api.php?action=query&list=categorymembers&cmtitle=Category:Physics [open in sandbox]
- Get page info about first 10 pages in Category:Physics.
- api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info [open in sandbox]
list=deletedrevs (dr)
- This module is deprecated.
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
List deleted revisions.
Operates in three modes:
- List deleted revisions for the given titles, sorted by timestamp.
- List deleted contributions for the given user, sorted by timestamp (no titles specified).
- List all deleted revisions in the given namespace, sorted by title and timestamp (no titles specified, druser not set).
Certain parameters only apply to some modes and are ignored in others.
- drstart
The timestamp to start enumerating from.
- Modes: 1، 2
- Type: timestamp (allowed formats)
- drend
The timestamp to stop enumerating at.
- Modes: 1، 2
- Type: timestamp (allowed formats)
- drdir
In which direction to enumerate:
- newer
- List oldest first. Note: drstart has to be before drend.
- older
- List newest first (default). Note: drstart has to be later than drend.
- Modes: 1، 3
- One of the following values: newer، older
- Default: older
- drfrom
Start listing at this title.
- Modes: 3
- drto
Stop listing at this title.
- Modes: 3
- drprefix
Search for all page titles that begin with this value.
- Modes: 3
- drunique
List only one revision for each page.
- Modes: 3
- Type: boolean (details)
- drnamespace
Only list pages in this namespace.
- Modes: 3
- One of the following values: 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- Default: 0
- drtag
Only list revisions tagged with this tag.
- druser
Only list revisions by this user.
- Type: user name
- drexcludeuser
Don't list revisions by this user.
- Type: user name
- drprop
Which properties to get:
- revid
- Adds the revision ID of the deleted revision.
- parentid
- Adds the revision ID of the previous revision to the page.
- user
- Adds the user who made the revision.
- userid
- Adds the ID of the user who made the revision.
- comment
- Adds the comment of the revision.
- parsedcomment
- Adds the parsed comment of the revision.
- minor
- Tags if the revision is minor.
- len
- Adds the length (bytes) of the revision.
- sha1
- Adds the SHA-1 (base 16) of the revision.
- content
- Adds the content of the revision.
- token
- Deprecated. Gives the edit token.
- tags
- Tags for the revision.
- Values (separate with | or alternative): revid، parentid، user، userid، comment، parsedcomment، minor، len، sha1، content، token، tags
- Default: user|comment
- drlimit
The maximum amount of revisions to list.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- drcontinue
When more results are available, use this to continue.
- List the last deleted revisions of the pages Main Page and Talk:Main Page, with content (mode 1).
- api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content [open in sandbox]
- List the last 50 deleted contributions by Bob (mode 2).
- api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50 [open in sandbox]
- List the first 50 deleted revisions in the main namespace (mode 3).
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50 [open in sandbox]
- List the first 50 deleted pages in the نقاش namespace (mode 3).
- api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique= [open in sandbox]
list=embeddedin (ei)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Find all pages that embed (transclude) the given title.
- eititle
Title to search. Cannot be used together with eipageid.
- eipageid
Page ID to search. Cannot be used together with eititle.
- Type: integer
- eicontinue
When more results are available, use this to continue.
- einamespace
The namespace to enumerate.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- eidir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- eifilterredir
How to filter for redirects.
- One of the following values: all، redirects، nonredirects
- Default: all
- eilimit
How many total pages to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- Show pages transcluding Template:Stub.
- api.php?action=query&list=embeddedin&eititle=Template:Stub [open in sandbox]
- Get information about pages transcluding Template:Stub.
- api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info [open in sandbox]
list=exturlusage (eu)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Enumerate pages that contain a given URL.
- euprop
Which pieces of information to include:
- ids
- Adds the ID of page.
- title
- Adds the title and namespace ID of the page.
- url
- Adds the URL used in the page.
- Values (separate with | or alternative): ids، title، url
- Default: ids|title|url
- euoffset
When more results are available, use this to continue.
- Type: integer
- euprotocol
Protocol of the URL. If empty and euquery is set, the protocol is http. Leave both this and euquery empty to list all external links.
- One of the following values: Can be empty, or bitcoin، ftp، ftps، geo، git، gopher، http، https، irc، ircs، magnet، mailto، mms، news، nntp، redis، sftp، sip، sips، sms، ssh، svn، tel، telnet، urn، worldwind، xmpp
- Default: (empty)
- euquery
Search string without protocol. See Special:LinkSearch. Leave empty to list all external links.
- eunamespace
The page namespaces to enumerate.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- eulimit
How many pages to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- euexpandurl
Expand protocol-relative URLs with the canonical protocol.
- Type: boolean (details)
list=filearchive (fa)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Enumerate all deleted files sequentially.
- fafrom
The image title to start enumerating from.
- fato
The image title to stop enumerating at.
- faprefix
Search for all image titles that begin with this value.
- fadir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- fasha1
SHA1 hash of image. Overrides fasha1base36.
- fasha1base36
SHA1 hash of image in base 36 (used in MediaWiki).
- faprop
Which image information to get:
- sha1
- Adds SHA-1 hash for the image.
- timestamp
- Adds timestamp for the uploaded version.
- user
- Adds user who uploaded the image version.
- size
- Adds the size of the image in bytes and the height, width and page count (if applicable).
- dimensions
- Alias for size.
- description
- Adds description of the image version.
- parseddescription
- Parse the description of the version.
- mime
- Adds MIME of the image.
- mediatype
- Adds the media type of the image.
- metadata
- Lists Exif metadata for the version of the image.
- bitdepth
- Adds the bit depth of the version.
- archivename
- Adds the filename of the archive version for non-latest versions.
- Values (separate with | or alternative): sha1، timestamp، user، size، dimensions، description، parseddescription، mime، mediatype، metadata، bitdepth، archivename
- Default: timestamp
- falimit
How many images to return in total.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- facontinue
When more results are available, use this to continue.
- Show a list of all deleted files.
- api.php?action=query&list=filearchive [open in sandbox]
list=imageusage (iu)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Find all pages that use the given image title.
- iutitle
Title to search. Cannot be used together with iupageid.
- iupageid
Page ID to search. Cannot be used together with iutitle.
- Type: integer
- iucontinue
When more results are available, use this to continue.
- iunamespace
The namespace to enumerate.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- iudir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- iufilterredir
How to filter for redirects. If set to nonredirects when iuredirect is enabled, this is only applied to the second level.
- One of the following values: all، redirects، nonredirects
- Default: all
- iulimit
How many total pages to return. If iuredirect is enabled, the limit applies to each level separately (which means up to 2 * iulimit results may be returned).
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- iuredirect
If linking page is a redirect, find all pages that link to that redirect as well. Maximum limit is halved.
- Type: boolean (details)
- Show pages using File:Albert Einstein Head.jpg.
- api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg [open in sandbox]
- Get information about pages using File:Albert Einstein Head.jpg.
- api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info [open in sandbox]
list=iwbacklinks (iwbl)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Find all pages that link to the given interwiki link.
Can be used to find all links with a prefix, or all links to a title (with a given prefix). Using neither parameter is effectively "all interwiki links".
- iwblprefix
Prefix for the interwiki.
- iwbltitle
Interwiki link to search for. Must be used with iwblblprefix.
- iwblcontinue
When more results are available, use this to continue.
- iwbllimit
How many total pages to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- iwblprop
Which properties to get:
- iwprefix
- Adds the prefix of the interwiki.
- iwtitle
- Adds the title of the interwiki.
- Values (separate with | or alternative): iwprefix، iwtitle
- Default: (empty)
- iwbldir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- Get pages linking to wikibooks:Test.
- api.php?action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks [open in sandbox]
- Get information about pages linking to wikibooks:Test.
- api.php?action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info [open in sandbox]
list=langbacklinks (lbl)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Find all pages that link to the given language link.
Can be used to find all links with a language code, or all links to a title (with a given language). Using neither parameter is effectively "all language links".
Note that this may not consider language links added by extensions.
- lbllang
Language for the language link.
- lbltitle
Language link to search for. Must be used with lbllang.
- lblcontinue
When more results are available, use this to continue.
- lbllimit
How many total pages to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- lblprop
Which properties to get:
- lllang
- Adds the language code of the language link.
- lltitle
- Adds the title of the language link.
- Values (separate with | or alternative): lllang، lltitle
- Default: (empty)
- lbldir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- Get pages linking to fr:Test.
- api.php?action=query&list=langbacklinks&lbltitle=Test&lbllang=fr [open in sandbox]
- Get information about pages linking to fr:Test.
- api.php?action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info [open in sandbox]
list=logevents (le)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Get events from logs.
- leprop
Which properties to get:
- ids
- Adds the ID of the log event.
- title
- Adds the title of the page for the log event.
- type
- Adds the type of log event.
- user
- Adds the user responsible for the log event.
- userid
- Adds the user ID who was responsible for the log event.
- timestamp
- Adds the timestamp for the log event.
- comment
- Adds the comment of the log event.
- parsedcomment
- Adds the parsed comment of the log event.
- details
- Lists additional details about the log event.
- tags
- Lists tags for the log event.
- Values (separate with | or alternative): ids، title، type، user، userid، timestamp، comment، parsedcomment، details، tags
- Default: ids|title|type|user|timestamp|comment|details
- letype
Filter log entries to only this type.
- One of the following values: Can be empty, or block، protect، rights، delete، upload، move، import، patrol، merge، suppress، tag، managetags، contentmodel، newusers
- leaction
Filter log actions to only this action. Overrides letype. In the list of possible values, values with the asterisk wildcard such as action/* can have different strings after the slash (/).
- One of the following values: block/block، block/reblock، block/unblock، contentmodel/change، contentmodel/new، delete/delete، delete/delete_redir، delete/event، delete/restore، delete/revision، import/interwiki، import/upload، managetags/activate، managetags/create، managetags/deactivate، managetags/delete، merge/merge، move/move، move/move_redir، patrol/patrol، patrol/autopatrol، protect/modify، protect/move_prot، protect/protect، protect/unprotect، rights/autopromote، rights/rights، suppress/block، suppress/delete، suppress/event، suppress/reblock، suppress/revision، tag/update، upload/overwrite، upload/revert، upload/upload، newusers/newusers، newusers/create، newusers/create2، newusers/byemail، newusers/autocreate
- lestart
The timestamp to start enumerating from.
- Type: timestamp (allowed formats)
- leend
The timestamp to end enumerating.
- Type: timestamp (allowed formats)
- ledir
In which direction to enumerate:
- newer
- List oldest first. Note: lestart has to be before leend.
- older
- List newest first (default). Note: lestart has to be later than leend.
- One of the following values: newer، older
- Default: older
- leuser
Filter entries to those made by the given user.
- Type: user name
- letitle
Filter entries to those related to a page.
- lenamespace
Filter entries to those in the given namespace.
- One of the following values: -2، -1، 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- leprefix
Filter entries that start with this prefix.
- letag
Only list event entries tagged with this tag.
- lelimit
How many total event entries to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- lecontinue
When more results are available, use this to continue.
- List recent log events.
- api.php?action=query&list=logevents [open in sandbox]
list=mystashedfiles (msf)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Get a list of files in the current user's upload stash.
- msfprop
أي الخصائص تريد لجلب للملفات.
- size
- جلب حجم الملف وأبعاد الصورة.
- type
- Fetch the file's MIME type and media type.
- Values (separate with | or alternative): size، type
- Default: (empty)
- msflimit
How many files to get.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- msfcontinue
When more results are available, use this to continue.
- Get the filekey, file size, and pixel size of files in the current user's upload stash.
- api.php?action=query&list=mystashedfiles&msfprop=size [open in sandbox]
list=pagepropnames (ppn)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
List all page property names in use on the wiki.
- ppncontinue
When more results are available, use this to continue.
- ppnlimit
The maximum number of names to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- Get first 10 property names.
- api.php?action=query&list=pagepropnames [open in sandbox]
list=pageswithprop (pwp)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
List all pages using a given page property.
- pwppropname
Page property for which to enumerate pages (action=query&list=pagepropnames returns page property names in use).
- This parameter is required.
- pwpprop
Which pieces of information to include:
- ids
- Adds the page ID.
- title
- Adds the title and namespace ID of the page.
- value
- Adds the value of the page property.
- Values (separate with | or alternative): ids، title، value
- Default: ids|title
- pwpcontinue
When more results are available, use this to continue.
- pwplimit
The maximum number of pages to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- pwpdir
In which direction to sort.
- One of the following values: ascending، descending
- Default: ascending
- List the first 10 pages using
{{DISPLAYTITLE:}}
. - api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value [open in sandbox]
- Get additional information about the first 10 pages using
__NOTOC__
. - api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info [open in sandbox]
list=prefixsearch (ps)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Perform a prefix search for page titles.
Despite the similarity in names, this module is not intended to be equivalent to Special:PrefixIndex; for that, see action=query&list=allpages with the apprefix parameter. The purpose of this module is similar to action=opensearch: to take user input and provide the best-matching titles. Depending on the search engine backend, this might include typo correction, redirect avoidance, or other heuristics.
- pssearch
Search string.
- This parameter is required.
- psnamespace
Namespaces to search.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- Default: 0
- pslimit
Maximum number of results to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- psoffset
When more results are available, use this to continue.
- Type: integer
- Default: 0
- Search for page titles beginning with meaning.
- api.php?action=query&list=prefixsearch&pssearch=meaning [open in sandbox]
list=protectedtitles (pt)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
List all titles protected from creation.
- ptnamespace
Only list titles in these namespaces.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- ptlevel
Only list titles with these protection levels.
- Values (separate with | or alternative): autoconfirmed، sysop
- ptlimit
How many total pages to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- ptdir
In which direction to enumerate:
- newer
- List oldest first. Note: ptstart has to be before ptend.
- older
- List newest first (default). Note: ptstart has to be later than ptend.
- One of the following values: newer، older
- Default: older
- ptstart
Start listing at this protection timestamp.
- Type: timestamp (allowed formats)
- ptend
Stop listing at this protection timestamp.
- Type: timestamp (allowed formats)
- ptprop
Which properties to get:
- timestamp
- Adds the timestamp of when protection was added.
- user
- Adds the user that added the protection.
- userid
- Adds the user ID that added the protection.
- comment
- Adds the comment for the protection.
- parsedcomment
- Adds the parsed comment for the protection.
- expiry
- Adds the timestamp of when the protection will be lifted.
- level
- Adds the protection level.
- Values (separate with | or alternative): timestamp، user، userid، comment، parsedcomment، expiry، level
- Default: timestamp|level
- ptcontinue
When more results are available, use this to continue.
- List protected titles.
- api.php?action=query&list=protectedtitles [open in sandbox]
- Find links to protected titles in the main namespace.
- api.php?action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere [open in sandbox]
list=querypage (qp)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Get a list provided by a QueryPage-based special page.
- qppage
The name of the special page. Note, this is case sensitive.
- This parameter is required.
- One of the following values: Ancientpages، BrokenRedirects، Deadendpages، DoubleRedirects، ListDuplicatedFiles، Listredirects، Lonelypages، Longpages، MediaStatistics، Mostcategories، Mostimages، Mostinterwikis، Mostlinkedcategories، Mostlinkedtemplates، Mostlinked، Mostrevisions، Fewestrevisions، Shortpages، Uncategorizedcategories، Uncategorizedpages، Uncategorizedimages، Uncategorizedtemplates، Unusedcategories، Unusedimages، Wantedcategories، Wantedfiles، Wantedpages، Wantedtemplates، Unwatchedpages، Unusedtemplates، Withoutinterwiki
- qpoffset
When more results are available, use this to continue.
- Type: integer
- Default: 0
- qplimit
Number of results to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
list=random (rn)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Get a set of random pages.
Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, Main Page is the first random page in the list, List of fictional monkeys will always be second, List of people on stamps of Vanuatu third, etc.
- rnnamespace
Return pages in these namespaces only.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- rnfilterredir
How to filter for redirects.
- One of the following values: all، redirects، nonredirects
- Default: nonredirects
- rnredirect
- Deprecated.
Use rnfilterredir=redirects instead.
- Type: boolean (details)
- rnlimit
Limit how many random pages will be returned.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 1
- rncontinue
When more results are available, use this to continue.
- Return two random pages from the main namespace.
- api.php?action=query&list=random&rnnamespace=0&rnlimit=2 [open in sandbox]
- Return page info about two random pages from the main namespace.
- api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info [open in sandbox]
list=recentchanges (rc)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Enumerate recent changes.
- rcstart
The timestamp to start enumerating from.
- Type: timestamp (allowed formats)
- rcend
The timestamp to end enumerating.
- Type: timestamp (allowed formats)
- rcdir
In which direction to enumerate:
- newer
- List oldest first. Note: rcstart has to be before rcend.
- older
- List newest first (default). Note: rcstart has to be later than rcend.
- One of the following values: newer، older
- Default: older
- rcnamespace
Filter changes to only these namespaces.
- Values (separate with | or alternative): -2، -1، 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- rcuser
Only list changes by this user.
- Type: user name
- rcexcludeuser
Don't list changes by this user.
- Type: user name
- rctag
Only list changes tagged with this tag.
- rcprop
Include additional pieces of information:
- user
- Adds the user responsible for the edit and tags if they are an IP.
- userid
- Adds the user ID responsible for the edit.
- comment
- Adds the comment for the edit.
- parsedcomment
- Adds the parsed comment for the edit.
- flags
- Adds flags for the edit.
- timestamp
- Adds timestamp of the edit.
- title
- Adds the page title of the edit.
- ids
- Adds the page ID, recent changes ID and the new and old revision ID.
- sizes
- Adds the new and old page length in bytes.
- redirect
- Tags edit if page is a redirect.
- patrolled
- Tags patrollable edits as being patrolled or unpatrolled.
- loginfo
- Adds log information (log ID, log type, etc) to log entries.
- tags
- Lists tags for the entry.
- sha1
- Adds the content checksum for entries associated with a revision.
- Values (separate with | or alternative): user، userid، comment، parsedcomment، flags، timestamp، title، ids، sizes، redirect، patrolled، loginfo، tags، sha1
- Default: title|timestamp|ids
- rctoken
- Deprecated.
Use action=query&meta=tokens instead.
- Values (separate with | or alternative): patrol
- rcshow
Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set rcshow=minor|!anon.
- Values (separate with | or alternative): minor، !minor، bot، !bot، anon، !anon، redirect، !redirect، patrolled، !patrolled، unpatrolled
- rclimit
How many total changes to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- rctype
Which types of changes to show.
- Values (separate with | or alternative): edit، new، log، external، categorize
- Default: edit|new|log|categorize
- rctoponly
Only list changes which are the latest revision.
- Type: boolean (details)
- rccontinue
When more results are available, use this to continue.
- rcgeneraterevisions
When being used as a generator, generate revision IDs rather than titles. Recent change entries without associated revision IDs (e.g. most log entries) will generate nothing.
- Type: boolean (details)
- List recent changes.
- api.php?action=query&list=recentchanges [open in sandbox]
- Get page info about recent unpatrolled changes.
- api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info [open in sandbox]
list=search (sr)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Perform a full text search.
- srsearch
Search for page titles or content matching this value. You can use the search string to invoke special search features, depending on what the wiki's search backend implements.
- This parameter is required.
- srnamespace
Search only within these namespaces.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- Default: 0
- srlimit
How many total pages to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- sroffset
When more results are available, use this to continue.
- Type: integer
- Default: 0
- srwhat
Which type of search to perform.
- One of the following values: title، text، nearmatch
- srinfo
Which metadata to return.
- Values (separate with | or alternative): totalhits، suggestion، rewrittenquery
- Default: totalhits|suggestion|rewrittenquery
- srprop
Which properties to return:
- size
- Adds the size of the page in bytes.
- wordcount
- Adds the word count of the page.
- timestamp
- Adds the timestamp of when the page was last edited.
- snippet
- Adds a parsed snippet of the page.
- titlesnippet
- Adds a parsed snippet of the page title.
- redirecttitle
- Adds the title of the matching redirect.
- redirectsnippet
- Adds a parsed snippet of the redirect title.
- sectiontitle
- Adds the title of the matching section.
- sectionsnippet
- Adds a parsed snippet of the matching section title.
- isfilematch
- Adds a boolean indicating if the search matched file content.
- categorysnippet
- Adds a parsed snippet of the matching category.
- score
- Deprecated and ignored.
- hasrelated
- Deprecated and ignored.
- Values (separate with | or alternative): size، wordcount، timestamp، snippet، titlesnippet، redirecttitle، redirectsnippet، sectiontitle، sectionsnippet، isfilematch، categorysnippet، score، hasrelated
- Default: size|wordcount|timestamp|snippet
- srinterwiki
Include interwiki results in the search, if available.
- Type: boolean (details)
- srenablerewrites
Enable internal query rewriting. Some search backends can rewrite the query into one its thinks gives better results, such as correcting spelling errors.
- Type: boolean (details)
- Search for meaning.
- api.php?action=query&list=search&srsearch=meaning [open in sandbox]
- Search texts for meaning.
- api.php?action=query&list=search&srwhat=text&srsearch=meaning [open in sandbox]
- Get page info about the pages returned for a search for meaning.
- api.php?action=query&generator=search&gsrsearch=meaning&prop=info [open in sandbox]
list=tags (tg)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
List change tags.
- tgcontinue
When more results are available, use this to continue.
- tglimit
The maximum number of tags to list.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- tgprop
Which properties to get:
- name
- Adds name of tag.
- displayname
- Adds system message for the tag.
- description
- Adds description of the tag.
- hitcount
- Adds the number of revisions and log entries that have this tag.
- defined
- Indicate whether the tag is defined.
- source
- Gets the sources of the tag, which may include extension for extension-defined tags and manual for tags that may be applied manually by users.
- active
- Whether the tag is still being applied.
- Values (separate with | or alternative): name، displayname، description، hitcount، defined، source، active
- Default: name
list=usercontribs (uc)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Get all edits by a user.
- uclimit
The maximum number of contributions to return.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- ucstart
The start timestamp to return from.
- Type: timestamp (allowed formats)
- ucend
The end timestamp to return to.
- Type: timestamp (allowed formats)
- uccontinue
When more results are available, use this to continue.
- ucuser
The users to retrieve contributions for. Cannot be used with ucuserids or ucuserprefix.
- Type: list of user names
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- ucuserids
The user IDs to retrieve contributions for. Cannot be used with ucuser or ucuserprefix.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- ucuserprefix
Retrieve contributions for all users whose names begin with this value. Cannot be used with ucuser or ucuserids.
- ucdir
In which direction to enumerate:
- newer
- List oldest first. Note: ucstart has to be before ucend.
- older
- List newest first (default). Note: ucstart has to be later than ucend.
- One of the following values: newer، older
- Default: older
- ucnamespace
Only list contributions in these namespaces.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- ucprop
Include additional pieces of information:
- ids
- Adds the page ID and revision ID.
- title
- Adds the title and namespace ID of the page.
- timestamp
- Adds the timestamp of the edit.
- comment
- Adds the comment of the edit.
- parsedcomment
- Adds the parsed comment of the edit.
- size
- Adds the new size of the edit.
- sizediff
- Adds the size delta of the edit against its parent.
- flags
- Adds flags of the edit.
- patrolled
- Tags patrolled edits.
- tags
- Lists tags for the edit.
- Values (separate with | or alternative): ids، title، timestamp، comment، parsedcomment، size، sizediff، flags، patrolled، tags
- Default: ids|title|timestamp|comment|size|flags
- ucshow
Show only items that meet these criteria, e.g. non minor edits only: ucshow=!minor.
If ucshow=patrolled or ucshow=!patrolled is set, revisions older than $wgRCMaxAge (7776000 seconds) won't be shown.
- Values (separate with | or alternative): minor، !minor، patrolled، !patrolled، top، !top، new، !new
- uctag
Only list revisions tagged with this tag.
- uctoponly
- Deprecated.
Only list changes which are the latest revision.
- Type: boolean (details)
- Show contributions of user Example.
- api.php?action=query&list=usercontribs&ucuser=Example [open in sandbox]
- Show contributions from all IP addresses with prefix 192.0.2..
- api.php?action=query&list=usercontribs&ucuserprefix=192.0.2. [open in sandbox]
list=users (us)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Get information about a list of users.
- usprop
Which pieces of information to include:
- blockinfo
- Tags if the user is blocked, by whom, and for what reason.
- groups
- Lists all the groups each user belongs to.
- groupmemberships
- Lists groups that each user has been explicitly assigned to, including the expiry date of each group membership.
- implicitgroups
- Lists all the groups a user is automatically a member of.
- rights
- Lists all the rights each user has.
- editcount
- Adds the user's edit count.
- registration
- Adds the user's registration timestamp.
- emailable
- Tags if the user can and wants to receive email through Special:Emailuser.
- gender
- Tags the gender of the user. Returns "male", "female", or "unknown".
- centralids
- Adds the central IDs and attachment status for the user.
- cancreate
- Indicates whether an account for valid but unregistered usernames can be created.
- Values (separate with | or alternative): blockinfo، groups، groupmemberships، implicitgroups، rights، editcount، registration، emailable، gender، centralids، cancreate
- usattachedwiki
With usprop=centralids, indicate whether the user is attached with the wiki identified by this ID.
- ususers
A list of users to obtain information for.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- ususerids
A list of user IDs to obtain information for.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- ustoken
- Deprecated.
Use action=query&meta=tokens instead.
- Values (separate with | or alternative): userrights
- Return information for user Example.
- api.php?action=query&list=users&ususers=Example&usprop=groups|editcount|gender [open in sandbox]
list=watchlist (wl)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Get recent changes to pages in the current user's watchlist.
- wlallrev
Include multiple revisions of the same page within given timeframe.
- Type: boolean (details)
- wlstart
The timestamp to start enumerating from.
- Type: timestamp (allowed formats)
- wlend
The timestamp to end enumerating.
- Type: timestamp (allowed formats)
- wlnamespace
Filter changes to only the given namespaces.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- wluser
Only list changes by this user.
- Type: user name
- wlexcludeuser
Don't list changes by this user.
- Type: user name
- wldir
In which direction to enumerate:
- newer
- List oldest first. Note: wlstart has to be before wlend.
- older
- List newest first (default). Note: wlstart has to be later than wlend.
- One of the following values: newer، older
- Default: older
- wllimit
How many total results to return per request.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- wlprop
Which additional properties to get:
- ids
- Adds revision IDs and page IDs.
- title
- Adds title of the page.
- flags
- Adds flags for the edit.
- user
- Adds the user who made the edit.
- userid
- Adds user ID of whoever made the edit.
- comment
- Adds comment of the edit.
- parsedcomment
- Adds parsed comment of the edit.
- timestamp
- Adds timestamp of the edit.
- patrol
- Tags edits that are patrolled.
- sizes
- Adds the old and new lengths of the page.
- notificationtimestamp
- Adds timestamp of when the user was last notified about the edit.
- loginfo
- Adds log information where appropriate.
- Values (separate with | or alternative): ids، title، flags، user، userid، comment، parsedcomment، timestamp، patrol، sizes، notificationtimestamp، loginfo
- Default: ids|title|flags
- wlshow
Show only items that meet these criteria. For example, to see only minor edits done by logged-in users, set wlshow=minor|!anon.
- Values (separate with | or alternative): minor، !minor، bot، !bot، anon، !anon، patrolled، !patrolled، unread، !unread
- wltype
Which types of changes to show:
- edit
- Regular page edits.
- new
- Page creations.
- log
- Log entries.
- external
- External changes.
- categorize
- Category membership changes.
- Values (separate with | or alternative): edit، new، log، external، categorize
- Default: edit|new|log|categorize
- wlowner
Used along with wltoken to access a different user's watchlist.
- Type: user name
- wltoken
A security token (available in the user's preferences) to allow access to another user's watchlist.
- wlcontinue
When more results are available, use this to continue.
- List the top revision for recently changed pages on the current user's watchlist.
- api.php?action=query&list=watchlist [open in sandbox]
- Fetch additional information about the top revision for recently changed pages on the current user's watchlist.
- api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment [open in sandbox]
- Fetch information about all recent changes to pages on the current user's watchlist.
- api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment [open in sandbox]
- Fetch page info for recently changed pages on the current user's watchlist.
- api.php?action=query&generator=watchlist&prop=info [open in sandbox]
- Fetch revision info for recent changes to pages on the current user's watchlist.
- api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user [open in sandbox]
- List the top revision for recently changed pages on the watchlist of user Example.
- api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC [open in sandbox]
list=watchlistraw (wr)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Get all pages on the current user's watchlist.
- wrcontinue
When more results are available, use this to continue.
- wrnamespace
Only list pages in the given namespaces.
- Values (separate with | or alternative): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- To specify all values, use *.
- wrlimit
How many total results to return per request.
- No more than ٥٠٠ (٥٬٠٠٠ for bots) allowed.
- Type: integer or max
- Default: 10
- wrprop
Which additional properties to get:
- changed
- Adds timestamp of when the user was last notified about the edit.
- Values (separate with | or alternative): changed
- wrshow
Only list items that meet these criteria.
- Values (separate with | or alternative): changed، !changed
- wrowner
Used along with wrtoken to access a different user's watchlist.
- Type: user name
- wrtoken
A security token (available in the user's preferences) to allow access to another user's watchlist.
- wrdir
The direction in which to list.
- One of the following values: ascending، descending
- Default: ascending
- wrfromtitle
Title (with namespace prefix) to begin enumerating from.
- wrtotitle
Title (with namespace prefix) to stop enumerating at.
- List pages on the current user's watchlist.
- api.php?action=query&list=watchlistraw [open in sandbox]
- Fetch page info for pages on the current user's watchlist.
- api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info [open in sandbox]
meta=allmessages (am)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Return messages from this site.
- ammessages
Which messages to output. * (default) means all messages.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- Default: *
- amprop
أي الخصائص تريد الحصول عليها:
- Values (separate with | or alternative): default
- amenableparser
Set to enable parser, will preprocess the wikitext of message (substitute magic words, handle templates, etc.).
- Type: boolean (details)
- amnocontent
If set, do not include the content of the messages in the output.
- Type: boolean (details)
- amincludelocal
Also include local messages, i.e. messages that don't exist in the software but do exist as in the ميدياويكي namespace. This lists all ميدياويكي-namespace pages, so it will also list those that aren't really messages such as Common.js.
- Type: boolean (details)
- amargs
Arguments to be substituted into message.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- amfilter
إرجاع الرسائل بالأسماء التي تحتوي على هذه السلسلة فقط.
- amcustomised
Return only messages in this customisation state.
- One of the following values: all، modified، unmodified
- Default: all
- amlang
إرجاع الرسائل بهذه اللغة.
- amfrom
إرجاع الرسائل ابتداء من هذه الرسالة.
- amto
إرجاع الرسائل التي تنتهي بهذه الرسالة.
- amtitle
Page name to use as context when parsing message (for amenableparser option).
- amprefix
إرجاء الرسائل بهذه البادئة.
- عرض رسائل تبدأ بipb-.
- api.php?action=query&meta=allmessages&refix=ipb- [open in sandbox]
- عرض رسائل august and mainpage باللغة الألمانية.
- api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de [open in sandbox]
meta=authmanagerinfo (ami)
- Source: MediaWiki
- License: GPL-2.0+
Retrieve information about the current authentication status.
- amisecuritysensitiveoperation
Test whether the user's current authentication status is sufficient for the specified security-sensitive operation.
- amirequestsfor
Fetch information about the authentication requests needed for the specified authentication action.
- One of the following values: login، login-continue، create، create-continue، link، link-continue، change، remove، unlink
- amimergerequestfields
Merge field information for all authentication requests into one array.
- Type: boolean (details)
- amimessageformat
Format to use for returning messages.
- One of the following values: html، wikitext، raw، none
- Default: wikitext
- Fetch the requests that may be used when beginning a login.
- api.php?action=query&meta=authmanagerinfo&amirequestsfor=login [open in sandbox]
- Fetch the requests that may be used when beginning a login, with form fields merged.
- api.php?action=query&meta=authmanagerinfo&amirequestsfor=login&amimergerequestfields=1 [open in sandbox]
- Test whether authentication is sufficient for action foo.
- api.php?action=query&meta=authmanagerinfo&amisecuritysensitiveoperation=foo [open in sandbox]
meta=filerepoinfo (fri)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Return meta information about image repositories configured on the wiki.
- friprop
Which repository properties to get (there may be more available on some wikis):
- apiurl
- URL to the repository API - helpful for getting image info from the host.
- name
- The key of the repository - used in e.g. $wgForeignFileRepos and imageinfo return values.
- displayname
- The human-readable name of the repository wiki.
- rooturl
- Root URL for image paths.
- local
- Whether that repository is the local one or not.
- Values (separate with | or alternative): name، displayname، rootUrl، local، url، thumbUrl، initialCapital، scriptDirUrl، scriptExtension، favicon، canUpload
- Default: name|displayname|rootUrl|local|url|thumbUrl|initialCapital|scriptDirUrl|scriptExtension|favicon|canUpload
- Get information about file repositories.
- api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname [open in sandbox]
meta=siteinfo (si)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Return general information about the site.
- siprop
Which information to get:
- general
- Overall system information.
- namespaces
- List of registered namespaces and their canonical names.
- namespacealiases
- List of registered namespace aliases.
- specialpagealiases
- List of special page aliases.
- magicwords
- List of magic words and their aliases.
- interwikimap
- Returns interwiki map (optionally filtered, optionally localised by using siinlanguagecode).
- dbrepllag
- Returns database server with the highest replication lag.
- statistics
- Returns site statistics.
- usergroups
- Returns user groups and the associated permissions.
- libraries
- Returns libraries installed on the wiki.
- extensions
- Returns extensions installed on the wiki.
- fileextensions
- Returns list of file extensions (file types) allowed to be uploaded.
- rightsinfo
- Returns wiki rights (license) information if available.
- restrictions
- Returns information on available restriction (protection) types.
- languages
- Returns a list of languages MediaWiki supports (optionally localised by using siinlanguagecode).
- languagevariants
- Returns a list of language codes for which LanguageConverter is enabled, and the variants supported for each.
- skins
- Returns a list of all enabled skins (optionally localised by using siinlanguagecode, otherwise in the content language).
- extensiontags
- Returns a list of parser extension tags.
- functionhooks
- Returns a list of parser function hooks.
- showhooks
- Returns a list of all subscribed hooks (contents of $wgHooks).
- variables
- Returns a list of variable IDs.
- protocols
- Returns a list of protocols that are allowed in external links.
- defaultoptions
- Returns the default values for user preferences.
- uploaddialog
- Returns the upload dialog configuration.
- Values (separate with | or alternative): general، namespaces، namespacealiases، specialpagealiases، magicwords، interwikimap، dbrepllag، statistics، usergroups، libraries، extensions، fileextensions، rightsinfo، restrictions، languages، languagevariants، skins، extensiontags، functionhooks، showhooks، variables، protocols، defaultoptions، uploaddialog
- Default: general
- sifilteriw
Return only local or only nonlocal entries of the interwiki map.
- One of the following values: local، !local
- sishowalldb
List all database servers, not just the one lagging the most.
- Type: boolean (details)
- sinumberingroup
Lists the number of users in user groups.
- Type: boolean (details)
- siinlanguagecode
Language code for localised language names (best effort) and skin names.
- Fetch site information.
- api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics [open in sandbox]
- Fetch a list of local interwiki prefixes.
- api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local [open in sandbox]
- Check the current replication lag.
- api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb= [open in sandbox]
meta=tokens
- Source: MediaWiki
- License: GPL-2.0+
Gets tokens for data-modifying actions.
- type
Types of token to request.
- Values (separate with | or alternative): createaccount، csrf، login، patrol، rollback، userrights، watch
- Default: csrf
- Retrieve a csrf token (the default).
- api.php?action=query&meta=tokens [open in sandbox]
- Retrieve a watch token and a patrol token.
- api.php?action=query&meta=tokens&type=watch|patrol [open in sandbox]
meta=userinfo (ui)
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Get information about the current user.
- uiprop
Which pieces of information to include:
- blockinfo
- Tags if the current user is blocked, by whom, and for what reason.
- hasmsg
- Adds a tag messages if the current user has pending messages.
- groups
- Lists all the groups the current user belongs to.
- groupmemberships
- Lists groups that the current user has been explicitly assigned to, including the expiry date of each group membership.
- implicitgroups
- Lists all the groups the current user is automatically a member of.
- rights
- Lists all the rights the current user has.
- changeablegroups
- Lists the groups the current user can add to and remove from.
- options
- Lists all preferences the current user has set.
- preferencestoken
- Deprecated. Get a token to change current user's preferences.
- editcount
- Adds the current user's edit count.
- ratelimits
- Lists all rate limits applying to the current user.
- Adds the user's email address and email authentication date.
- realname
- Adds the user's real name.
- acceptlang
- Echoes the
Accept-Language
header sent by the client in a structured format. - registrationdate
- Adds the user's registration date.
- unreadcount
- Adds the count of unread pages on the user's watchlist (maximum 999; returns 1000+ if more).
- centralids
- Adds the central IDs and attachment status for the user.
- Values (separate with | or alternative): blockinfo، hasmsg، groups، groupmemberships، implicitgroups، rights، changeablegroups، options، preferencestoken، editcount، ratelimits، email، realname، acceptlang، registrationdate، unreadcount، centralids
- uiattachedwiki
With uiprop=centralids, indicate whether the user is attached with the wiki identified by this ID.
- Get information about the current user.
- api.php?action=query&meta=userinfo [open in sandbox]
- Get additional information about the current user.
- api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg [open in sandbox]
action=removeauthenticationdata
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Remove authentication data for the current user.
- request
Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=remove.
- This parameter is required.
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Attempt to remove the current user's data for FooAuthenticationRequest.
- api.php?action=removeauthenticationdata&request=FooAuthenticationRequest&token=123ABC [open in sandbox]
action=resetpassword
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Send a password reset email to a user.
- user
User being reset.
- Type: user name
Email address of the user being reset.
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Send a password reset email to user Example.
- api.php?action=resetpassword&user=Example&token=123ABC [open in sandbox]
- Send a password reset email for all users with email address [email protected].
- api.php?action=resetpassword&[email protected]&token=123ABC [open in sandbox]
action=revisiondelete
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Delete and undelete revisions.
- type
Type of revision deletion being performed.
- This parameter is required.
- One of the following values: revision، archive، oldimage، filearchive، logging
- target
Page title for the revision deletion, if required for the type.
- ids
Identifiers for the revisions to be deleted.
- This parameter is required.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- hide
What to hide for each revision.
- Values (separate with | or alternative): content، comment، user
- show
What to unhide for each revision.
- Values (separate with | or alternative): content، comment، user
- suppress
Whether to suppress data from administrators as well as others.
- One of the following values: yes، no، nochange
- Default: nochange
- reason
Reason for the deletion or undeletion.
- tags
Tags to apply to the entry in the deletion log.
- Values (separate with | or alternative):
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Hide content for revision 12345 on the page Main Page.
- api.php?action=revisiondelete&target=Main%20Page&type=revision&ids=12345&hide=content&token=123ABC [open in sandbox]
- Hide all data on log entry 67890 with the reason BLP violation.
- api.php?action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&reason=BLP%20violation&token=123ABC [open in sandbox]
action=rollback
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Undo the last edit to the page.
If the last user who edited the page made multiple edits in a row, they will all be rolled back.
- title
Title of the page to roll back. Cannot be used together with pageid.
- pageid
Page ID of the page to roll back. Cannot be used together with title.
- Type: integer
- tags
Tags to apply to the rollback.
- Values (separate with | or alternative):
- user
Name of the user whose edits are to be rolled back.
- This parameter is required.
- Type: user name
- summary
Custom edit summary. If empty, default summary will be used.
- Default: (empty)
- markbot
Mark the reverted edits and the revert as bot edits.
- Type: boolean (details)
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
- One of the following values: watch، unwatch، preferences، nochange
- Default: preferences
- token
A "rollback" token retrieved from action=query&meta=tokens
For compatibility, the token used in the web UI is also accepted.
- This parameter is required.
- Roll back the last edits to page Main Page by user Example.
- api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC [open in sandbox]
- Roll back the last edits to page Main Page by IP user 192.0.2.5 with summary Reverting vandalism, and mark those edits and the revert as bot edits.
- api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1 [open in sandbox]
action=rsd
- Source: MediaWiki
- License: GPL-2.0+
Export an RSD (Really Simple Discovery) schema.
- Export the RSD schema.
- api.php?action=rsd [open in sandbox]
action=setnotificationtimestamp
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Update the notification timestamp for watched pages.
This affects the highlighting of changed pages in the watchlist and history, and the sending of email when the "أرسل إلي رسالة إلكترونية عند تعديل صفحة أو ملف في قائمة مراقبتي" preference is enabled.
- entirewatchlist
Work on all watched pages.
- Type: boolean (details)
- timestamp
Timestamp to which to set the notification timestamp.
- Type: timestamp (allowed formats)
- torevid
Revision to set the notification timestamp to (one page only).
- Type: integer
- newerthanrevid
Revision to set the notification timestamp newer than (one page only).
- Type: integer
- continue
When more results are available, use this to continue.
- titles
A list of titles to work on.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- pageids
A list of page IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- revids
A list of revision IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- 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.
- 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، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، redirects، revisions، search، templates، transcludedin، watchlist، watchlistraw
- redirects
Automatically resolve redirects in titles, pageids, and revids, and in pages returned by 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 gan، iu، kk، ku، shi، sr، tg، uz و zh.
- Type: boolean (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Reset the notification status for the entire watchlist.
- api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC [open in sandbox]
- Reset the notification status for Main page.
- api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC [open in sandbox]
- Set the notification timestamp for Main page so all edits since 1 January 2012 are unviewed.
- api.php?action=setnotificationtimestamp&titles=Main_page×tamp=2012-01-01T00:00:00Z&token=123ABC [open in sandbox]
- Reset the notification status for pages in the مستخدم namespace.
- api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC [open in sandbox]
action=setpagelanguage
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Changing the language of a page is not allowed on this wiki.
Enable $wgPageLanguageUseDB to use this action.
- title
Title of the page whose language you wish to change. Cannot be used together with pageid.
- pageid
Page ID of the page whose language you wish to change. Cannot be used together with title.
- Type: integer
- lang
Language code of the language to change the page to. Use default to reset the page to the wiki's default content language.
- This parameter is required.
- One of the following values: default، ab، ace، ady، ady-cyrl، aeb، aeb-arab، aeb-latn، af، ak، aln، am، an، ang، anp، ar، arc، arn، arq، ary، arz، as، ase، ast، atj، av، avk، awa، ay، az، azb، ba، ban، bar، bbc، bbc-latn، bcc، bcl، be، be-tarask، bg، bgn، bh، bho، bi، bjn، bm، bn، bo، bpy، bqi، br، brh، bs، bto، bug، bxr، ca، cbk-zam، cdo، ce، ceb، ch، chr، chy، ckb، co، cps، cr، crh، crh-cyrl، crh-latn، cs، csb، cu، cv، cy، da، de، de-at، de-ch، de-formal، din، diq، dsb، dtp، dty، dv، dz، ee، egl، el، eml، en، en-ca، en-gb، eo، es، et، eu، ext، fa، ff، fi، fit، fj، fo، fr، frc، frp، frr، fur، fy، ga، gag، gan، gan-hans، gan-hant، gd، gl، glk، gn، gom، gom-deva، gom-latn، gor، got، grc، gsw، gu، gv، ha، hak، haw، he، hi، hif، hif-latn، hil، hr، hrx، hsb، ht، hu، hy، ia، id، ie، ig، ii، ik، ike-cans، ike-latn، ilo، inh، io، is، it، iu، ja، jam، jbo، jut، jv، ka، kaa، kab، kbd، kbd-cyrl، kg، khw، ki، kiu، kk، kk-arab، kk-cn، kk-cyrl، kk-kz، kk-latn، kk-tr، kl، km، kn، ko، ko-kp، koi، krc، kri، krj، krl، ks، ks-arab، ks-deva، ksh، ku، ku-arab، ku-latn، kv، kw، ky، la، lad، lb، lbe، lez، lfn، lg، li، lij، liv، lki، lmo، ln، lo، loz، lrc، lt، ltg، lus، luz، lv، lzh، lzz، mai، map-bms، mdf، mg، mhr، mi، min، mk، ml، mn، mo، mr، mrj، ms، mt، mwl، my، myv، mzn، na، nah، nan، nap، nb، nds، nds-nl، ne، new، niu، nl، nl-informal، nn، nov، nrm، nso، nv، ny، oc، olo، om، or، os، pa، pag، pam، pap، pcd، pdc، pdt، pfl، pi، pih، pl، pms، pnb، pnt، prg، ps، pt، pt-br، qu، qug، rgn، rif، rm، rmy، ro، roa-tara، ru، rue، rup، ruq، ruq-cyrl، ruq-latn، rw، sa، sah، sat، sc، scn، sco، sd، sdc، sdh، se، sei، ses، sg، sgs، sh، shi، shn، si، sk، sl، sli، sm، sma، sn، so، sq، sr، sr-ec، sr-el، srn، ss، st، stq، su، sv، sw، szl، ta، tcy، te، tet، tg، tg-cyrl، tg-latn، th، ti، tk، tl، tly، tn، to، tokipona، tpi، tr، tru، ts، tt، tt-cyrl، tt-latn، tw، ty، tyv، tzm، udm، ug، ug-arab، ug-latn، uk، ur، uz، ve، vec، vep، vi، vls، vmf، vo، vot، vro، wa، war، wo، wuu، xal، xh، xmf، yi، yo، yue، za، zea، zh، zh-cn، zh-hans، zh-hant، zh-hk، zh-mo، zh-my، zh-sg، zh-tw، zu
- reason
Reason for the change.
- tags
Change tags to apply to the log entry resulting from this action.
- Values (separate with | or alternative):
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Change the language of Main Page to Basque.
- api.php?action=setpagelanguage&title=Main%20Page&lang=eu&token=123ABC [open in sandbox]
- Change the language of the page with ID 123 to the wiki's default content language.
- api.php?action=setpagelanguage&pageid=123&lang=default&token=123ABC [open in sandbox]
action=stashedit
- This module is internal or unstable. Its operation may change without notice.
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Prepare an edit in shared cache.
This is intended to be used via AJAX from the edit form to improve the performance of the page save.
- title
Title of the page being edited.
- This parameter is required.
- section
Section number. 0 for the top section, new for a new section.
- sectiontitle
The title for a new section.
- text
Page content.
- stashedtexthash
Page content hash from a prior stash to use instead.
- summary
Change summary.
- contentmodel
Content model of the new content.
- This parameter is required.
- One of the following values: wikitext، javascript، json، css، text
- contentformat
Content serialization format used for the input text.
- This parameter is required.
- One of the following values: text/x-wiki، text/javascript، application/json، text/css، text/plain
- baserevid
Revision ID of the base revision.
- This parameter is required.
- Type: integer
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
action=tag
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Add or remove change tags from individual revisions or log entries.
- rcid
One or more recent changes IDs from which to add or remove the tag.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- revid
One or more revision IDs from which to add or remove the tag.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- logid
One or more log entry IDs from which to add or remove the tag.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- add
Tags to add. Only manually defined tags can be added.
- Values (separate with | or alternative):
- remove
Tags to remove. Only tags that are either manually defined or completely undefined can be removed.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- reason
Reason for the change.
- Default: (empty)
- tags
Tags to apply to the log entry that will be created as a result of this action.
- Values (separate with | or alternative):
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Add the vandalism tag to revision ID 123 without specifying a reason
- api.php?action=tag&revid=123&add=vandalism&token=123ABC [open in sandbox]
- Remove the spam tag from log entry ID 123 with the reason Wrongly applied
- api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC [open in sandbox]
action=tokens
- This module is deprecated.
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Get tokens for data-modifying actions.
This module is deprecated in favor of action=query&meta=tokens.
- type
Types of token to request.
- Values (separate with | or alternative): block، createaccount، csrf، delete، edit، email، import، login، move، options، patrol، protect، rollback، unblock، userrights، watch
- Default: edit
- Retrieve an edit token (the default).
- api.php?action=tokens [open in sandbox]
- Retrieve an email token and a move token.
- api.php?action=tokens&type=email|move [open in sandbox]
action=unblock
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Unblock a user.
- id
ID of the block to unblock (obtained through list=blocks). Cannot be used together with user or userid.
- Type: integer
- user
Username, IP address or IP address range to unblock. Cannot be used together with id or userid.
- userid
User ID to unblock. Cannot be used together with id or user.
- Type: integer
- reason
Reason for unblock.
- Default: (empty)
- tags
Change tags to apply to the entry in the block log.
- Values (separate with | or alternative):
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Unblock block ID #105.
- api.php?action=unblock&id=105 [open in sandbox]
- Unblock user Bob with reason Sorry Bob.
- api.php?action=unblock&user=Bob&reason=Sorry%20Bob [open in sandbox]
action=undelete
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Restore revisions of a deleted page.
A list of deleted revisions (including timestamps) can be retrieved through prop=deletedrevisions, and a list of deleted file IDs can be retrieved through list=filearchive.
- title
Title of the page to restore.
- This parameter is required.
- reason
Reason for restoring.
- Default: (empty)
- tags
Change tags to apply to the entry in the deletion log.
- Values (separate with | or alternative):
- timestamps
Timestamps of the revisions to restore. If both timestamps and fileids are empty, all will be restored.
- Type: list of timestamps (allowed formats)
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- fileids
IDs of the file revisions to restore. If both timestamps and fileids are empty, all will be restored.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
- One of the following values: watch، unwatch، preferences، nochange
- Default: preferences
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Undelete page Main Page.
- api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page [open in sandbox]
- Undelete two revisions of page Main Page.
- api.php?action=undelete&title=Main%20Page&token=123ABC×tamps=2007-07-03T22:00:45Z|2007-07-02T19:48:56Z [open in sandbox]
action=unlinkaccount
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Remove a linked third-party account from the current user.
- request
Use this authentication request, by the id returned from action=query&meta=authmanagerinfo with amirequestsfor=unlink.
- This parameter is required.
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Attempt to remove the current user's link for the provider associated with FooAuthenticationRequest.
- api.php?action=unlinkaccount&request=FooAuthenticationRequest&token=123ABC [open in sandbox]
action=upload
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Upload a file, or get the status of pending uploads.
Several methods are available:
- Upload file contents directly, using the file parameter.
- Upload the file in pieces, using the filesize, chunk, and offset parameters.
- Have the MediaWiki server fetch a file from a URL, using the url parameter.
- Complete an earlier upload that failed due to warnings, using the filekey parameter.
Note that the HTTP POST must be done as a file upload (i.e. using multipart/form-data
) when sending the file.
- filename
Target filename.
- comment
Upload comment. Also used as the initial page text for new files if text is not specified.
- Default: (empty)
- tags
Change tags to apply to the upload log entry and file page revision.
- Values (separate with | or alternative):
- text
Initial page text for new files.
- watch
- Deprecated.
Watch the page.
- Type: boolean (details)
- watchlist
Unconditionally add or remove the page from the current user's watchlist, use preferences or do not change watch.
- One of the following values: watch، preferences، nochange
- Default: preferences
- ignorewarnings
Ignore any warnings.
- Type: boolean (details)
- file
File contents.
- Must be posted as a file upload using multipart/form-data.
- url
URL to fetch the file from.
- filekey
Key that identifies a previous upload that was stashed temporarily.
- sessionkey
- Deprecated.
Same as filekey, maintained for backward compatibility.
- stash
If set, the server will stash the file temporarily instead of adding it to the repository.
- Type: boolean (details)
- filesize
Filesize of entire upload.
- The value must be between ٠ and ١٠٤٬٨٥٧٬٦٠٠.
- Type: integer
- offset
Offset of chunk in bytes.
- The value must be no less than ٠.
- Type: integer
- chunk
Chunk contents.
- Must be posted as a file upload using multipart/form-data.
- async
Make potentially large file operations asynchronous when possible.
- Type: boolean (details)
- checkstatus
Only fetch the upload status for the given file key.
- Type: boolean (details)
- token
A "csrf" token retrieved from action=query&meta=tokens
- This parameter is required.
- Upload from a URL.
- api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC [open in sandbox]
- Complete an upload that failed due to warnings.
- api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC [open in sandbox]
action=userrights
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Change a user's group membership.
- user
User name.
- Type: user name
- userid
User ID.
- Type: integer
- add
Add the user to these groups, or if they are already a member, update the expiry of their membership in that group.
- Values (separate with | or alternative): bot، sysop، bureaucrat
- expiry
Expiry timestamps. May be relative (e.g. 5 months or 2 weeks) or absolute (e.g. 2014-09-18T12:34:56Z). If only one timestamp is set, it will be used for all groups passed to the add parameter. Use infinite, indefinite, infinity, or never for a never-expiring user group.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- Default: infinite
- remove
Remove the user from these groups.
- Values (separate with | or alternative): bot، sysop، bureaucrat
- reason
Reason for the change.
- Default: (empty)
- token
A "userrights" token retrieved from action=query&meta=tokens
For compatibility, the token used in the web UI is also accepted.
- This parameter is required.
- tags
Change tags to apply to the entry in the user rights log.
- Values (separate with | or alternative):
- Add user FooBot to group bot, and remove from groups sysop and bureaucrat.
- api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC [open in sandbox]
- Add the user with ID 123 to group bot, and remove from groups sysop and bureaucrat.
- api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC [open in sandbox]
- Add user SometimeSysop to group sysop for 1 month.
- api.php?action=userrights&user=SometimeSysop&add=sysop&expiry=1%20month&token=123ABC [open in sandbox]
action=validatepassword
- This module requires read rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Validate a password against the wiki's password policies.
Validity is reported as Good if the password is acceptable, Change if the password may be used for login but must be changed, or Invalid if the password is not usable.
- password
Password to validate.
- This parameter is required.
- user
User name, for use when testing account creation. The named user must not exist.
- Type: user name
Email address, for use when testing account creation.
- realname
Real name, for use when testing account creation.
- Validate the password foobar for the current user.
- api.php?action=validatepassword&password=foobar [open in sandbox]
- Validate the password qwerty for creating user Example.
- api.php?action=validatepassword&password=querty&user=Example [open in sandbox]
action=watch
- This module requires read rights.
- This module requires write rights.
- This module only accepts POST requests.
- Source: MediaWiki
- License: GPL-2.0+
Add or remove pages from the current user's watchlist.
- title
- Deprecated.
The page to (un)watch. Use titles instead.
- unwatch
If set the page will be unwatched rather than watched.
- Type: boolean (details)
- continue
When more results are available, use this to continue.
- titles
A list of titles to work on.
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- pageids
A list of page IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- revids
A list of revision IDs to work on.
- Type: list of integers
- Separate values with | or alternative. Maximum number of values is ٥٠ (٥٠٠ for bots).
- 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.
- 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، pageswithprop، prefixsearch، protectedtitles، querypage، random، recentchanges، redirects، revisions، search، templates، transcludedin، watchlist، watchlistraw
- redirects
Automatically resolve redirects in titles, pageids, and revids, and in pages returned by 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 gan، iu، kk، ku، shi، sr، tg، uz و zh.
- Type: boolean (details)
- token
A "watch" token retrieved from action=query&meta=tokens
- This parameter is required.
- Watch the page Main Page.
- api.php?action=watch&titles=Main_Page&token=123ABC [open in sandbox]
- Unwatch the page Main Page.
- api.php?action=watch&titles=Main_Page&unwatch=&token=123ABC [open in sandbox]
- Watch the first few pages in the main namespace.
- api.php?action=watch&generator=allpages&gapnamespace=0&token=123ABC [open in sandbox]
format=json
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Output data in JSON format.
- callback
If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.
- utf8
If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.
- Type: boolean (details)
- ascii
If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.
- Type: boolean (details)
- formatversion
Output formatting:
- 1
- Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
- 2
- Experimental modern format. Details may change!
- latest
- Use the latest format (currently 2), may change without warning.
- One of the following values: 1، 2، latest
- Default: 1
- Return the query result in the JSON format.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=json [open in sandbox]
format=jsonfm
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Output data in JSON format (pretty-print in HTML).
- wrappedhtml
Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.
- Type: boolean (details)
- callback
If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.
- utf8
If specified, encodes most (but not all) non-ASCII characters as UTF-8 instead of replacing them with hexadecimal escape sequences. Default when formatversion is not 1.
- Type: boolean (details)
- ascii
If specified, encodes all non-ASCII using hexadecimal escape sequences. Default when formatversion is 1.
- Type: boolean (details)
- formatversion
Output formatting:
- 1
- Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
- 2
- Experimental modern format. Details may change!
- latest
- Use the latest format (currently 2), may change without warning.
- One of the following values: 1، 2، latest
- Default: 1
- Return the query result in the JSON format.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm [open in sandbox]
format=none
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Output nothing.
- Return the query result in the NONE format.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=none [open in sandbox]
format=php
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Output data in serialized PHP format.
- formatversion
Output formatting:
- 1
- Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
- 2
- Experimental modern format. Details may change!
- latest
- Use the latest format (currently 2), may change without warning.
- One of the following values: 1، 2، latest
- Default: 1
- Return the query result in the PHP format.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=php [open in sandbox]
format=phpfm
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Output data in serialized PHP format (pretty-print in HTML).
- wrappedhtml
Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.
- Type: boolean (details)
- formatversion
Output formatting:
- 1
- Backwards-compatible format (XML-style booleans, * keys for content nodes, etc.).
- 2
- Experimental modern format. Details may change!
- latest
- Use the latest format (currently 2), may change without warning.
- One of the following values: 1، 2، latest
- Default: 1
- Return the query result in the PHP format.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm [open in sandbox]
format=rawfm
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Output data, including debugging elements, in JSON format (pretty-print in HTML).
- wrappedhtml
Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.
- Type: boolean (details)
- Return the query result in the RAW format.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm [open in sandbox]
format=xml
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Output data in XML format.
- xslt
If specified, adds the named page as an XSL stylesheet. The value must be a title in the ميدياويكي namespace ending in
.xsl
.- includexmlnamespace
If specified, adds an XML namespace.
- Type: boolean (details)
- Return the query result in the XML format.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml [open in sandbox]
format=xmlfm
- This module requires read rights.
- Source: MediaWiki
- License: GPL-2.0+
Output data in XML format (pretty-print in HTML).
- wrappedhtml
Return the pretty-printed HTML and associated ResourceLoader modules as a JSON object.
- Type: boolean (details)
- xslt
If specified, adds the named page as an XSL stylesheet. The value must be a title in the ميدياويكي namespace ending in
.xsl
.- includexmlnamespace
If specified, adds an XML namespace.
- Type: boolean (details)
- Return the query result in the XML format.
- api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm [open in sandbox]
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 [email protected] or file a bug report at https://phabricator.wikimedia.org/.