API reference

High-level request structure

User code mainly interacts with pywikibot.Page objects, which represent pages on a specific wiki. These objects get their properties by calling functions on their associated pywikibot.Site object, which represents a specific wiki.

The pywikibot.Site object then calls the MediaWiki API using the functions provided by data.api. This layer then uses comms.http.request() to do the actual HTTP request.

Table of contents

• pywikibot — Base Classes and Functions
  • Bot
  • Category
  • Claim
  • Coordinate
  • CurrentPageBot
  • FilePage
  • ItemPage
  • LexemeForm
  • LexemePage
  • LexemeSense
  • Link
  • MediaInfo
  • Page
  • PropertyPage
  • Site()
  • SiteLink
  • Timestamp
  • User
  • WbGeoShape
  • WbMonolingualText
  • WbQuantity
  • WbTabularData
  • WbTime
  • WbUnknown
  • WikidataBot
  • async_manager()
  • async_request()
  • calledModuleName()
  • critical()
  • debug()
  • error()
  • exception()
  • handle_args()
  • html2unicode()
  • info()
  • input()
  • input_choice()
  • input_yn()
  • log()
  • output()
  • page_put_queue
  • showDiff()
  • show_help()
  • sleep()
  • stdout()
  • stopme()
  • translate()
  • url2unicode()
  • warning()
• config — Pywikibot Config File
  • API reference
  • Option setting
• page — MediaWiki Pages
  • BaseLink
  • BasePage
  • Category
  • Claim
  • FileInfo
  • FilePage
  • ItemPage
  • LexemeForm
  • LexemePage
  • LexemeSense
  • Link
  • MediaInfo
  • Page
  • Property
  • PropertyPage
  • Revision
  • SiteLink
  • User
  • WikibaseEntity
  • WikibasePage
  • html2unicode()
  • url2unicode()
  • page._collections Wikibase Entity Structures
  • page._decorators — Page Decorators
  • page._revision — Page Revision
  • page._toolforge module
• proofreadpage — ProofreadPage Extension
  • FullHeader
  • IndexPage
  • PagesTagParser
  • ProofreadPage
  • PurgeRequest
  • TagAttr
  • TagAttrDesc
  • check_if_cached()
  • decompose()
• pagegenerators — Page Generators
  • GENERATOR OPTIONS
  • FILTER OPTIONS
  • AllpagesPageGenerator()
  • AncientPagesPageGenerator()
  • CategorizedPageGenerator()
  • CategoryFilterPageGenerator()
  • DayPageGenerator()
  • DeadendPagesPageGenerator()
  • DequePreloadingGenerator()
  • EdittimeFilterPageGenerator()
  • FileLinksGenerator()
  • GeneratorFactory
  • GoogleSearchPageGenerator
  • ImagesPageGenerator()
  • InterwikiPageGenerator()
  • ItemClaimFilterPageGenerator()
  • LanguageLinksPageGenerator()
  • LinkedPageGenerator()
  • LinksearchPageGenerator()
  • LiveRCPageGenerator()
  • LogeventsPageGenerator()
  • LonelyPagesPageGenerator()
  • LongPagesPageGenerator()
  • MySQLPageGenerator()
  • NamespaceFilterPageGenerator()
  • NewimagesPageGenerator()
  • NewpagesPageGenerator()
  • PageClassGenerator()
  • PageTitleFilterPageGenerator()
  • PageWithTalkPageGenerator()
  • PagesFromPageidGenerator()
  • PagesFromTitlesGenerator()
  • PetScanPageGenerator
  • PrefixingPageGenerator()
  • PreloadingEntityGenerator()
  • PreloadingGenerator()
  • QualityFilterPageGenerator()
  • RandomPageGenerator()
  • RandomRedirectPageGenerator()
  • RecentChangesPageGenerator()
  • RedirectFilterPageGenerator()
  • RegexBodyFilterPageGenerator()
  • RegexFilterPageGenerator()
  • RepeatingGenerator()
  • SearchPageGenerator()
  • ShortPagesPageGenerator()
  • SubCategoriesPageGenerator()
  • SubpageFilterGenerator()
  • TextIOPageGenerator()
  • UnCategorizedCategoryGenerator()
  • UnCategorizedImageGenerator()
  • UnCategorizedPageGenerator()
  • UnCategorizedTemplateGenerator()
  • UnconnectedPageGenerator()
  • UnusedFilesGenerator()
  • UnwatchedPagesPageGenerator()
  • UserContributionsGenerator()
  • UserEditFilterGenerator()
  • WantedPagesPageGenerator()
  • WikibaseItemFilterPageGenerator()
  • WikibaseItemGenerator()
  • WikibaseSearchItemPageGenerator()
  • WikidataPageFromItemGenerator()
  • WikidataSPARQLPageGenerator()
  • WithoutInterwikiPageGenerator()
  • XMLDumpOldPageGenerator()
  • XMLDumpPageGenerator
  • YearPageGenerator()
  • page_with_property_generator()
  • pagegenerators._factory — Pagegenerators Options Handler
  • pagegenerators._filters — Filter Funtions
  • pagegenerators._generators — Generator Functions
• site — MediaWiki sites
  • BaseSite — Base Class for Sites
  • APISite — API Interface for Sites
  • DataSite — API Interface for Wikibase
  • Obsolete Sites — Outdated Sites
  • Siteinfo — Site Info Container
  • Namespace — Namespace Object
  • TokenWallet — Token Wallet
  • Uploader — Uploader Interface
• login module
  • BotPassword
  • ClientLoginManager
  • LoginManager
  • LoginStatus
  • OauthLoginManager
• logentries module
  • BlockEntry
  • LogEntry
  • LogEntryFactory
  • MoveEntry
  • OtherLogEntry
  • PatrolEntry
  • RightsEntry
  • UploadEntry
  • UserTargetLogEntry
• family — MediaWiki families
  • Family
  • AutoFamily()
  • DefaultWikibaseFamily
  • Family
  • FandomFamily
  • SingleSiteFamily
  • SubdomainFamily
  • WikibaseFamily
  • WikimediaFamily
  • WikimediaOrgFamily
• families — Family Config Files
  • families.commons_family — Commons
  • families.foundation_family — Foundation Wiki
  • families.i18n_family — Translate Wiki
  • families.incubator_family — Incubator
  • families.lingualibre_family — Lingua Libre
  • families.mediawiki_family — MediaWiki
  • families.meta_family — Meta
  • families.osm_family — OpenStreetMap
  • families.outreach_family — Outreach
  • families.species_family — Species
  • families.vikidia_family — Vikidia
  • families.wikibooks_family — Wikibooks
  • families.wikidata_family — Wikidata
  • families.wikifunctions_family — Wikifunctions
  • families.wikihow_family — Wikihow
  • families.wikimania_family — Wikimania
  • families.wikimediachapter_family — Wikimedia Chapter
  • families.wikinews_family — Wikinews
  • families.wikipedia_family — Wikipedia
  • families.wikiquote_family — Wikiquote
  • families.wikisource_family — Wikisource
  • families.wikisopore_family — Wikispore
  • families.wikitech_family — Wikitech
  • families.wikiversity_family — Wikiversity
  • families.wikivoyage_family— Wikivoyage
  • families.wiktionary_family — Wiktionary
  • families.wowwiki_family — Fandom WOW
• data — Data Exchange
  • WaitingMixin
  • data.api — MediaWiki API Requests
  • data.memento — Memento Requests
  • data.mysql — Mysql Requests
  • data.sparql — SPARQL requests
  • data.wikistats — WikiStats requests
• comms — Communication layer
  • comms.eventstreams — Server-Sent Events Client
  • comms.http — HTTP access interface
• exceptions — Exceptions and Warning Classes
  • APIError
  • APIMWError
  • AbuseFilterDisallowedError
  • ArgumentDeprecationWarning
  • ArticleExistsConflictError
  • AutoblockUserError
  • CaptchaError
  • CascadeLockedPageError
  • CircularRedirectError
  • Client414Error
  • ClientError
  • CoordinateGlobeUnknownError
  • EditConflictError
  • EntityTypeUnknownError
  • Error
  • FamilyMaintenanceWarning
  • FatalServerError
  • HiddenKeyError
  • InconsistentTitleError
  • InterwikiRedirectPageError
  • InvalidPageError
  • InvalidTitleError
  • IsNotRedirectPageError
  • IsRedirectPageError
  • LockedNoPageError
  • LockedPageError
  • MaxlagTimeoutError
  • NoCreateError
  • NoMoveTargetError
  • NoPageError
  • NoSiteLinkError
  • NoUsernameError
  • NoWikibaseEntityError
  • NotEmailableError
  • NotImplementedWarning
  • OtherPageSaveError
  • PageCreatedConflictError
  • PageDeletedConflictError
  • PageInUseError
  • PageLoadRelatedError
  • PageRelatedError
  • PageSaveRelatedError
  • SectionError
  • Server504Error
  • ServerError
  • SiteDefinitionError
  • SpamblacklistError
  • TimeoutError
  • TitleblacklistError
  • TranslationError
  • UnknownExtensionError
  • UnknownFamilyError
  • UnknownSiteError
  • UnsupportedPageError
  • UploadError
  • UserRightsError
  • VersionParseError
  • WikiBaseError
• textlib — Changing Wikitext
  • Content
  • MultiTemplateMatchBuilder
  • Section
  • TimeStripper
  • TimeStripperPatterns
  • _create_default_regexes()
  • add_text()
  • case_escape()
  • categoryFormat()
  • compileLinkR()
  • does_text_contain_section()
  • expandmarker()
  • extract_sections()
  • extract_templates_and_params()
  • extract_templates_and_params_regex_simple()
  • findmarker()
  • getCategoryLinks()
  • getLanguageLinks()
  • get_regexes()
  • glue_template_and_params()
  • ignore_case()
  • interwikiFormat()
  • interwikiSort()
  • isDisabled()
  • reformat_ISBNs()
  • removeCategoryLinks()
  • removeCategoryLinksAndSeparator()
  • removeDisabledParts()
  • removeHTMLParts()
  • removeLanguageLinks()
  • removeLanguageLinksAndSeparator()
  • replaceCategoryInPlace()
  • replaceCategoryLinks()
  • replaceExcept()
  • replaceLanguageLinks()
  • replace_links()
  • to_latin_digits()
  • to_local_digits()
• cosmetic_changes — Cosmetic Changes of Wikitext
  • CANCEL
  • CosmeticChangesToolkit
• bot — Classes for Building Bots
  • critical()
  • debug()
  • error()
  • exception()
  • log()
  • warning()
  • output()
  • stdout()
  • LoggingFormatter
  • set_interface()
  • init_handlers()
  • writelogheader()
  • input()
  • input_choice()
  • input_yn()
  • input_list_choice()
  • ui
  • Option
  • StandardOption
  • NestedOption
  • IntegerOption
  • ContextOption
  • ListOption
  • ShowingListOption
  • MultipleChoiceList
  • ShowingMultipleChoiceList
  • OutputProxyOption
  • HighlightContextOption
  • ChoiceException
  • UnhandledAnswer
  • Choice
  • StaticChoice
  • LinkChoice
  • AlwaysChoice
  • QuitKeyboardInterrupt
  • InteractiveReplace
  • calledModuleName()
  • handle_args()
  • show_help()
  • suggest_help()
  • writeToCommandLogFile()
  • open_webbrowser()
  • OptionHandler
  • BaseBot
  • Bot
  • ConfigParserBot
  • SingleSiteBot
  • MultipleSitesBot
  • CurrentPageBot
  • AutomaticTWSummaryBot
  • ExistingPageBot
  • FollowRedirectPageBot
  • CreatingPageBot
  • RedirectPageBot
  • NoRedirectPageBot
  • WikidataBot
• specialbots — Special Reusable Bots
  • BaseUnlinkBot
  • InteractiveUnlink
  • UploadRobot
• bot_choice — UI Options and Choices
  • AlwaysChoice
  • Choice
  • ChoiceException
  • ContextOption
  • HighlightContextOption
  • IntegerOption
  • LinkChoice
  • ListOption
  • MultipleChoiceList
  • NestedOption
  • Option
  • OutputOption
  • OutputProxyOption
  • QuitKeyboardInterrupt
  • ShowingListOption
  • ShowingMultipleChoiceList
  • StandardOption
  • StaticChoice
  • UnhandledAnswer
• userinterfaces — User interfaces
  • _interface_base — Abstract User Interface
  • terminal_interface module — Terminal User Interface
  • terminal_interface_base — Base Terminal Interface
  • terminal_interface_unix — Unix Terminal Interface
  • terminal_interface_win32 —- Windows Terminal Interface
  • buffer_interface — Buffer Interface
  • gui — Graphical User Interface
  • transliteration — Transliteration
• logging — Logging Functions
  • STDOUT
  • VERBOSE
  • INPUT
  • add_init_routine()
  • logoutput()
  • info()
  • output()
  • stdout()
  • warning()
  • error()
  • log()
  • critical()
  • debug()
  • exception()
• daemonize — Daemonize Current Process (Unix only)
  • daemonize()
• date — Date Classes and Functions
  • MonthFormat
  • MonthNames
  • addFmt1()
  • alwaysTrue()
  • apply_month_delta()
  • decSinglVal()
  • dh()
  • dh_centuryAD()
  • dh_centuryBC()
  • dh_constVal()
  • dh_dayOfMnth()
  • dh_decAD()
  • dh_decBC()
  • dh_millenniumAD()
  • dh_millenniumBC()
  • dh_mnthOfYear()
  • dh_noConv()
  • dh_number()
  • dh_simpleYearAD()
  • dh_singVal()
  • dh_yearAD()
  • dh_yearBC()
  • encDec0()
  • encDec1()
  • escapePattern2()
  • formatYear()
  • format_date()
  • getAutoFormat()
  • get_month_delta()
  • intToLocalDigitsStr()
  • intToRomanNum()
  • localDigitsStrToInt()
  • makeMonthList()
  • makeMonthNamedList()
  • monthName()
  • multi()
  • romanNumToInt()
  • slh()
• time — Time Classes and Functions
  • MW_KEYS
  • TZoneFixedOffset
  • Timestamp
  • parse_duration()
  • str2timedelta()
• diff — Helpers for computing deltas
  • Hunk
  • PatchManager
  • cherry_pick()
  • html_comparator()
• echo — Echo Extension Classes and functions
  • Notification
• editor — Text editor class
  • TextEditor
• fixes — standard fixes for replace.py script
• flow — Flow Entities
  • Board
  • FlowPage
  • Post
  • Topic
• i18n — i18n Support
  • bundles()
  • get_bot_prefix()
  • input()
  • known_languages()
  • messages_available()
  • set_messages_package()
  • translate()
  • twget_keys()
  • twhas_key()
  • twtranslate()
• plural — i18n Plural rules
  • plural_rule()
• interwiki_graph — Graphviz Drawing for Interwiki
  • GraphDrawer
  • GraphSavingThread
  • Subject
  • getFilename()
• titletranslate — Interwiki Title Translator
  • translate()
• tools — Miscellaneous Helper Functions
  • ComparableMixin
  • MediaWikiVersion
  • ModuleDeprecationWrapper
  • SelfCallDict
  • SelfCallMixin
  • SelfCallString
  • Version
  • add_decorated_full_name()
  • add_full_name()
  • as_filename()
  • cached()
  • classproperty
  • compute_file_hash()
  • deprecate_arg()
  • deprecated()
  • deprecated_args()
  • file_mode_checker()
  • first_lower()
  • first_upper()
  • get_wrapper_depth()
  • has_module()
  • is_ip_address()
  • issue_deprecation_warning()
  • manage_wrapping()
  • merge_unique_dicts()
  • normalize_username()
  • open_archive()
  • redirect_func()
  • remove_last_args()
  • strtobool()
  • suppress_warnings
  • tools.chars — Character Based Helper Functions
  • tools.collections — Container datatypes
  • tools.deprecate — Deprecating Decorators and Classes
  • tools.djvu — DJVU files wrapper
  • tools.formatter — Formatting Related Functions and Classes
  • tools.itertools — Iterators for Efficient Looping
  • tools.threading — Thread-based Classes
  • tools._logging — logging.Formatter Subclass
• xmlreader — XML Reader
  • XmlDump
  • XmlEntry
  • parseRestrictions()
• site_detect — Classes for Detecting MediaWiki Sites
  • MWSite
  • WikiHTMLPageParser
  • check_response()
• throttle — Slow Down Wiki I/O
  • ProcEntry
  • Throttle
  • pid
• version — Determine Pywikibot Version
  • get_module_filename()
  • get_module_mtime()
  • get_toolforge_hostname()
  • getversion()
  • getversion_git()
  • getversion_nightly()
  • getversion_onlinerepo()
  • getversion_package()
  • getversion_svn()
  • getversiondict()
  • github_svn_rev2hash()
  • package_versions()
  • svn_rev_info()
• backports — Python Backports
  • batched()
  • nullcontext
  • pairwise()
  • removeprefix()
  • removesuffix()