API:Client code/All

From MediaWiki.org
Jump to navigation Jump to search

This page contains a set of lists, by language, of all known client libraries that can be used with the MediaWiki Action API.

API client libraries[edit]

Dates and version numbers were updated on 2019-06-19.
Last evaluation for recommended libraries(API:Client_code) was done on 2019-06-19.

Awk[edit]

Name Description Last release Release Date Last activity
BotWikiAwk Framework and libraries for creating bots. Includes example bots. March 27, 2019
Wikiget Awk CLI program to interface with MediaWiki API for read/write including OAuth. June 8, 2019

C++[edit]

Name Description Last release Release Date Last activity
libmediawiki. A library that allows easy editing of a wiki through the MediaWiki API. September 9, 2017

Common Lisp[edit]

Name Description Last release Release Date Last activity
cl-mediawiki A Common Lisp wrapper for the Mediawiki API. November 10th, 2016

Go[edit]

Name Description Last release Release Date Last activity
go-mediawiki Go wrapper for the MediaWiki API. v0.1 November 4, 2013 February 8, 2017
go-mwclient Wrapper for the MediaWiki API (supports maxlag, query continuations, OAuth). 1.0.3 August 3, 2018 August 3, 2018

Haskell[edit]

Name Description Last release Release Date Last activity
haskell mediawiki A complete Haskell binding to the MediaWiki API letting you programmatically access (read and write) MediaWiki content. 0.2.6 November 20, 2013 November 20, 2013

Java[edit]

Name Description Last release Release Date Last activity
Bliki Engine Can convert wikicode to HTML, DocBook or PDF. Has a helper library for API calls April 27, 2019
dkpro-jwpl Java Wikipedia Library Facilitates access to all information in Wikipedia. 1.1.0 April 26, 2016 October 10, 2018
dkpro-jwktl Java Wiktionary Library. Enables efficient and structured access to the information encoded in the English and German Wiktionary language. 1.1.0 April 29, 2016 April 15, 2019
JavaWikiBotFramework A library to retrieve data from and maintain MediaWiki-based wikis such as Wikipedia. 4.0.0 September 13, 2016 February 15, 2019
jwiki A library for effortlessly interacting with Wikipedia/MediaWiki. 1.7.0 November 2, 2018 June 1, 2019
Kaspar Framework for editing MediaWiki wikis. 0.2 July 18, 2015 January 14, 2016
Mediawiki-Japi An API for the MediaWiki web API. 0.1.03 March 20, 2019 March 20, 2019
Wiki.java A MediaWiki bot framework. 0.36 February 8, 2019 June 19, 2019
Wikidata Toolkit A library with functions to process data from Wikidata and other Wikibase sites, via XML dumps or the API. For more info, see Wikidata Toolkit. 0.10.0 June 12, 2019 June 14, 2019
WPCleaner WPCleaner is a tool designed to help with various maintenance tasks on wikis run with MediaWiki software. June 21, 2019

JavaScript[edit]

Name Description Last release Release Date Last activity
wikidata-sdk (Node.js) Wikidata SDK is a javascript toolkit for querying Wikidata.org and simplify its results. v7.0.8 June 5, 2019 June 2, 2019
mwbot (Node.js) MWBot uses the Promise pattern and other ES6 methodologies, optimised for creating bots that make edits. Works with any MediaWiki site. v1.0.10 October 30, 2017 February 20, 2019
wikijs (Node.js) WikiJs provides a high-level interface for editing, querying and searching through the API. Works with any MediaWiki site. v4.11.1 January 6, 2019 June 12, 2019
nodemw (Node.js) A generic MediaWiki API client for Node.js. v0.12.2 September 16, 2018 September 16, 2018
mediawiki (Node.js) This JavaScript framework provides methods for common use cases (e.g. log in, read, edit, etc.) as well as a generic API client. Includes handling for rate throttling. July 2, 2014
mediawiki-js (browser) Ultra-light, vanilla JavaScript wrapper of Mediawiki API for use in the browser (npm). June 5, 2018
CeJS (Node.js, browser) A JavaScript framework including MediaWiki functions to build bots, running on Node.js and in the browser. See Wikipedia bot examples. 2.0.0 October 28, 2015 June 22, 2019
mediawiki.api (browser) Generic MediaWiki API client for client-side JavaScript. It ships with MediaWiki core as a ResourceLoader module bundle. It abstracts some high-level concepts and provides a generic client for other queries. Maintained as part of MediaWiki.

In-wiki JavaScript clients:

Name Description Last release Release Date Last activity
mwapilib2 A layer overtop of the requests. Make JS gadgets easier. September 25, 2016
JsMwApi A convenience wrapper around raw requests, with some helpers for editing and parsing. June 11, 2014

Lua[edit]

Name Description Last release Release Date Last activity
mediawikiapi Makes query (tokens, userinfo), clientlogin, upload, and logout calls. It handles HTTPS requests and cookies and can be used to upload files to Wikimedia Commons. September 20, 2018

MATLAB[edit]

Name Description Last release Release Date Last activity
MatWiki A preliminary (as of Feb 2019) MATLAB R2016b(9.1.x) client supporting just bot-logins & semantic #ask queries. v1.0.0 February 19, 2019 February 19, 2019

.NET[edit]

Name Description Last release Release Date Last activity
AutoWikiBrowser's WikiFunctions library has classes for editing and getting lists of pages via the API. 6.0.0.1 September 15, 2018 June 16, 2019
DotNetWikiBot Framework Written in C#, based on Microsoft® .NET Framework 3.5 (Tutorial). February 16, 2016
MorebitsDotNet Contains C# code for uploading files through the API. February 15, 2016
LinqToWiki Strongly typed library for accessing most of MediaWiki API, with support for autocompletion. 1.5.0 May 7, 2015 May 7, 2015
WikiClientLibrary A .NET Standard & asynchronous MediaWiki API client library for wiki sites. The library also supports Flow/Wikibase/Wikia-specific API. v0.7.0-int.2 May 26, 2019 May 31, 2019

OCaml[edit]

Name Description Last release Release Date Last activity
ocaml-mediawiki A high-level binding for the MediaWiki API written in OCaml. August 29, 2012

Perl[edit]

Name Description Last release Release Date Last activity
MediaWiki::Bot A higher-level Perl module with read and write functions. Easily extensible with plugins, for example to provide administrator functions (Evaluation).

source code on Github.

5.006003 July 7, 2016 July 7, 2016
MediaWiki::API A Perl module for interfacing with the MediaWiki API with file upload/download and editing support. (Debian package). (Evaluation). 0.41 November 13, 2015 November 13, 2015

PHP[edit]

Name Description Last release Release Date Last activity
Apibot A modular, somewhat ambitious bot with overlayed UNIX-like framework. 0.4.0
mediawiki-api-base Library for basic MediaWiki api use. 2.4.0 November 2,2017 July 30, 2018
mediawiki-api A simple library for interacting with the MediaWiki API. 0.7.2 November 20, 2017 April 6, 2019
wikibase-api Library for querying Wikidata. 0.7 July 4, 2016 August 17, 2018
wikidrain A wrapper for the WikiMedia API centralized around easily and simply querying Wikipedia articles. April 15, 2016
MediaWiki_Api A simple PHP curl based API wrapper with basic functionality. Almost completely undocumented. v1.0.0 June 21, 2018 January 10, 2019
Wikimate Gets and edits MediaWiki pages. v0.12.0 February 3, 2017 June 19, 2019
boz-mw Also support image upload and read/write in Wikibase/Wikidata. Inline documentation. 0.1.0 2018 Sept 29, 2019

There are many PHP frameworks for the api, see here for a full list and comparison of frameworks.

Python[edit]

Name Description Last release Release Date Last activity
Pywikibot A collection of python scripts and a powerful library for bot writing. (Git repository) (IRC) (Evaluation). 3.0.20190430 April 30, 2019 June 22, 2019
mwclient Python library that makes most of the API functions accessible. Last release: v0.9.3, November 2018. (PyPI) (Evaluation). 0.9.3 November 23, 2018 June 10, 2019
Wikipedia-API Easy to use Python 3 library. Provides read-only API. Last release: v0.4.3, January 2019. 0.5.1 April 7, 2019 April 7, 2019
ceterach Python3 library, fully PEP8 compliant. December 14, 2018
wptools Wikipedia tools (for Humans). Read-only API. v0.4.17 August 17, 2018 August 17, 2018
wiki-scripts Framework for writing bots, maintenance scripts or performing data analysis. 1.2 December 31, 2017 June 13, 2019
Pattern (GitHub) Web mining module, has classes for handling MediaWiki API requests, handles continuations. 2.6 July 8, 2013 August 18, 2018

Simple Python wrappers for no-abstraction interfaces to the MediaWiki API and basic session handling:

Name Description Last release Release Date Last activity
pywikiapi A minimalistic library that handles some of the core MediaWiki API complexities like handling continuations, login, errors, and warnings, but does not impose any additional abstraction layers. 1.3.2 April 13, 2019 April 13, 2019
simplemediawiki Python 2.6+ and 3.3+ compatible. Docs. Last updated in March 2017. (PyPI) (Evaluation) 1.2.0b2 August 12, 2013 March 16, 2017
python-mwapi Simple Python Wrapper around MediaWiki API v0.5.0 September 15, 2015 May 18, 2019
async_mediawiki An asynchronous python libary to get mediawiki content 0.2.0 October 31, 2018 March 28, 2019
analytics-zero-sms October 21, 2015
mwstreaming A collection of scripts and utilities to support the stream-processing of MediaWiki data. 0.55 April 15, 2015 April 15, 2015
Wikipedia A Python library that makes it easy to access and parse data from Wikipedia. v1.1 December 24, 2013 November 11, 2016
wikitools Provides several layers of abstraction around the API. Doesn't support Python 3. 0.41

June 7, 2015

August 28, 2016

R[edit]

Name Description Last release Release Date Last activity
WikipediR A wrapper for the MediaWiki API, aimed particularly at the Wikimedia 'production' wikis, such as Wikipedia. Can be used to retrieve page text, information about users or the history of pages, and elements of the category tree. 1.5.0 February 15, 2017 February 15, 2017

Ruby[edit]

Name Description Last release Release Date Last activity
Mediawiki Ruby API Ruby API client library in active development by Wikimedia Foundation Release Engineering. 0.71 January 31, 2017 December 5, 2017
MediaWiki::Gateway Ruby framework for the API. v1.1.0 January 5, 2016 January 5, 2016
wikipedia-client Ruby framework using the API. v1.10.0 March 5, 2018 March 5, 2018
Sunflower Provides Ruby access to MediaWiki API; can be used as a base for more sophisticated bots or as standalone by beginners. 0.5.12 May 14, 2016 May 14, 2016
MediaWiki::Butt Stable but powerful Ruby framework for the API in active development. (Evaluation). 3.0.0 October 19, 2017 January 3, 2019
MediaWiktory (low-level) and Infoboxer (high-level, semantic) clients to MediaWiki, with idiomatic API, support for custom Wiki modules. v0.1.3 February 8, 2018 February 8, 2018

Rust[edit]

Name Description Last release Release Date Last activity
mediawiki-rs Wrapper for the MediaWiki API. June 30, 2018
WP:RS An extremely low-level wrapper to the MediaWiki API. June 27, 2017
Wikibase RS Rust library to talk to the Wikibase API and serialize data into Rust data structures. 0.37 June 19, 2019 Jun 19, 2019
mediawiki_rust A MediaWiki client library in Rust. June 23, 2019

Scala[edit]

Name Description Last release Release Date Last activity
scalawiki MediaWiki client in Scala. 0.6.0 May 29, 2019 June 23, 2019
dbpedia extraction framework Data extraction framework for DBpedia with support Wiki source retrived via MediaWiki API. DBpedia_2015-10 July 25, 2016 April 13, 2019
scmw Simple MediaWiki API wrapper for needs of Commonist image upload tool. v-0.140.0 December 22, 2017 December 22, 2017