Skip to content
Steve edited this page Sep 22, 2017 · 30 revisions

Getting data in wptools centers on request "actions". We make API requests to get data, and then we assign values from the data to select data members. Most actions map to a get_{action} method. All request actions are cached except random requests, which are repeatable. The wptools user-agent will look like this:

wptools/<version> (https://github.com/siznax/wptools) <libs>

page actions

Action Method Description
* get() some mix of all actions below
claims get_claims() Wikidata:API action=wbgetentities request for Q entity labels
imageinfo get_imageinfo() Mediawiki API:Imageinfo request for image info
parse get_parse() MediaWiki:API action=parse request for parsetree/infobox data
query get_query() MediaWiki:API action=query request for extracts, image, etc.
querymore get_more() MediaWiki:API action=query request for files, categories, views, etc.
random get_random() Mediawiki API:Random for random page
rest get_restbase() RESTBase /page/ requests for page content
wikidata get_wikidata() Wikidata:API action=wbgetentities for page wikidata
page.cache
{
  claims:       {query, response, info},
  imageinfo:    {query, response, info},
  parse:        {query, response, info},
  query:        {query, response, info},
  querymore:    {query, response, info},
  rest:         {query, response, info},
  wikidata:     {query, response, info}
}

category actions

Action Method Description
categorymembers get_members() Mediawiki API:Categorymembers for category members
random:14 get_random() Mediawiki API:Random for random category (ns=14)
category.cache
{
  category:     {query, response, info},
}

site actions

Action Method Description
siteinfo get_info() Mediawiki API:Siteinfo and Extension:PageViewInfo for site info
sitematrix get_sites() Wikimedia Commons Extension:SiteMatrix for sitematrix and a randomly selected site
siteviews get_info() Mediawiki Extension:PageViewInfo for sitewide unique visitors
site.cache
{
  siteinfo:     {query, response, info},
  sitematrix:   {query, response, info},
  sitevisitors: {query, response, info}
}
Clone this wiki locally