עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=query
(main | query)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
אחזור נתונים ממדיה־ויקי ועליה.
כל שינויי הנתונים יצטרכו תחילה להשתמש ב־query כדי לקבל אסימון למניעת שימוש לרעה מאתרים זדוניים.
פרמטרים ייעודיים:
זמינים פרמטרים כלליים אחרים.
- prop
אילו מאפיינים לקבל על הדפים בשאילתה.
- categories
- לרשום את כל הקטגוריות שהדף שייך אליהן.
- categoryinfo
- החזרת מידע על הקטגוריות הנתונות.
- cirrusbuilddoc
- היטל של מסמך עבור ערך ב־CirrusSearch משרתי בסיס הנתונים
- cirruscompsuggestbuilddoc
- היטל של המסמך שבשימוש מציע ההשלמות
- cirrusdoc
- היטל של מסמך עבור ערך ב־CirrusSearch משרתי החיפוש
- contributors
- קבלת רשימה של תורמים שנכנסו לחשבון ומניין של תורמים שלא נכנסו לחשבון לדף.
- coordinates
- החזרת נקודות ציון של דפים נתונים.
- deletedrevisions
- קבלת מידע על גרסה מחוקה.
- duplicatefiles
- רשימת כל הקבצים שהם כפולים של קבצים נתונים לפי ערכי הגיבוב.
- extlinks
- החזרת כל ה־URL־ים החיצוניים (לא בינוויקי) מהדפים הנתונים.
- extracts
- החזרת קטעים של הדפים הנתונים בטקסט רגיל או ב־HTML מוגבל.
- fileusage
- מציאת כל הדפים שמשתמשים בקבצים הנתונים.
- globalusage
- החזרת שימוש גלובלי בתמונה עבור תמונה מסוימת.
- imageinfo
- החזרת מידע על קובץ והיסטורייה העלאה.
- images
- להחזיר את כל הקבצים שמכילים הדפים הנתונים.
- info
- קבלת מידע בסיסי על הדף.
- iwlinks
- החזרת כל קישורי הבינוויקי מהדפים הנתונים.
- langlinks
- החזרת כל הקישורים הבין־לשוניים מהדפים הנתונים.
- links
- החזרת כל הקישורים מהדפים שצוינו.
- linkshere
- מציאת כל הדפים שמקשרים לדפים הנתונים.
- mmcontent
- קבלת התיאור והיעדים של רשימת הספאם
- pageimages
- החזרת מידע על תמונות בדפים, כגון תמונות ממוזערות ונוכחות של תמונות.
- pageprops
- קבלת מאפייני דף שונים שמוגדרים בתוכן הדף.
- pageterms
- קבלת מושגי ויקינתונים (בדרך־כלל תוויות, תיאורים, וכינויים) שמשויכים לדף דרך קישור אתר.
- pageviews
- הצגת נתוני צפייה לפי דף (מספר הצפיות בכל אחד מ־pvipdays הימים האחרונים).
- redirects
- מחזיר את כל ההפניות לדפים הנתונים.
- revisions
- קבלת מידע על גרסה.
- stashimageinfo
- החזרת מידע על הקובץ עבור הקבצים המוסלקים.
- templates
- החזרת כל הדפים המוכללים בדפים הנתונים.
- transcludedin
- מציאת כל הדפים שמכלילים את הדפים הנתונים.
- transcodestatus
- קבלת מצב המרה משנית עבור דף הקובץ שניתן.
- videoinfo
- הרחבת מידע על תמונה (imageinfo) שיכלול את המידע על מקור הווידאו (נגזרים)
- wbentityusage
- החזרת כל מזהי השאילתות ששימשו בדפים הנתונים.
- description
- פנימי. קבלת תיאור קצר, כלומר כותרת־משנה שמסבירה במה עוסק דף היעד.
- mapdata
- פנימי. בקשת כל נתוני המפה של קרטוגרפר עבור הדפים הנתונים
- ערכים (מופרדים באמצעות "|" או or תו חלופי): categories, categoryinfo, cirrusbuilddoc, cirruscompsuggestbuilddoc, cirrusdoc, contributors, coordinates, deletedrevisions, duplicatefiles, extlinks, extracts, fileusage, globalusage, imageinfo, images, info, iwlinks, langlinks, links, linkshere, mmcontent, pageimages, pageprops, pageterms, pageviews, redirects, revisions, stashimageinfo, templates, transcludedin, transcodestatus, videoinfo, wbentityusage, description, mapdata
- list
אילו רשימות לקבל.
- abusefilters
- הצגת פרטים על מסנני השחתות.
- abuselog
- הצגת אירועים שנתפסו על־ידי אחד ממסנני ההשחתות.
- allcategories
- למנות את כל הקטגוריות.
- alldeletedrevisions
- רשימת כל הגרסאות המחוקות על־ידי משתמש או במרחב.
- allfileusages
- לרשום את כל שימושי הקובץ, כולל בלתי־קיימים.
- allimages
- למנות את כל התמונות לפי הסדר.
- alllinks
- למנות את כל הקישורים שמצביעים למרחב שם נתון.
- allpages
- למנות את כל הדפים לפי הסדר במרחב שם נתון.
- allredirects
- רשימה של כל ההפניות למרחב שם.
- allrevisions
- רשימת כל הגרסאות.
- alltransclusions
- רשימת כל ההכללות (דפים שמוטבעים באמצעות {{x}}), כולל כאלה שאינם קיימים.
- allusers
- למנות את כל המשתמשים הרשומים.
- backlinks
- מציאת כל הדפים שמקשרים לדף הנתון.
- betafeatures
- רשימת כל אפשרויות הבטא
- blocks
- לרשום את כל המשתמשים וכתובות ה־IP שנחסמו.
- categorymembers
- רשימת כל הדפים בקטגוריה נתונה.
- centralnoticeactivecampaigns
- קבלת רשימה של מבצעי פרסום פעילים כעת עם תאריכי התחלה וסוף ושל הכּרזות המשויכות.
- centralnoticelogs
- קבלת יומן של שינויי הגדרות של מבצע פרסום.
- checkuser
- בדיקה אילו כתובות IP משמשות שם משתמש מסוים או אילו שמות משתמש משמשות כתובת IP מסוימת.
- checkuserlog
- קבלת רשומות מיומן בדיקת משתמשים.
- embeddedin
- חיפוש כל הדפים שמטביעים (מכלילים) את הכותרת הנתונה.
- exturlusage
- למנות דפים שמכילים URL נתון.
- filearchive
- למנות את כל הקבצים המחוקים לפי הסדר.
- gadgetcategories
- החזרת רשימת קטגוריות של גאדג'טים.
- gadgets
- החזרת רשימת גאדג'טים שמשמשים בוויקי הזה.
- geosearch
- החזרת דפים שיש להם נקודות ציון שנמצאות באזור מסוים.
- globalallusers
- מניית כל המשתמשים הגלובליים.
- globalblocks
- רשימה של כתובות ה־IP שחסומות גלובלית.
- globalgroups
- למנות את כל הקבוצות הגלובליות.
- imageusage
- מציאת כל הדפים שמתמשים בשם התמונה הנתונה.
- iwbacklinks
- מציאות כל הדפים שמקשרים לקישור הבינוויקי הנתון.
- langbacklinks
- מציאת כל הדפים שמקשרים לקישור השפה הנתון.
- linterrors
- קבלת רשימת שגיאות ניקיון
- logevents
- קבלת אירועים מהרישומים.
- mostviewed
- רשימת הדפים הנצפים ביותר (על סמך ספירת הצפיות בדפים ביום האחרון).
- mystashedfiles
- קבלת רשימת קבצים בסליק ההעלאה של המשתמש הנוכחי.
- pagepropnames
- רשימת כל שמות המאפיינים שמשמשים בוויקי.
- pageswithprop
- לרשום את כל הדפים שמשתמשים במאפיין דף נתון.
- prefixsearch
- ביצוע חיפוש תחילית של כותרות דפים.
- protectedtitles
- לרשום את כל הכותרות שמוגנות מפני יצירה.
- querypage
- קבלת רשימה שמסופקת על־ידי דף מיוחד מבוסס־QueryPage.
- random
- קבלת ערכת דפים אקראיים.
- recentchanges
- למנות שינויים אחרונים.
- search
- ביצוע חיפוש בכל הטקסט.
- tags
- רשימת תגי שינוי.
- usercontribs
- קבלת כל העריכות של המשתמש.
- users
- קבלת מידע על רשימת משתמשים.
- watchlist
- קבלת שינויים אחרונים לדפים ברשימת המעקב של המשתמש הנוכחי.
- watchlistraw
- קבלת כל הדפים ברשימת המעקב של המשתמש הנוכחי.
- wblistentityusage
- החזרת כל הדפים שמשתמשים במזהי הישות הנתונים.
- wikisets
- למנות את כל ערכות הוויקי.
- deletedrevs
- מיושן. רשימת גרסאות מחוקות.
- readinglistentries
- פנימי. קבלת רשימת הדפים מרשימה מסוימת.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): abusefilters, abuselog, allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, betafeatures, blocks, categorymembers, centralnoticeactivecampaigns, centralnoticelogs, checkuser, checkuserlog, embeddedin, exturlusage, filearchive, gadgetcategories, gadgets, geosearch, globalallusers, globalblocks, globalgroups, imageusage, iwbacklinks, langbacklinks, linterrors, logevents, mostviewed, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw, wblistentityusage, wikisets, deletedrevs, readinglistentries
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- meta
אילו מטא־נתונים לקבל.
- allmessages
- החזרת הודעות מהאתר הזה.
- authmanagerinfo
- אחזור מידע אודות מצב האימות הנוכחי.
- babel
- קבלת מידע על השפות שהמשתמש יודע
- featureusage
- קבלה של סיכום של שימוש באפשרויות API רשומות עבור סוכן לקוח.
- filerepoinfo
- החזרת מידע מטא על מאגרי תמונות שמוגדרים בוויקי.
- globalpreferences
- שליפת ההעדפות הגלובליות של המשתמש הנוכחי.
- globalrenamestatus
- הצגת מידע אודות שינויי שמות משתמשים גלובליים שנמצאים בתהליך.
- globaluserinfo
- מציג מידע על משתמש גלובלי
- languageinfo
- מחזירה מידע על שפות זמינות.
- linterstats
- קבלת מספר שגיאות הניקיון בכל קטגוריה
- notifications
- קבלת התראות שממתינות למשתמש הנוכחי.
- siteinfo
- החזרת מידע כללי על האתר.
- siteviews
- הצגת נתוני צפייה עבור כל האתר (מספר הצפיות הכולל בכל אחד מ־pvisdays הימים האחרונים).
- tokens
- קבלת אסימונים לפעולות שמשנות נתונים.
- unreadnotificationpages
- קבלת דפים שעבורם יש הודעות שלא נקראו למשתמש הנוכחי.
- userinfo
- קבלת מידע על המשתמש הנוכחי.
- wikibase
- קבלת מידע על לקוח ויקיבייס ועל מאגר הוויקיבייס המשויך.
- oath
- פנימי. בדיקה האם אימות דו־שלבי (OATH) מופעל עבור משתמש.
- readinglists
- פנימי. רשימה או סינון של רשימות הקריאה של משתמש והצגת מטא־נתונים עליהן.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): allmessages, authmanagerinfo, babel, featureusage, filerepoinfo, globalpreferences, globalrenamestatus, globaluserinfo, languageinfo, linterstats, notifications, siteinfo, siteviews, tokens, unreadnotificationpages, userinfo, wikibase, oath, readinglists
- indexpageids
לכלול פסקת pageids נוספת עם רשימת כל מזהי הדף שהוחזרו.
- סוג: בוליאני (פרטים)
- export
יצוא הגרסאות הנוכחיות של כל הדפים הנתונים המחוללים.
- סוג: בוליאני (פרטים)
- exportnowrap
להחזיר את ה־XML של היצוא בלי לעטוף אותו בתוצאת XML (אותו תסדיר כמו Special:Export). אפשר להשתמש בזה רק עם query+export.
- סוג: בוליאני (פרטים)
- exportschema
להשתמש בגרסה הנתונה של תסדיר היטל XML בעת היצוא. יכול לשמש רק עם query+export.
- אחד מהערכים הבאים: 0.10, 0.11
- ברירת המחדל: 0.11
- iwurl
האם לקבל את ה־URL המלא אם הכותרת היא קישור בינוויקי.
- סוג: בוליאני (פרטים)
- continue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך. אפשר למצוא מידע מפורט יותר על איך להמשיך שאילתות באתר mediawiki.org.
- rawcontinue
להחזיר נתוני query-continue גולמיים להמשך.
- סוג: בוליאני (פרטים)
- titles
רשימת כותרות.
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- pageids
רשימת מזהי דף לעבוד עליהם.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- revids
רשימת מזהי גרסה לעבוד עליהם. נא לשים לב לכך שכמעט כל מודולי ה־query ימירו מזהי גרסאות למזהה הדף המתאים ויעבדו במקום זאת על הגרסה האחרונה. רק prop=revisions משתמש בגרסאות מדויקות לתגובה.
- סוג: רשימת מספרים שלמים
- הפרדה בין ערכים נעשית באמצעות | או תו חלופי.
- המספר המרבי של ערכים הוא 50 (או 500 עבור לקוחות שמותרות להם מגבלות גבוהות יותר).
- generator
קבלת רשימת דפים לעבוד עליהם על־ידי הרצת יחידת ה־query שצוינה.
לתשומת ליבך: לשמות בפרמטר generator צריכה להיות התחילית "g", ר' דוגמאות.
- allcategories
- למנות את כל הקטגוריות.
- alldeletedrevisions
- רשימת כל הגרסאות המחוקות על־ידי משתמש או במרחב.
- allfileusages
- לרשום את כל שימושי הקובץ, כולל בלתי־קיימים.
- allimages
- למנות את כל התמונות לפי הסדר.
- alllinks
- למנות את כל הקישורים שמצביעים למרחב שם נתון.
- allpages
- למנות את כל הדפים לפי הסדר במרחב שם נתון.
- allredirects
- רשימה של כל ההפניות למרחב שם.
- allrevisions
- רשימת כל הגרסאות.
- alltransclusions
- רשימת כל ההכללות (דפים שמוטבעים באמצעות {{x}}), כולל כאלה שאינם קיימים.
- backlinks
- מציאת כל הדפים שמקשרים לדף הנתון.
- categories
- לרשום את כל הקטגוריות שהדף שייך אליהן.
- categorymembers
- רשימת כל הדפים בקטגוריה נתונה.
- deletedrevisions
- קבלת מידע על גרסה מחוקה.
- duplicatefiles
- רשימת כל הקבצים שהם כפולים של קבצים נתונים לפי ערכי הגיבוב.
- embeddedin
- חיפוש כל הדפים שמטביעים (מכלילים) את הכותרת הנתונה.
- exturlusage
- למנות דפים שמכילים URL נתון.
- fileusage
- מציאת כל הדפים שמשתמשים בקבצים הנתונים.
- geosearch
- החזרת דפים שיש להם נקודות ציון שנמצאות באזור מסוים.
- images
- להחזיר את כל הקבצים שמכילים הדפים הנתונים.
- imageusage
- מציאת כל הדפים שמתמשים בשם התמונה הנתונה.
- iwbacklinks
- מציאות כל הדפים שמקשרים לקישור הבינוויקי הנתון.
- langbacklinks
- מציאת כל הדפים שמקשרים לקישור השפה הנתון.
- links
- החזרת כל הקישורים מהדפים שצוינו.
- linkshere
- מציאת כל הדפים שמקשרים לדפים הנתונים.
- mostviewed
- רשימת הדפים הנצפים ביותר (על סמך ספירת הצפיות בדפים ביום האחרון).
- pageswithprop
- לרשום את כל הדפים שמשתמשים במאפיין דף נתון.
- prefixsearch
- ביצוע חיפוש תחילית של כותרות דפים.
- protectedtitles
- לרשום את כל הכותרות שמוגנות מפני יצירה.
- querypage
- קבלת רשימה שמסופקת על־ידי דף מיוחד מבוסס־QueryPage.
- random
- קבלת ערכת דפים אקראיים.
- recentchanges
- למנות שינויים אחרונים.
- redirects
- מחזיר את כל ההפניות לדפים הנתונים.
- revisions
- קבלת מידע על גרסה.
- search
- ביצוע חיפוש בכל הטקסט.
- templates
- החזרת כל הדפים המוכללים בדפים הנתונים.
- transcludedin
- מציאת כל הדפים שמכלילים את הדפים הנתונים.
- watchlist
- קבלת שינויים אחרונים לדפים ברשימת המעקב של המשתמש הנוכחי.
- watchlistraw
- קבלת כל הדפים ברשימת המעקב של המשתמש הנוכחי.
- wblistentityusage
- החזרת כל הדפים שמשתמשים במזהי הישות הנתונים.
- readinglistentries
- פנימי. קבלת רשימת הדפים מרשימה מסוימת.
- אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, geosearch, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, mostviewed, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw, wblistentityusage, readinglistentries
- redirects
פתרון אוטומטי של הפניות ב־query+titles, ב־query+pageids, וב־query+revids, ובדפים שמחזיר query+generator.
- סוג: בוליאני (פרטים)
- converttitles
המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן ban, en, crh, gan, iu, ku, mni, sh, shi, sr, tg, tly, uz, wuu, zgh וגם zh.
- סוג: בוליאני (פרטים)
דוגמאות:
- אחזור site info (מידע על האתר) ו־revisions של עמוד ראשי.
- api.php?action=query&prop=revisions&meta=siteinfo&titles=%D7%A2%D7%9E%D7%95%D7%93%20%D7%A8%D7%90%D7%A9%D7%99&rvprop=user|comment&continue= [פתיחה בארגז חול]
- אחזור גרסאת של דפים שמתחילים ב־API/.
- api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [פתיחה בארגז חול]