modules.json

[
	{
		"filename": "tokens",
		"docstring": "Demo of `Token` module: Fetch token of type `login`",
		"endpoint": "https://www.mediawiki.org/w/api.php",
		"params": {
			"action": "query",
			"meta": "tokens",
			"type": "login",
			"format": "json"
		}
	},
	{
		"filename": "geocoordinates",
		"docstring": "Demo of `Geosearch` module: Obtain coordinates for wiki pages nearby",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"prop": "coordinates",
			"titles": "Wikimedia Foundation",
			"format": "json"
		}
	},
	{
		"filename": "geoimagesearch",
		"docstring": "Demo of `Geosearch` module: Use generator module\n\tto get search results for pages near Wikimedia HQ\n\twith images",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"generator": "geosearch",
			"prop": "coordinates|pageimages",
			"ggscoord": "37.7891838|-122.4033522",
			"format": "json"
		}
	},
	{
		"filename": "geosearch",
		"docstring": "Demo of `Geosearch` module: Search for wiki pages nearby",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "geosearch",
			"gscoord": "37.7891838|-122.4033522",
			"gsradius": "10000",
			"gslimit": "10",
			"format": "json"
		}
	},
	{
		"filename": "get_category_items",
		"docstring": "Demo of `Categorymembers` module : List twenty items in a category",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "categorymembers",
			"cmtitle": "Category:Physics",
			"cmlimit": "20",
			"format": "json"
		}
	},
	{
		"filename": "get_page_images",
		"docstring": "Demo of `Images` module: Send a GET request to obtain a JSON\n\tobject listing all of the image files embedded on a single page",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"prop": "images",
			"titles": "Albert Einstein",
			"format": "json"
		}
	},
	{
		"filename": "get_recent_category_items",
		"docstring": "Demo of `Categorymembers` module : Get the ten articles most recently added to a category",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "categorymembers",
			"cmtitle": "Category:Physics",
			"cmsort": "timestamp",
			"cmdir": "desc",
			"format": "json"
		}
	},
	{
		"filename": "get_redirects",
		"docstring": "Demo of `Redirects` module: Get all redirects to the given page(s)",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"titles": "Jacques Kallis",
			"prop": "redirects",
			"format": "json"
		}
	},
	{
		"filename": "get_subcategories",
		"docstring": "Demo of `Categorymembers` module : Get ten subcategories of a category",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "categorymembers",
			"cmtitle": "Category:Wikipedia",
			"cmtype": "subcat",
			"format": "json"
		}
	},
	{
		"filename": "languagesearch",
		"docstring": "Demo of `Languagesearch` module: Search for a language in any language",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "languagesearch",
			"search": "Gu",
			"format": "json"
		}
	},
	{
		"filename": "search",
		"docstring": "Demo of `Search` module: Search for a text or title",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "search",
			"srsearch": "Nelson Mandela",
			"format": "json"
		}
	},
	{
		"filename": "opensearch",
		"docstring": "Demo of `Opensearch` module: Search the wiki and obtain\n\tresults in an OpenSearch (http://www.opensearch.org) format",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "opensearch",
			"search": "Hampi",
			"limit": "5",
			"namespace": "0",
			"format": "json"
		}
	},
	{
		"filename": "prefixsearch",
		"docstring": "Demo of `Prefixsearch` module: Perform a prefix search for page titles",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "prefixsearch",
			"pssearch": "Star Wars",
			"format": "json"
		}
	},
	{
		"filename": "get_category_info",
		"docstring": "Demo of `Categoryinfo` module: Get information about a few categories",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"titles": "Category:Foo|Category:Infobox templates",
			"prop": "categoryinfo"
		}
	},
	{
		"filename": "parse",
		"docstring": "Demo of `Parse` module: Parse content of a page",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "parse",
			"page": "Pet door",
			"format": "json"
		}
	},
	{
		"filename": "get_pages_revisions",
		"docstring": "Demo of `Revisions` module: Get revision data with content for pages with titles [[API]] and [[Main Page]]",
		"endpoint": "https://www.mediawiki.org/w/api.php",
		"params": {
			"action": "query",
			"prop": "revisions",
			"titles": "API|Main Page",
			"rvprop": "timestamp|user|comment|content",
			"rvslots": "main",
			"formatversion": "2",
			"format": "json"
		}
	},
	{
		"filename": "get_filtered_page_revisions",
		"docstring": "Demo of `Revisions` module: Get data including content of last 5 revisions of the title [[API:Geosearch]] made after July 1st 2018 excluding changes made by the user SSethi (WMF)",
		"endpoint": "https://www.mediawiki.org/w/api.php",
		"params": {
			"action": "query",
			"prop": "revisions",
			"titles": "API:Geosearch",
			"rvlimit": "5",
			"rvprop": "timestamp|user|comment|content",
			"rvdir": "newer",
			"rvstart": "2018-07-01T00:00:00Z",
			"rvexcludeuser": "SSethi (WMF)",
			"rvslots": "main",
			"formatversion": "2",
			"format": "json"
		}
	},
	{
		"filename": "get_links",
		"docstring": "Demo of `Links` module: Get all links on the given page(s)",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"titles": "Albert Einstein",
			"prop": "links"
		}
	},
	{
		"filename": "get_info",
		"docstring": "Demo of `Info` module: Send a GET request to display information about a page.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"titles": "Albert Einstein",
			"prop": "info",
			"inprop": "url|talkid"
		}
	},
	{
		"filename": "get_allpages",
		"docstring": "Demo of `Allpages` module: Get all pages whose title contains the text \"Jungle,\" in whole or part.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "allpages",
			"apfrom": "jungle"
		}
	},
	{
		"filename": "get_allimages_by_name",
		"docstring": "List all images in the namespace, starting from files that begin with 'Graffiti_000'. Limit the initial response to just the first three images.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "allimages",
			"aifrom": "Graffiti_000",
			"ailimit": "3"
		}
	},
	{
		"filename": "get_allimages_by_date",
		"docstring": "List all images in the namespace, starting from January 1, 2010, at 18:05:46 UTC.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "allimages",
			"aisort": "timestamp",
			"aistart": "2010-01-01T18:05:46Z"
		}
	},
	{
		"filename": "get_imageinfo",
		"docstring": "Demo of `Imageinfo` module: Get information about an image file.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"prop": "imageinfo",
			"titles": "File:Billy Tipton.jpg"
		}
	},
	{
		"filename": "get_categories",
		"docstring": "Demo of `Categories` module: Get categories associated with a page.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"prop": "categories",
			"titles": "Janelle Monáe"
		}
	},
	{
		"filename": "get_allcategories",
		"docstring": "Demo of `Allcategories` module: Get all categories, starting from a certian point, as ordered by category title.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "allcategories",
			"acfrom": "15th-century caliphs"
		}
	},
	{
		"filename": "get_allusers",
		"docstring": "Demo of `Allusers` module: Get all users, starting from those whose name begins with the string, 'Drov'.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "allusers",
			"auprefix": "Drov"
		}
	},
	{
		"filename": "get_backlinks",
		"docstring": "Demo of `Backlinks` module: Get request to list pages which link to a certain page.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "backlinks",
			"bltitle": "philosophy"
		}
	},
	{
		"filename": "get_random",
		"docstring": "Demo of `Random` module: Get request to list 5 random pages.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "random",
			"rnlimit": "5"
		}
	},
	{
		"filename": "paraminfo",
		"docstring": "Demo of `Paraminfo` module: Get information about other action API modules and their parameters.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "paraminfo",
			"format": "json",
			"modules": "parse|query+info|query"
		}
	},
	{
		"filename": "get_user_watchlist_feed",
		"docstring": "Demo of `Feedwatchlist` module: Get a watchlist feed from another user.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "feedwatchlist",
			"wlowner": "sample_user",
			"wltoken": "sample_watchlist_token"
		}
	},
	{
		"filename": "get_alllinks",
		"docstring": "Demo of `Alllinks` module: List links pointing to the given namespace.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "alllinks",
			"alnamespace": "0",
			"alunique": "1"
		}
	},
	{
		"filename": "get_usercontribs",
		"docstring": "Demo of `Usercontribs` module: List user contributions.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "usercontribs",
			"ucuser": "Jimbo Wales"
		}
	},
	{
		"filename": "get_allfileusages",
		"docstring": "Demo of `allfileusage` module: List all file usages, including non-existing.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "allfileusages",
			"afprefix": "Icon",
			"afprop": "ids|title"
		}
	},
	{
		"filename": "get_embedded_pages",
		"docstring": "Demo of `Embeddedin` module: Get all page(s) that embed a given page",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "embeddedin",
			"eititle": "Computer",
			"eilimit": "20"
		}
	},
	{
		"filename": "get_exturlusage",
		"docstring": "Demo of `Exturlusage` module: Enumerate pages that contain a given URL.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "exturlusage",
			"euquery": "slashdot.org"
		}
	},
	{
		"filename": "get_allrevisions",
		"docstring": "Demo of `Allrevisions` module: get revision data of multiple pages and users",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "allrevisions",
			"arvprop": "ids|flags|timestamp",
			"arvuser": "Place holder"
		}
	},
	{
		"filename": "get_pagepropnames",
		"docstring": "Demo of `Pagepropnames` module: List page property names on the given wiki.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "pagepropnames",
			"format": "json"
		}
	},
	{
		"filename": "get_protectedtitles",
		"docstring": "Demo of `Protectedtitles` module: Get the first 2 titles which only sysops can create",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "protectedtitles",
			"ptlevel": "sysop",
			"ptlimit": "2"
		}
	},
	{
		"filename": "get_imageusage",
		"docstring": "Demo of `Imageusage` module: List the first 3 pages that use a given image title",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "imageusage",
			"iutitle": "File:Wiki_logo_Nupedia.jpg",
			"iulimit": "3"
		}
	},
	{
		"filename": "get_iwlinks",
		"docstring": "Demo of `Iwlinks` module: Get the interwiki links from a given page.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"prop": "iwlinks",
			"titles": "Albert Einstein"
		}
	},
	{
		"filename": "get_logevents",
		"docstring": "Demo of `Logevents` module: Get the three most recent logevents.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "logevents",
			"lelimit": "3"
		}
	},
	{
		"filename": "get_tags",
		"docstring": "Demo of `Tags` module: Get the first three change tags and their hitcounts.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "tags",
			"tgprop":"hitcount",
			"tglimit": "3"
		}
	},
	{
		"filename": "get_allredirects",
		"docstring": "Demo of `Allredirects` module: Get the first three unique pages containing redirects to the main namespace.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "allredirects",
			"arunique": "1",
			"arnamespace": "0",
			"arlimit": "3"
		}
	},
	{
		"filename": "get_alltransclusions",
		"docstring": "Demo of `Alltransclusions` module: Get three unique pages in the main namespace which contain transclusions.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"format": "json",
			"list": "alltransclusions",
			"atunique": "1",
			"atnamespace": "0",
			"atlimit": "3"
		}
	},
	{
		"filename": "get_blocked_users",
		"docstring": "Demo of `Blocks` module: GET request to list recent blocked users.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "blocks",
			"bklimit": "3",
			"bkprop": "id|user|by|timestamp|expiry|reason|range|flags",
			"format": "json"
		}
	},
	{
		"filename": "get_querypage_list",
		"docstring": "Demo of `Querypage` module: List first 10 pages which are uncategorized",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "querypage",
			"qppage": "Uncategorizedpages",
			"qplimit": "10",
			"format": "json"
		}
	},
	{
		"filename": "get_recent_changes",
		"docstring": "Demo of `RecentChanges` module: Get the three most recent changes with sizes and flags",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "recentchanges",
			"rcprop": "title|ids|sizes|flags|user",
			"rclimit": "3",
			"format": "json"
		}
	},
	{
		"filename": "get_red_links",
		"docstring": "Demo of `Links` module to identify red or missing links on a page.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"generator": "links",
			"titles": "Wikipedia:Most-wanted_articles",
			"gpllimit": "20",
			"format": "json"
		}
	},
	{
		"filename": "get_users",
		"docstring": "Demo of `Users` module: Get information about several users: [[1.2.3.4]], [[Catrope]], [[Vandal01]], and [[Bob]]",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "users",
			"ususers": "Catrope|Bob",
			"usprop": "blockinfo|groups|editcount|registration|emailable|gender",
			"format": "json"
		}
	},
	{
		"filename": "get_contributors",
		"docstring": "Demo of `Contributors` module: Get request to list all logged-in contributors and count of anonymous contributors to a page.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"titles": "MediaWiki",
			"prop": "contributors",
			"format": "json"
		}
	},
	{
		"filename": "get_alldeletedrevs",
		"docstring": "Demo of `alldeletedrevisions` module: List the all deleted revisions from User",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "query",
			"list": "alldeletedrevisions",
			"adruser": "Mahesh",
			"adrprop": "ids|user|comment",
			"format": "json"
		}
	},
	{
		"filename": "rsd",
		"docstring": "Demo of `Rsd` module: Get request to export an RSD schema.",
		"endpoint": "https://en.wikipedia.org/w/api.php",
		"params": {
			"action": "rsd",
			"format": "json"
		}
	}
]