עזרה של 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
- החזרת מידע על הקטגוריות הנתונות.
- contributors
- קבלת רשימה של תורמים שנכנסו לחשבון ומניין של תורמים אלמוניים לדף.
- deletedrevisions
- קבלת מידע על גרסה מחוקה.
- duplicatefiles
- רשימת כל הקבצים שהם כפולים של קבצים נתונים לפי ערכי הגיבוב.
- extlinks
- החזרת כל ה־URL־ים החיצוניים (לא בינוויקי) מהדפים הנתונים.
- fileusage
- מציאת כל הדפים שמשתמשים בקבצים הנתונים.
- imageinfo
- החזרת מידע על קובץ והיסטורייה העלאה.
- images
- להחזיר את כל הקבצים שמכילים הדפים הנתונים.
- info
- קבלת מידע בסיסי על הדף.
- iwlinks
- החזרת כל קישורי הבינוויקי מהדפים הנתונים.
- langlinks
- החזרת כל הקישורים הבין־לשוניים מהדפים הנתונים.
- links
- החזרת כל הקישורים מהדפים שצוינו.
- linkshere
- מציאת כל הדפים שמקשרים לדפים הנתונים.
- pageprops
- קבלת מאפייני דף שונים שמוגדרים בתוכן הדף.
- redirects
- מחזיר את כל ההפניות לדפים הנתונים.
- revisions
- קבלת מידע על גרסה.
- stashimageinfo
- החזרת מידע על הקובץ עבור הקבצים המוסלקים.
- templates
- החזרת כל הדפים המוכללים בדפים הנתונים.
- transcludedin
- מציאת כל הדפים שמכלילים את הדפים הנתונים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 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
- רשימה של כל ההפניות למרחב שם.
- allrevisions
- רשימת כל הגרסאות.
- alltransclusions
- רשימת כל ההכללות (דפים שמוטבעים באמצעות {{x}}), כולל כאלה שאינם קיימים.
- allusers
- למנות את כל המשתמשים הרשומים.
- backlinks
- מציאת כל הדפים שמקשרים לדף הנתון.
- blocks
- לרשום את כל המשתמשים וכתובות ה־IP שנחסמו.
- categorymembers
- רשימת כל הדפים בקטגוריה נתונה.
- embeddedin
- חיפוש כל הדפים שמטמיעים (מכלילים) את הכותרת הנתונה.
- exturlusage
- למנות דפים שמכילים URL נתון.
- filearchive
- למנות את כל הקבצים המחוקים לפי הסדר.
- imageusage
- מציאת כל הדפים שמתמשים בשם התמונה הנתונה.
- iwbacklinks
- מציאות כל הדפים שמקשרים לקישור הבינוויקי הנתון.
- langbacklinks
- מציאת כל הדפים שמקשרים לקישור השפה הנתון.
- logevents
- קבלת אירועים מהרישומים.
- mystashedfiles
- קבלת רשימת קבצים בסליק ההעלאה של המשתמש הנוכחי.
- pagepropnames
- רשימת כל שמות המאפיינים שמשמשים בוויקי.
- pageswithprop
- לרשום את כל הדפים שמשתמשים במאפיין דף נתון.
- prefixsearch
- ביצוע חיפוש תחילית של כותרות דפים.
- protectedtitles
- לרשום את כל הכותרות שמוגנות מפני יצירה.
- querypage
- קבלת רשימה שמסופקת על־ידי דף מיוחד מבוסס־QueryPage.
- random
- קבלת ערכת דפים אקראיים.
- recentchanges
- למנות שינויים אחרונים.
- search
- ביצוע חיפוש בכל הטקסט.
- tags
- רשימת תגי שינוי.
- usercontribs
- קבלת כל העריכות של המשתמש.
- users
- קבלת מידע על רשימת משתמשים.
- watchlist
- קבלת שינויים אחרונים לדפים ברשימת המעקב של המשתמש הנוכחי.
- watchlistraw
- קבלת כל הדפים ברשימת המעקב של המשתמש הנוכחי.
- deletedrevs
- מיושן. רשימת גרסאות מחוקות.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, allusers, backlinks, blocks, categorymembers, embeddedin, exturlusage, filearchive, imageusage, iwbacklinks, langbacklinks, logevents, mystashedfiles, pagepropnames, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users, watchlist, watchlistraw, deletedrevs
- meta
אילו מטא־נתונים לקבל.
- allmessages
- החזרת הודעות מהאתר הזה.
- authmanagerinfo
- אחזור מידע אודות מצב האימות הנוכחי.
- filerepoinfo
- החזרת מידע מטא על מאגרי תמונות שמוגדרים בוויקי.
- languageinfo
- מחזירה מידע על שפות זמינות.
- siteinfo
- החזרת מידע כללי על האתר.
- tokens
- קבלת אסימונים לפעולות שמשנות נתונים.
- userinfo
- קבלת מידע על המשתמש הנוכחי.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): allmessages, authmanagerinfo, filerepoinfo, languageinfo, siteinfo, tokens, userinfo
- indexpageids
לכלול פסקת pageids נוספת עם רשימת כל מזהי הדף שהוחזרו.
- סוג: בוליאני (פרטים)
- export
יצוא הגרסאות הנוכחיות של כל הדפים הנתונים המחוללים.
- סוג: בוליאני (פרטים)
- exportnowrap
להחזיר את ה־XML של היצוא בלי לעטוף אותו בתוצאת XML (אותו תסדיר כמו Special:Export). אפשר להשתמש בזה רק עם query+export.
- סוג: בוליאני (פרטים)
- exportschema
להשתמש בגרסה הנתונה של תסדיר היטל XML בעת היצוא. יכול לשמש רק עם query+export.
- אחד מהערכים הבאים: 0.10, 0.11
- ברירת המחדל: 0.11
- 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
- רשימה של כל ההפניות למרחב שם.
- allrevisions
- רשימת כל הגרסאות.
- alltransclusions
- רשימת כל ההכללות (דפים שמוטבעים באמצעות {{x}}), כולל כאלה שאינם קיימים.
- backlinks
- מציאת כל הדפים שמקשרים לדף הנתון.
- categories
- לרשום את כל הקטגוריות שהדף שייך אליהן.
- categorymembers
- רשימת כל הדפים בקטגוריה נתונה.
- deletedrevisions
- קבלת מידע על גרסה מחוקה.
- duplicatefiles
- רשימת כל הקבצים שהם כפולים של קבצים נתונים לפי ערכי הגיבוב.
- embeddedin
- חיפוש כל הדפים שמטמיעים (מכלילים) את הכותרת הנתונה.
- exturlusage
- למנות דפים שמכילים URL נתון.
- fileusage
- מציאת כל הדפים שמשתמשים בקבצים הנתונים.
- images
- להחזיר את כל הקבצים שמכילים הדפים הנתונים.
- imageusage
- מציאת כל הדפים שמתמשים בשם התמונה הנתונה.
- iwbacklinks
- מציאות כל הדפים שמקשרים לקישור הבינוויקי הנתון.
- langbacklinks
- מציאת כל הדפים שמקשרים לקישור השפה הנתון.
- links
- החזרת כל הקישורים מהדפים שצוינו.
- linkshere
- מציאת כל הדפים שמקשרים לדפים הנתונים.
- pageswithprop
- לרשום את כל הדפים שמשתמשים במאפיין דף נתון.
- prefixsearch
- ביצוע חיפוש תחילית של כותרות דפים.
- protectedtitles
- לרשום את כל הכותרות שמוגנות מפני יצירה.
- querypage
- קבלת רשימה שמסופקת על־ידי דף מיוחד מבוסס־QueryPage.
- random
- קבלת ערכת דפים אקראיים.
- recentchanges
- למנות שינויים אחרונים.
- redirects
- מחזיר את כל ההפניות לדפים הנתונים.
- revisions
- קבלת מידע על גרסה.
- search
- ביצוע חיפוש בכל הטקסט.
- templates
- החזרת כל הדפים המוכללים בדפים הנתונים.
- transcludedin
- מציאת כל הדפים שמכלילים את הדפים הנתונים.
- watchlist
- קבלת שינויים אחרונים לדפים ברשימת המעקב של המשתמש הנוכחי.
- watchlistraw
- קבלת כל הדפים ברשימת המעקב של המשתמש הנוכחי.
- אחד מהערכים הבאים: allcategories, alldeletedrevisions, allfileusages, allimages, alllinks, allpages, allredirects, allrevisions, alltransclusions, backlinks, categories, categorymembers, deletedrevisions, duplicatefiles, embeddedin, exturlusage, fileusage, images, imageusage, iwbacklinks, langbacklinks, links, linkshere, pageswithprop, prefixsearch, protectedtitles, querypage, random, recentchanges, redirects, revisions, search, templates, transcludedin, watchlist, watchlistraw
- redirects
פתרון אוטומטי של הפניות ב־query+titles, ב־query+pageids, וב־query+revids, ובדפים שמחזיר query+generator.
- סוג: בוליאני (פרטים)
- converttitles
המרת כותרות לסוגי כתב אחרים אם זה נחוץ. זה עובד רק אם שפת הכותרת של הוויקי תומכת בהמרת סוגי כתב. השפות שתומכות בהמרת סוגי כתב הן en, crh, gan, iu, kk, ku, shi, sr, tg, uz וגם zh.
- סוג: בוליאני (פרטים)
דוגמאות:
- אחזור site info ו־revisions של Main Page.
- api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment&continue= [פתיחה בארגז חול]
- אחזור גרסאת של דפים שמתחילים ב־API/.
- api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions&continue= [פתיחה בארגז חול]