עזרה של MediaWiki API

זהו דף תיעוד של API שנוצר באופן אוטומטי.

תיעוד ודוגמאות: https://www.mediawiki.org/wiki/API

יחידה ראשית

  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מצב: כל האפשרויות שמוצגות בדף הזה אמורות לעבוד, אבל ה־API עדיין בפיתוח פעיל, ויכול להשתנות בכל זמן. עשו מינוי ל רשימת הדיוור mediawiki-api-announce להודעות על עדכונים.

בקשות שגויות: כשבקשות שגויות נשלחות ל־API, תישלח כותרת HTTP עם המפתח "MediaWiki-API-Error" ואז גם הערך של הכותרת וגם קוד השגיאה יוגדרו לאותו ערך. למידע נוסף ר' API: שגיאות ואזהרות.

פרמטרים:
action

איזו פעולה לבצע.

אחד מהערכים הבאים: block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, stashedit, tag, tokens, unblock, undelete, upload, userrights, watch
ברירת מחדל: help
format

תסדיר הפלט.

אחד מהערכים הבאים: dbg, dbgfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, xml, xmlfm, yaml, yamlfm
ברירת מחדל: jsonfm
maxlag

שיהוי מרבי יכול לשמש כשמדיה־ויקי מותקנת בצביר עם מסד נתונים משוכפל. כדי לחסוך בפעולות שגורמות יותר שיהוי בשכפול אתר, הפרמטר הזה יכול לגרום ללקוח להמתין עד ששיהוי השכפול יורד מתחת לערך שצוין. במקרה של שיהוי מוגזם, קוד השגיאה maxlag מוחזר עם הודעה כמו Waiting for $host: $lag seconds lagged.
ר' מדריך למשתמש: פרמטר maxlag למידע נוסף.

סוג: מספר שלם
smaxage

הגדרת כותרת בקרת מטמון HTTP‏ s-maxage למספר כזה של שניות.

סוג: מספר שלם
ברירת מחדל: 0
maxage

הגדרת כותרת בקרת מטמון HTTP‏ max-age למספר כזה של שניות.

סוג: מספר שלם
ברירת מחדל: 0
assert

לוודא שהמשתמש נכנס אם זה מוגדר ל־user, או שיש לו הרשאת בוט אם זה bot.

אחד מהערכים הבאים: user, bot
requestid

כל ערך שיינתן כאן ייכלל בתשובה. אפשר להשתמש בזה כדי להבדיל בין בקשות.

servedby

לכלול את שם המארח ששירת את הבקשה בתוצאות.

סוג: בוליאני (פרטים)
curtimestamp

הכללת חותם־הזמן הנוכחי בתוצאה.

סוג: בוליאני (פרטים)
origin

בעת גישה ל־API עם בקשת AJAX חוצה מתחמים (CORS), יש להציב כאן את המתחם שהבקשה יוצאת ממנו. זה היה להיות כלול בכל בקשה מקדימה, ולכן הוא חייב להיות חלק מה־URI של הבקשה (לא גוף ה־POST). זה חייב להיות תואם במדויק לאחד המקורות בכותרת Origin, כך שזה צריך להיות מוגדר למשהו כמו https://en.wikipedia.org או https://meta.wikimedia.org. אם הפרמטר הזה אינו תואם לכותרת Origin, תוחזר תשובת 403. אם הפרמטר הזה תורם לכותרת Origin והמקור נמצא ברשימה הלבנה, תוגדר כותרת Access-Control-Allow-Origin.

uselang

באיזו שפה להשתמש לתרגומי הודעות. אפשר לקבל רשימת קודים מ־action=query&meta=siteinfo עם siprop=languages או לציין user כדי להשתמש בהעדפת השפה של המשתמש הנוכחי, או להגדיר את content להשתמש בקוד השפה של הוויקי הזה.

ברירת מחדל: user
דוגמאות:
עזרה ליחידה הראשית.
api.php?action=help
כל העזרה בדף אחד.
api.php?action=help&recursivesubmodules=1
הרשאות:
writeapi
שימוש ב־API לשינוי דפים
הוענקו ל: all, user, bot
apihighlimits
להשתמש במגבלות גבוהות יותר בשאילתות API (שאילתות אטיות: 500; שאילתות מהירות: 5000). המגבלות לשאילתות אטיות חלות גם על פרמטרים מרובי־ערכים.
הוענקו ל: bot, sysop

action=block

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

חסימת משתמש.

פרמטרים:
user

שם משתמש, כתובת IP, או טווח IP שהנך רוצה לחסום.

פרמטר זה נדרש.
expiry

זמן תפוגה. יכול להיות יחסי (למשל 5 months או 2 weeks) או מוחלט (למשל 2014-09-18T12:34:56Z). אם זה מוגדר ל־infinite‏, indefinite, או never, החסימה לא תפוג לעולם.

ברירת מחדל: never
reason

סיבה לחסימה.

ברירת מחדל: (ריק)
anononly

לחסום משתמשים אלמוניים בלבד (דהיינו, השבתת עריכות אלמוניות מכתובת ה־IP הזאת)

סוג: בוליאני (פרטים)
nocreate

מניעת יצירת חשבונות

סוג: בוליאני (פרטים)
autoblock

חסימה אוטומטית גם של כתובת ה־IP האחרונה שהשתמש בה ושל כל כתובת IP שינסה להשתמש בה בעתיד.

סוג: בוליאני (פרטים)
noemail

למנוע ממשתמש לשלוח דואר אלקטרוני דרך הוויקי. (דורש את ההרשאה blockemail).

סוג: בוליאני (פרטים)
hidename

הסרת השם מיומן החסימות. (דורש את ההרשאה hideuser.)

סוג: בוליאני (פרטים)
allowusertalk

לאפשר למשתמש לערוך את דף השיחה שלו או שלה (תלוי ב־$wgBlockAllowsUTEdit).

סוג: בוליאני (פרטים)
reblock

אם המשתמש כבר חסום, לדרוס את החסימה הנוכחית.

סוג: בוליאני (פרטים)
watchuser

לעקוב אחרי דף המשתמש ודף השיחה של המשתמש או של כתובת ה־IP.

סוג: בוליאני (פרטים)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
חסימת כתובת ה־IP‏ 192.0.2.5 לשלושה ימים עם הסיבה First strike.
api.php?action=block&user=192.0.2.5&expiry=3%20days&reason=First%20strike&token=123ABC
חסימת המשתמש Vandal ללא הגבלת זמן עם הסיבה Vandalism, ומניעת יצירת חשבובות חדשים ושליחת דוא"ל.
api.php?action=block&user=Vandal&expiry=never&reason=Vandalism&nocreate=&autoblock=&noemail=&token=123ABC

action=checktoken

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

בדיקת התקינות של האסימון מ־action=query&meta=tokens.

פרמטרים:
type

סוג האסימון שבבדיקה.

פרמטר זה נדרש.
אחד מהערכים הבאים: csrf, patrol, rollback, userrights, watch
token

איזה אסימון לבדוק.

פרמטר זה נדרש.
maxtokenage

הגיל המרבי המותר של האסימון, בשניות.

סוג: מספר שלם
דוגמה:
בדיקת התקינות של אסימון csrf.
api.php?action=checktoken&type=csrf&token=123ABC

action=clearhasmsg

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מנקה את דגל hasmsg עבור המשתמש הנוכחי.

דוגמה:
לנקות את דגל hasmsg עבור המשתמש הנוכחי.
api.php?action=clearhasmsg

action=compare

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת ההבדל בין 2 דפים.

יש להעביר מספר גרסה, כותרת דף או מזהה דף גם ל־"from" וגם ל־"to".

פרמטרים:
fromtitle

כותרת ראשונה להשוואה.

fromid

מס׳ זיהוי של העמוד הראשון להשוואה.

סוג: מספר שלם
fromrev

גרסה ראשונה להשוואה.

סוג: מספר שלם
totitle

כותרת שנייה להשוואה.

toid

מס׳ מזהה של העמוד השני להשוואה.

סוג: מספר שלם
torev

גרסה שנייה להשוואה.

סוג: מספר שלם
דוגמה:
יצירת תיעוד שינוי בין גרסה 1 ל־2.
api.php?action=compare&fromrev=1&torev=2

action=createaccount

  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

יצירת חשבון משתמש חדש.

פרמטרים:
name

שם משתמש.

פרמטר זה נדרש.
סוג: שם משתמש
password

ססמה (לא ישפיע אם הוגדר mailpassword).

domain

שם מתחם לאימות חיצוני (רשות).

token

אסימון יצירת חשבון הושג בבקשה הראשונה.

email

כתובת הדוא״ל של המשתמש (רשות).

פרמטר זה נדרש.
realname

השם האמתי של המשתמש (רשות).

mailpassword

אם הוגדר ערך כלשהו, תישלח ססמה אקראית אל המשתמש.

סוג: בוליאני (פרטים)
reason

הסיבה כרשות ליצירת החשבון כפי שתופיע ברישומים.

language

קוד השפה שיוגדר כבררת המחדל למשתמש (רשות, בררת המחדל היא שפת התוכן).

דוגמאות:
יצירת המשתמש testuser עם הססמה test123.
api.php?action=createaccount&name=testuser&password=test123
יצירת המשתמש testmailuser ושליחת ססמה שיוצרה אקראית בדוא״ל.
api.php?action=createaccount&name=testmailuser&mailpassword=true&reason=MyReason

action=delete

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מחיקת דף.

פרמטרים:
title

כותרת העמוד למחיקה. לא ניתן להשתמש בשילוב עם pageid.

pageid

מס׳ הזיהוי של העמוד למחיקה. לא ניתן להשתמש בשילוב עם title.

סוג: מספר שלם
reason

סיבת המחיקה. אם לא הוגדרה, תתווסף סיבה שנוצרה אוטומטית.

watch
מיושן.

הוספת העמוד לרשימת המעקב של המשתמש הנוכחי.

סוג: בוליאני (פרטים)
watchlist

הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.

אחד מהערכים הבאים: watch, unwatch, preferences, nochange
ברירת מחדל: preferences
unwatch
מיושן.

הסרת הדף מרשימת המעקב של של המשתמש הנוכחי.

סוג: בוליאני (פרטים)
oldimage

שם התמונה הישנה למחיקה כפי שסופק ל־action=query&prop=imageinfo&iiprop=archivename.

token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.

action=edit

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

יצירה ועריכה של דפים.

פרמטרים:
title

שם הדף לעריכה. לא לשימוש עם pageid.

pageid

מזהה הדף לעריכה. לא לשימוש עם title.

סוג: מספר שלם
section

מספר הפסקה 0 לפסקה העליונה, new לפסקה חדשה.

sectiontitle

הכותרת לפסקה החדשה.

text

תוכן הדף.

summary

תקציר עריכה. גם גותרת פסקה כש־section=new ו־sectiontitle אינו מוגדר.

tags

אילו תגי שינוי להחיל על הגרסה.

ערכים (מופרדים באמצעות "|"):
minor

עריכה משנית.

סוג: בוליאני (פרטים)
notminor

שינוי לא משני.

סוג: בוליאני (פרטים)
bot

סימון עריכה זו כבוט.

סוג: בוליאני (פרטים)
basetimestamp

חותם־זמן של גרסת הבסיס, משמש לזיהוי התנגשויות עריכה. אפשר לקבל אותו באמצעות action=query&prop=revisions&rvprop=timestamp.

סוג: חותם־זמן (תסדירים מורשים)
starttimestamp

חותם־הזמן של תחילת תהליך העריכה, משמש לזיהוי התנגשויות. אפשר לקבל ערך מתאים באמצעות curtimestamp בעת תחילת תהליך העריכה (למשל בזמן טעינת תוכן הדף לעריכה).

סוג: חותם־זמן (תסדירים מורשים)
recreate

לעקוב את כל הטעויות על כך שהדף נמחק בינתיים.

סוג: בוליאני (פרטים)
createonly

לא לערוך את הדף אם הוא כבר קיים.

סוג: בוליאני (פרטים)
nocreate

לזרוק שגיאה אם הדף אינו קיים.

סוג: בוליאני (פרטים)
watch
מיושן.

הוספת העמוד לרשימת המעקב של המשתמש הנוכחי.

סוג: בוליאני (פרטים)
unwatch
מיושן.

הסרת הדף מרשימת המעקב של של המשתמש הנוכחי.

סוג: בוליאני (פרטים)
watchlist

להוסיף את הדף לרשימת המעקב של המשתמש הנוכחי או להסיר אותו משם, להשתמש בהעדפות, או לא לשנות את מצב המעקב.

אחד מהערכים הבאים: watch, unwatch, preferences, nochange
ברירת מחדל: preferences
md5

גיבוב MD5 של הפרמטר text או צירוף של הפטמטרים prependtext ו־appendtext. אם זה מוגדר, העריכה לא תיעשה אלא אם כן הגיבוב נכון.

prependtext

הוספת הטקסט הזה לתחילת הדף. דורס את text.

appendtext

הוספת הטקסט הזה לסוף הדף. דורס את text.

יש להשתמש ב־section=new כדי להוסיף פסקה חדשה, ולא בפרמטר הזה.

undo

לבטל את הגרסה הזאת. דורס את text‏, prependtext ו־appendtext.

סוג: מספר שלם
undoafter

ביטול כל הגרסאות מ־undo עד כאן. אם זה לא מוגדר, לבטל רק גרסה אחת.

סוג: מספר שלם
redirect

לפתור הפניות אוטומטית.

סוג: בוליאני (פרטים)
contentformat

תסדיר להסדרת תוכן שמשמש את טקסט הקלט.

אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
contentmodel

מודל התוכן של התוכן החדש.

אחד מהערכים הבאים: wikitext, javascript, json, css, text
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

האסימון תמיד צריך להישלח בתור הפרמטר האחרון, או לפחות אחרי הפרמטר text parameter.

פרמטר זה נדרש.

action=emailuser

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

שליחת דוא"ל למשתמש.

פרמטרים:
target

לאיזה משתמש לשלוח דוא"ל.

פרמטר זה נדרש.
subject

כותרת נושא.

text

גוף הדואר.

פרמטר זה נדרש.
ccme

שליחת עותק של הדואר הזה אליי.

סוג: בוליאני (פרטים)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמה:
שליחת דוא"ל למשתמש WikiSysop עם הטקסט Content.
api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC

action=expandtemplates

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

הרחבת כל התבניות בקוד הוויקי.

פרמטרים:
title

כותרת הדף.

ברירת מחדל: API
text

איזה קוד ויקי להמיר.

פרמטר זה נדרש.
revid

מזהה גרסה, עבור {{REVISIONID}} ומשתנים דומים.

סוג: מספר שלם
prop

אילו חלקי מידע לקבל.

יש לשים לכך שאם לא נבחרו ערכים, התוצאה תכיל את קוד הוויקי, אבל הפלט יהיה בתסדיר מיושן.

wikitext
קוד הוויקי המורחב.
categories
קטגוריות כלשהן שקיימות בקלט ואינן מיוצגות בפלט הוויקיטקסט.
properties
מאפייני דף המוגדרים במילות קסם מורחבות בקוד ויקי.
volatile
האם הפלט הוא נדיף ואין להשתמש בו במקום אחר בעמוד.
ttl
הזמן המרבי שאחריו המטמונים של התוצאה צריכים לפוג.
modules
כל יחידות ה־ResourceLoader שפונקציות מפענח ביקשו לוסיף לפלט. יש לבקש את jsconfigvars או את encodedjsconfigvars יחד עם modules.
jsconfigvars
נותן משתני הגדרות של JavaScript שייחודיים לדף הזה.
encodedjsconfigvars
נותן משתני הגדרות של JavaScript שייחודיים לדף הזה בתור מחרוזת JSON.
parsetree
עץ פענוח XML של הקלט.
ערכים (מופרדים באמצעות "|"): wikitext, categories, properties, volatile, ttl, modules, jsconfigvars, encodedjsconfigvars, parsetree
includecomments

האם לכלול הערות HTML בפלט.

סוג: בוליאני (פרטים)
generatexml
מיושן.

יצירת עץ פענוח XML (מוחלף ב־prop=parsetree).

סוג: בוליאני (פרטים)
דוגמה:
להרחיב את קוד הוויקי {{Project:Sandbox}}.
api.php?action=expandtemplates&text={{Project:Sandbox}}

action=feedcontributions

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת הזנת תרומות משתמש.

פרמטרים:
feedformat

תסדיר ההזנה.

אחד מהערכים הבאים: rss, atom
ברירת מחדל: rss
user

לקבל תרומות של אילו משמשים.

פרמטר זה נדרש.
סוג: שם משתמש
namespace

לפי איזה מרחב שם לסנן את התרומות.

אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
year

החל משנה (ולפני כן).

סוג: מספר שלם
month

החל מחודש (ולפני כן).

סוג: מספר שלם
tagfilter

סינון תרומות בעלות התגיות הבאות.

ערכים (מופרדים באמצעות "|"):
ברירת מחדל: (ריק)
deletedonly

הצגת תרומות שנמחקו בלבד.

סוג: בוליאני (פרטים)
toponly

הצגת עריכות שהן הגרסה העדכנית ביותר בלבד.

סוג: בוליאני (פרטים)
newonly

להציג רק עריכות שהן יצירות דפים.

סוג: בוליאני (פרטים)
showsizediff

להציג את ההבדל בגודל בין גרסאות.

סוג: בוליאני (פרטים)
דוגמה:
החזרת תרומות עבור המשתמש Example.
api.php?action=feedcontributions&user=Example

action=feedrecentchanges

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

להחזיר הזנת שינויים אחרונים.

פרמטרים:
feedformat

תסדיר ההזנה.

אחד מהערכים הבאים: rss, atom
ברירת מחדל: rss
namespace

לאיזה מרחב שם להגביל את התוצאות.

אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
invert

כל מרחבי השם למעט זה שנבחר.

סוג: בוליאני (פרטים)
associated

לכלול מרחב שם משויך (שיחה או ראשי).

סוג: בוליאני (פרטים)
days

לכמה ימים להגביל את התוצאות.

הערך לא יכולים להיות קטנים מ־1.
סוג: מספר שלם
ברירת מחדל: 7
limit

המספר המרבי של התוצאות להחזיר.

הערך חייב להיות בין 1 ל־50.
סוג: מספר שלם
ברירת מחדל: 50
from

להציג תוצאות מאז.

סוג: חותם־זמן (תסדירים מורשים)
hideminor

הסתרת שינוים משניים.

סוג: בוליאני (פרטים)
hidebots

הסתרת שינויים שנעשו על ידי בוטים.

סוג: בוליאני (פרטים)
hideanons

הסתרת שינויים שנעשו על ידי אנונימים.

סוג: בוליאני (פרטים)
hideliu

הסתרת שינויים שנעשו על ידי משתמשים רשומים.

סוג: בוליאני (פרטים)
hidepatrolled

הסתרת שינויים שנבדקו.

סוג: בוליאני (פרטים)
hidemyself

הסתרת שינוים שנעשו על ידי המשתמש הנוכחי.

סוג: בוליאני (פרטים)
tagfilter

סינון לפי תגית.

target

הצגת שינויים שנעשו בדפים המקושרים לדף זה בלבד.

showlinkedto

להציג את השינויים בדפים שמקושרים לדף שנבחר במקום זה.

סוג: בוליאני (פרטים)
דוגמאות:
הצגת שינויים אחרונים.
api.php?action=feedrecentchanges
הצגת שינויים אחרונים עבור 30 ימים.
api.php?action=feedrecentchanges&days=30

action=feedwatchlist

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת הזנת רשימת מעקב.

פרמטרים:
feedformat

תסדיר ההזנה.

אחד מהערכים הבאים: rss, atom
ברירת מחדל: rss
hours

רשימת דפים ששונו בתוך מספר כזה של שעות מעכשיו.

הערך חייב להיות בין 1 ל־72.
סוג: מספר שלם
ברירת מחדל: 24
linktosections

לקשר ישר לפסקאות ששונו אם אפשר.

סוג: בוליאני (פרטים)
allrev

לכלול גרסאות מרובות של אותו הדף בתוך מסגרת הזמן הנתונה.

סוג: בוליאני (פרטים)
wlowner

משמש יחד עם token לגישה לרשימת מעקב של משתמש אחר.

סוג: שם משתמש
wltoken

אסימון אבטחה (זמין ב־העדפות) שמאפשר לגשת לרשימת מעקב של משתמש אחר.

wlshow

הצגה רק של פריטים שמתאימים לאמות המידה האלו. למשל, כדי לראות רק עריכות משניות שעשו משתמשים שנכנסו לחשבון, יש להגדיר show=minor|!anon.

ערכים (מופרדים באמצעות "|"): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, unread, !unread
wltype

אולי סוגי שינויים להציג:

edit
עריכות דף רגילות.
external
שינויים חיצוניים.
new
יצירות דף.
log
עיולי יומן.
ערכים (מופרדים באמצעות "|"): edit, external, new, log
ברירת מחדל: edit|new|log
wlexcludeuser

Don't list changes by this user

סוג: שם משתמש
דוגמאות:
הצגת הזנת רשימת מעקב.
api.php?action=feedwatchlist
להציג את כל השינויים בדפים שבמעקב ב־6 השעות האחרונות.
api.php?action=feedwatchlist&allrev=&hours=6

action=filerevert

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לשחזר את הקובץ לגרסה ישנה יותר.

פרמטרים:
filename

שם קובץ היעד, ללא התחילית File:.

פרמטר זה נדרש.
comment

הערת העלאה.

ברירת מחדל: (ריק)
archivename

שם הארכיון של הגרסה שאליה ישוחזר הקובץ.

פרמטר זה נדרש.
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמה:
לשחזר את Wiki.png לגרסה מ־2011-03-05T15:27:40Z.
api.php?action=filerevert&filename=Wiki.png&comment=Revert&archivename=20110305152740!Wiki.png&token=123ABC

action=help

  • מקור: MediaWiki
  • רישיון: GPL-2.0+

הצגת עזרה עבור היחידות שצוינו.

פרמטרים:
modules

עזרה של אילו יחידות להציג (ערכים של הפרמטרים action ו־format, או main). אפשר להגדיר תת־יחידות עם +.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
ברירת מחדל: main
submodules

לכלול עזרה לתת־יחידות ליחידה שצוינה.

סוג: בוליאני (פרטים)
recursivesubmodules

לכלול עזרה לתת־יחידות באופן רקורסיבי.

סוג: בוליאני (פרטים)
wrap

לעטוף את הפלט במבנה תשובת API תקני.

סוג: בוליאני (פרטים)
toc

לכלול תוכן עניינים בפלט HTML.

סוג: בוליאני (פרטים)
דוגמאות:
עזרה ליחידה הראשית.
api.php?action=help
כל העזרה בדף אחד.
api.php?action=help&recursivesubmodules=1
עזרה ליחידת העזרה עצמה.
api.php?action=help&modules=help
עזרה לשתי תת־יחידות של שאילתה.
api.php?action=help&modules=query+info|query+categorymembers

action=imagerotate

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

סיבוב של תמונה אחת או יותר.

פרמטרים:
rotation

בכמה מעלות לסובב בכיוון השעון.

פרמטר זה נדרש.
אחד מהערכים הבאים: 90, 180, 270
continue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

titles

רשימת כותרות.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
pageids

רשימת מזהי דף לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
revids

רשימת מזהי גרסה לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
generator

קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.

לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.

אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, 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

פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.

סוג: בוליאני (פרטים)
converttitles

המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz, zh.

סוג: בוליאני (פרטים)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
לסובב את File:Example.png ב־90 מעלות.
api.php?action=imagerotate&titles=File:Example.jpg&rotation=90&token=123ABC
לסובב את כל התמונות ב־Category:Flip ב־180 מעלות.
api.php?action=imagerotate&generator=categorymembers&gcmtitle=Category:Flip&gcmtype=file&rotation=180&token=123ABC

action=import

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לייבא דף מוויקי אחר או מקובץ XML.

יש לשים לב לכך שפעולת HTTP POST צריכה להיעשות בתור העלאת קובץ (כלומר, עם multipart/form-data) בזמן שליחת קובץ לפרמטר xml.

פרמטרים:
summary

תקציר יבוא.

xml

קובץ XML שהועלה.

חייב להישלח (posted) בתור העלאת קובץ באמצעות multipart/form-data.
interwikisource

ליבוא בין אתרי ויקי: מאיזה ויקי לייבא.

אחד מהערכים הבאים:
interwikipage

ליבוא בין אתרי ויקי: איזה דף לייבא.

fullhistory

ליבוא בין אתרי ויקי: לייבר את ההיסטוריה המלאה, לא רק את הגרסה הנוכחית.

סוג: בוליאני (פרטים)
templates

ליבוא בין אתרי ויקי: לייבא גם את כל התבניות המוכללות.

סוג: בוליאני (פרטים)
namespace

לייבא למרחב השם הזה. לא ניתן להשתמש בזה יחד עם rootpage.

אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
rootpage

לייבא בתור תת־משנה של הדף הזה. לא ניתן להשתמש בזה יחד עם namespace.

token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.

action=login (lg)

  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

להיכנס ולקבל עוגיות אימות.

במקרה של כניסה מוצלחת, העוגיות הדרושות תיכללנה בכותרות תשובות של HTTP. במקרה של כניסה לא מוצלחת, הניסיונות הבאים עשויים להיות חנוקים כדי להגביל תקיפות ניחוש ססמה אוטומטי.

פרמטרים:
lgname

שם משתמש.

lgpassword

ססמה.

lgdomain

שם מתחם (רשות).

lgtoken

אסימון כניסה התקבל בבקשה הראשונה.

action=logout

  • מקור: MediaWiki
  • רישיון: GPL-2.0+

יציאה וניקוי של נתוני הפעילות.

דוגמה:
הוצאת המשתמש הנוכחי.
api.php?action=logout

action=managetags

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

ביצוע פעולות ניהוליות הקשורות בשינוי תגיות.

פרמטרים:
operation

איזו פעולה לבצע:

create
יצירת תג שינוי חדש לשימוש ידני.
delete
הסרת תג שינוי ממסד הנתונים, כולל הסרת התג מכל הגרסאות, עיולי שינויים אחרונים ועיולי יומן שהוא משמש בהן.
activate
הפעלת תג שינוי, ואפשור למשתמש להחיל אותו ידנית.
deactivate
כיבוי תג שינוי, ומניעה ממשתמשים להחיל אותו ידנית.
פרמטר זה נדרש.
אחד מהערכים הבאים: create, delete, activate, deactivate
tag

תג ליצירה, מחיקה, הפעלה או כיבוי. ליצירת תג, התג לא צריך להיות קיים. למחיקת תג, התג צריך להיות קיים. להפעלת תג, התג צריך להתקיים ולא להיות בשימוש של הרחבה. לכיבוי תג, התג צריך להיות קיים ומוגדר ידנית.

פרמטר זה נדרש.
reason

סיבה אופציונלית ליצירה, מחיקה, הפעלה או כיבוי של תג.

ignorewarnings

האם להתעלם מכל האזהרות שמופיעות תוך כדי הפעולה.

סוג: בוליאני (פרטים)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
יצירת תג בשם spam עם הסיבה For use in edit patrolling
api.php?action=managetags&operation=create&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC
מחיקת התג vandlaism עם הסיבה Misspelt
api.php?action=managetags&operation=delete&tag=vandlaism&reason=Misspelt&token=123ABC
הפעלת התג spam עם הסיבה For use in edit patrolling
api.php?action=managetags&operation=activate&tag=spam&reason=For+use+in+edit+patrolling&token=123ABC
כיבוי התג spam עם הסיבה No longer required
api.php?action=managetags&operation=deactivate&tag=spam&reason=No+longer+required&token=123ABC

action=move

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

העברת עמוד.

פרמטרים:
from

שם הדף ששמו ישונה. לא יכול לשמש יחד עם fromid.

fromid

מזהה הדף של הדף שצריך לשנות את שמו. לא יכול לשמש עם from.

סוג: מספר שלם
to

לאיזו כותרת לשנות את שם הדף.

פרמטר זה נדרש.
reason

הסיבה לשינוי השם.

ברירת מחדל: (ריק)
movetalk

שינוי שם דף השיחה, אם הוא קיים.

סוג: בוליאני (פרטים)
movesubpages

שינוי השמות של דפי־המשנה, אם זה שייך.

סוג: בוליאני (פרטים)
noredirect

לא ליצור הפניה.

סוג: בוליאני (פרטים)
watch
מיושן.

הוספת הדף וההפניה לרשימת המעקב של המשתמש הנוכחי.

סוג: בוליאני (פרטים)
unwatch
מיושן.

הסרת הדף וההפניה מרשימת המעקב של המשתמש הנוכחי.

סוג: בוליאני (פרטים)
watchlist

הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.

אחד מהערכים הבאים: watch, unwatch, preferences, nochange
ברירת מחדל: preferences
ignorewarnings

להתעלם מכל האזהרות.

סוג: בוליאני (פרטים)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמה:
העברת Badtitle ל־Goodtitle בלי להשאיר הפניה.
api.php?action=move&from=Badtitle&to=Goodtitle&token=123ABC&reason=Misspelled%20title&movetalk=&noredirect=

action=opensearch

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

חיפוש בוויקי בפרוטוקול OpenSearch.

פרמטרים:
search

מחרוזת לחיפוש.

limit

המספר המרבי של התוצאות שתוחזרנה.

המספר המרבי המותר הוא 100 (עבור בוטים – 100).
סוג: מספר שלם או max
ברירת מחדל: 10
namespace

שמות מתחם לחיפוש.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ברירת מחדל: 0
suggest

לא לעשות דבר אם $wgEnableOpenSearchSuggest הוא false.

סוג: בוליאני (פרטים)
redirects

איך לטפל בהפניות:

return
להחזיר את ההפניה עצמה.
resolve
להחזיר את דף היעד. יכול להחזיר פחות מ־limit תוצאות.

מסיבות היסטוריות, בררת המחדל היא "return" עבור format=json ו־"resolve" עבור תסדירים אחרים.

אחד מהערכים הבאים: return, resolve
format

תסדיר הפלט.

אחד מהערכים הבאים: json, jsonfm, xml, xmlfm
ברירת מחדל: json
warningsaserror

אם אזהרות מוּעלות עם format=json, להחזיר שגיאת API במקום להתעלם מהן.

סוג: בוליאני (פרטים)
דוגמה:
חיפוש דפים שמתחילים ב־Te.
api.php?action=opensearch&search=Te

action=options

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

שינוי העדפות של המשתמש הנוכחי.

רק אפשרויות שמוגדרות בליבה או באחת מההרחבות המותקנות, או אפשרויות עם מפתחות עם התחילית "userjs-" (שמיועדות לשימוש תסריטי משתמשים) יכולות להיות מוגדרות.

פרמטרים:
reset

אתחול ההעדפות לבררות המחדל של האתר.

סוג: בוליאני (פרטים)
resetkinds

רשימת סוגי אפשרויות לאתחל כאשר מוגדרת האפשרות reset.

ערכים (מופרדים באמצעות "|"): registered, registered-multiselect, registered-checkmatrix, userjs, special, unused, all
ברירת מחדל: all
change

רשימת שינויים, בתסדיר name=value (למשל skin=vector). הערך אינו יכול להכיל תווי מקל (|). אם לא ניתן ערך, אפילו לא סימן שווה, למשל optionname|otheroption|...‎, האפשרות תאופס לערך בררת המחדל שלה.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
optionname

שם האפשרות שצריך להגדיר לערך שניתן ב־optionvalue.

optionvalue

ערך האפשרות שצוין ב־optionname, יכול להכיל תווי מקל.

token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
אתחול כל ההעדפות.
api.php?action=options&reset=&token=123ABC
לשנות את ההעדפות skin ו־hideminor.
api.php?action=options&change=skin=vector|hideminor=1&token=123ABC
לאתחל את כל ההעדפות ואז להגדיר את skin ואת nickname.
api.php?action=options&reset=&change=skin=monobook&optionname=nickname&optionvalue=[[User:Beau|Beau]]%20([[User_talk:Beau|talk]])&token=123ABC

action=paraminfo

  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת מידע על יחידות של API.

פרמטרים:
modules

רשימה של שמות יחידות (ערכים של הפרמטרים action ו־format, או main). אפשר להגדיר תת־יחידות עם +.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
helpformat

תסדיר מחרוזות העזרה.

אחד מהערכים הבאים: html, wikitext, raw, none
ברירת מחדל: none
querymodules
מיושן.

רשימת שמות יחידות query (ערך של הפרמטר prop‏, meta או list). יש להשתמש ב־modules=query+foo במקום querymodules=foo.

ערכים (מופרדים באמצעות "|"): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allmessages, allpages, allredirects, alltransclusions, allusers, 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, pagepropnames, pageprops, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, siteinfo, stashimageinfo, tags, templates, tokens, transcludedin, usercontribs, userinfo, users, watchlist, watchlistraw
מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
mainmodule
מיושן.

קבלת מידע עם היחידה הראשית (העליונה). יש להשתמש ב־modules=main במקום זה.

pagesetmodule
מיושן.

קבלת מידע גם על יחידת pageset (שמספק את titles=‎ וידידיו).

formatmodules
מיושן.

רשימת שמות תסדירים (ערכים של הפרמטר format). יש להשתמש ב־modules במקום זה.

ערכים (מופרדים באמצעות "|"): dbg, dbgfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, xml, xmlfm, yaml, yamlfm

action=parse

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מפענח את התוכן ומחזיר פלט מפענח.

ר' את יחידת ה־prop השיונות של action=query כדי לקבל מידע על הגרסה הנוכחית של הדף.

יש מספר דרכים לציין טקסט לפענוח:

  1. ציון דף או גרסה באמצעות page‏, pageid, או oldid.
  2. ציון התוכן במפורש, באמצעות text‏, title, ו־contentmodel.
  3. ציון רק של התקציר לפענוח. ל־prop צריך לתת ערך ריק.
פרמטרים:
title

שם הדף שהטקסט שייך אליו. אם זה מושמט, יש לציין את contentmodel, ו־API ישמש ככותרת.

text

הטקסט לפענוח. יש להשתמש ב־title או ב־contentmodel.

summary

התקציר שצריך לפענח.

page

פענוח תוכן הדף הזה. לא יכול לשמש יחד עם text ו־title.

pageid

לפענח את התוכן של הדף הזה. דורס את page.

סוג: מספר שלם
redirects

אם page או pageid מוגדרים להפניה, לפתור אותה.

סוג: בוליאני (פרטים)
oldid

לפענח את התוכן של הגרסה הזאת. דורס את page ואת pageid.

סוג: מספר שלם
prop

אילו פריטי מידע לקבל:

text
נותן טקסט מפוענח של קוד הוויקי.
langlinks
נותן קישורי שפה בקוד הוויקי המפוענח.
categories
נותן קטגוריות בקוד ויקי מפוענח.
categorieshtml
נותן את גרסת ה־HTML של הקטגוריות.
links
נותן קישורים פנימיים בקוד הוויקי המפוענח.
templates
נותן תבניות בקוד הוויקי המפוענח.
images
נותן תמונות בקוד הוויקי המפוענח.
externallinks
מתן קישורים חיצוניים בקוד הוויקי המפוענח.
sections
מתן הפסקאות בקוד הוויקי המפוענח.
revid
הוספת מזהה הגרסה של הדף המפוענח.
displaytitle
הוספת הכותרת של קוד הוויקי המפוענח.
headitems
נותן פריטים לשים ב־<head> של הדף.
headhtml
נותן את ה־<head> המפוענח של הדף.
modules
מצן יחידות ResourceLoader שמשמשות בדף. יש לבקש את jsconfigvars או את encodedjsconfigvars יחד עם modules.
jsconfigvars
נותן משתני הגדרות של JavaScript שייחודיים לדף הזה.
encodedjsconfigvars
נותן משתני הגדרות של JavaScript שייחודיים לדף הזה בתור מחרוזת JSON.
indicators
נותן את ה־HTML של מחווני מצב דף שמשמשים בדף.
iwlinks
מתן קישורי בינוויקי בקוד הוויקי המפוענח.
wikitext
מתן קוד הוויקי המקורי שפוענח.
properties
נותן מאפיינים שונים שמוגדרים בקוד הוויקי המפוענח.
limitreportdata
נותן דו"ח הגבלות בדרך מובנית. לא נותן שום נתונים כאשר מוגדר disablelimitreport.
limitreporthtml
נותן את גרסת ה־HTML של דו"ח ההגבלות. לא נותן שום נתונים כאשר מוגדר disablelimitreport.
parsetree
עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן wikitext)
ערכים (מופרדים באמצעות "|"): text, langlinks, categories, categorieshtml, links, templates, images, externallinks, sections, revid, displaytitle, headitems, headhtml, modules, jsconfigvars, encodedjsconfigvars, indicators, iwlinks, wikitext, properties, limitreportdata, limitreporthtml, parsetree
ברירת מחדל: text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle|iwlinks|properties
pst

לעשות התמרה לפני שמירה על הקלט לפני פענוחו. תקין רק בשימוש עם טקסט.

סוג: בוליאני (פרטים)
onlypst

לעשות התמרה לפני שמירה (pre-save transform‏, PST) על הקלט, אבל לא לפענח אותו. מחזיר את אותו קוד הוויקי אחרי החלת PST. תקף רק בשימוש עם text.

סוג: בוליאני (פרטים)
effectivelanglinks

כולל קישור שפה שמספקות הרחבות (לשימוש עם prop=langlinks).

סוג: בוליאני (פרטים)
section

לאחזר את התוכן של הפסקה עם המספר הזה, או, אם זה new, ליצור פסקה חדשה.

new יכובד רק בעת ציון text.

sectiontitle

כותרת פסקה חדשה כאשר section הוא new.

בניגוד לעריכת דף, זה לא מתגבה ל־summary כשזה מושמט אם ריק.

disablepp
מיושן.

יש להשתמש ב־disablelimitreport במקום.

סוג: בוליאני (פרטים)
disablelimitreport

להשמיט את דו"ח הקדם־מעבד ("NewPP limit report") מפלט המפענח.

סוג: בוליאני (פרטים)
disableeditsection

להשמיט את קישורי עריכת הפסקאות מפלט המפענח.

סוג: בוליאני (פרטים)
disabletidy

לא להריץ ניקוי HTML (למשל tidy) על פלט המפענח.

סוג: בוליאני (פרטים)
generatexml
מיושן.

יצירת עץ פענוח של XML (נדרש מודל תוכן wikitext; מוחלף ב־prop=parsetree).

סוג: בוליאני (פרטים)
preview

לפענח במצב תצוגה מקדימה.

סוג: בוליאני (פרטים)
sectionpreview

לפענח במצב תצוגה מקדימה של פסקה (מדליק גם את מצב תצוגה מקדימה).

סוג: בוליאני (פרטים)
disabletoc

להשמיט את תוכן העניינים בפלט.

סוג: בוליאני (פרטים)
contentformat

תסדיר הסדרת תוכן שישמש לטקסט הקלט. תקף רק עם text.

אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
contentmodel

מודל התוכן של טקסט הקלט. אם זה מושמט, יש לציין את title והערך ההתחלתי יהיה המודל של הכותרת שצוינה. תקין רק כאשר משמש עם text.

אחד מהערכים הבאים: wikitext, javascript, json, css, text

action=patrol

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לנטר דף או גרסה.

פרמטרים:
rcid

מזהה שינויים אחרונים לניטור.

סוג: מספר שלם
revid

מזהה גרסה לניטור.

סוג: מספר שלם
token

אסימון "patrol" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
לנטר עיול משינויים אחרונים.
api.php?action=patrol&token=123ABC&rcid=230672766
לנטר גרסה.
api.php?action=patrol&token=123ABC&revid=230672766

action=protect

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לשנות את רמת ההגנה של דף.

פרמטרים:
title

כותרת הדף להגנה או הסרת הגנה. לא ניתן להשתמש בזה יחד עם pageid.

pageid

מזהה הדף להגנה או הסרת הגנה. לא ניתן להשתמש בזה יחד עם title.

סוג: מספר שלם
protections

רשימת רמות הכנה, בתסדיר action=level (למשל edit=sysop).

פרמטר זה נדרש.
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
expiry

חותמי־זמן של תפוגה. אם הוגדר רק חותם־זמן אחד, הוא ישמש לכל ההגנות. יש להשתמש ב־infinite‏, indefinite‏, infinity, או never להגנה שלא פגה לעולם.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
ברירת מחדל: infinite
reason

סיבה להגנה או הסרת הגנה.

ברירת מחדל: (ריק)
cascade

הפעלת הגנה מדורגת (כלומר, להגן על דפים שמוכללים בדף הזה ועל תמונות שמשמות בו). אין לזה השפעה אם אף אחת מרמות ההגנה שניתנו אינה תומכת בדירוג.

סוג: בוליאני (פרטים)
watch
מיושן.

אם זה מוגדר, הוספת הדף שהגנה נוספת אליו או מוסרת ממנו לרשימת המעקב של המשתמש הנוכחי.

סוג: בוליאני (פרטים)
watchlist

הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.

אחד מהערכים הבאים: watch, unwatch, preferences, nochange
ברירת מחדל: preferences
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.

action=purge

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

ניקוי המטמון לכותרות שניתנו.

דורש בקשת POST אם המשתמש לא נכנס לחשבון.

פרמטרים:
forcelinkupdate

עדכון טבלאות הקישורים.

סוג: בוליאני (פרטים)
forcerecursivelinkupdate

עדכון טבלת הקישורים ועדכון טבלאות הקישורים עבור כל דף שמשתמש בדף הזה בתור תבנית.

סוג: בוליאני (פרטים)
continue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

titles

רשימת כותרות.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
pageids

רשימת מזהי דף לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
revids

רשימת מזהי גרסה לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
generator

קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.

לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.

אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, 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

פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.

סוג: בוליאני (פרטים)
converttitles

המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz, zh.

סוג: בוליאני (פרטים)
דוגמאות:
ניקוי המטמון של הדפים Main Page ו־API.
api.php?action=purge&titles=Main_Page|API
ניקוי 10 הדפים הראשונים במרחב הראשי.
api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10

action=query

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

אחזור נתונים ממדיה־ויקי ועליה.

כל שינויי הנתונים יצטרכו תחילה להשתמש ב־query כדי לקבל אסימון למניעת שימוש לרעה מאתרים זדוניים.

פרמטרים:
prop

אילו מאפיינים לקבל על הדפים בשאילתה.

ערכים (מופרדים באמצעות "|"): categories, categoryinfo, contributors, deletedrevisions, duplicatefiles, extlinks, fileusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, pageprops, redirects, revisions, stashimageinfo, templates, transcludedin
list

אילו רשימות לקבל.

ערכים (מופרדים באמצעות "|"): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, alltransclusions, allusers, backlinks, blocks, categorymembers, deletedrevs, embeddedin, exturlusage, filearchive, imageusage, iwbacklinks, langbacklinks, logevents, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw
meta

אילו מטא־נתונים לקבל.

ערכים (מופרדים באמצעות "|"): allmessages, filerepoinfo, siteinfo, tokens, userinfo
indexpageids

לכלול פסקת pageids נוספת עם רשימת כל מזהי הדף שהוחזרו.

סוג: בוליאני (פרטים)
export

יצוא הגרסאות הנוכחיות של כל הדפים הנתונים המחוללים.

סוג: בוליאני (פרטים)
exportnowrap

להחזיר את ה־XML של היצוא בלי לעטוף אותו בתוצאת XML (אותו תסדיר כמו Special:Export). אפשר להשתמש בזה רק עם export.

סוג: בוליאני (פרטים)
iwurl

האם לקבל את ה־URL המלא אם הכותרת היא קישור בינוויקי.

סוג: בוליאני (פרטים)
continue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

rawcontinue

להחזיר נתוני query-continue גולמיים להמשך.

סוג: בוליאני (פרטים)
titles

רשימת כותרות.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
pageids

רשימת מזהי דף לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
revids

רשימת מזהי גרסה לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
generator

קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.

לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.

אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, 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

פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.

סוג: בוליאני (פרטים)
converttitles

המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz, zh.

סוג: בוליאני (פרטים)

prop=categories (cl)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לרשום את כל הקטגוריות שהדף שייך אליהן.

פרמטרים:
clprop

אילו מאפיינים נוספים לקבל עבור כל קטגוריה:

sortkey
הוספת מפתח מיון (מחרוזת הקסדצימלית) ותחילית מפתח מיון (החלק הקריא) עבור קטגוריה.
timestamp
הוספת חותם־הזמן של יצירת הקטגוריה.
hidden
תיוג קטגוריות שהוסתרו באמצעות __HIDDENCAT__.
ערכים (מופרדים באמצעות "|"): sortkey, timestamp, hidden
clshow

איזה סוג של קטגוריות להציג.

ערכים (מופרדים באמצעות "|"): hidden, !hidden
cllimit

כמה קטגוריות להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
clcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

clcategories

לרשום רק את הקטגוריות האלו. שימושי לבדיקה עם דף מסוים נמצא בקטגוריה מסוימת.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
cldir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
דוגמאות:
קבלת רשימת קטגוריות שהם Albert Einstein שייך אליהן.
api.php?action=query&prop=categories&titles=Albert%20Einstein
קבלת מידע על כל הקטגוריות שמשמשות בדף Albert Einstein.
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info

prop=categoryinfo (ci)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת מידע על הקטגוריות הנתונות.

פרמטר:
cicontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמה:
קבחצ מידע על Category:Foo ועל Category:Bar.
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar

prop=contributors (pc)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת רשימה של תורמים שנכנסו לחשבון ומניין של תורמים אלמוניים לדף.

פרמטרים:
pcgroup

לכלול רק משתמשים בקבוצות הנתונות. לא כולל קבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.

ערכים (מופרדים באמצעות "|"): bot, sysop, bureaucrat
pcexcludegroup

לא לכלול משתמשים בקבוצות הנתונות. לא כולל קבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.

ערכים (מופרדים באמצעות "|"): bot, sysop, bureaucrat
pcrights

לכלול רק משתמשים עם ההרשאות הנתונות. לא כולל הרשאות שניתנו בקבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.

ערכים (מופרדים באמצעות "|"): apihighlimits, applychangetags, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, 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, passwordreset, patrol, patrolmarks, protect, proxyunbannable, 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
מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
pcexcluderights

לא לכלול משתמשים עם ההרשאות הנתונות. לא כולל הרשאות שניתנו בקבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.

ערכים (מופרדים באמצעות "|"): apihighlimits, applychangetags, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, 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, passwordreset, patrol, patrolmarks, protect, proxyunbannable, 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
מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
pclimit

כמה תורמים להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
pccontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמה:
הצגת תורמים לדף עמוד ראשי.
api.php?action=query&prop=contributors&titles=Main_Page

prop=deletedrevisions (drv)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת מידע על גרסה מחוקה.

יכול לשמש במספר דרכים:

  1. קבלת גרסאות מחוקות עבור ערכת דפים, על־ידי הגדרת שמות או מזהי דף. ממוין לפי שם וחותם־זמן.
  2. קבלת מידע על ערכת גרסאות מחוקות באמצעות הגדרת המזהים שלהם עם revid־ים. ממוין לפי מזהה גרסה.
פרמטרים:
drvprop

אילו מאפיינים לקבל עבור כל גרסה:

ids
מזהה הגרסה.
flags
דגלי גרסה (משני).
timestamp
חותם־הזמן של הגרסה.
user
המתמש שעשה את הגרסה
userid
מזהה המשתמש של יוצר הגרסה.
size
אורך (בבתים) של הגרסה.
sha1
SHA-1 (בבסיס 16) של הגרסה.
contentmodel
מזהה מודל התוכן של הגרסה.
comment
הערה מאת המשתמש על הגרסה.
parsedcomment
הערה מפוענחת מאת המשתמש על הגרסה.
content
הטקסט של הגרסה.
tags
התגים עבור הגרסה.
parsetree
עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן wikitext).
ערכים (מופרדים באמצעות "|"): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
ברירת מחדל: ids|timestamp|flags|comment|user
drvlimit

הגבלת מספר הגרסאות שיוחזרו.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
drvexpandtemplates

להרחיב תבניות בתוכן הגרסה (דורש drvprop=content).

סוג: בוליאני (פרטים)
drvgeneratexml
מיושן.

יצירת עץ פענוח XML עבור תוכן הגרסה (דורש את drvprop=content; מוחלף ב־drvprop=parsetree).

סוג: בוליאני (פרטים)
drvparse

פענוח תוכן הגרסה (דורש drvprop=content). מסיבות של ביצועים, אם האפשרות הזאת משמשת, drvlimit נכפה לערך 1.

סוג: בוליאני (פרטים)
drvsection

לאחזר רק את התוכן של הפִסקה עם המספר הזה.

drvdiffto

מזהה הגרסה שאליו תושווה כל גרסה. יש להשתמש ב־prev‏, next ו־cur עבור הגרסה הקודמת, הבא והנוכחית, בהתאמה.

drvdifftotext

הטקסט שאליו תושווה כל גרסה. מבצע השוואה רק של מספר מוגבל של גרסאות. דורס את drvdiffto. אם מוגדר drvsection, רק הפסקה הזאת תושווה אל מול הטקסט הזה.

drvcontentformat

תסדיר ההסדרה שמשמש את drvdifftotext וצפוי לפלט של תוכן.

אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
drvstart

מאיזה חותם־זמן להתחיל למנות. לא תקף בעיבוד רשימת מזהי גרסה.

סוג: חותם־זמן (תסדירים מורשים)
drvend

באיזה חותם־זמן להפסיק למנות. לא תקף בעת עיבוד רשימת מזהי גרסה.

סוג: חותם־זמן (תסדירים מורשים)
drvdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: drvstart חייב להיות לפני drvend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: drvstart חייב להיות אחרי drvend.
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
drvtag

לרשום רק גרסאות עם התג הזה.

drvuser

לרשום רק גרסאות מאת המשתמש הזה.

סוג: שם משתמש
drvexcludeuser

לא לרשום גרסאות מאת המשתמש הזה.

סוג: שם משתמש
drvcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
רשימת גרסאות מחוקות של הדפים Main Page ו־Talk:Main Page, עם תוכן.
api.php?action=query&prop=deletedrevisions&titles=Main%20Page|Talk:Main%20Page&drvprop=user|comment|content
קבלת מידע לגרסה המחוקה 123456.
api.php?action=query&prop=deletedrevisions&revids=123456

prop=duplicatefiles (df)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

רשימת כל הקבצים שהם כפולים של קבצים נתונים לפי ערכי הגיבוב.

פרמטרים:
dflimit

כמה קבצים כפולים להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
dfcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

dfdir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
dflocalonly

חיפוש אחר קבצים במאגר המקומי בלבד.

סוג: בוליאני (פרטים)
דוגמאות:
חיפוש אחר כפילויות של קובץ:Albert Einstein Head.jpg.
api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles
חיפוש אחר כפילויות בין כל הקבצים.
api.php?action=query&generator=allimages&prop=duplicatefiles
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת כל ה־URL־ים החיצוניים (לא בינוויקי) מהדפים הנתונים.

פרמטרים:
ellimit

כמה קישורים להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
eloffset

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

סוג: מספר שלם
elprotocol

הפרוטוקול של ה־URL. אם זה ריק, ו־elquery מוגדר, הפרוטוקול הוא http. יש להשאיר את זה ואת elquery ריק כדי לרשום את כל הקישורים החיצוניים.

אחד מהערכים הבאים: יכול להיות ריק או 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
ברירת מחדל: (ריק)
elquery

מחרוזת חיפוש ללא פרוטוקול. שימושי לבדיקה האם דף מסוים מכיל url חיצוני מסוים.

elexpandurl

הרחבת URL־ים בעלי פרוטוקול יחסי בפרוטוקול קנוני.

סוג: בוליאני (פרטים)
דוגמה:
קבלת רשימת קישורים חיצוניים ב־Main Page.
api.php?action=query&prop=extlinks&titles=Main%20Page

prop=fileusage (fu)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מציאת כל הדפים שמשתמשים בקבצים הנתונים.

פרמטרים:
fuprop

אילו מאפיינים לקבל:

pageid
מזהה הדף של כל דף.
title
השם של כל דף.
redirect
דגל אם הדף הוא הפניה.
ערכים (מופרדים באמצעות "|"): pageid, title, redirect
ברירת מחדל: pageid|title|redirect
funamespace

לכלול רק דפים במרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
fushow

לחפש רק פריטים שמתאימים לאמות המידה הבאות:

redirect
להציג רק הפניות.
!redirect
לא להציג הפניות.
ערכים (מופרדים באמצעות "|"): redirect, !redirect
fulimit

כמה להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
fucontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
קבלת רשימת דפים שמשתמשים ב־File:Example.jpg.
api.php?action=query&prop=fileusage&titles=File%3AExample.jpg
קבלת מידע על דפים שמשתמשים ב־File:Example.jpg.
api.php?action=query&generator=fileusage&titles=File%3AExample.jpg&prop=info

prop=imageinfo (ii)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת מידע על קובץ והיסטורייה העלאה.

פרמטרים:
iiprop

איזה מידע על הקובץ לקבל:

timestamp
הוספת חותם־זמן לגרסה שהועלתה.
user
הוספה המשתמש שהעלה כל גרסה של קובץ.
userid
הוספת מזהה המשתמש שהעלה כל גרסה של קובץ.
comment
תגובה על הגרסה.
parsedcomment
פענוח ההערה על גרסה.
canonicaltitle
הוספת הכותרת הקנונית של הקובץ.
url
מתן URL לקובץ ולדף התיאור.
size
הוספת הגודל של הקובץ בבתים והגובה, הרוחב ומניין הדפים (אם זה מתאים).
dimensions
כינוי ל־size.
sha1
הוספת גיבוב SHA-1 עבור הקובץ.
mime
הוספת סוג ה־MIME של הקובץ.
thumbmime
הוספת סוג ה־MIME של התמונה הממוזערת (נדרש url והפרמטר iiurlwidth).
mediatype
הוספת סוג המדיה של הקובץ.
metadata
טעינת מטא־נתונים של Exif עבור גרסת הקובץ.
commonmetadata
רשימת מטא־נתונים כלליים על תסדיר הקובץ עבור גרסת הקובץ.
extmetadata
רשימת מטא־נתונים מעוצבים משולבים ממספר מקורות. התוצאה מעוצבת ב־HTML.
archivename
הוספת שם הקובץ של גרסת הארכיון עבור הגרסאות שאינן האחרונה.
bitdepth
הוספת עומק הביטים של הגרסה.
uploadwarning
משמש את Special:Upload כדי לקבל מידע על קובץ קיים. לא נועד לשימוש מחוץ לליבת MediaWiki.
ערכים (מופרדים באמצעות "|"): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning
ברירת מחדל: timestamp|user
iilimit

כמה גרסאות של קובץ לכל קובץ.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 1
iistart

מאיז חותם־זמן להתחיל רשימה.

סוג: חותם־זמן (תסדירים מורשים)
iiend

באיזה חותם־זמן לסיים את הרשימה.

סוג: חותם־זמן (תסדירים מורשים)
iiurlwidth

אם מוגדר iiprop=url, יוחזר URL לתמונה שגודלה הותאם לרוחב הזה. מסיבות של ביצועים, אם האפשרות הזאת משמשת, לא יוחזרו יותר מ־50 תמונות.

סוג: מספר שלם
ברירת מחדל: -1
iiurlheight

דומה ל־iiurlwidth.

סוג: מספר שלם
ברירת מחדל: -1
iimetadataversion

גרסת המטא־נתונים לשימוש. אם מוגדר latest, להשתמש בגרסה החדשה ביותר. בררת המחדל היא 1 לצורך תאימות אחורה.

ברירת מחדל: 1
iiextmetadatalanguage

באיזו שפה לאחזר את המטא־נתונים. זה משפיע על אילו תרגומים לאחזר, האם יש כמה, וגם איך דברים כמו מספרים וערכים שונים מעוצבים.

ברירת מחדל: he
iiextmetadatamultilang

אם תרגומים של המאפיין extmetadata זמינים, לאחזר את כולם.

סוג: בוליאני (פרטים)
iiextmetadatafilter

אם זה מוגדר ולא ריק, רק המפתחות האלה יוחזרו עבור iiprop=extmetadata.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
iiurlparam

מחרוזת פרמטר ייחודית למטפל. למשל, PDF־ים יכולים להשתמש ב־page15-100px.‏ iiurlwidth צריך לשמש ולהיות עקבי עם iiurlparam.

ברירת מחדל: (ריק)
iicontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

iilocalonly

חיפוש אחר קבצים במאגר המקומי בלבד.

סוג: בוליאני (פרטים)

prop=images (im)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

להחזיר את כל הקבצים שמכילים הדפים הנתונים.

פרמטרים:
imlimit

כמה קבצים להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
imcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

imimages

לרשום רק את הקבצים האלה. שימוש לבדיקת האם לדף מסוים יש קובץ מסוים.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
imdir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
דוגמאות:
קבלת רשימת קבצים שמשמשים ב־Main Page.
api.php?action=query&prop=images&titles=Main%20Page
קבלת מידע על כל הקבצים שמשמשים ב־Main Page.
api.php?action=query&generator=images&titles=Main%20Page&prop=info

prop=info (in)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת מידע בסיסי על הדף.

פרמטרים:
inprop

אילו מאפיינים נוספים לקבל:

protection
לרשום את רמת ההגנה של כל דף.
talkid
מזהה הדף של דף השיחה עבור כל דף שאינו דף שיחה.
watched
לרשום את מצב המעקב של כל דף.
watchers
מספר העוקבים, אם קיבלת הרשאה.
notificationtimestamp
חותם־זמן של הודעת רשימת מעקב של כל דף.
subjectid
מזהה הדף של הדף העיקרי של כל דף שיחה.
url
נותן URL מלא, URL לעריכה ו־URL קנוני לכל דף.
readable
האם המשתמש יכול להציג דף זה.
preload
נותן את הטקסט שמוחזר על־ידי EditFormPreloadText.
displaytitle
נותן את האופן שבה שם הדף באמת מוצג.
ערכים (מופרדים באמצעות "|"): protection, talkid, watched, watchers, notificationtimestamp, subjectid, url, readable, preload, displaytitle
intestactions

בדיקה האם המשתמש הנוכחי יכול לבצע פעולות מסוימות על הדף.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
intoken
מיושן.

להשתמש ב־action=query&meta=tokens במקום.

ערכים (מופרדים באמצעות "|"): edit, delete, protect, move, block, unblock, email, import, watch
incontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
קבלת מידע על הדף Main Page
api.php?action=query&prop=info&titles=Main%20Page
קבלת מידע כללי ומידע על הגנה של הדף Main Page.
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת כל קישורי הבינוויקי מהדפים הנתונים.

פרמטרים:
iwprop

אילו מאפיינים נוספים לקבל עבור כל קישור בין־לשוני:

url
הוספת ה־URL המלא.
ערכים (מופרדים באמצעות "|"): url
iwprefix

להחזיר רק קישורי בינוויקי עם התחילית הזאת.

iwtitle

איזה קישור בינוויקי לחפש. צריך להשתמש בזה יחד עם iwprefix.

iwdir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
iwlimit

כמה קישורי בינוויקי להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
iwcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

iwurl
מיושן.

האם לקבל את ה־URL המלא (לא יכול לשמש עם iwprop).

סוג: בוליאני (פרטים)
דוגמה:
קבלת קישורי בינוויקי מהדף Main Page.
api.php?action=query&prop=iwlinks&titles=Main%20Page
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת כל הקישורים הבין־לשוניים מהדפים הנתונים.

פרמטרים:
llprop

אילו מאפיינים נוספים לקבל עבור כל קישור בין־לשוני:

url
הוספת ה־URL המלא.
langname
הוספת שם השפה המתורגם (עם המאמץ הטוב ביותר). יש להשתמש ב־llinlanguagecode כדי לשלוט בשפה.
autonym
הוספת השם הילידי של השפה.
ערכים (מופרדים באמצעות "|"): url, langname, autonym
lllang

להחזיר רק קישורי שפה עם קוד השפה הזה.

lltitle

קישור לחיפוש. חובה להשתמש עם lllang.

lldir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
llinlanguagecode

קוד שפה ששמות שפות מתורגמות.

ברירת מחדל: he
lllimit

כמה קישורי שפה להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
llcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

llurl
מיושן.

האם לקבל את ה־URL המלא (לא יכול לשמש עם llprop).

סוג: בוליאני (פרטים)
דוגמה:
קבלת קישורים בין־לשוניים מהדף Main Page.
api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=
  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת כל הקישורים מהדפים שצוינו.

פרמטרים:
plnamespace

להציג קישורים רק במרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
pllimit

כמה קישורים להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
plcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

pltitles

לרשום רק קישורים לכותרות האלו. שימושי לבדיקה האם דף מסוים מקשר לכותרת מסוימת.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
pldir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
דוגמאות:
קבלת קישורים מהדף Main Page
api.php?action=query&prop=links&titles=Main%20Page
קבלת מידע על דפי הקישור בדף Main Page.
api.php?action=query&generator=links&titles=Main%20Page&prop=info
קבלת קישורים מהדף Main Page במרחבי השם משתמש ו־תבנית.
api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10

prop=linkshere (lh)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מציאת כל הדפים שמקשרים לדפים הנתונים.

פרמטרים:
lhprop

אילו מאפיינים לקבל:

pageid
מזהה הדף של כל דף.
title
השם של כל דף.
redirect
דגל אם הדף הוא הפניה.
ערכים (מופרדים באמצעות "|"): pageid, title, redirect
ברירת מחדל: pageid|title|redirect
lhnamespace

לכלול רק דפים במרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
lhshow

הצגת פריטים שתואמים את הדרישות הללו בלבד:

redirect
הצגת הפניות בלבד.
!redirect
הצגת קישורים שאינם הפניות בלבד.
ערכים (מופרדים באמצעות "|"): redirect, !redirect
lhlimit

כמה להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
lhcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
קבלת רשימת דפים שמקשרים ל־Main Page.
api.php?action=query&prop=linkshere&titles=Main%20Page
קבל מידע על דפים שמקשרים ל־Main Page.
api.php?action=query&generator=linkshere&titles=Main%20Page&prop=info

prop=pageprops (pp)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת מאפיינים שונים בתוכן הדף.

פרמטרים:
ppcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

ppprop

לרשום רק את המאפיינים האלה. שימושי לבדיקה האם דף מסוים משתמש במאפיין דף מסוים.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
דוגמה:
קבלת מאפיינים עבור הדפים Main Page ו־MediaWiki.
api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki

prop=redirects (rd)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מחזיר את כל ההפניות לדפים הנתונים.

פרמטרים:
rdprop

אילו מאפיינים לקבל:

pageid
מזהה הדף של כל הפניה.
title
השם של כל הפניה.
fragment
מובאה מכל הפניה, אם יש.
ערכים (מופרדים באמצעות "|"): pageid, title, fragment
ברירת מחדל: pageid|title
rdnamespace

לכלול רק דפים במרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
rdshow

לחפש רק פריטים שמתאימים לאמות המידה הבאות:

fragment
להציג רק הפניות עם מקטע.
!fragment
להציג רק הפניות ללא מקטע.
ערכים (מופרדים באמצעות "|"): fragment, !fragment
rdlimit

כמה הפניות להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
rdcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
קבלת רשימת הפניות ל־Main Page
api.php?action=query&prop=redirects&titles=Main%20Page
קבלת מידע על כל ההפניות ל־Main Page.
api.php?action=query&generator=redirects&titles=Main%20Page&prop=info

prop=revisions (rv)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת מידע על גרסה.

יכול לשמש במספר דרכים:

  1. קבלת נתונים על ערכת דפים (גרסה אחרונה), באמצעות כותרות או מזהי דף.
  2. קבלת גרסאות עבור דף נתון אחד, באמצעות שימוש בכותרות או במזהי דף עם start‏, end או limit.
  3. קבלת נתונים על ערכת גרסאות באמצעות הגדרת המזהים שלהם עם revid־ים.
פרמטרים:
rvprop

אילו מאפיינים לקבל עבור כל גרסה:

ids
מזהה הגרסה.
flags
דגלי גרסה (משני).
timestamp
חותם־הזמן של הגרסה.
user
המתמש שעשה את הגרסה
userid
מזהה המשתמש של יוצר הגרסה.
size
אורך (בבתים) של הגרסה.
sha1
SHA-1 (בבסיס 16) של הגרסה.
contentmodel
מזהה מודל התוכן של הגרסה.
comment
הערה מאת המשתמש על הגרסה.
parsedcomment
הערה מפוענחת מאת המשתמש על הגרסה.
content
הטקסט של הגרסה.
tags
התגים עבור הגרסה.
parsetree
עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן wikitext).
ערכים (מופרדים באמצעות "|"): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
ברירת מחדל: ids|timestamp|flags|comment|user
rvlimit

הגבלת מספר הגרסאות שיוחזרו.

יכול לשמש רק עם דף בודד (mode #2).
המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
rvexpandtemplates

להרחיב תבניות בתוכן הגרסה (דורש rvprop=content).

סוג: בוליאני (פרטים)
rvgeneratexml
מיושן.

יצירת עץ פענוח XML עבור תוכן הגרסה (דורש את rvprop=content; מוחלף ב־rvprop=parsetree).

סוג: בוליאני (פרטים)
rvparse

פענוח תוכן הגרסה (דורש rvprop=content). מסיבות של ביצועים, אם האפשרות הזאת משמשת, rvlimit נכפה לערך 1.

סוג: בוליאני (פרטים)
rvsection

לאחזר רק את התוכן של הפִסקה עם המספר הזה.

rvdiffto

מזהה הגרסה שאליו תושווה כל גרסה. יש להשתמש ב־prev‏, next ו־cur עבור הגרסה הקודמת, הבא והנוכחית, בהתאמה.

rvdifftotext

הטקסט שאליו תושווה כל גרסה. מבצע השוואה רק של מספר מוגבל של גרסאות. דורס את rvdiffto. אם מוגדר rvsection, רק הפסקה הזאת תושווה אל מול הטקסט הזה.

rvcontentformat

תסדיר ההסדרה שמשמש את rvdifftotext וצפוי לפלט של תוכן.

אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
rvstartid

מאיזה מזהה גרסה להתחיל למנות.

יכול לשמש רק עם דף בודד (mode #2).
סוג: מספר שלם
rvendid

באיזה מזהה גרסה להפסיק את מניית הגרסאות.

יכול לשמש רק עם דף בודד (mode #2).
סוג: מספר שלם
rvstart

מאיזה חותם־זמן של גרסה להתחיל למנות.

יכול לשמש רק עם דף בודד (mode #2).
סוג: חותם־זמן (תסדירים מורשים)
rvend

למנות עד חותם־הזמן הזה.

יכול לשמש רק עם דף בודד (mode #2).
סוג: חותם־זמן (תסדירים מורשים)
rvdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: rvstart חייב להיות לפני rvend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: rvstart חייב להיות אחרי rvend.
יכול לשמש רק עם דף בודד (mode #2).
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
rvuser

לכלול רק גרסאות מאת משתמש.

יכול לשמש רק עם דף בודד (mode #2).
סוג: שם משתמש
rvexcludeuser

לא לכלול שינויים מאת משתמש.

יכול לשמש רק עם דף בודד (mode #2).
סוג: שם משתמש
rvtag

לרשום רק גרסאות עם התג הזה.

rvtoken
מיושן.

אילו אסימונים לקבל עבור כל גרסה.

ערכים (מופרדים באמצעות "|"): rollback
rvcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
קבל נתונים על תוכן עבור הגרסאות האחרונות של הכותרות API ו־Main Page.
api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content
קבלת 5 הגרסאות האחרונות של Main Page.
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment
קבלת 5 הגרסאות הראשונות של Main Page.
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer
קבלת 5 הגרסאות הראשונות של Main Page שנעשו אחרי 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
קבלת 5 הגרבאות הראשונות של Main Page שלא נעשו על־ידי המשתמש האלמוני 127.0.0.1.
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1
קבלת 5 הגרסאות הראשונות של Main Page שנעשו על־ידי המשתמש MediaWiki default.
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default

prop=stashimageinfo (sii)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת מידע על הקובץ עבור הקבצים המוסלקים.

פרמטרים:
siifilekey

מפתח שמזהה העלאה קודמת שהונחה בצד באופן זמני.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
siisessionkey
מיושן.

כינוי ל־siifilekey, לתאימות אחורה.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
siiprop

איזה מידע על הקובץ לקבל:

timestamp
הוספת חותם־זמן לגרסה שהועלתה.
canonicaltitle
הוספת הכותרת הקנונית של הקובץ.
url
מתן URL לקובץ ולדף התיאור.
size
הוספת הגודל של הקובץ בבתים והגובה, הרוחב ומניין הדפים (אם זה מתאים).
dimensions
כינוי ל־size.
sha1
הוספת גיבוב SHA-1 עבור הקובץ.
mime
הוספת סוג ה־MIME של הקובץ.
thumbmime
הוספת סוג ה־MIME של התמונה הממוזערת (נדרש url והפרמטר siiurlwidth).
metadata
טעינת מטא־נתונים של Exif עבור גרסת הקובץ.
commonmetadata
רשימת מטא־נתונים כלליים על תסדיר הקובץ עבור גרסת הקובץ.
extmetadata
רשימת מטא־נתונים מעוצבים משולבים ממספר מקורות. התוצאה מעוצבת ב־HTML.
bitdepth
הוספת עומק הביטים של הגרסה.
ערכים (מופרדים באמצעות "|"): timestamp, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, metadata, commonmetadata, extmetadata, bitdepth
ברירת מחדל: timestamp|url
siiurlwidth

אם מוגדר siiprop=url, יוחזר URL לתמונה שגודלה הותאם לרוחב הזה. מסיבות של ביצועים, אם האפשרות הזאת משמשת, לא יוחזרו יותר מ־50 תמונות.

סוג: מספר שלם
ברירת מחדל: -1
siiurlheight

דומה ל־siiurlwidth.

סוג: מספר שלם
ברירת מחדל: -1
siiurlparam

מחרוזת פרמטר ייחודית למטפל. למשל, PDF־ים יכולים להשתמש ב־page15-100px.‏ siiurlwidth צריך לשמש ולהיות עקבי עם siiurlparam.

ברירת מחדל: (ריק)
דוגמאות:
החזרת מידע על קובץ מוסלק.
api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567
החזרת תמונות ממוזערות עבור שני קבצים מוסלקים.
api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurlwidth=120&siiprop=url

prop=templates (tl)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת כל הדפים המוכללים בדפים הנתונים.

פרמטרים:
tlnamespace

הצגת תבניות רק במרחב השם הזה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
tllimit

כמה תבניות להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
tlcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

tltemplates

לרשום רק את התבניות האלו. שימושי לבדיקה האם דף מסוים משתמש בתבנית מסוימת.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
tldir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
דוגמאות:
קבלת התבניות המשמשות בדף Main Page.
api.php?action=query&prop=templates&titles=Main%20Page
קבלת מידע על דפי התבנית שמשמשים ב־Main Page.
api.php?action=query&generator=templates&titles=Main%20Page&prop=info
קבלת מידע במרחבי השם משתמש ו־תבנית שמוכללים בדף Main Page.
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10

prop=transcludedin (ti)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מציאת כל הדפים שמכלילים את הדפים הנתונים.

פרמטרים:
tiprop

אילו מאפיינים לקבל:

pageid
מזהה הדף של כל דף.
title
השם של כל דף.
redirect
דגל אם הדף הוא הפניה.
ערכים (מופרדים באמצעות "|"): pageid, title, redirect
ברירת מחדל: pageid|title|redirect
tinamespace

לכלול רק דפים במרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
tishow

לחפש רק פריטים שמתאימים לאמות המידה הבאות:

redirect
להציג רק הפניות.
!redirect
לא להציג הפניות.
ערכים (מופרדים באמצעות "|"): redirect, !redirect
tilimit

כמה להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
ticontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
קבלת רשימה של דפים שמכלילים את Main Page.
api.php?action=query&prop=transcludedin&titles=Main%20Page
קבלת מידע על הדפים שמכלילים את Main Page.
api.php?action=query&generator=transcludedin&titles=Main%20Page&prop=info

list=allcategories (ac)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

למנות את כל הקטגוריות.

פרמטרים:
acfrom

מאיזו קטגוריה להתחיל למנות.

accontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

acto

באיזו קטגוריה להפסיק למנות.

acprefix

חיפוש כל כותרות הקטגוריות שמתחילות בערך הזה.

acdir

באיזה כיוון למיין.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
acmin

להחזיר רק קטגוריות עם מספר כזה לפחות של חברים.

סוג: מספר שלם
acmax

להחזיר רק קטגוריות עם מספר כזה לכל היותר של חברים.

סוג: מספר שלם
aclimit

כמה קטגוריות להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
acprop

אילו מאפיינים לקבל:

size
הוספת מספר הדפים בקטגוריה.
hidden
מתייג קטגוריות מוסתרות עם __HIDDENCAT__.
ערכים (מופרדים באמצעות "|"): size, hidden
ברירת מחדל: (ריק)
דוגמאות:
רשימת קטגוריות עם מידע על מספר הדפים בכל אחת מהן.
api.php?action=query&list=allcategories&acprop=size
אחזור מידע על דף הקטגוריה עצמו עבור קטגוריות שמתחילות ב־List.
api.php?action=query&generator=allcategories&gacprefix=List&prop=info

list=alldeletedrevisions (adr)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

רשימת כל הגרסאות המחוקות על־ידי משתמש או במרחב.

פרמטרים:
adrprop

אילו מאפיינים לקבל עבור כל גרסה:

ids
מזהה הגרסה.
flags
דגלי גרסה (משני).
timestamp
חותם־הזמן של הגרסה.
user
המתמש שעשה את הגרסה
userid
מזהה המשתמש של יוצר הגרסה.
size
אורך (בבתים) של הגרסה.
sha1
SHA-1 (בבסיס 16) של הגרסה.
contentmodel
מזהה מודל התוכן של הגרסה.
comment
הערה מאת המשתמש על הגרסה.
parsedcomment
הערה מפוענחת מאת המשתמש על הגרסה.
content
הטקסט של הגרסה.
tags
התגים עבור הגרסה.
parsetree
עץ פענוח XML של תוכן הגרסה (דורש מודל תוכן wikitext).
ערכים (מופרדים באמצעות "|"): ids, flags, timestamp, user, userid, size, sha1, contentmodel, comment, parsedcomment, content, tags, parsetree
ברירת מחדל: ids|timestamp|flags|comment|user
adrlimit

הגבלת מספר הגרסאות שיוחזרו.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
adrexpandtemplates

להרחיב תבניות בתוכן הגרסה (דורש adrprop=content).

סוג: בוליאני (פרטים)
adrgeneratexml
מיושן.

יצירת עץ פענוח XML עבור תוכן הגרסה (דורש את adrprop=content; מוחלף ב־adrprop=parsetree).

סוג: בוליאני (פרטים)
adrparse

פענוח תוכן הגרסה (דורש adrprop=content). מסיבות של ביצועים, אם האפשרות הזאת משמשת, adrlimit נכפה לערך 1.

סוג: בוליאני (פרטים)
adrsection

לאחזר רק את התוכן של הפִסקה עם המספר הזה.

adrdiffto

מזהה הגרסה שאליו תושווה כל גרסה. יש להשתמש ב־prev‏, next ו־cur עבור הגרסה הקודמת, הבא והנוכחית, בהתאמה.

adrdifftotext

הטקסט שאליו תושווה כל גרסה. מבצע השוואה רק של מספר מוגבל של גרסאות. דורס את adrdiffto. אם מוגדר adrsection, רק הפסקה הזאת תושווה אל מול הטקסט הזה.

adrcontentformat

תסדיר ההסדרה שמשמש את adrdifftotext וצפוי לפלט של תוכן.

אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
adruser

לרשום רק גרסאות מאת המשתמש הזה.

סוג: שם משתמש
adrnamespace

לרשום רק דפים במרחב השם הזה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
adrstart

מאיזה חותם־זמן להתחיל למנות.

יכול לשמש רק adruser.
סוג: חותם־זמן (תסדירים מורשים)
adrend

באיזה חותם־זמן להפסיק למנות.

יכול לשמש רק adruser.
סוג: חותם־זמן (תסדירים מורשים)
adrdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: adrstart חייב להיות לפני adrend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: adrstart חייב להיות אחרי adrend.
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
adrfrom

להתחיל את הרשימה בשם הזה.

לא יכול לשמש עם adruser.
adrto

להפסיק את הרשימה בכותרת הזאת.

לא יכול לשמש עם adruser.
adrprefix

חיפוש כל שמות הדפים שמתחילים בערך הזה.

לא יכול לשמש עם adruser.
adrexcludeuser

לא לרשום גרסאות מאת המשתמש הזה.

לא יכול לשמש עם adruser.
סוג: שם משתמש
adrtag

לרשום רק גרסאות עם התג הזה.

adrcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

adrgeneratetitles

בעת שימוש בתור מחולל, לחולל כותרת במקום מזהי גרסה.

סוג: בוליאני (פרטים)
דוגמאות:
לרשום את 50 התרומות המחוקות האחרונות של משתמש Example.
api.php?action=query&list=alldeletedrevisions&adruser=Example&adrlimit=50
רשימת 50 הגרסאות המחוקות הראשונות במרחב הראשי.
api.php?action=query&list=alldeletedrevisions&adrdir=newer&adrlimit=50

list=allfileusages (af)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לרשום את כל שימושי הקובץ, כולל בלתי־קיימים.

פרמטרים:
afcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

affrom

מאיזה שם קובץ להתחיל למנות.

afto

שם הקובץ שהמנייה תסתיים בו.

afprefix

חיפוש כל שמות הקבצים שמתחילים עם הערך הזה.

afunique

להציג רק שמות קבצים ייחודיים. לא יכול לשמש עם afprop=ids. בעת שימוש בתור מחולל, נותן דפי יעד במקום דפי מקור.

סוג: בוליאני (פרטים)
afprop

אילו חלקי מידע לכלול:

ids
הוספת מזהי הדף של הדפים המשתמשים (לא יכול לשמש עם afunique).
title
הוספת שם הקובץ.
ערכים (מופרדים באמצעות "|"): ids, title
ברירת מחדל: title
aflimit

כמה פריטים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
afdir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
דוגמאות:
רשימת שמות קבצים, כולל חסרים, עם מזהי הדפים שהם מופיעים בהם, החל מ־B.
api.php?action=query&list=allfileusages&affrom=B&afprop=ids|title
רשימת שמות קבצים ייחודיים.
api.php?action=query&list=allfileusages&afunique=&affrom=B
קבלת כל שמות הקבצים, כולל חסרים.
api.php?action=query&generator=allfileusages&gafunique=&gaffrom=B
קבלת דפים שמכילים את הקבצים.
api.php?action=query&generator=allfileusages&gaffrom=B

list=allimages (ai)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

למנות את כל התמונות לפי הסדר.

פרמטרים:
aisort

לפי איזה מאפיין למיין.

אחד מהערכים הבאים: name, timestamp
ברירת מחדל: name
aidir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending, newer, older
ברירת מחדל: ascending
aifrom

מאיזה שם תמונה להתחיל למנות. יכול לשמש רק עם aisort=name.

aito

כותרת תמונה שבה תסתיים המניי. יכול לשמש רק עם aisort=name.

aicontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

aistart

מאיזה חותם־זמן להתחיל למנות. יכול לשמש רק עם aisort=timestamp.

סוג: חותם־זמן (תסדירים מורשים)
aiend

באיזה חותם זמן להפסיק לרשום. אפשר להשתמש בזה רק עם aisort=timestamp.

סוג: חותם־זמן (תסדירים מורשים)
aiprop

איזה מידע על הקובץ לקבל:

timestamp
הוספת חותם־זמן לגרסה שהועלתה.
user
הוספה המשתמש שהעלה כל גרסה של קובץ.
userid
הוספת מזהה המשתמש שהעלה כל גרסה של קובץ.
comment
תגובה על הגרסה.
parsedcomment
פענוח ההערה על גרסה.
canonicaltitle
הוספת הכותרת הקנונית של הקובץ.
url
מתן URL לקובץ ולדף התיאור.
size
הוספת הגודל של הקובץ בבתים והגובה, הרוחב ומניין הדפים (אם זה מתאים).
dimensions
כינוי ל־size.
sha1
הוספת גיבוב SHA-1 עבור הקובץ.
mime
הוספת סוג ה־MIME של הקובץ.
mediatype
הוספת סוג המדיה של הקובץ.
metadata
טעינת מטא־נתונים של Exif עבור גרסת הקובץ.
commonmetadata
רשימת מטא־נתונים כלליים על תסדיר הקובץ עבור גרסת הקובץ.
extmetadata
רשימת מטא־נתונים מעוצבים משולבים ממספר מקורות. התוצאה מעוצבת ב־HTML.
bitdepth
הוספת עומק הביטים של הגרסה.
ערכים (מופרדים באמצעות "|"): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, mediatype, metadata, commonmetadata, extmetadata, bitdepth
ברירת מחדל: timestamp|url
aiprefix

חיפוש כל שמות התמונות שמתחילים בערך הזה. יכול לשמש רק עם aisort=name.

aiminsize

להגביל לתמונות עם מספר כזה של בתים לפחות.

סוג: מספר שלם
aimaxsize

להגביל לתמונות עם מספר כזה לכל היותר של בתים.

סוג: מספר שלם
aisha1

גיבוב SHA1 של תמונה. דריסת aisha1base36.

aisha1base36

גיבוב SHA1 של התמונה בבסיס 36 (הבסיס בו נעשה שימוש במדיה־ויקי).

aiuser

להחזיר רק קבצים שהועלו על־ידי המשתמש הזה. יכול לשמש רק עם aisort=timestamp. לא יכול לשמש יחד עם aifilterbots.

סוג: שם משתמש
aifilterbots

איך לסנן קבצים שמעלים בוטים. יכול לשמש רק עם aisort=timestamp. לא יכול לשמש יחד עם aiuser.

אחד מהערכים הבאים: all, bots, nobots
ברירת מחדל: all
aimime

אילו סוגי MIME לחבפש, למשל image/jpeg.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
ailimit

כמה תמונות להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
דוגמאות:
הצגת רשימה של קבצים שמתחילים באות B.
api.php?action=query&list=allimages&aifrom=B
הצגת רשימת קבצים שהועלו לאחרונה, דומה ל־Special:NewFiles.
api.php?action=query&list=allimages&aiprop=user|timestamp|url&aisort=timestamp&aidir=older
להציג רשימה של קבצות שסוג ה־MIME שלהם הוא image/png או image/png.
api.php?action=query&list=allimages&aimime=image/png|image/gif
הצגת מידע על 4 קבצים המתחילים באות T.
api.php?action=query&generator=allimages&gailimit=4&gaifrom=T&prop=imageinfo
  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

למנות את כל הקישורים שמצביעים למרחב שם נתון.

פרמטרים:
alcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

alfrom

מאיזה שם קישור להתחיל למנות.

alto

כותרת הקישור שהמנייה תסתיים בו.

alprefix

חיפוש כל הכותרות המקושרות שמתחילות בערך הזה.

alunique

להציג רק שמות מקושרים ייחודיים. לא יכול לשמש עם alprop=ids. בעת שימוש בתור מחולל, נותן דפי יעד במקום דפי מקור.

סוג: בוליאני (פרטים)
alprop

אילו חלקי מידע לכלול:

ids
הוספת מזהי הדף של הדף המקשר (לא יכול לשמש עם alunique).
title
הוספת שם הקישור.
ערכים (מופרדים באמצעות "|"): ids, title
ברירת מחדל: title
alnamespace

איזה מרחב שם למנות.

אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ברירת מחדל: 0
allimit

כמה פריטים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
aldir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
דוגמאות:
רשימת כותרות מקושרות, כולל חסרות, עם מזהי הדפים שהן מופיעות בהם, החל מ־B.
api.php?action=query&list=alllinks&alfrom=B&alprop=ids|title
רשימת כותרות מקושרים ייחודיות.
api.php?action=query&list=alllinks&alunique=&alfrom=B
קבלת כל הכותרות המקושרות, וסימון החסרות.
api.php?action=query&generator=alllinks&galunique=&galfrom=B
קבלת דפים שמכילים את הקישורים.
api.php?action=query&generator=alllinks&galfrom=B

list=allpages (ap)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

למנות את כל הדפים לפי הסדר במרחב שם נתון.

פרמטרים:
apfrom

מאיזה שם דף להתחיל למנות.

apcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

apto

כותרת הדף שהמנייה תסתיים בו.

apprefix

חיפוש כל שמות הדפים שמתחילים בערך הזה.

apnamespace

איזה מרחב שם למנות.

אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ברירת מחדל: 0
apfilterredir

אילו דפים לרשום.

אחד מהערכים הבאים: all, redirects, nonredirects
ברירת מחדל: all
apminsize

להגביל לדפים עם מספר כזה לפחות של בתים.

סוג: מספר שלם
apmaxsize

להגביל לדפים שיש בהם לכל היותר מספר כזה של בתים.

סוג: מספר שלם
apprtype

להגביל רק לדפים מוגנים.

ערכים (מופרדים באמצעות "|"): edit, move, upload
apprlevel

לסנו הגנות לפי רמת ההגנה (חייב לשמש עם apprtype= parameter).

ערכים (מופרדים באמצעות "|"): יכול להיות ריק או autoconfirmed, sysop
apprfiltercascade

לסנן הגנות לפי דירוגיות (לא תקף כאשר apprtype אינו מוגדר).

אחד מהערכים הבאים: cascading, noncascading, all
ברירת מחדל: all
aplimit

כמה דפים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
apdir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
apfilterlanglinks

סינון על סמך קיום קישורים לשוניים בדף. יש לשים לב לכך שזה אולי לא יתייחס לקישורים לשוניים שנוספו על־ידי הרחבות.

אחד מהערכים הבאים: withlanglinks, withoutlanglinks, all
ברירת מחדל: all
apprexpiry

לפי איזו תפוגת הגנה לסנן את הדף הזה:

indefinite
לקבל רק דפים מוגנית לצמיתות.
definite
לקבל רק דפים עם תפוגת הגנה מוגדרת.
all
לקבל דפים עם תפוגת הגנה כלשהי.
אחד מהערכים הבאים: indefinite, definite, all
ברירת מחדל: all
דוגמאות:
להציג רשימה של דפים במתחילים באות B.
api.php?action=query&list=allpages&apfrom=B
להציג מידע על 4 דפים שמתחילים באות T.
api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info
להציג את תוכן של 2 הדפים הראשונים שמתחילים ב־Re ושאינם דפי הפניה.
api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

list=allredirects (ar)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

רשימה של כל ההפניות למרחב שם.

פרמטרים:
arcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

arfrom

מאיזו כותרת הפניה להתחיל את מנייה.

arto

כותרת ההפניה שהמנייה תיפסק בה.

arprefix

חיפוש על דפי היעד שמתחילים בערך הזה.

arunique

להציג רק דפים ייחודיים. לא יכול לשמש עם arprop=ids|fragment|interwiki. בעת שימוש בתור מחולל, נותן דפי יעד במקום דפי מקור.

סוג: בוליאני (פרטים)
arprop

אילו חלקי מידע לכלול:

ids
הוספת מזהה הדף של הדף המפנה (לא יכול לשמש עם arunique).
title
הוספת כותרת ההפניה.
fragment
הוספת המובאה מההפניה, אם יש (לא יכול לשמש עם arunique).
interwiki
הוספת תחילית הבינוויקי מההפניה, אם יש (לא יכול לשמש עם arunique).
ערכים (מופרדים באמצעות "|"): ids, title, fragment, interwiki
ברירת מחדל: title
arnamespace

איזה מרחב שם למנות.

אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ברירת מחדל: 0
arlimit

כמה פריטים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
ardir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
דוגמאות:
רשימת דפי יעד, כולל חסרים, עם מזהי הדפים שהם מופיעים בהם, החל מ־B.
api.php?action=query&list=allredirects&arfrom=B&arprop=ids|title
רשימת דפי יעד ייחודיים.
api.php?action=query&list=allredirects&arunique=&arfrom=B
קבלת על דפי היעד, תוך כדי סימון החסרים.
api.php?action=query&generator=allredirects&garunique=&garfrom=B
קבלת דפים שמכילים את ההפניות.
api.php?action=query&generator=allredirects&garfrom=B

list=alltransclusions (at)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

רשימת כל ההכללות (דפים שמוטבעים באמצעות {{x}}), כולל כאלה שאינם קיימים.

פרמטרים:
atcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

atfrom

מאיזו כותרת ההכללה להתחיל למנות.

atto

כותרת ההכללה שהמנייה תיפסק בה.

atprefix

חיפוש כל הכותרות המוכללות שמתחילות הערך הזה.

atunique

להציג רק שמות מוכללים ייחודיים. לא יכול לשמש עם atprop=ids. בעת שימוש בתור מחולל, נותן דפי יעד במקום דפי מקור.

סוג: בוליאני (פרטים)
atprop

אילו חלקי מידע לכלול:

ids
הוספת מזהי הדף של הדפים המכלילים (לא יכול לשמש עם atunique).
title
הוספת כותרת ההכללה.
ערכים (מופרדים באמצעות "|"): ids, title
ברירת מחדל: title
atnamespace

איזה מרחב שם למנות.

אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ברירת מחדל: 10
atlimit

כמה פריטים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
atdir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
דוגמאות:
רשימת כותרות מוכללות, כולל חסרות, עם מזהי הדפים שהן מופיעות בהם, החל מ־B.
api.php?action=query&list=alltransclusions&atfrom=B&atprop=ids|title
רשימת כותרת מוכללות ייחודיות.
api.php?action=query&list=alltransclusions&atunique=&atfrom=B
קבלת כל כל הכותרות המוכללות, תוך כדי סימון החסרות.
api.php?action=query&generator=alltransclusions&gatunique=&gatfrom=B
קבלת דפים שמכילים את ההכללות.
api.php?action=query&generator=alltransclusions&gatfrom=B

list=allusers (au)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

למנות את כל המשתמשים הרשומים.

פרמטרים:
aufrom

מאיזה שם משתמש להתחיל למנות.

auto

באיזה שם משתמש להפסיק למנות.

auprefix

חיפוש כל המשתמשים שמתחילים בערך הזה.

audir

באיזה כיוון למיין.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
augroup

לכלול רק משתמשים בקבוצות הנתונות.

ערכים (מופרדים באמצעות "|"): bot, sysop, bureaucrat
auexcludegroup

לא לכלול משתמשים בקבוצות הנתונות.

ערכים (מופרדים באמצעות "|"): bot, sysop, bureaucrat
aurights

לכלול רק משתמשים עם ההרשאות הנתונות. לא כולל הרשאות שניתנו בקבוצות משתמעות או אוטומטיות כגון *, user או autoconfirmed.

ערכים (מופרדים באמצעות "|"): apihighlimits, applychangetags, autoconfirmed, autopatrol, bigdelete, block, blockemail, bot, browsearchive, changetags, createaccount, createpage, createtalk, delete, deletedhistory, deletedtext, deletelogentry, deleterevision, edit, editcontentmodel, editinterface, editprotected, editmyoptions, editmyprivateinfo, editmyusercss, editmyuserjs, editmywatchlist, editsemiprotected, editusercssjs, 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, passwordreset, patrol, patrolmarks, protect, proxyunbannable, 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
מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
auprop

אילו פרטי מידע לכלול:

blockinfo
הוספת מידע עם החסימה הנוכחית של משתמש.
groups
הוספת קבוצות שמשתמש חבר בהן. זה משתמש ביותר משאבי דפדפן ויכול להחזיר פחות תוצאות מהמגבלה.
implicitgroups
לרשום את כל הקבוצות שהמשתמש חבר בהן אוטומטית.
rights
רשימת הההרשאות שיש למשתמש.
editcount
הוספת מניין העריכות של המשתמש .
registration
הוספת חותם־הזמן של זמן הרישום של המשתמש (יכול להיות ריק).
ערכים (מופרדים באמצעות "|"): blockinfo, groups, implicitgroups, rights, editcount, registration
aulimit

כמה שמות משתמש בסך הכול לשנות.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
auwitheditsonly

לרשום רק משתמשים שעשו עריכות.

סוג: בוליאני (פרטים)
auactiveusers

לרשום רק משתמשים שהיו פעילים ב־30 הימים האחרונים.

סוג: בוליאני (פרטים)
דוגמה:
לרשום משתמשים שמתחילים ב־Y.
api.php?action=query&list=allusers&aufrom=Y
  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מציאת כל הדפים שמקשרים לדף הנתון.

פרמטרים:
bltitle

איזו כותרת לחפש. לא ניתן להשתמש בזה יחד עם blpageid.

blpageid

מזהה דף לחיפוש. לא ניתן להשתמש בזה יחד עם bltitle.

סוג: מספר שלם
blcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

blnamespace

איזה מרחב שם למנות.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
bldir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
blfilterredir

איך לסנן הפניות. אם זה מוגדר ל־nonredirects כש־blredirect מופעל, זה חל רק על הרמה השנייה.

אחד מהערכים הבאים: all, redirects, nonredirects
ברירת מחדל: all
bllimit

כמה דפים להחזיר בסך הכול. אם blredirect מופעל, ההגבלה חלה על כל רמה בנפרד (כלומר יכולות להיות מוחזרות עד 2 * bllimit תוצאות).

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
blredirect

אם הדף המקשר הוא הפניה, למצוא גם את כל הדפים שמקשרים לאותה ההפניה. ההגבלה המרבית מוקטנת בחצי.

סוג: בוליאני (פרטים)
דוגמאות:
הצגת קישורים ל־Main Page.
api.php?action=query&list=backlinks&bltitle=Main%20Page
קבל מידע על דפים שמקשרים ל־Main page.
api.php?action=query&generator=backlinks&gbltitle=Main%20Page&prop=info

list=blocks (bk)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לרשום את כל המשתמשים וכתובות ה־IP שנחסמו.

פרמטרים:
bkstart

מאיזה חותם‏־זמן להתחיל למנות.

סוג: חותם־זמן (תסדירים מורשים)
bkend

באיזה חותם זמן להפסיק למנות.

סוג: חותם־זמן (תסדירים מורשים)
bkdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: bkstart חייב להיות לפני bkend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: bkstart חייב להיות אחרי bkend.
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
bkids

רשימת מזהי חסימות לרשום (לא חובה).

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
bkusers

רשימת משתמשים לחיפוש (לא חובה).

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
bkip

קבלת כל החסימות שחלות על טווח ה־IP או ה־CIDR הזה, כולל חסימות טווח. לא יכול לשמש יחד עם bkusers. טווחי CIDR רחבים מ־IPv4/16 או IPv6/19 אינם מתקבלים.

bklimit

המספר המרבי של חסימות לרשום.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
bkprop

אילו מאפיינים לקבל:

id
הוספת מזהה החסימה.
user
הוספת שם המשתמש שנחסם.
userid
הוספת המזהה של המשמש שנחסם.
by
הוספת שם המשתמש שחסם.
byid
הוספת מזהה המשתמש שחסם.
timestamp
הוספת חותם־הזמן של החסימה.
expiry
הוספת חותם־הזמן של תפוגת החסימה.
reason
הוספת הסיבה שניתנה לחסימה.
range
הוספת טווח כתובות ה־IP שהחסימה משפיעה עליהן.
flags
מתייג את ההחרמה (autoblock‏, anononly, וכו'.).
ערכים (מופרדים באמצעות "|"): id, user, userid, by, byid, timestamp, expiry, reason, range, flags
ברירת מחדל: id|user|by|timestamp|expiry|reason|flags
bkshow

להציג רק פריטים שמתאימים לאמות המידה האלו. למשל, כדי לראות רק חסימות ללא לצמיתות על כתובות IP יש להגדיר bkshow=ip|!temp.

ערכים (מופרדים באמצעות "|"): account, !account, temp, !temp, ip, !ip, range, !range
bkcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
רשימת חסימות.
api.php?action=query&list=blocks
רשימת חסימות של המשתמשים Alice ו־Bob.
api.php?action=query&list=blocks&bkusers=Alice|Bob

list=categorymembers (cm)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

רשימת כל הדפים בקטגוריה נתונה.

פרמטרים:
cmtitle

איזו קטגוריה למנות (נדרש). חייב לכלול את התחילית קטגוריה:. לא יכול לשמש יחד עם cmpageid.

cmpageid

מזהה הדף של הקטגוריה שצריך למנות. לא יכול לשמש יחד עם cmtitle.

סוג: מספר שלם
cmprop

אילו חלקי מידע לכלול:

ids
הוספת מזהה הדף.
title
הוספת השם ומזהה מרחב השם של הדף.
sortkey
הוספת מפתח המיון שמשמש למיון בקטגוריה (מחרזות הקסדצימלית).
sortkeyprefix
הוספת מפתח המיון שמשמש למיון בקטגוריה (מחרוזת הקסדצימלית).
type
הוספת הסוג שהדף מוין אליו (דף, תת־קטגוריה, או קובץ).
timestamp
הוספת חותם־הזמן שבו הדף נכלל.
ערכים (מופרדים באמצעות "|"): ids, title, sortkey, sortkeyprefix, type, timestamp
ברירת מחדל: ids|title
cmnamespace

לכלול רק דפים במרחבי השם האלה. יש לשים לב לכך ש־cmtype=subcat או cmtype=file יכולים לשמש במקום cmnamespace=14 או 6.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
cmtype

איזה סוג של חברי קטגוריה לכלול. לא תקף כאשר מוגדר cmsort=timestamp.

ערכים (מופרדים באמצעות "|"): page, subcat, file
ברירת מחדל: page|subcat|file
cmcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

cmlimit

מספר הדפים המרבי שיוחזר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
cmsort

לפי איזה מאפיין למיין.

אחד מהערכים הבאים: sortkey, timestamp
ברירת מחדל: sortkey
cmdir

באיזה כיוון למיין.

אחד מהערכים הבאים: asc, desc, ascending, descending, newer, older
ברירת מחדל: ascending
cmstart

מאיזה חותם־זמן להתחיל לרשום. יכול לשמש רק עם cmsort=timestamp.

סוג: חותם־זמן (תסדירים מורשים)
cmend

באיזה חותם־זמן לסיים לרשום. יכול לשמש רק עם cmsort=timestamp.

סוג: חותם־זמן (תסדירים מורשים)
cmstarthexsortkey

מפתח מיון להתחיל לרשום ממנו, כפי שמוחזר על־ידי cmprop=sortkey</kbd. יכול לשמש רק עם cmsort=sortkey.

cmendhexsortkey

מפתח מיון לסיים לרשום ממנו, כפי שמוחזר על־ידי cmprop=sortkey. יכול לשמש רק עם cmsort=sortkey.

cmstartsortkeyprefix

תחילית מפתח מיון להתחיל לרשום ממנה. יכול לשמש רק עם cmsort=sortkey. דורס את cmstarthexsortkey.

cmendsortkeyprefix

תחילית מפתח מיון שהרשימה תסתיים לפניה (לא בה, אם הערך הזה מוגדר, הוא לא ייכלל!). יכול לשמש רק עם cmsort=sortkey. דורס את cmendhexsortkey.

cmstartsortkey
מיושן.

כדאי להשתמש ב־cmstarthexsortkey במקום.

cmendsortkey
מיושן.

כדאי להשתמש ב־cmendhexsortkey במקום.

דוגמאות:
קבלת עשרת העמודים הראשונים שתחת קטגוריה:פיזיקה.
api.php?action=query&list=categorymembers&cmtitle=Category:Physics
קבל מידע על הדף עבור 10 הדפים הראשונים ב־Category:Physics.
api.php?action=query&generator=categorymembers&gcmtitle=Category:Physics&prop=info

list=deletedrevs (dr)

  • יחידה זו אינה מומלצת לשימוש.
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

רשימת גרסאות מחוקות.

פועל בשלושה אופנים:

  1. רשימת גרסאות מחוקות לשמות שניתנו, ממוינות לפי חותם־זמן.
  2. רשימת תרומות מחוקות של המשתמש שניתן, ממוינות לפי חותם־זמן (בלי לציין שמות).
  3. רשימת כל הגרסאות המחוקות במרחב השם שניתן, ממוינות לפי שם וחותם־זמן (בלי לציין שמות, בלי להגדיר druser).

פרמטרים מסוימים חלים רק על חלק מהאופנים ולא תקפים באחרים.

פרמטרים:
drstart

באיזה חותם־זמן להתחיל למנות.

מצבים: 1, 2
סוג: חותם־זמן (תסדירים מורשים)
drend

באיזה חותם־זמן להפסיק למנות.

מצבים: 1, 2
סוג: חותם־זמן (תסדירים מורשים)
drdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: drstart חייב להיות לפני drend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: drstart חייב להיות אחרי drend.
מצבים: 1, 3
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
drfrom

להתחיל את הרשימה בשם הזה.

מצב: 3
drto

להפסיק את הרשימה בכותרת הזאת.

מצב: 3
drprefix

חיפוש כל שמות הדפים שמתחילים בערך הזה.

מצב: 3
drunique

לרשום רק גרסה אחת עבור כל דף.

מצב: 3
סוג: בוליאני (פרטים)
drnamespace

לרשום רק דפים במרחב השם הזה.

מצב: 3
אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ברירת מחדל: 0
drtag

לרשום רק גרסאות עם התג הזה.

druser

לרשום רק גרסאות מאת המשתמש הזה.

סוג: שם משתמש
drexcludeuser

לא לרשום גרסאות מאת המשתמש הזה.

סוג: שם משתמש
drprop

אילו מאפיינים לקבל:

revid
הוספת מזהה הגרסה של הגרסה המחוקה.
parentid
הוספת מזהה הגרסה של הגרסה הקודמת של הדף.
user
הוספת המשתמש שעשה את הגרסה.
userid
הוספת מזהה המשתמש שעשה את הגרסה.
comment
הוספת ההערה על הגרסה.
parsedcomment
הוספת ההערה המפוענחת על הגרסה.
minor
מתייג אם הגרסה משנית.
len
מוסיף את האורך (בבתים) של הגרסה.
sha1
הוספת ה־SHA-1 (בסיס 16) של הגרסה.
content
הוספת התוכן של הגרסה.
token
מיושן. נותן אסימון עריכה.
tags
תגים עבור הגרסה.
ערכים (מופרדים באמצעות "|"): revid, parentid, user, userid, comment, parsedcomment, minor, len, sha1, content, token, tags
ברירת מחדל: user|comment
drlimit

המספר המרבי של הגרסאות שיירשם.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
drcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
רשימת כל הגרסאות המחוקות של הדפים Main Page ו־Talk:Main Page, עם תוכן (mode 1).
api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content
רשימת 50 העריכות המחוקות האחרונות של Bob‏ (mode 2).
api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50
רשימת 50 הגרסאות המחוקות הראשונות במרחב הראשי (mode 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50
רשימת 50 הדפים המחוקים הראשונים במרחב השם שיחה‏ (mode 3).
api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique=

list=embeddedin (ei)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

חיפוש כל הדפים שמטמיעים (מכלילים) את הכותרת הנתונה.

פרמטרים:
eititle

איזו כותרת לחפש. לא ניתן להשתמש בזה יחד עם eipageid.

eipageid

מזהה דף לחיפוש. לא יכול לשמש יחד עם eititle.

סוג: מספר שלם
eicontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

einamespace

איזה מרחב שם למנות.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
eidir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
eifilterredir

איך לסנן עבור הפניות.

אחד מהערכים הבאים: all, redirects, nonredirects
ברירת מחדל: all
eilimit

כמה דפים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
דוגמאות:
הצגת דפים שמכלילים את Template:Stub.
api.php?action=query&list=embeddedin&eititle=Template:Stub
קבלת מידע על דפים שמכלילים את Template:Stub.
api.php?action=query&generator=embeddedin&geititle=Template:Stub&prop=info

list=exturlusage (eu)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

למנות דפים שמכילים URL נתון.

פרמטרים:
euprop

אילו חלקי מידע לכלול:

ids
הוספת מזהה הדף.
title
הוספת השם ומזהה מרחב השם של הדף.
url
הוספת ה־URL שמשמש בדף.
ערכים (מופרדים באמצעות "|"): ids, title, url
ברירת מחדל: ids|title|url
euoffset

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

סוג: מספר שלם
euprotocol

הפרוטוקול של ה־URL. אם זה ריק, ו־euquery מוגדר, הפרוטוקול הוא http. יש להשאיר את זה ואת euquery ריק כדי לרשום את כל הקישורים החיצוניים.

אחד מהערכים הבאים: יכול להיות ריק או 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
ברירת מחדל: (ריק)
euquery

מחרוזת חיפוש ללא פרוטוקל. ר' Special:LinkSearch. יש להשאיר את זה ריק כדי לרשום את כל הקישורים החיצוניים.

eunamespace

איזה מרחב שם למנות.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
eulimit

כמה דפים להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
euexpandurl

הרחבת URL־ים בעלי פרוטוקול יחסי בפרוטוקול קנוני.

סוג: בוליאני (פרטים)

list=filearchive (fa)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

למנות את כל הקבצים המחוקים לפי הסדר.

פרמטרים:
fafrom

מאיזו כותרת תמונה להתחיל למנות.

fato

באיזו כותרת תמונה להפסיק למנות.

faprefix

חיפוש כל שמות התמונות שמתחילים בערך הזה.

fadir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
fasha1

גיבוב SHA1 של תמונה. דורס את fasha1base36.

fasha1base36

גיבוב SHA1 של תמונה בבסיס 36 (משמש במדיה־ויקי).

faprop

איזה מידע על תמונה לקבל:

sha1
הוספת גיבוב SHA-1 עבור התמונה.
timestamp
הוספת חותם־זמן לגרסה המועלית.
user
הוספת המשתמש שהעלה על גרסת התמונה.
size
הוספת הגודל של התמונה בבתים והגובה, הרוחב ומניין הדפים (אם מתאים).
dimensions
כינוי ל־size.
description
הוספת תיאור לגרסת התמונה.
parseddescription
פענוח התיאור של הגרסה.
mime
הוספת ה־MIME של התמונה.
mediatype
הוספת סוג המדיה של התמונה.
metadata
רשימת מטא־נתוני Exif עבור גרסת הקובץ.
bitdepth
הוספת עומק הביטים של הגרסה.
archivename
הוספת שם הקובץ של גרסה מאורכבת עבור גרסאות שאינן האחרונה.
ערכים (מופרדים באמצעות "|"): sha1, timestamp, user, size, dimensions, description, parseddescription, mime, mediatype, metadata, bitdepth, archivename
ברירת מחדל: timestamp
falimit

כמה תמונות להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
facontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמה:
הצגת רשימת כל הקבצים המחוקים.
api.php?action=query&list=filearchive

list=imageusage (iu)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מציאת כל הדפים שמתמשים בשם התמונה הנתונה.

פרמטרים:
iutitle

איזו כותרת לחפש. לא ניתן להשתמש בזה יחד עם iupageid.

iupageid

מזהה דף לחיפוש. לא יכול לשמש יחד עם iutitle.

סוג: מספר שלם
iucontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

iunamespace

איזה מרחב שם למנות.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
iudir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
iufilterredir

איך לסנן הפניות. אם זה מוגדר ל־nonredirects כש־iuredirect מופעל, זה חל רק על הרמה השנייה.

אחד מהערכים הבאים: all, redirects, nonredirects
ברירת מחדל: all
iulimit

כמה דפים להחזיר בסך הכול. אם iuredirect מופעל, ההגבלה חלה על כל רמה בנפרד (כלומר יכולות להיות מוחזרות עד 2 * iulimit תוצאות).

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
iuredirect

אם הדף המקשר הוא הפניה, למצוא גם את כל הדפים שמקשרים לאותה ההפניה. ההגבלה המרבית מוקטנת בחצי.

סוג: בוליאני (פרטים)
  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מציאות כל הדפים שמקשרים לקישור הבינוויקי הנתון.

יכול לשמש למציאת כל הקישורים עם התחילית, או כל הקישורים לכותרת (עם תחילית נתונה). אי־שימוש בשום פרמטר אומר "כל קישורי בינוויקי".

פרמטרים:
iwblprefix

תחילית לבינוויקי.

iwbltitle

איזה קישור בינוויקי לחפש. צריך להשתמש בזה יחד עם iwblblprefix.

iwblcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

iwbllimit

כמה דפים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
iwblprop

אילו מאפיינים לקבל:

iwprefix
הוספת התחילית של הבינוויקי.
iwtitle
הוספת הכותרת של הבינוויקי.
ערכים (מופרדים באמצעות "|"): iwprefix, iwtitle
ברירת מחדל: (ריק)
iwbldir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מציאת כל הדפים שמקשרים לקישור השפה הנתון.

יכול לשמש למציאת כל הקישורים עם קוד שפה, או כל הקישורים לכותרת (עם שפה נתונה). אי־שימוש בשום פרמטר פירושו "כל קישורי שפה".

נא לשים לב לכך שזה עשוי לא להתייחס לקישורי שפה שמוסיפות הרחבות.

פרמטרים:
lbllang

שפה עבור קישור שפה.

lbltitle

איזה קישור שפה לחפש. חייב לשמש עם lbllang.

lblcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

lbllimit

כמה דפים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
lblprop

אילו מאפיינים לקבל:

lllang
הוספת קוד השפה של קישור השפה.
lltitle
הוספת הכותרת של קישור השפה.
ערכים (מופרדים באמצעות "|"): lllang, lltitle
ברירת מחדל: (ריק)
lbldir

באיזה כיוון לרשום.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending

list=logevents (le)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת אירועים מהרישומים.

פרמטרים:
leprop

אילו מאפיינים לקבל:

ids
הוספת המזהה של אירוע היומן.
title
הוספת שם הדף של אירוע היומן.
type
הוספת הסוג של אירוע היומן.
user
הוספת המשתמש האחראי על אירוע היומן.
userid
הוספת מזהה המשתמש האחראי על אירוע היומן.
timestamp
הוספת חותם־הזמן עבור האירוע.
comment
הוספת ההערה של האירוע.
parsedcomment
הוספת ההערה המפוענחת של האירוע.
details
הוספת פרטים נוספים על האירוע.
tags
רשימת התגים של האירוע.
ערכים (מופרדים באמצעות "|"): ids, title, type, user, userid, timestamp, comment, parsedcomment, details, tags
ברירת מחדל: ids|title|type|user|timestamp|comment|details
letype

סינון עיולי יומן רק לסוג הזה.

אחד מהערכים הבאים: יכול להיות ריק או block, protect, rights, delete, upload, move, import, patrol, merge, suppress, tag, managetags, contentmodel, newusers
leaction

סינון פעולות יומן רק לפעולה הזאת. דורס את letype. ברשימת הערכים האפשריים, ערכים עם תו־כל כוכבית כגון action/* יכולים להיות מחרוזות שונות אחרי הקו הנטוי (/).

אחד מהערכים הבאים: protect/modify, protect/protect, protect/unprotect, block/block, block/reblock, block/unblock, contentmodel/change, delete/delete, 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, protect/move_prot, 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

מאיזה חותם־זמן להתחיל למנות.

סוג: חותם־זמן (תסדירים מורשים)
leend

באיזה חותם זמן להפסיק לרשום.

סוג: חותם־זמן (תסדירים מורשים)
ledir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: lestart חייב להיות לפני leend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: lestart חייב להיות אחרי leend.
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
leuser

לסנן את העיולים שעשה המשתמש הנתון.

letitle

סינון עיולים רק לכאלה שמתייחסים לדף.

lenamespace

סינון עיולים רק לכאלה במרחב השם הנתון.

אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
leprefix

סינון עיולים לכאלה שמתחילים עם התחילית הזאת.

letag

לרשום רק אירועים שמתויגם בתג הזה.

lelimit

כמה עיולי אירועים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
lecontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמה:
רשימת אירועי יומן אחרונים.
api.php?action=query&list=logevents

list=pagepropnames (ppn)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

רשימת כל שמות המאפיינים שמשמשים בוויקי.

פרמטרים:
ppncontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

ppnlimit

המספר המרבי של השמות להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
דוגמה:
לתת את 10 שמות המאפיינים הראשונים.
api.php?action=query&list=pagepropnames

list=pageswithprop (pwp)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לרשום את כל הדפים שמשתמשים במאפיין דף נתון.

פרמטרים:
pwppropname

מאפיין דף שעבורו למנות דפים.

פרמטר זה נדרש.
pwpprop

אילו חלקי מידע לכלול:

ids
הוספת מזהה הדף.
title
הוספת השם ומזהה מרחב השם של הדף.
value
הוספת הערך של מאפיין הדף.
ערכים (מופרדים באמצעות "|"): ids, title, value
ברירת מחדל: ids|title
pwpcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

pwplimit

מספר הדפים המרבי שיוחזר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
pwpdir

באיזה כיוון לסדר.

אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
דוגמאות:
הצגת עשרת הדפים הראשונים שעושים שימוש ב־{{DISPLAYTITLE:}}.
api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value
קבלת מידע נוסף על עשרת הדפים הראשונים המשתמשים ב־__NOTOC__.
api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info

list=prefixsearch (ps)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

ביצוע חיפוש תחילית של כותרות דפים.

פרמטרים:
pssearch

מחרוזת לחיפוש.

פרמטר זה נדרש.
psnamespace

שמות מתחם לחיפוש.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ברירת מחדל: 0
pslimit

מספר התוצאות המרבי להחזרה.

המספר המרבי המותר הוא 100 (עבור בוטים – 200).
סוג: מספר שלם או max
ברירת מחדל: 10
psoffset

מספר תוצאות לדילוג.

סוג: מספר שלם
ברירת מחדל: 0
דוגמה:
חיפוש שםות דפים שמתחילים ב־meaning.
api.php?action=query&list=prefixsearch&pssearch=meaning

list=protectedtitles (pt)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לרשום את כל הכותרות שמוגנות מפני יצירה.

פרמטרים:
ptnamespace

לרשום רק כותרות במרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ptlevel

לרשום רק שמות עם רמת ההגנה הזאת.

ערכים (מופרדים באמצעות "|"): autoconfirmed, sysop
ptlimit

כמה דפים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
ptdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: ptstart חייב להיות לפני ptend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: ptstart חייב להיות אחרי ptend.
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
ptstart

להתחיל לרשום בחותם־זמן ההגנה הזה.

סוג: חותם־זמן (תסדירים מורשים)
ptend

באיזה חותם־זמן הגנה לסיים את הרשימה.

סוג: חותם־זמן (תסדירים מורשים)
ptprop

אילו מאפיינים לקבל:

timestamp
הוספת חותם־הזמן של הוספת ההגנה.
user
הוספת המשתמש שהוסיף את ההגנה.
userid
הוספת מזהה המשתמש שהוסיף את ההגנה.
comment
הוספת ההערה עבור ההגנה.
parsedcomment
הוספת ההערה המפוענחת עבור ההגנה.
expiry
הוספת חותם־הזמן של הסרת ההגנה.
level
הוספת רמת ההגנה.
ערכים (מופרדים באמצעות "|"): timestamp, user, userid, comment, parsedcomment, expiry, level
ברירת מחדל: timestamp|level
ptcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
רשימת כותרות מוגנות.
api.php?action=query&list=protectedtitles
חיפוש קישורים לכותרות מוגנות במרחב הראשי.
api.php?action=query&generator=protectedtitles&gptnamespace=0&prop=linkshere

list=querypage (qp)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת רשימה שמסופקת על־ידי דף מיוחד מבוסס־QueryPage.

פרמטרים:
qppage

שם הדף המיוחד. לתשומת לבך, זה תלוי־רישיות.

פרמטר זה נדרש.
אחד מהערכים הבאים: 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

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

סוג: מספר שלם
ברירת מחדל: 0
qplimit

מספר תוצאות להחזרה.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10

list=random (rn)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת ערכת דפים אקראיים.

הדפים רשומים בסדר קבוע, ורק נקודת ההתחלה אקראית. זה אומר שאם, למשל, Main Page הוא הדף האקראי הראשון הרשימה, List of fictional monkeys יהיה תמיד השני, List of people on stamps of Vanuatu שלישי, וכו'.

פרמטרים:
rnnamespace

מחזיר דפים רק במרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
rnfilterredir

איך לסנן הפניות.

אחד מהערכים הבאים: all, redirects, nonredirects
ברירת מחדל: nonredirects
rnredirect
מיושן.

נא להשתמש ב־rnfilterredir=redirects במקום.

סוג: בוליאני (פרטים)
rnlimit

להגביל את מספר הדפים האקראיים שיוחזרו.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 1
rncontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
להחזיר שני דפים אקראיים מהמרחב הראשי.
api.php?action=query&list=random&rnnamespace=0&rnlimit=2
החזרת מידע על הדף על שני דפים אקראיים מהמרחב הראשי.
api.php?action=query&generator=random&grnnamespace=0&grnlimit=2&prop=info

list=recentchanges (rc)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

למנות שינויים אחרונים.

פרמטרים:
rcstart

מאיזה חותם־זמן להתחיל למנות.

סוג: חותם־זמן (תסדירים מורשים)
rcend

באיזה חותם זמן להפסיק לרשום.

סוג: חותם־זמן (תסדירים מורשים)
rcdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: rcstart חייב להיות לפני rcend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: rcstart חייב להיות אחרי rcend.
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
rcnamespace

לסנן את השינויים רק למרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
rcuser

לרשום רק שינויים של המשתמש הזה.

סוג: שם משתמש
rcexcludeuser

Don't list changes by this user

סוג: שם משתמש
rctag

לרשום רק שינויים שמתויגים עם התג הזה.

rcprop

לכלול פריטי מידע נוספים:

user
הוספת המשתמש האחראי על העריכה ותיוג אם זאת כתובת IP.
userid
הוספת המשתמש האחראי על העריכה.
comment
הוספת ההערה על העריכה.
parsedcomment
הוספת ההערה המפוענחת על העריכה.
flags
הוספת דגלים לעריכה.
timestamp
הוספת חותם־זמן של העריכה.
title
הוספת שם הדף של העריכה.
ids
הוספת מזהה הדף, מזהה שינויים אחרונים, והמזהה הגרסה החדשה והישנה.
sizes
הוספת אורך הדף החדש והישן בבתים.
redirect
מתייג שהדף הוא הפניה.
patrolled
מתייג עריכה בת־בדיקה בתור בדוקה או בלתי־בדוקה.
loginfo
הוספת מידע יומן (זהה יומן, סוג יומן וכו') לעיולי יומן.
tags
רשימת תגים עבור העיול.
sha1
הוספת סיכום־ביקורת תוכן לעיולים שמשויכים לגרסה.
ערכים (מופרדים באמצעות "|"): user, userid, comment, parsedcomment, flags, timestamp, title, ids, sizes, redirect, patrolled, loginfo, tags, sha1
ברירת מחדל: title|timestamp|ids
rctoken
מיושן.

יש להשתמש ב־action=query&meta=tokens במקום.

ערכים (מופרדים באמצעות "|"): patrol
rcshow

הצגה רק של פריטים שמתאימים לאמות המידה האלו. למשל, כדי לראות רק עריכות משניות שעשו משתמשים שנכנסו לחשבון, יש להגדיר rcshow=minor|!anon.

ערכים (מופרדים באמצעות "|"): minor, !minor, bot, !bot, anon, !anon, redirect, !redirect, patrolled, !patrolled, unpatrolled
rclimit

כמה שינויים להחזיר בסך הכול.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
rctype

אילו סוגים של שינויים להציג.

ערכים (מופרדים באמצעות "|"): edit, external, new, log
ברירת מחדל: edit|new|log
rctoponly

לרשום רק שינויים שהם הגרסה האחרונה.

סוג: בוליאני (פרטים)
rccontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
הצגת השינויים האחרונים.
api.php?action=query&list=recentchanges
קבלת מידע על הדף על שינויים אחרונים שלא נבדקו.
api.php?action=query&generator=recentchanges&grcshow=!patrolled&prop=info

list=search (sr)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

ביצוע חיפוש בכל הטקסט.

פרמטרים:
srsearch

חיפוש שמות דפים או תוכן שמתאים לערך הזה. אפשר להשתמש בחיפוש מחרוזת כדי לקרוא לאפשרויות חיפוש מתקדמות, בהתאם למה שממומש בשרת החיפוש של הוויקי.

פרמטר זה נדרש.
srnamespace

חיפוש רק במרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ברירת מחדל: 0
srwhat

איזה סוג חיפוש לבצע.

אחד מהערכים הבאים: title, text, nearmatch
srinfo

אילו מטא־נתונים להחזיר.

ערכים (מופרדים באמצעות "|"): totalhits, suggestion, rewrittenquery
ברירת מחדל: totalhits|suggestion|rewrittenquery
srprop

אילו מאפיינים להחזיר:

size
הוספת גודל הדף בבתים.
wordcount
הוספת מניין המילים של הדף.
timestamp
הוספת חותם־הזמן של העריכה האחרונה של הדף.
snippet
הוספת קטע קצר מפוענח מהדף.
titlesnippet
הוספת קטע קצר מפוענח משם הדף.
redirecttitle
הוספת שם ההפניה התואמת.
redirectsnippet
הוספת קטע קצר מפוענח משם ההפניה.
sectiontitle
הוספת שם הפסקה התואמת.
sectionsnippet
הוספת קטע קצר מפוענח של שם הפסקה התואמת.
isfilematch
הוספת בוליאני שמציין אם החיפוש תאם לתוכן של קובץ.
categorysnippet
הוספת קטע קצר מפוענח של הקטגוריה התואמת.
score
מיושן וחסר־השפעה.
hasrelated
מיושן וחסר־השפעה.
ערכים (מופרדים באמצעות "|"): size, wordcount, timestamp, snippet, titlesnippet, redirecttitle, redirectsnippet, sectiontitle, sectionsnippet, isfilematch, categorysnippet, score, hasrelated
ברירת מחדל: size|wordcount|timestamp|snippet
sroffset

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

סוג: מספר שלם
ברירת מחדל: 0
srlimit

כמה דפים להחזיר בסך הכול.

המספר המרבי המותר הוא 50 (עבור בוטים – 500).
סוג: מספר שלם או max
ברירת מחדל: 10
srinterwiki

לכלול תוצאות בינוויקי בחיפוש, אם זמין.

סוג: בוליאני (פרטים)
srenablerewrites

הפעלת שכתוב שאילתות פנימי. שרתי חיפוש אחדים יכולים לשכתב את השאילתה לצורה שלדעתם נותנת תוצאות טובות יותר, למשל תיקון שגיאות כתיב.

סוג: בוליאני (פרטים)
דוגמאות:
חיפוש meaning.
api.php?action=query&list=search&srsearch=meaning
חיפוש טקסטים עבור meaning.
api.php?action=query&list=search&srwhat=text&srsearch=meaning
קבלת מידע על הדף עבור שמוחזרים מחיפוש אחרי meaning.
api.php?action=query&generator=search&gsrsearch=meaning&prop=info

list=tags (tg)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

רשימת תגי שינוי.

פרמטרים:
tgcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

tglimit

המספר המרבי של תגים לרשום.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
tgprop

אילו מאפיינים לקבל:

name
הוספת שם התג.
displayname
הוספת הודעת המערכת עבור התג.
description
הוספת תיאור התג.
hitcount
הוספת מספר הגרסאות ועיולי היומן עם התג הזה.
defined
ציון האם התג מוגדר.
source
קבלת מקורות התג, שיכולים להיות extension עבור תגים שמגדירות הרחבות ו־manual עבור תגים שמשתמשים יכולים להחיל ידנית.
active
האם התג עדיין מוּחל.
ערכים (מופרדים באמצעות "|"): name, displayname, description, hitcount, defined, source, active
ברירת מחדל: name

list=usercontribs (uc)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת כל העריכות של המשתמש.

פרמטרים:
uclimit

המספר המרבי של התרומות להחזיר.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
ucstart

באיזה חותם־הזמן להתחיל.

סוג: חותם־זמן (תסדירים מורשים)
ucend

באיזה חותם־הזמן לסיים

סוג: חותם־זמן (תסדירים מורשים)
uccontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

ucuser

עבור אילו משתמשים לאחזר תרומות.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
ucuserprefix

אחזור תרומות עבור כל המשתמשים שהשמות שלהם מתחילים בערך הזה. דורס את ucuser.

ucdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: ucstart חייב להיות לפני ucend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: ucstart חייב להיות אחרי ucend.
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
ucnamespace

לרשום רק תרומות במרחבי השם האלה.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
ucprop

לכלול פריטי מידע נוספים:

ids
הוספת מזהה הדף ומזהה הגרסה.
title
הוספת השם ומזהה מרחב השם של הדף.
timestamp
הוספת חותם־הזמן של העריכה.
comment
הוספת ההערה על העריכה.
parsedcomment
הוספת ההערה המפוענחת של העריכה.
size
הוספת הגודל החדש של העריכה.
sizediff
הוספת ההפרש של העריכה אל מול ההורה שלה.
flags
הוספת הדגלים של העריכה.
patrolled
מתייג עריכות בדוקות.
tags
רשימת תגים עבור עריכות.
ערכים (מופרדים באמצעות "|"): ids, title, timestamp, comment, parsedcomment, size, sizediff, flags, patrolled, tags
ברירת מחדל: ids|title|timestamp|comment|size|flags
ucshow

הצגה רק של פריטים שמתאימים לאמות המידה האלה, למשל רק עריכות לא־משניות.

אם מוגדר ucshow=patrolled או ucshow=!patrolled, גרסאות ישנות מ־$wgRCMaxAge‏ (7776000 שניות) לא תוצגנה.

ערכים (מופרדים באמצעות "|"): minor, !minor, patrolled, !patrolled, top, !top, new, !new
uctag

לרשום רק גרסאות עם התג הזה.

uctoponly
מיושן.

לרשום רק שינויים שהם הגרסה האחרונה.

סוג: בוליאני (פרטים)
דוגמאות:
הצגת התרומות של המשתמש Example.
api.php?action=query&list=usercontribs&ucuser=Example
הצגת תרומות מכל כתובות ה־IP שמתחילות ב־192.0.2..
api.php?action=query&list=usercontribs&ucuserprefix=192.0.2.

list=users (us)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת מידע על רשימת משתמשים.

פרמטרים:
usprop

אילו חלקי מידע לקבל:

blockinfo
מתייג אם המשתמש חסום, על־ידי מי, ומאיזו סיבה.
groups
רשימת כל הקבוצות שהמשתמש שייך אליהן.
implicitgroups
רשימת כל הקבוצות שהמשתמש חבר בהן אוטומטית.
rights
רשימת כל ההרשאות שיש למשתמש.
editcount
הוספת מניין העריכות של המשתמש.
registration
הוספת חותם־הזמן של רישום המשתמש.
emailable
מתייג אם המשתמש יכול ורוצה לקבל דואר אלקטרוני דרך Special:Emailuser.
gender
מתייג את המגדר של המשתמש. מחזיר "male"‏, "female" או "unknown".
ערכים (מופרדים באמצעות "|"): blockinfo, groups, implicitgroups, rights, editcount, registration, emailable, gender
ususers

רשימת משתמשים שעליהם צריך לקבל מידע.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
ustoken
מיושן.

יש להשתמש ב־action=query&meta=tokens במקום.

ערכים (מופרדים באמצעות "|"): userrights
דוגמה:
החזרת מידע עבור המשתמש Example.
api.php?action=query&list=users&ususers=Example&usprop=groups|editcount|gender

list=watchlist (wl)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת שינויים אחרונים לדפים ברשימת המעקב של המשתמש הנוכחי.

פרמטרים:
wlallrev

לכלול גרסאות מרובות של אותו הדף בתוך מסגרת הזמן הנתונה.

סוג: בוליאני (פרטים)
wlstart

מאיזה חותם־זמן להתחיל למנות.

סוג: חותם־זמן (תסדירים מורשים)
wlend

באיזה חותם זמן להפסיק לרשום.

סוג: חותם־זמן (תסדירים מורשים)
wlnamespace

סינון שינויים רק למרחבי השם שניתנו.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
wluser

לרשום רק שינויים של המשתמש הזה.

סוג: שם משתמש
wlexcludeuser

Don't list changes by this user

סוג: שם משתמש
wldir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: wlstart חייב להיות לפני wlend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: wlstart חייב להיות אחרי wlend.
אחד מהערכים הבאים: newer, older
ברירת מחדל: older
wllimit

כמה תוצאות סך הכול להחזיר בכל בקשה.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
wlprop

אילו מאפיינים נוספים לקבל:

ids
הוספת מזהי גסה ומזהי דף.
title
הוספת שם הדף.
flags
הוספת דגלים לעריכה.
user
הוספת המשתמש שעשה את העריכה.
userid
הוספת מזהה המשתמש של מי שעשה את העריכה.
comment
הוספת ההערה של העריכה.
parsedcomment
הוספת ההערכה המפוענחת של העריכה.
timestamp
הוספת חותם־זמן של העריכה.
patrol
תיוג עריכות שנבדקו.
sizes
הוספת האורך החדש והישן של הדף.
notificationtimestamp
הוספת חותם־זמן של ההודעה האחרונה למשתמש על העריכה.
loginfo
הוספת מידע מהיומן איפה שמתאים.
ערכים (מופרדים באמצעות "|"): ids, title, flags, user, userid, comment, parsedcomment, timestamp, patrol, sizes, notificationtimestamp, loginfo
ברירת מחדל: ids|title|flags
wlshow

הצגה רק של פריטים שמתאימים לאמות המידה האלו. למשל, כדי לראות רק עריכות משניות שעשו משתמשים שנכנסו לחשבון, יש להגדיר wlshow=minor|!anon.

ערכים (מופרדים באמצעות "|"): minor, !minor, bot, !bot, anon, !anon, patrolled, !patrolled, unread, !unread
wltype

אולי סוגי שינויים להציג:

edit
עריכות דף רגילות.
external
שינויים חיצוניים.
new
יצירות דף.
log
עיולי יומן.
ערכים (מופרדים באמצעות "|"): edit, external, new, log
ברירת מחדל: edit|new|log
wlowner

משמש יחד עם wltoken לגישה לרשימת מעקב של משתמש אחר.

סוג: שם משתמש
wltoken

אסימון אבטחה (זמין ב־העדפות) שמאפשר לגשת לרשימת מעקב של משתמש אחר.

wlcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

דוגמאות:
לרשום את הגרסה האחרונה עבור דפים שהשתנו לאחרונה ברשימת המעקב של המשתמש הנוכחי.
api.php?action=query&list=watchlist
אחזור מידע נוסף על הגרסה האחרונה עבור דפים שהשתנו לאחרונה ברשימת המעקב של המשתמש הנוכחי.
api.php?action=query&list=watchlist&wlprop=ids|title|timestamp|user|comment
אחזור מידע על כל השינויים האחרונים לדפים ברשימת המעקב של המשתמש הנוכחי.
api.php?action=query&list=watchlist&wlallrev=&wlprop=ids|title|timestamp|user|comment
אחזור מידע על הדף עבור דפים שהשתנו לאחרונה ברשימת המעקב של המשתמש הנוכחי.
api.php?action=query&generator=watchlist&prop=info
אחזור מידע על הגרסה עבור דפים שהשתנו לאחרונה ברשימת המעקב של המשתמש הנוכחי.
api.php?action=query&generator=watchlist&gwlallrev=&prop=revisions&rvprop=timestamp|user
לרשום את הגרסה האחרונה עבור דפים שהשתנו לאחרונה ברשימת המעקב של משתמש Example.
api.php?action=query&list=watchlist&wlowner=Example&wltoken=123ABC

list=watchlistraw (wr)

  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת כל הדפים ברשימת המעקב של המשתמש הנוכחי.

פרמטרים:
wrcontinue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

wrnamespace

לרשום רק דפים במרחב השם הנתון.

ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
wrlimit

כמה תוצאות סך הכול להחזיר בכל בקשה.

המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
סוג: מספר שלם או max
ברירת מחדל: 10
wrprop

אילו מאפיינים נוספים לקבל:

changed
הוספת חותם־הזמן של ההודעה האחרונה למשתמש על העריכה.
ערכים (מופרדים באמצעות "|"): changed
wrshow

לרשום רק פריטים שעונים על אמות המידה האלו.

ערכים (מופרדים באמצעות "|"): changed, !changed
wrowner

משמש יחד עם wrtoken לגישה לרשימת מעקב של משתמש אחר.

סוג: שם משתמש
wrtoken

אסימון אבטחה (זמין ב־העדפות) שמאפשר לגשת לרשימת מעקב של משתמש אחר.

wrdir

באיזה כיוון למנות:

newer
לרשום את הישנים ביותר בהתחלה. לתשומת לבך: wrstart חייב להיות לפני wrend.
older
לרשום את החדשים ביותר בהתחלה (בררת מחדל). לתשומת לבך: wrstart חייב להיות אחרי wrend.
אחד מהערכים הבאים: ascending, descending
ברירת מחדל: ascending
wrfromtitle

מאיזו כותרת (עם תחילית מרחב שם) להתחיל למנות.

wrtotitle

באיזו כותרת (עם תחילית מרחב שם) להפסיק למנות.

דוגמאות:
לרשום דפים ברשימת המעקב של המשתמש הנוכחי.
api.php?action=query&list=watchlistraw
אחזור מידע על הדפים עבור דפים ברשימת המעקב של המשתמש הנוכחי.
api.php?action=query&generator=watchlistraw&gwrshow=changed&prop=info

meta=allmessages (am)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת הודעות מהאתר הזה.

פרמטרים:
ammessages

אילו הודעות לפלוט. כתיבת * (בררת מחדל) תפלוט את כל ההודעות.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
ברירת מחדל: *
amprop

אלו מאפיינים לקבל.

ערכים (מופרדים באמצעות "|"): default
amenableparser

יש להגדיר כדי להפעיל את המפענח, יעשה קדם־עיבוד לקוד ויקי של ההודעה (יחליף מילות קסם, יטפל בתבניות, וכו').

סוג: בוליאני (פרטים)
amnocontent

אם זה מוגדר, לא לכלול את תוכן ההודעות בפלט.

סוג: בוליאני (פרטים)
amincludelocal

לכלול גם הודעות מקומיות, כלומר הודעות שאינן קיימות בתכנה, אבל כן קיימות בתור דף מדיה־ויקי. זה רושם את כל דפי MediaWiki: כך שזה ירשום גם דפים שאינם באמת הודעות, כגון Common.js.

סוג: בוליאני (פרטים)
amargs

ארגומנטים שיוחלפו לתוך ההודעה.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
amfilter

החזרה רק של הודעות עם שמות שמכילים את המחרוזת הזאת.

amcustomised

להחזיר רק הודעות במצב ההתאמה הזה.

אחד מהערכים הבאים: all, modified, unmodified
ברירת מחדל: all
amlang

החזרת הודעת בשפה הזאת.

amfrom

החזרת הודעת החל מההודעה הזאת.

amto

החזרת הודעות עד ההודעה הזאת.

amtitle

שם דף לשימוש בתור הֶקשר בעת ענוח הודעה (עבור האפשרות amenableparser).

amprefix

החזרת הודעת עם התחילית הזאת.

דוגמאות:
להציג הודעות שמתחילות ב־ipb-.
api.php?action=query&meta=allmessages&amprefix=ipb-
להציג את ההודעות august ו־mainpage בגרמנית.
api.php?action=query&meta=allmessages&ammessages=august|mainpage&amlang=de

meta=filerepoinfo (fri)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת מידע מטא על מאגרי תמונות שמוגדרים בוויקי.

פרמטר:
friprop

אילו מאפייני מאגר לקבל (יכולים להיות יותר מזה באתרי ויקי אחדים):

apiurl
URL ל־API של המאגר – מועיל לקבלת מידע על התמונה מהמארח.
name
המפתח של המאגר – משמש למשל בערכים המוחזרים מ־$wgForeignFileRepos ומ־imageinfo.
displayname
שם קריא של אתר הוויקי של המאגר.
rooturl
URL שורש לנתיבי תמונות.
local
האם המאגר הוא מקומי או לא.
ערכים (מופרדים באמצעות "|"): name, displayname, rootUrl, local, url, thumbUrl, initialCapital, scriptDirUrl, scriptExtension, favicon, canUpload
ברירת מחדל: name|displayname|rootUrl|local|url|thumbUrl|initialCapital|scriptDirUrl|scriptExtension|favicon|canUpload
דוגמה:
קבלת מידע על מאגרי קבצים.
api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname

meta=siteinfo (si)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

החזרת מידע כללי על האתר.

פרמטרים:
siprop

איזה מיד לקבל:

general
מידע מערכת כללי.
namespaces
רשימת מרחבי שם רשומים והשמות הקנוניים שלהם.
namespacealiases
רשימת כינויי מרחבי שם רשומים.
specialpagealiases
רשימת כינויים דפים מיוחדים.
magicwords
רשימות מילות קסם וכינוייהן.
interwikimap
החזרת מפת בינוויקי (אפשר שתהיה מסוננת, אפשר שתהיה מותאמת מקומית באמצעות siinlanguagecode).
dbrepllag
החזרת שרת מסד־נתונים עם שיהוי השכפול הגבוה ביותר.
statistics
החזרזת סטטיסטיקות אתר.
usergroups
החזרת קבוצות משתמשים וההרשאות המשויכות.
libraries
החזרת הספריות המותקנות בוויקי.
extensions
החזרת ההרחבות המותקנות בוויקי.
fileextensions
החזרת רשימת סיומות קבצים שאפשר להעלות.
rightsinfo
החזרת הזכויות (הרישיון) של הוויקי, אם זמין.
restrictions
החזרת מידע על ההגבלות (ההגנות) הזמינות.
languages
החזרת השפות שמדיה־ויקי תומכת בהן (זה יכול להיות מותאם מקומים עם siinlanguagecode).
skins
החזרת רשימת כל העיצובים הזמינים (זה יכול להיות מותאם מקומית באמצעות siinlanguagecode, אחרת זה יהיה בשפת התוכן).
extensiontags
החזרת רשימת תגי הרחבת מפענח.
functionhooks
החזרת hook־ים של הרחבות מפענח.
showhooks
החזרת כל ה־hook־ים המנויים (תוכן של $wgHooks).
variables
החזרת מזהי משתנים.
protocols
החזרת רשימת הפרוטוקולים המותרים בקישורים חיצוניים.
defaultoptions
החזרת הערכים ההתחלתיים של העדפות משתמש.
ערכים (מופרדים באמצעות "|"): general, namespaces, namespacealiases, specialpagealiases, magicwords, interwikimap, dbrepllag, statistics, usergroups, libraries, extensions, fileextensions, rightsinfo, restrictions, languages, skins, extensiontags, functionhooks, showhooks, variables, protocols, defaultoptions
ברירת מחדל: general
sifilteriw

החזרה רק של עיולים מקומיים או רק של עיולים לא מקומיים ממפת הבינוויקי.

אחד מהערכים הבאים: local, !local
sishowalldb

רשימת כל שרתי מסד הנתונים, לא רק אלה שהכי מתעכבים.

סוג: בוליאני (פרטים)
sinumberingroup

רשימת מספרי משתמשים בקבוצות משתמשים.

סוג: בוליאני (פרטים)
siinlanguagecode

קוד שפה ששמות שפות מתורגמות (מאמץ טוב ביותר) ושמות עיצובים.

דוגמאות:
איזור מידע על האתר.
api.php?action=query&meta=siteinfo&siprop=general|namespaces|namespacealiases|statistics
אחזור תחיליות בינוויקי מקומיות.
api.php?action=query&meta=siteinfo&siprop=interwikimap&sifilteriw=local
בדיקת שיהוי השכפול הנוכחי.
api.php?action=query&meta=siteinfo&siprop=dbrepllag&sishowalldb=

meta=tokens

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת אסימונים לפעולות שמשנות נתונים.

פרמטר:
type

סוגי האסימונים לבקש.

ערכים (מופרדים באמצעות "|"): csrf, patrol, rollback, userrights, watch
ברירת מחדל: csrf
דוגמאות:
אחזור אסימון csrf (בררת המחדל).
api.php?action=query&meta=tokens
אחזור אסימון של רשימת המעקב ואסימון של ניטור
api.php?action=query&meta=tokens&type=watch|patrol

meta=userinfo (ui)

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת מידע על המשתמש הנוכחי.

פרמטר:
uiprop

אילו חלקי מידע לכלול:

blockinfo
מתייג אם המשתמש הנוכחי נחסם, על־ידי מי ומאיזו סיבה.
hasmsg
הוספת התג messages אם למשתמש הנוכחי יש הודעות ממתינות.
groups
רשימת כל הקבוצות שהמשתמש שייך אליהן.
implicitgroups
רשימת כל הקבוצות שהמשתמש שייך אליהן באופן אוטומטי.
rights
רשימת כל ההרשאות שיש למשתמש הזה.
changeablegroups
רשימת הקבוצות שהמשתמש הנוכחי יכול להוסיף אליהן ולגרוע מהן.
options
רשימת כל ההעדפות שהמשתמש הנוכחי הגדיר.
preferencestoken
מיושן. קבלת אסימון לשינוי ההעדפות של המשתמש הנוכחי.
editcount
הוספת מניין העריכות של המשתמש הנוכחי.
ratelimits
רשימת כל מגבלות הקצב שחלות על המשתמש הנוכחי.
email
הוספת כתובת הדוא"ל ותאריך אימות כתובת הדוא"ל.
realname
הוספת השם האמתי של המשתמש.
acceptlang
מדפיס את כותרת Accept-Language ששלח הלקוח בתסדיר מובנה.
registrationdate
הוספת תאריך הרישום של המשתמש.
unreadcount
הוספת מניין הדפים שלא נקראו ברשימת המעקב של המשתמש (לכל היותר 999; מחזיר 1000+ אם יש יותר).
ערכים (מופרדים באמצעות "|"): blockinfo, hasmsg, groups, implicitgroups, rights, changeablegroups, options, preferencestoken, editcount, ratelimits, email, realname, acceptlang, registrationdate, unreadcount
דוגמאות:
קבלת מידע על המשתמש הנוכחי.
api.php?action=query&meta=userinfo
קבלת מידע נוסף על המשתמש הנוכחי.
api.php?action=query&meta=userinfo&uiprop=blockinfo|groups|rights|hasmsg

action=revisiondelete

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מחיקה ושחזור ממחיקה של גרסאות.

פרמטרים:
type

סוג מחיקת הגרסה שמתבצע.

פרמטר זה נדרש.
אחד מהערכים הבאים: revision, archive, oldimage, filearchive, logging
target

שם הדף למחיקת גרסה, אם זה נחוץ לסוג.

ids

מזהים של הגרסה שתימחק.

פרמטר זה נדרש.
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
hide

מה להסתיר עבור כל גרסה.

ערכים (מופרדים באמצעות "|"): content, comment, user
show

הסתרה של מה לבטל עבור כל גרסה.

ערכים (מופרדים באמצעות "|"): content, comment, user
suppress

האם להעלים נתונים ממפעילים ומאחרים.

אחד מהערכים הבאים: yes, no, nochange
ברירת מחדל: nochange
reason

סיבה למחיקה או לשחזור ממחיקה.

token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
הסתרת התוכן של הגרסה 12345 בדף Main Page.
api.php?action=revisiondelete&target=Main%20Page&type=revision&ids=12345&hide=content&token=123ABC
הסתרת כל הנתוהים על עיול היומן 67890 עם הסיבה BLP violation.
api.php?action=revisiondelete&type=logging&ids=67890&hide=content|comment|user&reason=BLP%20violation&token=123ABC

action=rollback

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

ביטול העריכה האחרונה לדף.

אם המשמש האחרון שערך את הדף עשה מספר עריכות זו אחר זו, הן תשוחזרנה.

פרמטרים:
title

שם הדף לשחזור. לא יכול לשמש יחד עם pageid.

pageid

מזהה הדף לשחזור. לא יכול לשמש יחד עם title.

סוג: מספר שלם
user

שם המשתמשים שהעריכות שלו תשוחזרנה.

פרמטר זה נדרש.
summary

תקציר עריכה מותאם. אם ריק, ישמש תקציר לפי בררת מחדל.

ברירת מחדל: (ריק)
markbot

לסמן את העריכות ששוחזרו ואת השחזור בתור עריכות בוט.

סוג: בוליאני (פרטים)
watchlist

הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.

אחד מהערכים הבאים: watch, unwatch, preferences, nochange
ברירת מחדל: preferences
token

אסימון "rollback" שאוחזר מ־action=query&meta=tokens

לשם תאימות, גם האסימון שמשמש בממשק דפדפן מתקבל.

פרמטר זה נדרש.
דוגמאות:
שחזור העריכות האחרונות לדף Main Page על־ידי המשתמש Example.
api.php?action=rollback&title=Main%20Page&user=Example&token=123ABC
שחזור העריכות האחרונות לדף Main Page מאת משתמש ה־IP‏ 192.0.2.5 עם התקציר Reverting vandalism וסימון של העריכות האלה ושל השחזור בתור עריכות בוט.
api.php?action=rollback&title=Main%20Page&user=192.0.2.5&token=123ABC&summary=Reverting%20vandalism&markbot=1

action=rsd

(main | rsd)
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

יצוא סכמת RSD‏ (Really Simple Discovery).

דוגמה:
יצוא סכמת ה־RSD.
api.php?action=rsd

action=setnotificationtimestamp

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

עדכון חותם־הזמן של ההודעה עבור דפים במעקב.

זה משפיע על הדגשת הדפים שהשתנו ברשימת המעקב ובהיסטוריה, ושליחת דואר אלקטרוני כאשר ההעדפה "לשלוח אליי דוא"ל כאשר משתנה דף או קובץ ברשימת המעקב שלי" מופעלת.

פרמטרים:
entirewatchlist

לעבוד על כל הדפים שבמעקב.

סוג: בוליאני (פרטים)
timestamp

חותם־הזמן להגדרת חותם־זמן של הודעה.

סוג: חותם־זמן (תסדירים מורשים)
torevid

לאיזו גרסה להגדיר את חותם הזמן (רק דף אחד).

סוג: מספר שלם
newerthanrevid

הגרסה שחותם־הזמן של ההודעה יוגדר בתור חדש ממנה (רק דף אחד).

סוג: מספר שלם
continue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

titles

רשימת כותרות.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
pageids

רשימת מזהי דף לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
revids

רשימת מזהי גרסה לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
generator

קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.

לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.

אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, 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

פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.

סוג: בוליאני (פרטים)
converttitles

המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz, zh.

סוג: בוליאני (פרטים)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
אתחול מצב ההודעה עבור כל רשימת המעקב.
api.php?action=setnotificationtimestamp&entirewatchlist=&token=123ABC
אתחול מצב ההודעה עבור Main Page.
api.php?action=setnotificationtimestamp&titles=Main_page&token=123ABC
הגדרת חותם־הזמן להודעה ל־Main page כך שכל העריכות מאז 1 בינואר 2012 מוגדרות בתור כאלה שלא נצפו.
api.php?action=setnotificationtimestamp&titles=Main_page&timestamp=2012-01-01T00:00:00Z&token=123ABC
אתחול מצב ההודעה עבור דפים במרחב השם משתמש.
api.php?action=setnotificationtimestamp&generator=allpages&gapnamespace=2&token=123ABC

action=stashedit

  • היחידה הזאת היא פנימית או בלתי־יציבה. הפעולה שלה יכולה להשתנות ללא הודעה מוקדמת.
  • יחידה זו דורשת הרשאות קריאה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: 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.

פרמטר זה נדרש.
section

Section number. 0 for the top section, new for a new section.

sectiontitle

The title for a new section.

text

Page content.

פרמטר זה נדרש.
contentmodel

Content model of the new content.

פרמטר זה נדרש.
אחד מהערכים הבאים: wikitext, javascript, json, css, text
contentformat

Content serialization format used for the input text.

פרמטר זה נדרש.
אחד מהערכים הבאים: text/x-wiki, text/javascript, application/json, text/css, text/plain
baserevid

Revision ID of the base revision.

פרמטר זה נדרש.
סוג: מספר שלם
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.

action=tag

(main | tag)
  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

הוספת או הסרה של תגים מגרסאות בודדות או עיולי יומן בודדים.

פרמטרים:
rcid

מזהה שינוי אחרון אחד או יותר שתג יתווסף אליו או יוסר ממנו.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
revid

מזהה גרסה אחד או יותר שתג יתווסף אליה או יוסר ממנה.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
logid

מזהה עיול יומן אחד או יותר שתג יתווסף אליו או יוסר ממנו.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
add

התגים להוספה. אפשר להוסיף רק תגים קיימים.

ערכים (מופרדים באמצעות "|"):
remove

תגים להסרה. רק תגים שהוגדרו ידנית או שאינם מוגדרים כלל יכולים להיות מוסרים.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
reason

סיבה לשינוי.

ברירת מחדל: (ריק)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
הוספת התג vandalism לגרסה עם המזהה 123 בלי לציין סיבה
api.php?action=tag&revid=123&add=vandalism&token=123ABC
הסרת התג spam מעיול עם המזהה 123 עם הסיבה Wrongly applied
api.php?action=tag&logid=123&remove=spam&reason=Wrongly+applied&token=123ABC

action=tokens

  • יחידה זו אינה מומלצת לשימוש.
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

קבלת אסימונים לפעולות שמשנות נתונים.

היחידה הזאת הוכרזה בתור מיושנת לטובת action=query&meta=tokens.

פרמטר:
type

סוגי האסימונים לבקש.

ערכים (מופרדים באמצעות "|"): block, delete, edit, email, import, move, options, patrol, protect, unblock, watch
ברירת מחדל: edit
דוגמאות:
אחזור אסימון עריכה (בררת המחדל).
api.php?action=tokens
אחזור אסימון דוא"ל ואסימון העברה.
api.php?action=tokens&type=email|move

action=unblock

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

שחרור משתמש מחסימה.

פרמטרים:
id

מזהה החסימה לשחרור (מתקבל דרך list=blocks). לא יכול לשמש יחד עם user.

סוג: מספר שלם
user

שם משתמש, כתובת IP או טווח IP לחסימה. לא יכול לשמש יחד עם id

reason

סיבה להסרת חסימה.

ברירת מחדל: (ריק)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
לשחרר את החסימה עם מזהה #105.
api.php?action=unblock&id=105
לשחרר את החסימה של המשתמש Bob עם הסיבה Sorry Bob.
api.php?action=unblock&user=Bob&reason=Sorry%20Bob

action=undelete

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

שחזור גרסאות של דף מחוק.

אפשר לאחזר רשימת גרסאות מחוקות (כולל חותמי־זמן) דרך list=deletedrevs, ואפשר לאחזר רשימת מזהי קבצים מחוקים דרך list=filearchive.

פרמטרים:
title

שם הדף לשחזור ממחיקה.

פרמטר זה נדרש.
reason

סיבה לשחזור.

ברירת מחדל: (ריק)
timestamps

חותמי־זמן של הגרסה לשחזור. אם גם timestamps וגם fileids ריקים, הכול ישוחזר.

סוג: רשימת חותמי־זמן (תסדירים מורשים)
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
fileids

מזהי גרסאות הקובץ לשחזור. אם גם timestamps וגם fileids ריקים, הכול ישוחזר.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
watchlist

הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.

אחד מהערכים הבאים: watch, unwatch, preferences, nochange
ברירת מחדל: preferences
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.

action=upload

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

העלאת קובץ, או קבלת מצב ההעלאות הממתינות.

יש מספר שיטות:

  • להעלות את הקובץ ישירות, באמצעות הפרמטר file.
  • להעלות את הקובץ בחלקים, באמצעות הפרמטרים filesize‏, chunk ו־offset.
  • לגרום לשרת מדיה־ויקי לאחזר את הקובץ מ־URL באמצעות הפרמטר url.
  • להשלים העלאה קודמת שנכשלה בשל אזהרות באמצעות הפרמטר filekey.

לתשומך לבך, יש לעשות את HTTP POST בתור העלאת קובץ (כלומר באמצעות multipart/form-data) בעת שליחת ה־file.

פרמטרים:
filename

שם קובץ היעד.

comment

הערת העלאה. משמש גם בתור טקסט הדף ההתחלתי עבור קבצים חדשים אם text אינו מצוין.

ברירת מחדל: (ריק)
text

טקסט הדף ההתחלתי לקבצים חדשים.

watch
מיושן.

לעקוב אחרי הדף.

סוג: בוליאני (פרטים)
watchlist

הוספה או הסרה של הדף ללא תנאי מרשימת המעקב של המשתמש הנוכחי, להשתמש בהעדפות או לא לשנות את המעקב.

אחד מהערכים הבאים: watch, preferences, nochange
ברירת מחדל: preferences
ignorewarnings

להתעלם מכל האזהרות.

סוג: בוליאני (פרטים)
file

תוכן הקובץ.

חייב להישלח (posted) בתור העלאת קובץ באמצעות multipart/form-data.
url

URL לאחזור הקובץ.

filekey

מפתח שמזהה העלאה קודמת שהונחה בצד באופן זמני.

sessionkey
מיושן.

אותו דבר כמו filekey, מושאר לצור תאימות אחורה.

stash

אם זה מוגדר, השרת יסליק את הקובץ זמנית במקום להוסיף אותו למאגר.

סוג: בוליאני (פרטים)
filesize

גודל הקובץ של כל ההעלאה.

הערך חייב להיות בין 0 ל־104,857,600.
סוג: מספר שלם
offset

היסט החתיכה בבתים.

הערך לא יכולים להיות קטנים מ־0.
סוג: מספר שלם
chunk

תוכן החתיכה.

חייב להישלח (posted) בתור העלאת קובץ באמצעות multipart/form-data.
async

להפוך פעולות קבצים גדולות לאסינכרוניות כשאפשר.

סוג: בוליאני (פרטים)
asyncdownload

להפוך אחזור URL לאסינכרוני.

סוג: בוליאני (פרטים)
leavemessage

אם משמש asyncdownload, להשאיר הודעה על דף שיחת משתמש אם זה מסתיים.

סוג: בוליאני (פרטים)
statuskey

לאחזר את מצב העלאת הקובץ עבור מפתח הקובץ הזה (העלאה באמצעות URL).

checkstatus

לאחזר רק מצב העלאה עבור מפתח הקובץ שניתן.

סוג: בוליאני (פרטים)
token

אסימון "csrf" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.

action=userrights

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

שינוי חברות בקבוצות של המשתמש.

פרמטרים:
user

שם משתמש.

userid

מזהה משתמש.

סוג: מספר שלם
add

הוספת המשתמש לקבוצות האלו.

ערכים (מופרדים באמצעות "|"): bot, sysop, bureaucrat
remove

הסרת משתמש מהקבוצות האלו.

ערכים (מופרדים באמצעות "|"): bot, sysop, bureaucrat
reason

סיבה לשינוי.

ברירת מחדל: (ריק)
token

אסימון "userrights" שאוחזר מ־action=query&meta=tokens

לשם תאימות, גם האסימון שמשמש בממשק דפדפן מתקבל.

פרמטר זה נדרש.
דוגמאות:
הוספת המשתמש FooBot לקבוצה bot והסרתו מהקבוצות sysop ו־bureaucrat.
api.php?action=userrights&user=FooBot&add=bot&remove=sysop|bureaucrat&token=123ABC
הוספת המשתמש עם המזהה 123 לקבוצה bot והסרתו מהקבוצות sysop ו־bureaucrat.
api.php?action=userrights&userid=123&add=bot&remove=sysop|bureaucrat&token=123ABC

action=watch

  • יחידה זו דורשת הרשאות קריאה.
  • היחידה הזאת דורשת הרשאות כתיבה.
  • יחידה זו מקבלת רק בקשות POST.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

להוסיף דפים לרשימת המעקב של המשתמש הנוכחי או הסרתם ממנה.

פרמטרים:
title
מיושן.

הדף להוסיף לרשימת המעקב או להסיר ממנה. יש להשתמש במקום זאת ב־titles.

unwatch

אם זה מוגדר, הדף יהיה לא במעקב במקום להיות במעקב.

סוג: בוליאני (פרטים)
continue

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

titles

רשימת כותרות.

הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
pageids

רשימת מזהי דף לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
revids

רשימת מזהי גרסה לעבוד עליהם.

סוג: רשימת מספרים שלמים
הפרדה בין ערכים נעשית באמצעות | מספר הערכים המרבי הוא 50 (עבור בוטים – 500).
generator

קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.

לתשומת לבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.

אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, 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

פתרון אוטומטי של הפניות ב־titles, ב־pageids, וב־revids, ובדפים שמחזיר generator.

סוג: בוליאני (פרטים)
converttitles

המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן gan, iu, kk, ku, shi, sr, tg, uz, zh.

סוג: בוליאני (פרטים)
token

אסימון "watch" שאוחזר מ־action=query&meta=tokens

פרמטר זה נדרש.
דוגמאות:
לעקוב אחרי הדף Main Page.
api.php?action=watch&titles=Main_Page&token=123ABC
להפסיק את המעקב אחרי הדף Main Page.
api.php?action=watch&titles=Main_Page&unwatch=&token=123ABC
לעקוב אחרי הדפים הראשונים במרחב הראשי.
api.php?action=watch&generator=allpages&gapnamespace=0&token=123ABC

format=dbg

(main | dbg)
  • יחידה זו אינה מומלצת לשימוש.
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט נתונים בתסדיר var_export() של PHP.

דוגמה:
להחזיר את תוצאות השאילתה בתסדיר DBG.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbg

format=dbgfm

  • יחידה זו אינה מומלצת לשימוש.
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט את הנתונים בתסדיר var_export() של PHP (עם הדפסה יפה ב־HTML).

דוגמה:
להחזיר את תוצאות השאילתה בתסדיר DBG.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbgfm

format=json

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט נתונים בתסדיר JSON.

פרמטרים:
callback

אם זה צוין, עוטף את הפלט לתוך קריאת פונקציה נתונה. למען הבטיחות, כל הנתונים הייחודיים למשתמש יוגבלו.

utf8

אם זה צוין, רוב התווים שאינם ASCII (אבל לא כולם) יקודדו בתור UTF-8 במקום להתחלף בסדרות חילוף הקסדצימליות. זאת בררת המחדל אם הערך של formatversion הוא לא 1.

סוג: בוליאני (פרטים)
ascii

אם זה צוין, לקודד את כל מה שאינו ASCII בסדרות חילוף הקסדצימליות. זאת בררת המחדל כש־formatversion היא 1.

סוג: בוליאני (פרטים)
formatversion

תסדיר הפלט:

1
תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
2
תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
latest
להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
אחד מהערכים הבאים: 1, 2, latest
ברירת מחדל: 1
דוגמה:
להחזיר את תוצאות השאילתה בתסדיר JSON.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=json

format=jsonfm

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט נתונים בתסדיר JSON (עם הדפסה יפה ב־HTML).

פרמטרים:
callback

אם זה צוין, עוטף את הפלט לתוך קריאת פונקציה נתונה. למען הבטיחות, כל הנתונים הייחודיים למשתמש יוגבלו.

utf8

אם זה צוין, רוב התווים שאינם ASCII (אבל לא כולם) יקודדו בתור UTF-8 במקום להתחלף בסדרות חילוף הקסדצימליות. זאת בררת המחדל אם הערך של formatversion הוא לא 1.

סוג: בוליאני (פרטים)
ascii

אם זה צוין, לקודד את כל מה שאינו ASCII בסדרות חילוף הקסדצימליות. זאת בררת המחדל כש־formatversion היא 1.

סוג: בוליאני (פרטים)
formatversion

תסדיר הפלט:

1
תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
2
תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
latest
להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
אחד מהערכים הבאים: 1, 2, latest
ברירת מחדל: 1
דוגמה:
להחזיר את תוצאות השאילתה בתסדיר JSON.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm

format=none

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לא לפלוט שום דבר.

דוגמה:
להחזיר את תוצאות השאילתה בתסדיר NONE.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=none

format=php

(main | php)
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט נתונים בתסדיר PHP מוסדר.

פרמטר:
formatversion

תסדיר הפלט:

1
תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
2
תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
latest
להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
אחד מהערכים הבאים: 1, 2, latest
ברירת מחדל: 1
דוגמה:
להחזיר את תוצאות השאילתה בתסדיר PHP.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=php

format=phpfm

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט נתונים בתסדיר PHP מוסדר (עם הדפסה יפה ב־HTML).

פרמטר:
formatversion

תסדיר הפלט:

1
תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
2
תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
latest
להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
אחד מהערכים הבאים: 1, 2, latest
ברירת מחדל: 1
דוגמה:
להחזיר את תוצאות השאילתה בתסדיר PHP.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm

format=rawfm

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט את הנתונים עם אלמנטים לניפוי שגיאות בתסדיר JSON (עם הדפסה יפה ב־HTML).

דוגמה:
להחזיר את תוצאות השאילתה בתסדיר RAW.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm

format=txt

(main | txt)
  • יחידה זו אינה מומלצת לשימוש.
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט נתונים בתסדיר print_r() של PHP.

דוגמה:
להחזיר את תוצאות השאילתה בתסדיר TXT.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txt

format=txtfm

  • יחידה זו אינה מומלצת לשימוש.
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט את הנתונים בתסדיר print_r() של PHP (עם הדפסה יפה ב־HTML).

דוגמה:
להחזיר את תוצאות השאילתה בתסדיר TXT.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=txtfm

format=xml

(main | xml)
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט נתונים בתסדיר XML.

פרמטרים:
xslt

אם צוין, יש להוסיף את שם הדף כגיליון עיצוב XSL. על הערך להיות כותרת ב מדיה ויקי במרחב שם המשתמש, המסתיים ב- .xsl.

includexmlnamespace

אם זה צוין, מוסיף מרחב שם של XML.

סוג: בוליאני (פרטים)
דוגמה:
להחזיר את תוצאות השאילתה בתסדיר XML.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml

format=xmlfm

  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט נתונים בתסדיר XML (עם הדפסה יפה ב־HTML).

פרמטרים:
xslt

אם צוין, יש להוסיף את שם הדף כגיליון עיצוב XSL. על הערך להיות כותרת ב מדיה ויקי במרחב שם המשתמש, המסתיים ב- .xsl.

includexmlnamespace

אם זה צוין, מוסיף מרחב שם של XML.

סוג: בוליאני (פרטים)
דוגמה:
להחזיר את תוצאות השאילתה בתסדיר XML.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm

format=yaml

  • יחידה זו אינה מומלצת לשימוש.
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט את הנתונים בתסדיר YAML.

פרמטרים:
callback

אם זה צוין, עוטף את הפלט לתוך קריאת פונקציה נתונה. למען הבטיחות, כל הנתונים הייחודיים למשתמש יוגבלו.

utf8

אם זה צוין, רוב התווים שאינם ASCII (אבל לא כולם) יקודדו בתור UTF-8 במקום להתחלף בסדרות חילוף הקסדצימליות. זאת בררת המחדל אם הערך של formatversion הוא לא 1.

סוג: בוליאני (פרטים)
ascii

אם זה צוין, לקודד את כל מה שאינו ASCII בסדרות חילוף הקסדצימליות. זאת בררת המחדל כש־formatversion היא 1.

סוג: בוליאני (פרטים)
formatversion

תסדיר הפלט:

1
תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
2
תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
latest
להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
אחד מהערכים הבאים: 1, 2, latest
ברירת מחדל: 1
דוגמה:
להחזיר את תוצאות השאילתה בתסדיר YAML.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml

format=yamlfm

  • יחידה זו אינה מומלצת לשימוש.
  • יחידה זו דורשת הרשאות קריאה.
  • מקור: MediaWiki
  • רישיון: GPL-2.0+

לפלוט נתונים בתסדיר YAML (עם הדפסה יפה ב־HTML).

פרמטרים:
callback

אם זה צוין, עוטף את הפלט לתוך קריאת פונקציה נתונה. למען הבטיחות, כל הנתונים הייחודיים למשתמש יוגבלו.

utf8

אם זה צוין, רוב התווים שאינם ASCII (אבל לא כולם) יקודדו בתור UTF-8 במקום להתחלף בסדרות חילוף הקסדצימליות. זאת בררת המחדל אם הערך של formatversion הוא לא 1.

סוג: בוליאני (פרטים)
ascii

אם זה צוין, לקודד את כל מה שאינו ASCII בסדרות חילוף הקסדצימליות. זאת בררת המחדל כש־formatversion היא 1.

סוג: בוליאני (פרטים)
formatversion

תסדיר הפלט:

1
תסדיר עם תאימות אחורה (ערכים בוליאניים בסגנון XML, מפתחות * לצומתי תוכן, וכו').
2
תסדיר מודרני ניסיוני. הפרטים יכולים להשתנות!
latest
להשתמש בתסדיר החדש ביותר (כרגע 2), יכול להשתנות ללא התראה.
אחד מהערכים הבאים: 1, 2, latest
ברירת מחדל: 1
דוגמה:
להחזיר את תוצאות השאילתה בתסדיר YAML.
api.php?action=query&meta=siteinfo&siprop=namespaces&format=yamlfm

סוגי נתונים

חלק מסוגי הפרמטרים בבקשות API דורשים הסבר נוסף:

בוליאני (boolean)
פרמטרים בוליאניים עובדים כמו תיבות סימון של HTML: אם הפרמטר צוין, בלי קשר לערך שלו, הוא אמת (true). בשביל ערך שקר (false), יש להשמיט את הפרמטר לגמרי.
חותם־זמן (timestamp)
אפשר לכתוב חותמי־זמן במספר תסדירים. תאריך ושעה לפי ISO 8601 הוא הדבר המומלת. כל הזמנים מצוינים ב־ UTC, לא תהיה השפעה לשום אזור זמן שיצוין.
  • תאריך ושעה לפי ISO 8601‏, 2001-01-15T14:56:00Z (לא חובה לכתוב פיסוק ו־Z)
  • תאריך ושעה לפי ISO 8601 עם חלקי שנייה (שלא תהיה להם שום השפעה), 2001-01-15T14:56:00.00001Z (לא חובה לכתוב קווים מפרידים, נקודתיים ו־Z)
  • תסדיר MediaWiki‏, 20010115145600
  • תסדיר מספרי כללי, 2001-01-15 14:56:00 (לאזור זמן אופציונלי של GMT‏, +##, או -## אין השפעה)
  • תסדיר EXIF‏, 2001:01:15 14:56:00
  • תסדיר RFC 2822 (אפשר להשמיט את אזור הזמן), Mon, 15 Jan 2001 14:56:00
  • תסדיר RFC 850 (אפשר להשמיט את אזור הזמן), Monday, 15-Jan-2001 14:56:00
  • תסדיר C ctime‏, Mon Jan 15 14:56:00 2001
  • שניות מאז 1970-01-01T00:00:00Z בתור מספר שלך בין 1 ל־13 (לא כולל 0)
  • המחרוזת now

קרדיטים

מפתחי ה־API:

  • רואן קטאו (מפתח מוביל 2007–2009)
  • ויקטור וסילייב
  • בריאן טונג מין
  • סאם ריד
  • יורי אסטרחן (יוצר, מפתח מוביל מספטמבר 2006 עד ספטמבר 2007)
  • בראד יורש (מפתח מוביל מאז 2013)

אנא שלחו הערות, הצעות ושאלות לכתובת [email protected] או כתבו דיווח באג באתר https://phabricator.wikimedia.org.