Довідка API Медіавікі

Це автоматично генерована сторінка документації API Медіавікі.

Документація та приклади: https://www.mediawiki.org/wiki/API

Головний модуль

Джерело: MediaWiki
Ліцензія: GPL-2.0+

Статус: Усі функції, вказані на цій сторінці, мають працювати, але API далі перебуває в активній розробці і може змінитися у будь-який момент. Підпишіться на список розсилки mediawiki-api-announce, щоб помічати оновлення.

Хибні запити: Коли до API надсилаються хибні запити, буде відіслано HTTP-шапку з ключем «MediaWiki-API-Error», а тоді і значення шапки, і код помилки, надіслані назад, будуть встановлені з тим же значенням. Більше інформації див. на API: Errors and warnings.

Параметри:

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: Максимальна затримка може використовуватися, коли MediaWiki інстальовано на реплікований кластер бази даних. Щоб зберегти дії, які спричиняють більшу затримку реплікації, цей параметр може змусити клієнт почекати, поки затримка реплікації не буде меншою за вказане значення. У випадку непомірної затримки, видається код помилки maxlag з повідомленням на зразок Очікування на $host: $lag секунд(и) затримки.
Див. Manual: Maxlag parameter для детальнішої інформації.; Тип: ціле число
smaxage: Встановити s-maxage HTTP кеш-контроль заголовок на стільки секунд. Помилки ніколи не кешуються.; Тип: ціле число; За замовчуванням: 0
maxage: Встановити max-age HTTP кеш-контроль заголовок на стільки секунд. Помилки ніколи не кешуються.; Тип: ціле число; За замовчуванням: 0
assert: Перевірити, що користувач увійшов у систему, якщо задано user, або має права бота, якщо задано bot.; Одне значення: user, bot
requestid: Будь-яке значення, вказане тут, буде включене у відповідь. Може використовуватися, щоб відрізняти запити.
servedby: Включити в результати ім'я хоста, який обробив запит.; Тип: логічний (деталі)
curtimestamp: Включити в результат поточну мітку часу.; Тип: логічний (деталі)
origin: При доступі до API з використанням крос-доменного AJAX-запиту (CORS), задайте параметру значення вихідного домена. Він має бути включений у будь-який попередній запит і таким чином мусить бути частиною запиту URI (не тіла POST). Він повинен точно співпадати з одним з виходів у заголовку Origin, тобто бути заданим чимось на зразок https://uk.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 для запису; Надано: bot
apihighlimits: Використовувати вищі ліміти у запитах API (повільні запити: 500; швидкі запити: 5000). Ліміти для повільних запитів також застосовуються до багатозначних параметрів.; Надані: bot, sysop

action=block

(main • block)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Заблокувати користувача.

https://www.mediawiki.org/wiki/API:Block

Параметри:

user: Ім'я користувача, IP-адреса або діапазон IP-адрес для блокування.; Цей параметр є обов'язковим.
expiry: Закінчення часу. Може бути відносним (напр., 5 місяців або 2 тижні) чи абсолютним (напр., 2014-09-18T12:34:56Z). Якщо вказано infinite, indefinite або never, блокування не закінчиться ніколи.; За замовчуванням: never
reason: Причина блокування.; За замовчуванням: (пусто)
anononly: Блокувати тільки анонімних користувачів (тобто відключити можливість анонімних редагувань з цієї IP-адреси).; Тип: логічний (деталі)
nocreate: Заборонити створення облікових записів.; Тип: логічний (деталі)
autoblock: Автоматично блокувати 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

(main • 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

(main • clearhasmsg)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Очищає прапорець hasmsg для поточного користувача.

https://www.mediawiki.org/wiki/API:ClearHasMsg

Приклад:

Очистити прапорець hasmsg для поточного користувача.: api.php?action=clearhasmsg

action=compare

(main • compare)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати порівняння двох сторінок.

Повинні бути номер версії, назва сторінки або ID сторінки для «від» і «до».

Параметри:

fromtitle: Перший заголовок для порівняння.
fromid: Перший ID сторінки для порівняння.; Тип: ціле число
fromrev: Перша версія для порівняння.; Тип: ціле число
totitle: Другий заголовок для порівняння.
toid: Другий ID сторінки для порівняння.; Тип: ціле число
torev: Друга версія для порівняння.; Тип: ціле число

Приклад:

Створити порівняння версій 1 і 2.: api.php?action=compare&fromrev=1&torev=2

action=createaccount

(main • createaccount)

Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Створити новий обліковий запис користувача.

https://www.mediawiki.org/wiki/API:Account_creation

Параметри:

name: Ім'я користувача.; Цей параметр є обов'язковим.; Тип: ім'я користувача
password: Пароль (ігнорується, якщо встановлено mailpassword).
domain: Домен для зовнішньої аутентифікації (опціонально).
token: Токен створення облікового запису отримано у першому запиті.
email: Адреса електронної пошти користувача (необов'язково).
realname: Справжнє ім'я користувача (необов'язково).
mailpassword: Якщо встановлено будь-яке значення, користувачеві буде надіслано випадковий пароль.; Тип: логічний (деталі)
reason: Необов'язкова причина для створення облікового запису, яка буде записана в журнал.
language: Код мови для встановлення за замовчуванням для користувача (необов'язково, за замовчуванням — мова вмісту).
captchaword: Answer to the CAPTCHA
captchaid: CAPTCHA ID from previous request

Приклади:

Створити користувача testuser з паролем test123.: api.php?action=createaccount&name=testuser&password=test123
Створити користувача testmailuser і надіслати на електронну пошту випадково-згенерований пароль.: api.php?action=createaccount&name=testmailuser&mailpassword=true&reason=MyReason

action=delete

(main • delete)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вилучити сторінку.

https://www.mediawiki.org/wiki/API:Delete

Параметри:

title: Назва сторінки для вилучення. Не можна використати разом з pageid.
pageid: ID-сторінки на вилучення. Не можна використати разом з title.; Тип: ціле число
reason: Причина вилучення. Якщо не вказана, буде використано автоматично-згенеровану.
watch: Застарілий.; Додати сторінку у список спостереження поточного користувача.; Тип: логічний (деталі)
watchlist: Беззастережно додати або вилучити сторінку зі списку спостереження поточного користувача, використати налаштування або не змінювати спостереження.; Одне значення: watch, unwatch, preferences, nochange; За замовчуванням: preferences
unwatch: Застарілий.; Вилучити сторінку зі списку спостереження поточного користувача.; Тип: логічний (деталі)
oldimage: Назва старого зображення на вилучення, як вказано у action=query&prop=imageinfo&iiprop=archivename.
token: Токен «csrf» отримано з action=query&meta=tokens; Цей параметр є обов'язковим.

Приклади:

Вилучити Main Page.: api.php?action=delete&title=Main%20Page&token=123ABC
Вилучити Main Page з причиною Preparing for move.: api.php?action=delete&title=Main%20Page&token=123ABC&reason=Preparing%20for%20move

action=edit

(main • edit)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Створювати і редагувати сторінки.

https://www.mediawiki.org/wiki/API:Edit

Параметри:

title

Назва сторінки для редагування. Не можна використати разом з pageid.

pageid

ID-сторінки для редагування. Не можна використати разом з 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.

Цей параметр є обов'язковим.

captchaword

Answer to the CAPTCHA

captchaid

CAPTCHA ID from previous request

Приклади:

Редагувати сторінку: api.php?action=edit&title=Test&summary=test%20summary&text=article%20content&basetimestamp=2007-08-24T12:34:54Z&token=123ABC
Додати зміст на початок сторінки: api.php?action=edit&title=Test&summary=NOTOC&minor=&prependtext=__NOTOC__%0A&basetimestamp=2007-08-24T12:34:54Z&token=123ABC
Скасувати версії з 13579 по 13585 з автоматичним описом змін: api.php?action=edit&title=Test&undo=13585&undoafter=13579&basetimestamp=2007-08-24T12:34:54Z&token=123ABC

action=emailuser

(main • emailuser)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Надіслати електронного листа користувачеві

https://www.mediawiki.org/wiki/API:Email

Параметри:

target: Користувач, якому відправляється електронний лист.; Цей параметр є обов'язковим.
subject: Заголовок теми.
text: Тіло листа.; Цей параметр є обов'язковим.
ccme: Надіслати копію цього повідомлення мені.; Тип: логічний (деталі)
token: Токен «csrf» отримано з action=query&meta=tokens; Цей параметр є обов'язковим.

Приклад:

Відправити листа користувачу WikiSysop з текстом Вміст.: api.php?action=emailuser&target=WikiSysop&text=Content&token=123ABC

action=expandtemplates

(main • expandtemplates)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Розгортає усі шаблони у вікітекст.

https://www.mediawiki.org/wiki/API:Parsing_wikitext#expandtemplates

Параметри:

title

Заголовок сторінки.

За замовчуванням: API

text

Вікітекст для перетворення.

Цей параметр є обов'язковим.

revid

ID версії, для {{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

(main • 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, 2300, 2301, 2302, 2303
year: Від року (і раніше).; Тип: ціле число
month: До місяця (і раніше).; Тип: ціле число
tagfilter: Відфільтрувати внесок, у якого є ці теґи.; Значення (розділені через |):; За замовчуванням: (пусто)
deletedonly: Показати лише вилучений внесок.; Тип: логічний (деталі)
toponly: Показати лише редагування, які є останніми версіями.; Тип: логічний (деталі)
newonly: Показати лише редагування, які є створеннями сторінок.; Тип: логічний (деталі)
showsizediff: Показати різницю розміру між версіями.; Тип: логічний (деталі)

Приклад:

Вивести внесок для користувача Example.: api.php?action=feedcontributions&user=Example

action=feedrecentchanges

(main • 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, 2300, 2301, 2302, 2303
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

(main • feedwatchlist)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає стрічку списку спостереження.

https://www.mediawiki.org/wiki/API:Watchlist_feed

Параметри:

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

Не перераховувати зміни, зроблені цим користувачем.

Тип: ім'я користувача

Приклади:

Показати стрічку списку спостереження.: api.php?action=feedwatchlist
Показати всі зміни до спостережуваних сторінок за останні 6 годин.: api.php?action=feedwatchlist&allrev=&hours=6

action=filerevert

(main • 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

(main • 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

(main • imagerotate)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Поворот одного або декількох зображень.

Параметри:

rotation

Градуси для повороту зображення за годинниковою стрілкою.

Цей параметр є обов'язковим.

Одне значення: 90, 180, 270

continue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

titles

Список назв над якими працювати.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

pageids

Список ідентифікаторів сторінок над якими працювати.

Тип: список цілих чисел

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

revids

Список ідентифікаторів версій над якими працювати.

Тип: список цілих чисел

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

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

(main • import)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Імпортувати сторінку з іншої вікі або з XML-файлу.

Зважте, що HTTP POST має бути виконано як завантаження файлу (тобто з використанням даних різних частин/форм) під час надсилання файлу для параметра xml.

https://www.mediawiki.org/wiki/API:Import

Параметри:

summary: Імпортувати підсумок.
xml: Завантажено XML-файл.; Повинно бути надіслано у формі надсилання файлу використовуючи 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, 2300, 2301, 2302, 2303
rootpage: Імпортувати як підсторінку цієї сторінки. Не можна використати разом з namespace.
token: Токен «csrf» отримано з action=query&meta=tokens; Цей параметр є обов'язковим.

Приклад:

Імпортувати meta:Help:ParserFunctions у простір назв 100 з повною історією.: api.php?action=import&interwikisource=meta&interwikipage=Help:ParserFunctions&namespace=100&fullhistory=&token=123ABC

(main • login)

Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Увійти в систему й отримати куки автентифікації.

У випадку успішного входження в систему, потрібні куки буде включено в заголовки HTTP-відповіді. У разі невдалого входу, подальші спроби будуть обмежені до ліміту автоматичних спроб підбирання пароля.

https://www.mediawiki.org/wiki/API:Login

Параметри:

lgname: Ім'я користувача.
lgpassword: Пароль.
lgdomain: Домен (необов'язково).
lgtoken: Токен входу в систему, отриманий у першому запиті.

Приклади:

Отримати токен входу в систему.: api.php?action=login&lgname=user&lgpassword=password
Увійти в систему.: api.php?action=login&lgname=user&lgpassword=password&lgtoken=123ABC

action=logout

(main • logout)

Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вийти й очистити дані сесії.

https://www.mediawiki.org/wiki/API:Logout

Приклад:

Вийти з поточного облікового запису.: api.php?action=logout

action=managetags

(main • managetags)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Виконати керівні завдання щодо зміни теґів.

https://www.mediawiki.org/wiki/API:Tag_management

Параметри:

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

(main • move)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перейменувати сторінку.

https://www.mediawiki.org/wiki/API:Move

Параметри:

from: Назва сторінки для перейменування. Не можна використати разом з fromid.
fromid: ID сторінки для перейменування. Не можна використати разом з 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

(main • opensearch)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Шукати у вікі з використанням протоколу OpenSearch.

https://www.mediawiki.org/wiki/API:Opensearch

Параметри:

search

Рядок пошуку.

limit

Максимальна кількість результатів для виведення.

Дозволено не більше 100 (100 для ботів).

Тип: ціле число або max

За замовчуванням: 10

namespace

Простори назв, у яких шукати.

Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303

За замовчуванням: 0

suggest

Нічого не робити, якщо $wgEnableOpenSearchSuggest хибний.

Тип: логічний (деталі)

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

(main • options)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Змінити налаштування поточного користувача.

Можна встановити лише опції, які зареєстровані у ядрі або в одному з інстальованих розширень, або опції з префіксом ключів userjs- (призначені для використання користувацькими скриптами).

https://www.mediawiki.org/wiki/API:Options

Параметри:

reset: Встановлює налаштування сайту за замовчуванням.; Тип: логічний (деталі)
resetkinds: Список типів опцій для перевстановлення, коли вказана опція reset.; Значення (розділені через |): registered, registered-multiselect, registered-checkmatrix, userjs, special, unused, all; За замовчуванням: all
change: Список змін, відформатованих як назва=значення (напр., 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

(main • paraminfo)

Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати інформацію про модулі API.

https://www.mediawiki.org/wiki/API:Parameter_information

Параметри:

modules: Список назв модулів (значення параметрів action і format або main). Можна вказати підмодулі через +.; Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).
helpformat: Формат рядків довідки.; Одне значення: html, wikitext, raw, none; За замовчуванням: none
querymodules: Застарілий.; Список назв модулів запитів (значення параметра 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, gadgetcategories, gadgets, 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, format=jsonfm, action=query&list=allpages та action=query&meta=siteinfo.: api.php?action=paraminfo&modules=parse|phpfm|query+allpages|query+siteinfo

action=parse

(main • parse)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Аналізує вміст і видає парсер виходу.

Див. різні prop-модулі action=query, щоб отримати інформацію з поточної версії сторінки.

Є декілька способів вказати текст для аналізу:

Вказати сторінку або версію, використавши page, pageid або oldid.
Вказати безпосередньо, використавши text, title і contentmodel.
Вказати лише підсумок аналізу. prop повинен мати порожнє значення.

https://www.mediawiki.org/wiki/API:Parsing_wikitext#parse

Параметри:

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

pst

Зробіть трансформацію вхідних даних перед збереженням і аналізом. Дійсне лише при використанні з текстом.

Тип: логічний (деталі)

onlypst

Зробіть трансформацію вхідних даних перед збереженням (PST), але не аналізуйте. Видає той самий вікітекст, після застосування PST. Дійсне лише у разі використання з text.

Тип: логічний (деталі)

effectivelanglinks

Включає мовні посилання, додані розширеннями (для використання з prop=langlinks).

Тип: логічний (деталі)

section

Видає вміст лише розділу з цим номером або при new створенні нового розділу.

new розділ відзначається лише при вказанні тексту text.

sectiontitle

Заголовок нового розділу, коли section має значення new.

На відміну від редагування сторінки, це не повертається до summary, якщо пропустити чи лишити порожнім.

disablepp

Застарілий.

Use disablelimitreport instead.

Тип: логічний (деталі)

disablelimitreport

Пропустити звіт препроцесора («NewPP limit report») на виході аналізу.

Тип: логічний (деталі)

disableeditsection

Пропустити посилання на редагування розділів на виході аналізу.

Тип: логічний (деталі)

disabletidy

Do not run HTML cleanup (e.g. tidy) on the parser output.

Тип: логічний (деталі)

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

Приклади:

Аналізувати сторінку.: api.php?action=parse&page=Project:Sandbox
Аналізувати вікітекст.: api.php?action=parse&text={{Project:Sandbox}}&contentmodel=wikitext
Аналізувати вікітекст, вказуючи назву сторінки.: api.php?action=parse&text={{PAGENAME}}&title=Test
Аналізувати опис.: api.php?action=parse&summary=Some+[[link]]&prop=

action=patrol

(main • patrol)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Відпатрулювати сторінку чи версію.

https://www.mediawiki.org/wiki/API:Patrol

Параметри:

rcid: ID нещодавніх змін для патрулювання.; Тип: ціле число
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

(main • protect)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Змінити рівень захисту сторінки.

https://www.mediawiki.org/wiki/API:Protect

Параметри:

title

Заголовок сторінки для (зняття) захисту. Не може використовуватися разом із pageid.

pageid

ID сторінки для (зняття) захисту. Не може використовуватися разом з 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

Цей параметр є обов'язковим.

Приклади:

Захистити сторінку.: api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=sysop|move=sysop&cascade=&expiry=20070901163000|never
Зняти захист зі сторінки, встановивши обмеження для all.: api.php?action=protect&title=Main%20Page&token=123ABC&protections=edit=all|move=all&reason=Lifting%20restrictions
Зняти захист з сторінки, встановивши відсутність обмежень.: api.php?action=protect&title=Main%20Page&token=123ABC&protections=&reason=Lifting%20restrictions

action=purge

(main • purge)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Очистити кеш для вказаних заголовків.

Вимагає запиту POST, якщо користувач не ввійшов у систему.

https://www.mediawiki.org/wiki/API:Purge

Параметри:

forcelinkupdate

Оновити таблиці посилань.

Тип: логічний (деталі)

forcerecursivelinkupdate

Оновити таблицю посилань, і оновити таблиці посилань для кожної сторінки, що використовує цю сторінку як шаблон.

Тип: логічний (деталі)

continue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

titles

Список назв над якими працювати.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

pageids

Список ідентифікаторів сторінок над якими працювати.

Тип: список цілих чисел

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

revids

Список ідентифікаторів версій над якими працювати.

Тип: список цілих чисел

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

generator

Отримати список сторінок над якими працювати шляхом виконання вказаного модуля запиту.

Примітка: Назви параметрів генератора повинні мати префікс «g», див. приклади.

redirects

Автоматично вирішувати перенаправлення у titles, pageids, і revids, та у сторінках, повернених generator.

Тип: логічний (деталі)

converttitles

Тип: логічний (деталі)

Приклади:

Очистити кеш Main Page і сторінки API.: api.php?action=purge&titles=Main_Page|API
Очистити кеш перших десяти сторінок у головному просторі назв.: api.php?action=purge&generator=allpages&gapnamespace=0&gaplimit=10

action=query

(main • query)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вибірка даних з і про MediaWiki.

Усі зміни даних у першу чергу мають використовувати запит на отримання токена, щоб запобігти зловживанням зі шкідливих сайтів.

Параметри:

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, gadgetcategories, gadgets, 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

Отримати список сторінок над якими працювати шляхом виконання вказаного модуля запиту.

Примітка: Назви параметрів генератора повинні мати префікс «g», див. приклади.

redirects

Автоматично вирішувати перенаправлення у titles, pageids, і revids, та у сторінках, повернених generator.

Тип: логічний (деталі)

converttitles

Тип: логічний (деталі)

Приклади:

Вибірка інформації про сайт та версій 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=

prop=categories (cl)

(main • query • categories)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати категорії, до яких сторінки належать.

https://www.mediawiki.org/wiki/API:Categories

Параметри:

clprop

Які додаткові властивості отримати для кожної категорії:

sortkey: Додає ключ сортування (шістнадцятковий рядок) і префікс ключа сортування (людиночитна частина) для категорії.
timestamp: Додає мітку часу, коли категорію було додано.
hidden: Тегує приховані категорії з допомогою __HIDDENCAT__.

Значення (розділені через |): sortkey, timestamp, hidden

clshow

Який тип категорій показувати.

Значення (розділені через |): hidden, !hidden

cllimit

Скільки категорій видати.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • categoryinfo)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає інформацію про подані категорії.

https://www.mediawiki.org/wiki/API:Categoryinfo

Параметр:

cicontinue: Коли доступно більше результатів, використовуйте це, щоб продовжити.

Приклад:

Отримати інформацію про Category:Foo і Category:Bar.: api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar

prop=contributors (pc)

(main • query • contributors)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати список залогінених дописувачів і кількість анонімних дописувачів до сторінки.

https://www.mediawiki.org/wiki/API:Contributors

Параметри:

pcgroup: Включати лише користувачів з даних груп. Не включає безумовні або автоматичні групи на зразок *, користувач або автопідтверджені.; Значення (розділені через |): bot, sysop, bureaucrat
pcexcludegroup: Виключати користувачів з даних груп. Не включає безумовні або автоматичні групи на зразок *, користувач або автопідтверджені.; Значення (розділені через |): bot, sysop, bureaucrat
pcrights: Включати лише користувачів з даними правами. Не включає права, надані безумовними або автоматичними групами на зразок *, користувач або автопідтверджені.; Значення (розділені через |): 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, gadgets-edit, gadgets-definition-edit, skipcaptcha; Максимальна кількість значень — 50 (500 для ботів).
pcexcluderights: Виключати користувачів з даними правами. Не включає права, надані безумовними або автоматичними групами на зразок *, користувач або автопідтверджені.; Значення (розділені через |): 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, gadgets-edit, gadgets-definition-edit, skipcaptcha; Максимальна кількість значень — 50 (500 для ботів).
pclimit: Скільки дописувачів виводити.; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або max; За замовчуванням: 10
pccontinue: Коли доступно більше результатів, використовуйте це, щоб продовжити.

Приклад:

Показати дописувачів до сторінки Main Page.: api.php?action=query&prop=contributors&titles=Main_Page

prop=deletedrevisions (drv)

(main • query • deletedrevisions)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати інформацію про вилучену версію.

Можна використати кількома способами:

Отримати вилучені версії набору сторінок, вказавши заголовки або ідентифікатори сторінок. Сортується за назвою і часовою міткою.
Отримати дані про набір вилучених версій, вказавши їх ID з ідентифікаторами версій. Сортується за ID версії.

https://www.mediawiki.org/wiki/API:Deletedrevisions

Параметри:

drvprop

Які властивості отримати для кожної версії:

ids: ID версії.
flags: Позначки версії (незначні).
timestamp: Часова мітка версії.
user: Користувач, який створив версію.
userid: ID користувача, який створив версію.
size: Довжина версії (в байтах).
sha1: SHA-1 (base 16) версії.
contentmodel: ID моделі вмісту версії.
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 (5000 для ботів).

Тип: ціле число або max

drvexpandtemplates

Розгорнути шаблони у вмісті версії (передбачає drvprop=content).

Тип: логічний (деталі)

drvgeneratexml

Застарілий.

Генерувати синтаксичне дерево XML для вмісту версії (передбачає drvprop=content; замінено на drvprop=parsetree).

Тип: логічний (деталі)

drvparse

Аналізувати вміст версії (передбачає drvprop=content). З причин продуктивності, якщо використовується ця опція, drvlimit встановлюється як 1.

Тип: логічний (деталі)

drvsection

Витягнути вміст лише розділу з цим номером.

drvdiffto

ID версії, з якою порівняти кожну версію. Використайте 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)

(main • query • duplicatefiles)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати усі файли, які є дублікатами поданих файлів з огляду на значення хешу.

https://www.mediawiki.org/wiki/API:Duplicatefiles

Параметри:

dflimit: Скільки файлів-дублікатів виводити.; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або max; За замовчуванням: 10
dfcontinue: Коли доступно більше результатів, використовуйте це, щоб продовжити.
dfdir: Напрямок, у якому перелічити.; Одне значення: ascending, descending; За замовчуванням: ascending
dflocalonly: Шукати лише файли у локальному репозиторії.; Тип: логічний (деталі)

Приклади:

Шукати дублікати File:Albert Einstein Head.jpg.: api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles
Шукати дублікати усіх файлів.: api.php?action=query&generator=allimages&prop=duplicatefiles

prop=extlinks (el)

(main • query • extlinks)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видати усі зовнішні URL (не інтервікі) з поданих сторінок.

https://www.mediawiki.org/wiki/API:Extlinks

Параметри:

ellimit: Скільки посилань виводити.; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або 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: Шукати рядок без протоколу. Корисно для перевірки, чи містить певна сторінка певне зовнішнє посилання.
elexpandurl: Розгорнути протокол-залежні URL за канонічним протоколом.; Тип: логічний (деталі)

Приклад:

Отримати список зовнішніх посилань на Main Page.: api.php?action=query&prop=extlinks&titles=Main%20Page

prop=fileusage (fu)

(main • query • fileusage)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Знайти всі сторінки, що використовують дані файли.

https://www.mediawiki.org/wiki/API:Fileusage

Параметри:

fuprop

Які властивості отримати:

pageid: ID кожної сторінки.
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, 2300, 2301, 2302, 2303

fushow

Показати лише елементи, що відповідають цим критеріям:

redirect: Показати лише перенаправлення.
!redirect: Показати лише не перенаправлення.

Значення (розділені через |): redirect, !redirect

fulimit

Скільки результатів виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • imageinfo)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає інформацію про файл й історію завантаження.

https://www.mediawiki.org/wiki/API:Imageinfo

Параметри:

iiprop

Яку інформацію отримати:

timestamp: Додає мітку часу для завантаженої версії.
user: Додає користувача, який завантажив кожну версію файлу.
userid: Додати ідентифікатор користувача, який завантажив кожну версію файлу.
comment: Коментар до версії.
parsedcomment: Аналізований коментар версії.
canonicaltitle: Додає канонічну назву файлу.
url: Дає посилання на файл і сторінку опису.
size: Додає розмір файлу в байтах, а також висоту, ширину і кількість сторінок (якщо це можливо).
dimensions: Псевдонім для розміру.
sha1: Додає SHA-1 хеш файлу.
mime: Додає MIME-тип файлу.
thumbmime: Додає MIME-мініатюри зображення (передбачає url і параметр iiurlwidth).
mediatype: Додає медіатип файлу.
metadata: Перелічує Exif-метадані версії файлу.
commonmetadata: Перелічує метадані формату версії файлу.
extmetadata: Перелічує форматовані метадані, поєднані з кількох джерел. Результати у форматі HTML.
archivename: Додає назву файлу архівної версії для неостанніх версій.
bitdepth: Додає бітну глибину версії.
uploadwarning: Використовується на Special:Upload page для отримання інформації про наявний файл. Не призначено для використання поза ядром MediaWiki.

Значення (розділені через |): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning

За замовчуванням: timestamp|user

iilimit

Скільки виводити версій кожного файлу.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 1

iistart

Часова мітка, з якої почати список.

Тип: часова мітка (дозволені формати)

iiend

Часова мітка, на якій закінчити список.

Тип: часова мітка (дозволені формати)

iiurlwidth

Якщо вказано iiprop=url, буде видано URL на масштабоване до цього розміру зображення. Для підвищення продуктивності, якщо використовується ця опція, не буде видано більше, ніж 50 масштабованих зображень.

Тип: ціле число

За замовчуванням: -1

iiurlheight

Аналогічно до iiurlwidth.

Тип: ціле число

За замовчуванням: -1

iimetadataversion

Версія метаданих, яку використати. Якщо вказано latest, використати останню версію. За замовчуванням — 1 для зворотної сумісності.

За замовчуванням: 1

iiextmetadatalanguage

Якою мовою вибирати метадані. Це стосується і того, який переклад вибирати, якщо є різні, і як форматувати різні числа та значення.

За замовчуванням: uk

iiextmetadatamultilang

Якщо переклади властивості extmetadata доступні, вибрати їх усі.

Тип: логічний (деталі)

iiextmetadatafilter

Якщо вказано і не порожньо, буде видано лише ці ключі для iiprop=extmetadata.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

iiurlparam

Рядок окремого параметра. Наприклад, PDF-ки можуть використовувати page15-100px. iiurlwidth повинно використовуватись і бути сумісним з iiurlparam.

За замовчуванням: (пусто)

iicontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

iilocalonly

Шукати лише файли у локальному репозиторії.

Тип: логічний (деталі)

Приклади:

Вибрати інформацію про поточну версію File:Albert Einstein Head.jpg.: api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo
Вибрати інформацію про версії File:Test.jpg від 2008 і раніше.: api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=2007-12-31T23:59:59Z&iiprop=timestamp|user|url

prop=images (im)

(main • query • images)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає усі файли, які містяться на вказаних сторінках.

https://www.mediawiki.org/wiki/API:Images

Параметри:

imlimit: Скільки файлів виводити.; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або 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)

(main • query • info)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати основні відомості про сторінку.

https://www.mediawiki.org/wiki/API:Info

Параметри:

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

prop=iwlinks (iw)

(main • query • iwlinks)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає усі інтервікі-посилання із вказаних сторінок.

https://www.mediawiki.org/wiki/API:Iwlinks

Параметри:

iwprop

Які додаткові властивості отримати для кожного міжмовного посилання:

url: Додає повну URL-адресу.

Значення (розділені через |): url

iwprefix

Видавати інтервікі-посилання лише з цим префіксом.

iwtitle

Інтервікі-посилання для пошуку. Повинно використовуватися з iwprefix.

iwdir

Напрямок, у якому перелічити.

Одне значення: ascending, descending

За замовчуванням: ascending

iwlimit

Скільки інтервікі-посилання виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

iwcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

iwurl

Застарілий.

Чи отримувати повну URL-адресу (не може використовуватися з iwprop).

Тип: логічний (деталі)

Приклад:

Отримати інтервікі-посилання зі сторінки Main Page.: api.php?action=query&prop=iwlinks&titles=Main%20Page

prop=langlinks (ll)

(main • query • langlinks)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає усі міжмовні посилання із вказаних сторінок.

https://www.mediawiki.org/wiki/API:Langlinks

Параметри:

llprop

Які додаткові властивості для отримання кожного із міжмовного посилання:

url: Додає повну URL-адресу.
langname: Додає локалізовану назву мови (найкращий варіант). Використайте llinlanguagecode для контролю мови.
autonym: Додає самоназву мови.

Значення (розділені через |): url, langname, autonym

lllang

Видавати лише мовні посилання з кодом мови.

lltitle

Посилання для пошуку. Повинно використовуватися з lllang.

lldir

Напрямок, у якому перелічити.

Одне значення: ascending, descending

За замовчуванням: ascending

llinlanguagecode

Код мови для локалізованих назв мов.

За замовчуванням: uk

lllimit

Скільки мовних посилань виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

llcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

llurl

Застарілий.

Чи отримувати повну URL-адресу (не може використовуватися з llprop).

Тип: логічний (деталі)

Приклад:

Отримати міжмовні посилання зі сторінки Main Page.: api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=

prop=links (pl)

(main • query • links)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає усі посилання із вказаних сторінок.

https://www.mediawiki.org/wiki/API:Links

Параметри:

plnamespace: Показати посилання лише у цих просторах назв.; Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303
pllimit: Скільки посилань виводити.; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або 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)

(main • query • linkshere)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Знайти усі сторінки, що посилаються на подані сторінки.

https://www.mediawiki.org/wiki/API:Linkshere

Параметри:

lhprop

Які властивості отримати:

pageid: ID кожної сторінки.
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, 2300, 2301, 2302, 2303

lhshow

Показати лише елементи, що відповідають цим критеріям:

redirect: Показати лише перенаправлення.
!redirect: Показати лише не перенаправлення.

Значення (розділені через |): redirect, !redirect

lhlimit

Скільки результатів виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • pageprops)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Дає різні властивості, визначені у вмісті сторінки.

https://www.mediawiki.org/wiki/API:Pageprops

Параметри:

ppcontinue: Коли доступно більше результатів, використовуйте це, щоб продовжити.
ppprop: Перерахувати лише ці властивості. Корисно для перевірки, чи певна сторінка використовує певну властивість сторінки.; Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

Приклад:

Отримати властивості для сторінок Main Page і MediaWiki.: api.php?action=query&prop=pageprops&titles=Main%20Page|MediaWiki

prop=redirects (rd)

(main • query • redirects)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає усі перенаправлення на дані сторінки.

https://www.mediawiki.org/wiki/API:Redirects

Параметри:

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, 2300, 2301, 2302, 2303

rdshow

Показати лише елементи, які відповідають цим критеріям:

fragment: Показати лише перенаправлення з фрагментом.
!fragment: Показати лише перенаправлення без фрагмента.

Значення (розділені через |): fragment, !fragment

rdlimit

Скільки перенаправлень виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • revisions)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати інформацію про версію.

Може бути використано кількома способами:

Отримати дані про набір сторінок (останні версії), вказавши назви або ідентифікатори сторінок.
Отримати версії для однієї вказаної сторінки, використавши назви або ідентифікатори і початок, кінець чи ліміт.
Отримати дані про набір версій, встановивши їх ID й ідентифікатори версій.

https://www.mediawiki.org/wiki/API:Revisions

Параметри:

rvprop

Які властивості отримати для кожної версії:

ids: ID версії.
flags: Позначки версії (незначні).
timestamp: Часова мітка версії.
user: Користувач, який створив версію.
userid: ID користувача, який створив версію.
size: Довжина версії (в байтах).
sha1: SHA-1 (base 16) версії.
contentmodel: ID моделі вмісту версії.
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

Обмежити кількість версій, які буде видано.

Може використовуватися тільки з однією сторінкою (режим #2).

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

rvexpandtemplates

Розгорнути шаблони у вмісті версії (передбачає rvprop=content).

Тип: логічний (деталі)

rvgeneratexml

Застарілий.

Генерувати синтаксичне дерево XML для вмісту версії (передбачає rvprop=content; замінено на rvprop=parsetree).

Тип: логічний (деталі)

rvparse

Аналізувати вміст версії (передбачає rvprop=content). З причин продуктивності, якщо використовується ця опція, rvlimit встановлюється як 1.

Тип: логічний (деталі)

rvsection

Витягнути вміст лише розділу з цим номером.

rvdiffto

rvdifftotext

Текст, з яким порівняти кожну версію. Порівнює лише обмежену кількість версій. Перевизначає rvdiffto. Якщо вказано rvsection, лише ця версія буде порівняна з цим текстом.

rvcontentformat

Формат серіалізації, використаний для rvdifftotext й очікуваний для контенту-результату.

Одне значення: text/x-wiki, text/javascript, application/json, text/css, text/plain

rvstartid

З якого ID версії почати перелік.

Може використовуватися тільки з однією сторінкою (режим #2).

Тип: ціле число

rvendid

Зупинити перелік версій на цьому ID версії.

Може використовуватися тільки з однією сторінкою (режим #2).

Тип: ціле число

rvstart

З якої часової мітки версії почати перелік.

Може використовуватися тільки з однією сторінкою (режим #2).

Тип: часова мітка (дозволені формати)

rvend

Перелічувати до цієї часової мітки.

Може використовуватися тільки з однією сторінкою (режим #2).

Тип: часова мітка (дозволені формати)

rvdir

У якому напрямку перелічувати:

newer: Спочатку найстарші. Примітка: rvstart має бути перед rvend.
older: Спочатку найновіші (за замовчуванням). Примітка: rvstart має бути перед rvend.

Може використовуватися тільки з однією сторінкою (режим #2).

Одне значення: newer, older

За замовчуванням: older

rvuser

Включати лише версій, зроблені цим користувачем.

Може використовуватися тільки з однією сторінкою (режим #2).

Тип: ім'я користувача

rvexcludeuser

Виключити версії, зроблені цим користувачем.

Може використовуватися тільки з однією сторінкою (режим #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)

(main • query • stashimageinfo)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає інформацію про приховані файли.

https://www.mediawiki.org/wiki/API:Stashimageinfo

Параметри:

siifilekey

Ключ, який ідентифікує попереднє завантаження, що було тимчасово приховане.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

siisessionkey

Застарілий.

Аліас для siifilekey, для зворотної сумісності.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

siiprop

Яку інформацію отримати:

timestamp: Додає мітку часу для завантаженої версії.
canonicaltitle: Додає канонічну назву файлу.
url: Дає посилання на файл і сторінку опису.
size: Додає розмір файлу в байтах, а також висоту, ширину і кількість сторінок (якщо це можливо).
dimensions: Псевдонім для розміру.
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)

(main • query • templates)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видає усі сторінки, які включені на вказаних сторінках.

https://www.mediawiki.org/wiki/API:Templates

Параметри:

tlnamespace: Показати шаблони лише у цьому просторі назв.; Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303
tllimit: Скільки шаблонів виводити.; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або 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)

(main • query • transcludedin)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Знайти усі сторінки, що включають подані сторінки.

https://www.mediawiki.org/wiki/API:Transcludedin

Параметри:

tiprop

Які властивості отримати:

pageid: ID кожної сторінки.
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, 2300, 2301, 2302, 2303

tishow

Показати лише елементи, що відповідають цим критеріям:

redirect: Показати лише перенаправлення.
!redirect: Показати лише не перенаправлення.

Значення (розділені через |): redirect, !redirect

tilimit

Скільки результатів виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • allcategories)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати всі категорії.

https://www.mediawiki.org/wiki/API:Allcategories

Параметри:

acfrom

Категорія, з якої почати перелічувати.

accontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

acto

Категорія, на якій закінчити перелічувати.

acprefix

Шукати усі назви категорій, які починаються з цього значення.

acdir

Напрямок сортування.

Одне значення: ascending, descending

За замовчуванням: ascending

acmin

Видати лише категорії, які мають щонайменше стільки елементів.

Тип: ціле число

acmax

Видати лише категорії, які мають максимум стільки елементів.

Тип: ціле число

aclimit

Скільки категорій видати.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • alldeletedrevisions)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати усі вилучені версії за користувачем або у просторі назв.

https://www.mediawiki.org/wiki/API:Alldeletedrevisions

Параметр:

adrprop

Які властивості отримати для кожної версії:

ids: ID версії.
flags: Позначки версії (незначні).
timestamp: Часова мітка версії.
user: Користувач, який створив версію.
userid: ID користувача, який створив версію.
size: Довжина версії (в байтах).
sha1: SHA-1 (base 16) версії.
contentmodel: ID моделі вмісту версії.
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 (5000 для ботів).

Тип: ціле число або max

adrexpandtemplates

Розгорнути шаблони у вмісті версії (передбачає adrprop=content).

Тип: логічний (деталі)

adrgeneratexml

Застарілий.

Генерувати синтаксичне дерево XML для вмісту версії (передбачає adrprop=content; замінено на adrprop=parsetree).

Тип: логічний (деталі)

adrparse

Аналізувати вміст версії (передбачає adrprop=content). З причин продуктивності, якщо використовується ця опція, adrlimit встановлюється як 1.

Тип: логічний (деталі)

adrsection

Витягнути вміст лише розділу з цим номером.

adrdiffto

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, 2300, 2301, 2302, 2303

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)

(main • query • allfileusages)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати усі використання файлів, включно з тими, що не існують.

https://www.mediawiki.org/wiki/API:Allfileusages

Параметри:

afcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

affrom

Назва файлу, з якої почати перераховувати.

afto

Назва файлу, якою закінчувати перераховувати.

afprefix

Шукати усі назви файлів, які починаються з цього значення.

afunique

Показувати лише окремі назви файлів. Не може використовуватися разом з afprop=ids. Коли використовується як генератор, видає цільові сторінки замість вихідних сторінок.

Тип: логічний (деталі)

afprop

Які відомості включати:

ids: Додає ідентифікатори із використаних сторінок (не буде використовуватися, при єдиній af).
title: Додає назву файлу.

Значення (розділені через |): ids, title

За замовчуванням: title

aflimit

Скільки всього елементів виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • allimages)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати усі зображення послідовно.

https://www.mediawiki.org/wiki/API:Allimages

Параметри:

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: Дає посилання на файл і сторінку опису.
size: Додає розмір файлу в байтах, а також висоту, ширину і кількість сторінок (якщо це можливо).
dimensions: Псевдонім для розміру.
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-хеш зображення у base 36 (використано в MediaWiki).

aiuser

Видати лише файли, завантажені цим користувачем. Можна використати лише з aisort=timestamp. Не можна використати разом з aifilterbots.

Тип: ім'я користувача

aifilterbots

Як фільтрувати файли, завантажені ботами. Можна використати лише з aisort=timestamp. Не можна використати разом з aiuser.

Одне значення: all, bots, nobots

За замовчуванням: all

aimime

Які MIME-типи шукати, напр., image/jpeg.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

ailimit

Скільки всього зображень видати.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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/gif: 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

list=alllinks (al)

(main • query • alllinks)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перераховувати всі посилання, які вказують на заданий простір назв.

https://www.mediawiki.org/wiki/API:Alllinks

Параметри:

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, 2300, 2301, 2302, 2303

За замовчуванням: 0

allimit

Скільки всього елементів виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • allpages)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перераховувати всі сторінки послідовно в заданому просторі назв.

https://www.mediawiki.org/wiki/API:Allpages

Параметри:

apfrom

Заголовок сторінки, з якого почати перелічувати.

apcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

apto

Заголовок сторінки, яким закінчувати перелічувати.

apprefix

Шукати усі назви сторінок, які починаються з цього значення.

apnamespace

Простір назв для переліку.

Одне значення: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303

За замовчуванням: 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 (5000 для ботів).

Тип: ціле число або 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
Показати вміст перших двох сторінок, що не є перенаправленнями і починаються на Re.: api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content

list=allredirects (ar)

(main • query • allredirects)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати усі перенаправлення на простір назв.

https://www.mediawiki.org/wiki/API:Allredirects

Параметри:

arcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

arfrom

Назва перенаправлення, з якої почати перераховувати.

arto

Назва перенаправлення, якою закінчувати перераховувати.

arprefix

Шукати усі цільові сторінки, які починаються з цього значення.

arunique

Показувати лише окремі цільові сторінки. Не може використовуватися разом з arprop=ids|fragment|interwiki. Коли використовується як генератор, видає цільові сторінки замість вихідних сторінок.

Тип: логічний (деталі)

arprop

Які відомості включити:

ids: Додає ID сторінки-перенаправлення (не можна використати разом з 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, 2300, 2301, 2302, 2303

За замовчуванням: 0

arlimit

Скільки всього елементів виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • alltransclusions)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Список усіх включень (сторінки, вставлені з використанням {{x}}), включно з неіснуючими.

https://www.mediawiki.org/wiki/API:Alltransclusions

Параметри:

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, 2300, 2301, 2302, 2303

За замовчуванням: 10

atlimit

Скільки всього елементів виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • allusers)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати усіх зареєстрованих користувачів.

https://www.mediawiki.org/wiki/API:Allusers

Параметри:

aufrom

Ім'я користувача, з якого почати перелічувати.

auto

Ім'я користувача, на якому закінчити перелічувати.

auprefix

Шукати усіх користувачів, які починаються з цього значення.

audir

Напрямок сортування.

Одне значення: ascending, descending

За замовчуванням: ascending

augroup

Включати лише користувачів з даних груп.

Значення (розділені через |): bot, sysop, bureaucrat

auexcludegroup

Виключити користувачів у даних групах.

Значення (розділені через |): bot, sysop, bureaucrat

aurights

Включати лише користувачів з даними правами. Не включає права, надані безумовними або автоматичними групами на зразок *, користувач або автопідтверджені.

Значення (розділені через |): 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, gadgets-edit, gadgets-definition-edit, skipcaptcha

Максимальна кількість значень — 50 (500 для ботів).

auprop

Які саме відомості включати:

blockinfo: Додає інформацію про поточне блокування користувача.
groups: Перераховує групи, до яких користувач належить. Це використовує більше ресурсів сервера і може видати менше результатів, ніж ліміт.
implicitgroups: Перераховує усіх групи, до яких користувач належить автоматично.
rights: Перераховує права, які користувач має.
editcount: Додає кількість редагувань користувача.
registration: Додає часову мітку, коли користувач зареєструвався, якщо доступно (може бути пустою).

Значення (розділені через |): blockinfo, groups, implicitgroups, rights, editcount, registration

aulimit

Скільки всього виводити імен користувачів.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

auwitheditsonly

Перерахувати лише користувачів, що зробили редагування.

Тип: логічний (деталі)

auactiveusers

Перерахувати лише користувачів, що були активні 30 останніх днів.

Тип: логічний (деталі)

Приклад:

Перерахувати користувачів, починаючи з Y.: api.php?action=query&list=allusers&aufrom=Y

list=backlinks (bl)

(main • query • backlinks)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Знайти усі сторінки, що посилаються на подану сторінку.

https://www.mediawiki.org/wiki/API:Backlinks

Параметри:

bltitle: Назва для пошуку. Не можна використати разом з blpageid.
blpageid: ID сторінки для пошуку. Не можна використати разом з bltitle.; Тип: ціле число
blcontinue: Коли доступно більше результатів, використовуйте це, щоб продовжити.
blnamespace: Простір назв для переліку.; Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303
bldir: Напрямок, у якому перелічити.; Одне значення: ascending, descending; За замовчуванням: ascending
blfilterredir: Як відфільтрувати перенаправлення. Якщо встановлено nonredirects при увімкненому blredirect, це застосовується лише до другого рівня.; Одне значення: all, redirects, nonredirects; За замовчуванням: all
bllimit: Скільки всього виводити сторінок. Якщо увімкнено blredirect, ліміт застосовується до кожного рівня окремо (це означає, що може бути видано до 2 * bllimit результатів).; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або 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)

(main • query • blocks)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати усіх заблокованих користувачів і IP-адреси.

https://www.mediawiki.org/wiki/API:Blocks

Параметри:

bkstart

Часова мітка, з якої почати перелік.

Тип: часова мітка (дозволені формати)

bkend

Часова мітка закінчення переліку.

Тип: часова мітка (дозволені формати)

bkdir

У якому напрямку перелічувати:

newer: Спочатку найстарші. Примітка: bkstart має бути перед bkend.
older: Спочатку найновіші (за замовчуванням). Примітка: bkstart має бути перед bkend.

Одне значення: newer, older

За замовчуванням: older

bkids

Вивести список заблокованих ID (необов'язково).

Тип: список цілих чисел

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

bkusers

Список користувачів для пошуку (необов'язково).

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

bkip

Отримати всі блокування, що стосуються цієї IP-адреси або CIDR-діапазону, включно з блокуваннями діапазонів. Не може бути використано разом з bkusers. CIDR-діапазони, ширші, ніж IPv4/16 чи IPv6/19, не приймаються.

bklimit

Максимальна кількість блокувань у списку.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

bkprop

Які властивості отримати:

id: Додає ID блокування.
user: Додає ім'я заблокованого користувача.
userid: Додає ID заблокованого користувача.
by: Додає ім'я користувача, який заблокував.
byid: Додає ID користувача, який заблокував.
timestamp: Додає часову мітку здійснення блокування.
expiry: Додає часову мітку закінчення терміну блокування.
reason: Додає причину, вказану при блокуванні.
range: Додає діапазон IP-адрес, на які поширюється блокування.
flags: Мітки бану (автоблокування, лише анонім тощо).

Значення (розділені через |): id, user, userid, by, byid, timestamp, expiry, reason, range, 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)

(main • query • categorymembers)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати усі сторінки у поданій категорії.

https://www.mediawiki.org/wiki/API:Categorymembers

Параметри:

cmtitle

Яку категорію вивести (обов'язково). Мусить включати префікс Категорія:. Не можна використати разом з cmpageid.

cmpageid

ID сторінки категорії для виведення. Не можна використати разом з cmtitle.

Тип: ціле число

cmprop

Які відомості включати:

ids: Додає ID сторінки.
title: Додає назву й ID простору назв сторінки.
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, 2300, 2301, 2302, 2303

cmtype

Який тип елементів категорії включати. Ігнорується, коли вказано cmsort=timestamp.

Значення (розділені через |): page, subcat, file

За замовчуванням: page|subcat|file

cmcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

cmlimit

Максимальна кількість сторінок для виведення.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

cmsort

Властивість, за якою сортувати.

Одне значення: sortkey, timestamp

За замовчуванням: sortkey

cmdir

У якому напрямку сортувати.

Одне значення: asc, desc, ascending, descending, newer, older

За замовчуванням: ascending

cmstart

Часова мітка, з якої почати список. Можна використати лише разом з cmsort=timestamp.

Тип: часова мітка (дозволені формати)

cmend

Часова мітка, якою закінчити список. Можна використати лише разом з cmsort=timestamp.

Тип: часова мітка (дозволені формати)

cmstarthexsortkey

Ключ сортування, з якого почати список, як видає cmprop=sortkey. Можна використати лише разом з cmsort=sortkey.

cmendhexsortkey

Ключ сортування, з якого почати список, як видає cmprop=sortkey. Можна використати лише разом з cmsort=sortkey.

cmstartsortkeyprefix

Префікс ключа сортування, з якого почати список. Можна використати лише разом з cmsort=sortkey. Перевизначає cmstarthexsortkey.

cmendsortkeyprefix

Префікс ключа сортування, перед яким закінчити список (не на; якщо це значення зустрінеться, його не буде включено!). Можна використати лише разом з cmsort=sortkey. Перевизначає cmendhexsortkey.

cmstartsortkey

Застарілий.

Використати натомість cmstarthexsortkey.

cmendsortkey

Застарілий.

Використати натомість cmendhexsortkey.

Приклади:

Отримати перші 10 сторінок у Category:Physics.: 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)

(main • query • deletedrevs)

Цей модуль є застарілим.
Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перелічити вилучені версії.

Працює у трьох режимах:

Перелічити вилучені версії поданих назв, відсортованих за часовою міткою.
Перелічити вилучений внесок поданого користувача, відсортований за часовою міткою (без вказання заголовків).
Перелічити усі вилучені версії у поданому просторі назв, відсортовані за назвою та часовою міткою (без вказання заголовків, druser не вказаний).

Окремі параметри можуть застосовуватися в одному режимі й ігноруватися в іншому.

https://www.mediawiki.org/wiki/API:Deletedrevs

Параметри:

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, 2300, 2301, 2302, 2303

За замовчуванням: 0

drtag

Перерахувати лише версії, помічені цим теґом.

druser

Перерахувати лише версії цього користувача.

Тип: ім'я користувача

drexcludeuser

Не перераховувати версії цього користувача.

Тип: ім'я користувача

drprop

Які властивості отримати:

revid: Додає ID вилученої версії.
parentid: Додає ID попередньої версії сторінки.
user: Додає користувача, який створив версію.
userid: Додає ID користувача, який створив версію.
comment: Додає коментар до версії.
parsedcomment: Додає проаналізований коментар до версії.
minor: Позначає, якщо версія створена незначним редагуванням.
len: Додає довжину (байти) версії.
sha1: Додає SHA-1 (base 16) версії.
content: Додає вміст версії.
token: Застаріло. Дає токен редагування.
tags: Теґи версії.

Значення (розділені через |): revid, parentid, user, userid, comment, parsedcomment, minor, len, sha1, content, token, tags

За замовчуванням: user|comment

drlimit

Максимальна кількість версій для переліку.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

drcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

Приклади:

Перерахувати останні вилучені версії сторінок Main Page і Talk:Main Page, з вмістом (режим 1).: api.php?action=query&list=deletedrevs&titles=Main%20Page|Talk:Main%20Page&drprop=user|comment|content
Перерахувати останні 50 вилучених редагувань Bob (режим 2).: api.php?action=query&list=deletedrevs&druser=Bob&drlimit=50
Перерахувати перші 50 вилучених версій у головному просторі назв (режим 3).: api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50
Перерахувати перші 50 вилучених сторінок у просторі назв Обговорення (режим 3).: api.php?action=query&list=deletedrevs&drdir=newer&drlimit=50&drnamespace=1&drunique=

list=embeddedin (ei)

(main • query • embeddedin)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Знайти всі сторінки, які вбудовують (включають) подану назву.

https://www.mediawiki.org/wiki/API:Embeddedin

Параметри:

eititle: Назва для пошуку. Не можна використати разом з eipageid.
eipageid: ID сторінки для пошуку. Не можна використати разом з eititle.; Тип: ціле число
eicontinue: Коли доступно більше результатів, використовуйте це, щоб продовжити.
einamespace: Простір назв для переліку.; Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303
eidir: Напрямок, у якому перелічити.; Одне значення: ascending, descending; За замовчуванням: ascending
eifilterredir: Як фільтрувати перенаправлення.; Одне значення: all, redirects, nonredirects; За замовчуванням: all
eilimit: Скільки всього сторінок виводити.; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або 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)

(main • query • exturlusage)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати сторінки, які містять поданий URL.

https://www.mediawiki.org/wiki/API:Exturlusage

Параметри:

euprop

Які відомості включати:

ids: Додає ID сторінки.
title: Додає заголовок і ID простору назв сторінки.
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, 2300, 2301, 2302, 2303

eulimit

Скільки сторінок виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

euexpandurl

Розгорнути протокол-залежні URL за канонічним протоколом.

Тип: логічний (деталі)

Приклад:

Показати сторінки, які посилаються на http://www.mediawiki.org.: api.php?action=query&list=exturlusage&euquery=www.mediawiki.org

list=filearchive (fa)

(main • query • filearchive)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати всі вилучені файли послідовно.

https://www.mediawiki.org/wiki/API:Filearchive

Параметри:

fafrom

Назва зображення, з якої почати перелічувати.

fato

Назва зображення, якою закінчити перелічувати.

faprefix

Шукати усі назви зображень, які починаються з цього значення.

fadir

Напрямок, у якому перелічити.

Одне значення: ascending, descending

За замовчуванням: ascending

fasha1

SHA1-хеш зображення. Перевизначає fasha1base36.

fasha1base36

SHA1-хеш зображення у base 36 (використано в MediaWiki).

faprop

Which image information to get:

sha1: Додає хеш SHA-1 до зображення.
timestamp: Додає часову мітку завантаженої версії.
user: Додає користувача, який завантажив версію зображення.
size: Додає розмір зображення у байтах, а також висоту, ширину і кількість сторінок (якщо є).
dimensions: Аліас розміру.
description: Додає опис версії зображення.
parseddescription: Аналіз опису зображення.
mime: Додає MIME-тип зображення.
mediatype: Додає медіатип зображення.
metadata: Вилає Exif-метадані версії зображення.
bitdepth: Додає бітну глибину версії.
archivename: Додає до імені версію архіву для неостаточного варіанту файлу.

Значення (розділені через |): sha1, timestamp, user, size, dimensions, description, parseddescription, mime, mediatype, metadata, bitdepth, archivename

За замовчуванням: timestamp

falimit

Скільки всього зображень виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

facontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

Приклад:

Показати список усіх вилучених файлів.: api.php?action=query&list=filearchive

list=gadgetcategories (gc)

(main • query • gadgetcategories)

Цей модуль вимагає прав на читання.
Джерело: Gadgets
Ліцензія: GPL-2.0+

Видає список категорій ґаджетів.

Параметри:

gcprop

Яку категорію ґаджетів отримати:

name: Внутрішнє ім'я категорії.
title: Назва категорії.
members: Кількість ґаджетів у категорії.

Значення (розділені через |): name, title, members

За замовчуванням: name

gcnames

Імена категорій для виведення.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

Приклади:

Отримати список наявних категорій ґаджетів: api.php?action=query&list=gadgetcategories
Отримати всю інформацію про категорії з іменами «foo» і «bar»: api.php?action=query&list=gadgetcategories&gcnames=foo|bar&gcprop=name|title|members

list=gadgets (ga)

(main • query • gadgets)

Цей модуль вимагає прав на читання.
Джерело: Gadgets
Ліцензія: GPL-2.0+

Видає список ґаджетів, використовуваних у цій вікі.

Параметри:

gaprop

Яку інформацію про ґаджет отримати:

id: Внутрішній ID ґаджета.
metadata: Метадані ґаджета.
desc: Опис ґаджета, перетворений у HTML (може бути повільно, використовуйте за справжньої потреби).

Значення (розділені через |): id, metadata, desc

За замовчуванням: id|metadata

gacategories

Ґаджети з яких категорій отримувати.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

gaids

ID ґаджетів для отримання.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

gaallowedonly

Список лише дозволених даному користувачеві ґаджетів.

Тип: логічний (деталі)

gaenabledonly

Список лише увімкнених даним користувачем ґаджетів.

Тип: логічний (деталі)

Приклади:

Отримати список ґаджетів разом з їх описами: api.php?action=query&list=gadgets&gaprop=id|desc
Отримати список ґаджетів з усіма можливими властивостями: api.php?action=query&list=gadgets&gaprop=id|metadata|desc
Отримати список ґаджетів, які належать до категорії «foo»: api.php?action=query&list=gadgets&gacategories=foo
Отримати інформацію про ґаджети «foo» і «bar»: api.php?action=query&list=gadgets&gaids=foo|bar&gaprop=id|desc|metadata
Отримати список ґаджетів, увімкнених даним користувачем: api.php?action=query&list=gadgets&gaenabledonly

list=imageusage (iu)

(main • query • imageusage)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Знайти всі сторінки, що використовують дану назву зображення.

https://www.mediawiki.org/wiki/API:Imageusage

Параметри:

iutitle: Назва для пошуку. Не можна використати разом з iupageid.
iupageid: ID сторінки для пошуку. Не можна використати разом з iutitle.; Тип: ціле число
iucontinue: Коли доступно більше результатів, використовуйте це, щоб продовжити.
iunamespace: Простір назв для переліку.; Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303
iudir: Напрямок, у якому перелічити.; Одне значення: ascending, descending; За замовчуванням: ascending
iufilterredir: Як відфільтрувати перенаправлення. Якщо встановлено для неперенаправлень при увімкненому iuredirect, це застосовується лише до другого рівня.; Одне значення: all, redirects, nonredirects; За замовчуванням: all
iulimit: Скільки всього виводити сторінок. Якщо увімкнено iuredirect, ліміт застосовується до кожного рівня окремо (це означає, що може бути видано до 2 * iulimit результатів).; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або max; За замовчуванням: 10
iuredirect: Якщо сторінка, яка посилається, є перенаправленням, знайти всі сторінки, які посилаються на це перенаправлення, теж. Максимальний ліміт зменшується наполовину.; Тип: логічний (деталі)

Приклади:

Показати сторінки, які використовують File:Albert Einstein Head.jpg.: api.php?action=query&list=imageusage&iutitle=File:Albert%20Einstein%20Head.jpg
Отримати інформацію про сторінки, які використовують File:Albert Einstein Head.jpg.: api.php?action=query&generator=imageusage&giutitle=File:Albert%20Einstein%20Head.jpg&prop=info

list=iwbacklinks (iwbl)

(main • query • iwbacklinks)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Знайти всі сторінки, які посилаються на дане інтервікі-посилання.

Може використовуватися, щоб знайти всі посилання з префіксом або всі посилання на назву (з даним префіксом). Без використання жодного параметра це, по суті, «всі інтервікі-посилання».

https://www.mediawiki.org/wiki/API:Iwbacklinks

Параметри:

iwblprefix

Префікс для інтервікі.

iwbltitle

Інтервікі-посилання для пошуку. Повинно використовуватися з iwblblprefix.

iwblcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

iwbllimit

Скільки всього сторінок виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

iwblprop

Які властивості отримати:

iwprefix: Додає префікс інтервікі.
iwtitle: Додає назву інтервікі.

Значення (розділені через |): iwprefix, iwtitle

За замовчуванням: (пусто)

iwbldir

Напрямок, у якому перелічити.

Одне значення: ascending, descending

За замовчуванням: ascending

Приклади:

Отримати сторінки, що посилаються на wikibooks:Test.: api.php?action=query&list=iwbacklinks&iwbltitle=Test&iwblprefix=wikibooks
Отримати інформацію про сторінки, що посилаються на wikibooks:Test.: api.php?action=query&generator=iwbacklinks&giwbltitle=Test&giwblprefix=wikibooks&prop=info

list=langbacklinks (lbl)

(main • query • langbacklinks)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Знайти всі сторінки, які посилаються на дане мовне посилання.

Може бути використано для пошуку всіх посилань з кодом мови або всіх посилань на назву (з урахуванням мови). Без жодного параметра це «усі мовні посилання».

Зверніть увагу, що це може не розглядати мовні посилання, додані розширеннями.

https://www.mediawiki.org/wiki/API:Langbacklinks

Параметри:

lbllang

Мова мовного посилання.

lbltitle

Мовне посилання для пошуку. Мусить бути використане з lbllang.

lblcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

lbllimit

Скільки всього сторінок виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

lblprop

Які властивості для отримання:

lllang: Додає код мови мовного посилання.
lltitle: Додає назву мовного посилання.

Значення (розділені через |): lllang, lltitle

За замовчуванням: (пусто)

lbldir

Напрямок, у якому перелічити.

Одне значення: ascending, descending

За замовчуванням: ascending

Приклади:

Отримати сторінки, що посилаються на fr:Test.: api.php?action=query&list=langbacklinks&lbltitle=Test&lbllang=fr
Отримати інформацію про сторінки, що посилаються на fr:Test.: api.php?action=query&generator=langbacklinks&glbltitle=Test&glbllang=fr&prop=info

list=logevents (le)

(main • query • logevents)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати події з журналів.

https://www.mediawiki.org/wiki/API:Logevents

Параметри:

leprop

Які властивості отримати:

ids: Додає ID події в журналі.
title: Додає назву сторінки події в журналі.
type: Додає тип події в журналі.
user: Додає користувача, відповідального за подію в журналі.
userid: Додає ID користувача, відповідального за подію в журналі.
timestamp: Додає часову мітку події.
comment: Додає коментар події.
parsedcomment: Додає проаналізований коментар події.
details: Виводить додаткові деталі щодо події.
tags: Виводить мітки події.

Значення (розділені через |): ids, title, type, user, userid, timestamp, comment, parsedcomment, details, tags

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, 2300, 2301, 2302, 2303

leprefix

Відфільтрувати до записів, що починаються з цього префікса.

letag

Перерахувати лише записи подій, помічені цим теґом.

lelimit

Скільки всього виводити записів подій.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

lecontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

Приклад:

Перелічити останні подій в журналі.: api.php?action=query&list=logevents

list=pagepropnames (ppn)

(main • query • pagepropnames)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перелічити усі назви властивостей сторінки, що використовуються у вікі.

https://www.mediawiki.org/wiki/API:Pagepropnames

Параметри:

ppncontinue: Коли доступно більше результатів, використовуйте це, щоб продовжити.
ppnlimit: Максимальна кількість назв для виведення.; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або max; За замовчуванням: 10

Приклад:

Отримати перші 10 назв властивостей.: api.php?action=query&list=pagepropnames

list=pageswithprop (pwp)

(main • query • pageswithprop)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перелічити усі сторінки, що використовують подану властивість сторінки.

https://www.mediawiki.org/wiki/API:Pageswithprop

Параметри:

pwppropname

Властивість сторі́нки, для якої перелічити сторінки́.

Цей параметр є обов'язковим.

pwpprop

Які відомості включати:

ids: Додає ID сторінки.
title: Додає заголовок і ID простору назв сторінки.
value: Додає значення властивості сторінки.

Значення (розділені через |): ids, title, value

За замовчуванням: ids|title

pwpcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

pwplimit

Максимальна кількість сторінок для виведення.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

pwpdir

У якому напрямку сортувати.

Одне значення: ascending, descending

За замовчуванням: ascending

Приклади:

Перелічити перші 10, що використовують {{DISPLAYTITLE:}}.: api.php?action=query&list=pageswithprop&pwppropname=displaytitle&pwpprop=ids|title|value
Отримати додаткову інформацію про перші 10 сторінок, що використовують __NOTOC__.: api.php?action=query&generator=pageswithprop&gpwppropname=notoc&prop=info

list=prefixsearch (ps)

(main • query • prefixsearch)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Виконати пошук назв сторінок по префіксу.

https://www.mediawiki.org/wiki/API:Prefixsearch

Параметри:

pssearch: Рядок пошуку.; Цей параметр є обов'язковим.
psnamespace: Простори назв, у яких шукати.; Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303; За замовчуванням: 0
pslimit: Максимальна кількість результатів для виведення.; Дозволено не більше 100 (200 для ботів).; Тип: ціле число або max; За замовчуванням: 10
psoffset: Кількість результатів, які пропустити.; Тип: ціле число; За замовчуванням: 0

Приклад:

Шукати назви сторінок, які починаються з meaning.: api.php?action=query&list=prefixsearch&pssearch=meaning

list=protectedtitles (pt)

(main • query • protectedtitles)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вивести список усіх назв, захищених від створення.

https://www.mediawiki.org/wiki/API:Protectedtitles

Параметри:

ptnamespace

Перерахувати назви лише в цих просторах назв.

Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303

ptlevel

Перерахувати лише назви з цими рівням захисту.

Значення (розділені через |): autoconfirmed, sysop

ptlimit

Скільки всього сторінок виводити.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

ptdir

У якому напрямку перелічувати:

newer: Спочатку найстарші. Примітка: ptstart має бути перед ptend.
older: Спочатку найновіші (за замовчуванням). Примітка: ptstart має бути перед ptend.

Одне значення: newer, older

За замовчуванням: older

ptstart

Почати список з цієї часової мітки захисту.

Тип: часова мітка (дозволені формати)

ptend

Закінчити список цією часовою міткою захисту.

Тип: часова мітка (дозволені формати)

ptprop

Які властивості отримати:

timestamp: Додає часову мітку встановлення захисту.
user: Додає користувача, який встановив захист.
userid: Додає ID користувача, який встановив захист.
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)

(main • query • querypage)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати список, кий дає спеціальна сторінка на базі QueryPage.

https://www.mediawiki.org/wiki/API: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 (5000 для ботів).; Тип: ціле число або max; За замовчуванням: 10

Приклад:

Видати результати з Special:Ancientpages.: api.php?action=query&list=querypage&qppage=Ancientpages

list=random (rn)

(main • query • random)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати набір випадкових сторінок.

Сторінки перелічені у певній послідовності, лише початкова точка рандомна. Це означає, що якщо, наприклад, Main Page є першою випадковою сторінкою у списку, List of fictional monkeys завжди буде другою, List of people on stamps of Vanuatu — третьою, і т. д.

Якщо кількість сторінок у просторі назв менша, ніж rnlimit, буде показано менше сторінок. Та сама сторінка не виводиться двічі.

https://www.mediawiki.org/wiki/API:Random

Параметри:

rnnamespace: Вивести сторінки лише у цих просторах назв.; Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303
rnfilterredir: How to filter for redirects.; Одне значення: all, redirects, nonredirects; За замовчуванням: nonredirects
rnredirect: Застарілий.; Завантажити випадкове перенаправлення замість випадкової сторінки.; Тип: логічний (деталі)
rnlimit: Обмежити кількість випадкових сторінок, які буде видано.; Дозволено не більше 500 (5000 для ботів).; Тип: ціле число або 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)

(main • query • recentchanges)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перерахувати нещодавні зміни.

https://www.mediawiki.org/wiki/API:Recentchanges

Параметри:

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, 2300, 2301, 2302, 2303

rcuser

Перерахувати лише зміни, зроблені цим користувачем.

Тип: ім'я користувача

rcexcludeuser

Не перераховувати зміни, зроблені цим користувачем.

Тип: ім'я користувача

rctag

Перерахувати лише зміни, помічені цим теґом.

rcprop

Включити додаткові відомості:

user: Додає користувача, відповідального за редагування і мітки, якщо він IP.
userid: Додає ID користувача, відповідального за редагування.
comment: Додає коментар редагування.
parsedcomment: Додає проаналізований коментар редагування.
flags: Додає прапорці редагування.
timestamp: Додає часову мітку редагування.
title: Додає назву сторінки, де було редагування.
ids: Додає ID сторінки, ID нещодавніх змін, а також ID нової і старої версій.
sizes: Додає нову і стару довжину сторінки в байтах.
redirect: Помічає редагування, якщо сторінка є перенаправленням.
patrolled: Помічає редагування як відпатрульвані чи невідпатрульовані.
loginfo: Додає інформацію журналу (ID журналу, тип журналу тощо) до записів журналу.
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 (5000 для ботів).

Тип: ціле число або 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)

(main • query • search)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Виконати повнотекстовий пошук.

https://www.mediawiki.org/wiki/API:Search

Параметри:

srsearch

Шукати назви сторінок або вміст, що співпадає з цим значенням. Ви можете використати рядок пошуку для виклику спеціальних функцій пошуку, залежно від внутрішніх установок пошуку у вікі.

Цей параметр є обов'язковим.

srnamespace

Шукати лише в межах цих просторів назв.

Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303

За замовчуванням: 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

Enable internal query rewriting. Some search backends can rewrite the query into one its thinks gives better results, such as correcting spelling errors.

Тип: логічний (деталі)

Приклади:

Шукати 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)

(main • query • tags)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Перелічити мітки змін.

https://www.mediawiki.org/wiki/API:Tags

Параметри:

tgcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

tglimit

Максимальна кількість міток у списку.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

tgprop

Які властивості отримати:

name: Додає назву мітки.
displayname: Додає системне повідомлення для мітки.
description: Додає опис мітки.
hitcount: Додає кількість версій та записів журналу, які мають цю мітку.
defined: Показує, чи мітка визначена.
source: Отримує джерела мітки, що може включати extension для визначених розширеннями міток і manual для міток, які користувачі можуть застосовувати вручну.
active: І все ж позначка досі задіяна.

Значення (розділені через |): name, displayname, description, hitcount, defined, source, active

За замовчуванням: name

Приклад:

Перелічити доступні мітки.: api.php?action=query&list=tags&tgprop=displayname|description|hitcount|defined

list=usercontribs (uc)

(main • query • usercontribs)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати всі редагування користувача.

https://www.mediawiki.org/wiki/API:Usercontribs

Параметри:

uclimit

Максимальна кількість елементів внеску для виведення.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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, 2300, 2301, 2302, 2303

ucprop

Включити додаткові відомомсті:

ids: Додає ID сторінки й ID версії.
title: Додає назву й ID простору назв сторінки.
timestamp: Додає часову мітку редагування.
comment: Додає коментар редагування.
parsedcomment: Додає проаналізований коментар редагування.
size: Додає новий розмір редагування.
sizediff: Додає зміну розміру порівняно з попереднім редагуванням.
flags: Додає прапорці редагування.
patrolled: Відзначає патрульовані редагування.
tags: Перелічує мітки редагування.

Значення (розділені через |): ids, title, timestamp, comment, parsedcomment, size, sizediff, flags, patrolled, tags

ucshow

Показати лише елементи, що відповідають цим критеріям, наприклад, лише не незначні редагування: ucshow=!minor.

Якщо вказано 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)

(main • query • users)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати інформацію про список користувачів.

https://www.mediawiki.org/wiki/API:Users

Параметри:

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)

(main • query • watchlist)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати нещодавні зміни сторінок у списку спостереження поточного користувача.

https://www.mediawiki.org/wiki/API:Watchlist

Параметри:

wlallrev

Включити декілька версій тієї з сторінки у поданому часовому діапазоні.

Тип: логічний (деталі)

wlstart

Часова мітка, з якої почати перелік.

Тип: часова мітка (дозволені формати)

wlend

Часова мітка завершення переліку.

Тип: часова мітка (дозволені формати)

wlnamespace

Відфільтрувати до змін лише у поданих просторах назв.

Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303

wluser

Перерахувати лише зміни, зроблені цим користувачем.

Тип: ім'я користувача

wlexcludeuser

Не перераховувати зміни, зроблені цим користувачем.

Тип: ім'я користувача

wldir

У якому напрямку перелічувати:

newer: Спочатку найстарші. Примітка: wlstart має бути перед wlend.
older: Спочатку найновіші (за замовчуванням). Примітка: wlstart має бути перед wlend.

Одне значення: newer, older

За замовчуванням: older

wllimit

Скільки всього видати результатів за один запит.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або max

За замовчуванням: 10

wlprop

Які додаткові властивості отримати:

ids: Додає ID версій та ID сторінок.
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)

(main • query • watchlistraw)

Цей модуль вимагає прав на читання.
Цей модуль може бути використаний як генератор.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати усі сторінки у списку спостереження поточного користувача.

https://www.mediawiki.org/wiki/API:Watchlistraw

Параметри:

wrcontinue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

wrnamespace

Перерахувати сторінки лише в поданих просторах назв.

Значення (розділені через |): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 2300, 2301, 2302, 2303

wrlimit

Скільки всього видати результатів за один запит.

Дозволено не більше 500 (5000 для ботів).

Тип: ціле число або 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)

(main • query • allmessages)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видати повідомлення від цього сайту.

https://www.mediawiki.org/wiki/API:Allmessages

Параметри:

ammessages: Які повідомлення виводити. * (за замовчуванням) означає усі повідомлення.; Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).; За замовчуванням: *
amprop: Які властивості отримати.; Значення (розділені через |): default
amenableparser: Встановити увімкнення парсеру, це попередньо обробить вікітекст повідомлення (підставити магічні слова, розкрити шаблони тощо).; Тип: логічний (деталі)
amnocontent: Якщо вказано, не включати повідомлення вміст повідомлення у результат.; Тип: логічний (деталі)
amincludelocal: Також включити локальні повідомлення, тобто повідомлення, що не існують у програмному забезпеченні, але існують як сторінка MediaWiki:. Це видає список усіх сторінок 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)

(main • query • filerepoinfo)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видати мета-інформацію про репозиторії зображень, налаштовані на вікі.

https://www.mediawiki.org/wiki/API:Filerepoinfo

Параметр:

friprop

Які властивості репозиторію отримати (на деяких вікі може бути більше):

apiurl: URL до репозиторію API — корисне для отримання інформації про зображення з хосту.
name: Ключ репозиторію — використано в e.g. $wgForeignFileRepos і значення imageinfo.
displayname: Людиночита назва репозиторію вікі.
rooturl: Корінний URL для шляху зображення.
local: Чи репозиторій локальний, чи ні.

Значення (розділені через |): name, displayname, rootUrl, local, url, thumbUrl, initialCapital, scriptDirUrl, scriptExtension, favicon, canUpload

Приклад:

Отримати інформацію про репозиторії файлів.: api.php?action=query&meta=filerepoinfo&friprop=apiurl|name|displayname

meta=siteinfo (si)

(main • query • siteinfo)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Видати загальну інформацію про сайт.

https://www.mediawiki.org/wiki/API:Siteinfo

Параметри:

siprop

Яку інформацію отримати:

general: Загальна системна інформація.
namespaces: Список зареєстрованих просторів назв та їхні канонічні назви.
namespacealiases: Список зареєстрованого простору прізвиськ.
specialpagealiases: Список аліасів спеціальної сторінки.
magicwords: Список магічних слів та їх аліасів.
interwikimap: Видає карту інтервікі (за бажанням, фільтровану, за бажанням локалізовану з використанням siinlanguagecode).
dbrepllag: Видає сервер бази даних з найбільшою затримкою відповіді.
statistics: Видає статистику сайту.
usergroups: Видає групи користувачів і пов'язані дозволи.
libraries: Видає бібліотеки, встановлені у вікі.
extensions: Видає розширення, встановлені у вікі.
fileextensions: Видає список розширень файлів, які дозволено завантажувати.
rightsinfo: Видає інформацію щодо прав (ліцензії) вікі, якщо наявна.
restrictions: Видає інформацію про наявні типи обмежень (захисту).
languages: Видає список мов, які підтримує MediaWiki (за бажанням локалізовані через siinlanguagecode).
skins: Видає список усіх доступних тем оформлення (опціонально локалізовані з використанням siinlanguagecode, в іншому разі — мовою вмісту).
extensiontags: Видає список теґів розширення парсеру.
functionhooks: Видає список гуків парсерних функцій.
showhooks: Видає список усіх підписаних гуків (вміст $wgHooks).
variables: Видає список змінних ID.
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

(main • query • tokens)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримує токени для дій, що змінюють дані.

https://www.mediawiki.org/wiki/API:Tokens

Параметр:

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)

(main • query • userinfo)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Отримати інформацію про поточного користувача.

https://www.mediawiki.org/wiki/API:Userinfo

Параметр:

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

(main • revisiondelete)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вилучити або відновити версії.

https://www.mediawiki.org/wiki/API:Revisiondelete

Параметри:

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

(main • rollback)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Скасувати останнє редагування цієї сторінки.

Якщо користувач, який редагував сторінку, зробив декілька редагувань підряд, їх усі буде відкочено.

https://www.mediawiki.org/wiki/API:Rollback

Параметри:

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

(main • setnotificationtimestamp)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Оновити часову мітку сповіщень для сторінок, що спостерігаються.

Це зачепить підсвічування змінених сторінок у списку спостереження та історії, а також надсилання електронного листа якщо опція налаштувань «Повідомляти електронною поштою про зміну сторінки або файлу з мого списку спостереження» увімкнена.

https://www.mediawiki.org/wiki/API:SetNotificationTimestamp

Параметри:

entirewatchlist

Опрацювати всі сторінки, що спостерігаються.

Тип: логічний (деталі)

timestamp

Часова мітка, яку вказати у якості часової мітки сповіщень.

Тип: часова мітка (дозволені формати)

torevid

Версія до якої вказати часову мітку сповіщень (лише одна сторінка).

Тип: ціле число

newerthanrevid

Версія, до новішої від якої вказати часову мітку сповіщень (лише одна сторінка).

Тип: ціле число

continue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

titles

Список назв над якими працювати.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

pageids

Список ідентифікаторів сторінок над якими працювати.

Тип: список цілих чисел

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

revids

Список ідентифікаторів версій над якими працювати.

Тип: список цілих чисел

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

generator

Отримати список сторінок над якими працювати шляхом виконання вказаного модуля запиту.

Примітка: Назви параметрів генератора повинні мати префікс «g», див. приклади.

redirects

Автоматично вирішувати перенаправлення у titles, pageids, і revids, та у сторінках, повернених generator.

Тип: логічний (деталі)

converttitles

Тип: логічний (деталі)

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

(main • 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+

Додати або вилучити зміни міток з окремих версій або записів журналу.

https://www.mediawiki.org/wiki/API:Tag

Параметри:

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

(main • 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

(main • unblock)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Розблокувати користувача.

https://www.mediawiki.org/wiki/API:Block

Параметри:

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

(main • undelete)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Відновити версії вилученої сторінки.

Список вилучених версій (включено з часовими мітками) може бути отримано через list=deletedrevs, а список ідентифікаторів вилучених файлів може бути отримано через list=filearchive.

https://www.mediawiki.org/wiki/API:Undelete

Параметри:

title: Назва сторінки, яку слід відновити.; Цей параметр є обов'язковим.
reason: Причина відновлення.; За замовчуванням: (пусто)
timestamps: Часові мітки версій, які слід відновити. Якщо і timestamps, і fileids порожні, буде відновлено всі версії.; Тип: список часових міток (дозволені формати); Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).
fileids: Ідентифікатори версій файлів, які слід відновити. Якщо і timestamps, і fileids порожні, буде відновлено всі версії.; Тип: список цілих чисел; Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).
watchlist: Безумовно додати або вилучити сторінку із списку спостереження поточного користувача, використати налаштування, або не змінювати статус (не)спостереження.; Одне значення: watch, unwatch, preferences, nochange; За замовчуванням: preferences
token: Токен «csrf» отримано з action=query&meta=tokens; Цей параметр є обов'язковим.

Приклади:

Відновити сторінку Main Page.: api.php?action=undelete&title=Main%20Page&token=123ABC&reason=Restoring%20main%20page
Відновити дві версії сторінки Main Page.: api.php?action=undelete&title=Main%20Page&token=123ABC&timestamps=2007-07-03T22:00:45Z|2007-07-02T19:48:56Z

action=upload

(main • upload)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Завантажити файл, або отримати статус завантажень у процесі.

Доступні декілька методів:

Завантажити вміст файлу напряму, використовуючи параметр file.
Завантажити файл шматками, використовуючи параметри filesize, chunk, та offset.
Змусити сервер Медіавікі отримати файл за URL, використовуючи параметр url.
Завершити раніше розпочате завантаження, яке не вдалось через попередження, використовуючи параметр filekey.

Зауважте, що HTTP POST повинен бути здійснений як завантаження файлу (наприклад, використовуючи multipart/form-data)

https://www.mediawiki.org/wiki/API:Upload

Параметри:

filename: Цільова назва файлу.
comment: Коментар завантаження. Також використовується як початковий текст сторінок для нових файлів, якщо text не вказано.; За замовчуванням: (пусто)
text: Початковий текст сторінок для нових файлів.
watch: Застарілий.; Спостерігати за сторінкою.; Тип: логічний (деталі)
watchlist: Безумовно додати або вилучити сторінку із списку спостереження поточного користувача, використати налаштування, або не змінювати статус (не)спостереження.; Одне значення: watch, preferences, nochange; За замовчуванням: preferences
ignorewarnings: Ігнорувати всі попередження.; Тип: логічний (деталі)
file: Вміст файлу.; Повинно бути надіслано у формі надсилання файлу використовуючи multipart/form-data.
url: URL з якого отримати файл.
filekey: Ключ, що ідентифікує попереднє завантаження яке було відкладено тимчасово
sessionkey: Застарілий.; Те ж саме, що filekey, підтримується для зворотної сумісності.
stash: Якщо вказано, сервер тимчасово відкладе файл замість додати його до репозиторію.; Тип: логічний (деталі)
filesize: Розмір файлу цілого завантаження.; Значення має бути між 0 і 104 857 600.; Тип: ціле число
offset: Зміщення шматка в байтах.; Значення має бути не менше 0.; Тип: ціле число
chunk: Шматок вмісту.; Повинно бути надіслано у формі надсилання файлу використовуючи multipart/form-data.
async: Зробити операції з потенційно великими файлами асинхронними коли можливо.; Тип: логічний (деталі)
asyncdownload: Зробити отримання за URL асинхронним.; Тип: логічний (деталі)
leavemessage: Якщо використовується asyncdownload, залишити повідомлення на сторінці обговорення користувача при закінченні.; Тип: логічний (деталі)
statuskey: Отримати статус завантаження для цього ключа файлу (завантаження за URL)
checkstatus: Отримувати статус завантаження лише для даного ключа файлу.; Тип: логічний (деталі)
token: Токен «csrf» отримано з action=query&meta=tokens; Цей параметр є обов'язковим.

Приклади:

Завантаження з URL.: api.php?action=upload&filename=Wiki.png&url=http%3A//upload.wikimedia.org/wikipedia/en/b/bc/Wiki.png&token=123ABC
Завершити завантаження, що не вдалось через попередження.: api.php?action=upload&filename=Wiki.png&filekey=filekey&ignorewarnings=1&token=123ABC

action=userrights

(main • userrights)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Змінити членство користувача у групах.

https://www.mediawiki.org/wiki/API:User_group_membership

Параметри:

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

(main • watch)

Цей модуль вимагає прав на читання.
Цей модуль вимагає прав на запис.
Цей модуль приймає лише POST-запити.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Додати або вилучити сторінки з списку спостереження поточного користувача.

https://www.mediawiki.org/wiki/API:Watch

Параметри:

title

Застарілий.

Сторінки до додання/вилучення. Використовуйте titles натомість.

unwatch

Якщо вказано, сторінку буде вилучено зі списку спостереження замість додання до нього.

Тип: логічний (деталі)

continue

Коли доступно більше результатів, використовуйте це, щоб продовжити.

titles

Список назв над якими працювати.

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

pageids

Список ідентифікаторів сторінок над якими працювати.

Тип: список цілих чисел

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

revids

Список ідентифікаторів версій над якими працювати.

Тип: список цілих чисел

Розділіть значення з допомогою |. Максимальна кількість значень — 50 (500 для ботів).

generator

Отримати список сторінок над якими працювати шляхом виконання вказаного модуля запиту.

Примітка: Назви параметрів генератора повинні мати префікс «g», див. приклади.

redirects

Автоматично вирішувати перенаправлення у titles, pageids, і revids, та у сторінках, повернених generator.

Тип: логічний (деталі)

converttitles

Тип: логічний (деталі)

token

Токен «watch» отримано з action=query&meta=tokens

Цей параметр є обов'язковим.

Приклади:

Спостерігати за сторінкою Головна сторінка.: api.php?action=watch&titles=Main_Page&token=123ABC
Вилучити сторінку Головна сторінка зі списку спостереження.: 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+

Вивести дані у форматі PHP var_export().

https://www.mediawiki.org/wiki/API:Data_formats

Приклад:

Повернути результат запиту у форматі DBG.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbg

format=dbgfm

(main • dbgfm)

Цей модуль є застарілим.
Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вивести дані у форматі PHP var_export() (вивід відформатованого коду за допомогою HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Приклад:

Повернути результат запиту у форматі DBG.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=dbgfm

format=json

(main • json)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вивести дані у форматі JSON.

https://www.mediawiki.org/wiki/API:Data_formats

Параметри:

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

(main • jsonfm)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вивести дані у форматі JSON (вивід відформатованого коду за допомогою HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Параметри:

callback

utf8

Тип: логічний (деталі)

ascii

Тип: логічний (деталі)

formatversion

Форматування виводу:

1: Формат зворотної сумісності (булеви XML-стилю, * ключі для вузлів вмісту тощо).
2: Експериментальний сучасний формат. Деталі можуть змінюватись.
latest: Використовувати найостанніший формат (наразі 2). Може змінюватись без попередження.

Одне значення: 1, 2, latest

За замовчуванням: 1

Приклад:

Повернути результат запиту у форматі JSON.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=jsonfm

format=none

(main • none)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Нічого не виводити.

https://www.mediawiki.org/wiki/API:Data_formats

Приклад:

Повернути результат запиту у форматі NONE.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=none

format=php

(main • php)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Виводити дані у форматі серіалізованого PHP.

https://www.mediawiki.org/wiki/API:Data_formats

Параметр:

formatversion

Форматування виводу:

1: Формат зворотної сумісності (булеви XML-стилю, * ключі для вузлів вмісту тощо).
2: Експериментальний сучасний формат. Деталі можуть змінюватись.
latest: Використовувати найостанніший формат (наразі 2). Може змінюватись без попередження.

Одне значення: 1, 2, latest

За замовчуванням: 1

Приклад:

Повернути результат запиту у форматі PHP.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=php

format=phpfm

(main • phpfm)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Виводити дані у форматі серіалізованого PHP (вивід відформатованого коду за допомогою HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Параметр:

formatversion

Форматування виводу:

1: Формат зворотної сумісності (булеви XML-стилю, * ключі для вузлів вмісту тощо).
2: Експериментальний сучасний формат. Деталі можуть змінюватись.
latest: Використовувати найостанніший формат (наразі 2). Може змінюватись без попередження.

Одне значення: 1, 2, latest

За замовчуванням: 1

Приклад:

Повернути результат запиту у форматі PHP.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=phpfm

format=rawfm

(main • rawfm)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Виводити дані у форматі JSON разом з елементами налагодження (вивід відформатованого коду за допомогою HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Приклад:

Повернути результат запиту у форматі RAW.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=rawfm

format=txt

(main • txt)

Цей модуль є застарілим.
Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Виводити дані у форматі PHP print_r().

https://www.mediawiki.org/wiki/API:Data_formats

Приклад:

Повернути результат запиту у форматі TXT.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=txt

format=txtfm

(main • txtfm)

Цей модуль є застарілим.
Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Виводити дані у форматі PHP print_r() (вивід відформатованого коду за допомогою HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Приклад:

Повернути результат запиту у форматі TXT.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=txtfm

format=xml

(main • xml)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Виводити дані у форматі XML.

https://www.mediawiki.org/wiki/API:Data_formats

Параметри:

xslt: Якщо вказано, додає названу сторінку як таблицю стилів XSL. Це значення повинне бути назвою у просторі назв MediaWiki, що закінчується на .xsl.
includexmlnamespace: Якщо вказано, додає простір назв XML.; Тип: логічний (деталі)

Приклад:

Повернути результат запиту у форматі XML.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=xml

format=xmlfm

(main • xmlfm)

Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вивести дані у форматі XML (вивід відформатованого коду за допомогою HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Параметри:

xslt: Якщо вказано, додає названу сторінку як таблицю стилів XSL. Це значення повинне бути назвою у просторі назв MediaWiki, що закінчується на .xsl.
includexmlnamespace: Якщо вказано, додає простір назв XML.; Тип: логічний (деталі)

Приклад:

Повернути результат запиту у форматі XML.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=xmlfm

format=yaml

(main • yaml)

Цей модуль є застарілим.
Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вивести дані у форматі YAML.

https://www.mediawiki.org/wiki/API:Data_formats

Параметри:

callback

utf8

Тип: логічний (деталі)

ascii

Тип: логічний (деталі)

formatversion

Форматування виводу:

1: Формат зворотної сумісності (булеви XML-стилю, * ключі для вузлів вмісту тощо).
2: Експериментальний сучасний формат. Деталі можуть змінюватись.
latest: Використовувати найостанніший формат (наразі 2). Може змінюватись без попередження.

Одне значення: 1, 2, latest

За замовчуванням: 1

Приклад:

Повернути результат запиту у форматі YAML.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=yaml

format=yamlfm

(main • yamlfm)

Цей модуль є застарілим.
Цей модуль вимагає прав на читання.
Джерело: MediaWiki
Ліцензія: GPL-2.0+

Вивести дані у форматі YAML (вивід відформатованого коду за допомогою HTML).

https://www.mediawiki.org/wiki/API:Data_formats

Параметри:

callback

utf8

Тип: логічний (деталі)

ascii

Тип: логічний (деталі)

formatversion

Форматування виводу:

1: Формат зворотної сумісності (булеви XML-стилю, * ключі для вузлів вмісту тощо).
2: Експериментальний сучасний формат. Деталі можуть змінюватись.
latest: Використовувати найостанніший формат (наразі 2). Може змінюватись без попередження.

Одне значення: 1, 2, latest

За замовчуванням: 1

Приклад:

Повернути результат запиту у форматі YAML.: api.php?action=query&meta=siteinfo&siprop=namespaces&format=yamlfm

Типи даних

Деякі типи параметрів у запитах API потребують ширшого пояснення:

boolean

Логічні параметри працюють як галочки HTML: якщо параметр вказано, не залежно від значення, він вважається істинним. Щоб значення було хибним, пропустіть параметр зовсім.

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:

Roan Kattouw (головний розробник вер. 2007–2009)
Victor Vasiliev
Bryan Tong Minh
Sam Reed
Yuri Astrakhan (творець, головний розробник вер. 2006 – вер. 2007)
Brad Jorsch (головний розробник 2013 – тепер)

Будь ласка, надсилайте свої коментарі, пропозиції та запитання на mediawiki-api@lists.wikimedia.org або зафайліть звіт про баґ на https://phabricator.wikimedia.org/.

Отримано з http://movahistory.org.ua/index.php/Спеціальна:ApiHelp

Довідка API Медіавікі

Головний модуль

action=block

action=checktoken

action=clearhasmsg

action=compare

action=createaccount

action=delete

action=edit

action=emailuser

action=expandtemplates

action=feedcontributions

action=feedrecentchanges

action=feedwatchlist

action=filerevert

action=help

action=imagerotate

action=import

action=login (lg)

action=logout

action=managetags

action=move

action=opensearch

action=options

action=paraminfo

action=parse

action=patrol

action=protect

action=purge

action=query

prop=categories (cl)

prop=categoryinfo (ci)

prop=contributors (pc)

prop=deletedrevisions (drv)

prop=duplicatefiles (df)

prop=extlinks (el)

prop=fileusage (fu)

prop=imageinfo (ii)

prop=images (im)

prop=info (in)

prop=iwlinks (iw)

prop=langlinks (ll)

prop=links (pl)

prop=linkshere (lh)

prop=pageprops (pp)

prop=redirects (rd)

prop=revisions (rv)

prop=stashimageinfo (sii)

prop=templates (tl)

prop=transcludedin (ti)

list=allcategories (ac)

list=alldeletedrevisions (adr)

list=allfileusages (af)

list=allimages (ai)

list=alllinks (al)

list=allpages (ap)

list=allredirects (ar)

list=alltransclusions (at)

list=allusers (au)

list=backlinks (bl)

list=blocks (bk)

list=categorymembers (cm)

list=deletedrevs (dr)

list=embeddedin (ei)

list=exturlusage (eu)

list=filearchive (fa)

list=gadgetcategories (gc)

list=gadgets (ga)

list=imageusage (iu)

list=iwbacklinks (iwbl)

list=langbacklinks (lbl)

list=logevents (le)

list=pagepropnames (ppn)

list=pageswithprop (pwp)

list=prefixsearch (ps)

list=protectedtitles (pt)

list=querypage (qp)

list=random (rn)

list=recentchanges (rc)

list=search (sr)