MediaWiki API cross reference#

See the table below for a cross reference between MediaWiki’s API and Pywikibot’s API.

action	APISite method	page method	other module method
block	`blockuser()`	`User.block()`
clientlogin	`login()`
compare	`compare()`
delete	`delete()`	`BasePage.delete()`
Deletedrevisions	`delete()`	`BasePage.delete()`
echomarkread	`notifications_mark_read()`		`echo.Notification.mark_as_read()`
edit	`editpage()`	`BasePage.save()` `BasePage.put()` `BasePage.touch()` `Page.set_redirect_target()` `BasePage.change_category()`	`proofreadpage.ProofreadPage.save()` `proofreadpage.IndexPage.save()` `bot.BaseBot.userPut()` `bot.CurrentPageBot.put_current()` `BaseUnlinkBot.unlink()`
emailuser		`User.send_email()`
expandtemplates	`expand_text()`	`BasePage.expand_text()`	`textlib.getCategoryLinks()`
flow	deprecated, see below
login	`login()`
logout	`logout()`
mergehistory	`merge_history()`	`BasePage.merge_history()`
move	`movepage()`	`BasePage.move()`
parse	`get_parsed_page()`	`BasePage.get_parsed_page()`
patrol	`patrol()`
protect	`protect()`	`BasePage.protect()`
purge	`purgepages()`	`BasePage.purge()`	`ProofreadPage.purge()`
query	see separate table (not yet)
revisiondelete	`deleterevs()`
rollback	`rollbackpage()`
shortenurl	`create_short_link()`	`BasePage.create_short_link()`
sitematrix	`fromDBName()`
thank	`thank_revision()`
unblock	`unblockuser()`	`User.unblock()`
undelete	`undelete()`	`BasePage.undelete()`
upload	`upload()` `site.Uploader.upload()`	`FilePage.upload()`	`UploadRobot.upload_file()`
watch	`watch()`	`BasePage.watch()`

Flow support#

Deprecated since version 9.4: will be removed with Pywikibot 12 or earlier (T371180).

action	APISite method	flow module method
flow	`load_board()` `load_topiclist()` `load_topic()` `load_post_current_revision()` `create_new_topic()` `reply_to_post()` `lock_topic()` `moderate_topic()` `delete_topic()` `hide_topic()` `suppress_topic()` `restore_topic()` `moderate_post()` `delete_post()` `hide_post()` `suppress_post()` `restore_post()`	`flow.Board.topics()` `flow.Topic.create_topic()` `flow.Topic.lock()` `flow.Topic.unlock()` `flow.Topic.delete_mod()` `flow.Topic.hide()` `flow.Topic.suppress()` `flow.Topic.restore()` `flow.Post.reply()` `flow.Post.delete()` `flow.Post.hide()` `flow.Post.suppress()` `flow.Post.restore()`
flowthank	`thank_post()`	`flow.Post.thank()`