<?xml version="1.0"?>
<api>
<error code="readapidenied" info="You need read permission to use this module" xml:space="preserve">
**********************************************************************************************************
** **
** This is an auto-generated MediaWiki API documentation page **
** **
** Documentation and Examples: **
** https://www.mediawiki.org/wiki/API **
** **
**********************************************************************************************************
Status: All features shown on this page should be working, but the API
is still in active development, and may change at any time.
Make sure to monitor our mailing list for any updates
Erroneous requests: When erroneous requests are sent to the API, a HTTP header will be sent
with the key "MediaWiki-API-Error" and then both the value of the
header and the error code sent back will be set to the same value
In the case of an invalid action being passed, these will have a value
of "unknown_action"
For more information see https://www.mediawiki.org/wiki/API:Errors_and_warnings
Documentation: https://www.mediawiki.org/wiki/API:Main_page
FAQ https://www.mediawiki.org/wiki/API:FAQ
Mailing list: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api
Api Announcements: https://lists.wikimedia.org/mailman/listinfo/mediawiki-api-announce
Bugs & Requests: https://bugzilla.wikimedia.org/buglist.cgi?component=API&bug_status=NEW&bug_status=ASSIGNED&bug_status=REOPENED&order=bugs.delta_ts
The ApiSandbox extension is installed on this wiki, it adds a graphical interface to using the MediaWiki Api.
It is helpful for new users, allowing request debugging without any extra tools.
See scrapbook.thingelstad.com/wiki/Special:ApiSandbox
Parameters:
format - The format of the output
One value: json, jsonfm, php, phpfm, wddx, wddxfm, xml, xmlfm, yaml, yamlfm, rawfm, txt, txtfm, dbg, dbgfm,
dump, dumpfm
Default: xmlfm
action - What action you would like to perform. See below for module help
One value: parsevalue, smwinfo, ask, askargs, sfautocomplete, sfautoedit, ext.srf.slideshow.show, geocode,
login, logout, query, expandtemplates, parse, opensearch, feedcontributions, feedwatchlist, help,
paraminfo, rsd, compare, tokens, purge, setnotificationtimestamp, rollback, delete, undelete,
protect, block, unblock, move, edit, upload, filerevert, emailuser, watch, patrol, import,
userrights, options
Default: help
version - When showing help, include version for each module
maxlag - Maximum lag can be used when MediaWiki is installed on a database replicated cluster.
To save actions causing any more site replication lag, this parameter can make the client
wait until the replication lag is less than the specified value.
In case of a replag error, a HTTP 503 error is returned, with the message like
"Waiting for $host: $lag seconds lagged\n".
See https://www.mediawiki.org/wiki/Manual:Maxlag_parameter for more information
smaxage - Set the s-maxage header to this many seconds. Errors are never cached
Default: 0
maxage - Set the max-age header to this many seconds. Errors are never cached
Default: 0
requestid - Request ID to distinguish requests. This will just be output back to you
servedby - Include the hostname that served the request in the results. Unconditionally shown on error
origin - When accessing the API using a cross-domain AJAX request (CORS), set this to the originating domain.
This must match one of the origins in the Origin: header exactly, so it has to be set to something like en.wikipedia.org or https://meta.wikimedia.org .
If this parameter does not match the Origin: header, a 403 response will be returned.
If this parameter matches the Origin: header and the origin is whitelisted, an Access-Control-Allow-Origin header will be set.
*** *** *** *** *** *** *** *** *** *** *** *** *** *** Modules *** *** *** *** *** *** *** *** *** *** *** *** *** ***
* action=parsevalue *
API module for parsing values using a ValueParser.
This module requires read rights
Parameters:
parser - Id of the ValueParser to use
This parameter is required
One value: bool, float, geocoordinate, int, null, title
values - The values to parse
This parameter is required
Separate values with '|'
Maximum number of values 50 (500 for bots)
options - The options the parser should use. Provided as a JSON object.
Example:
Help page:
* action=smwinfo *
API module get info about this SMW install.
This module requires read rights
Parameters:
info - The info to provide.
Values (separate with '|'): propcount, usedpropcount, declaredpropcount, proppagecount
Default: propcount|usedpropcount|declaredpropcount
Example:
api.php?action=smwinfo&info=proppagecount|propcount
* action=ask *
API module to query SMW by providing a query in the ask language.
This module requires read rights
Parameters:
query - The query string in ask-language
This parameter is required
Example:
api.php?action=ask&query=[[Modification%20date::%2B]]|%3FModification%20date|sort%3DModification%20date|order%3Ddesc
* action=askargs *
API module to query SMW by providing a query specified as a list of conditions, printouts and parameters.
This module requires read rights
Parameters:
conditions - The query conditions, i.e. the requirements for a subject to be included
This parameter is required
Separate values with '|'
Maximum number of values 50 (500 for bots)
printouts - The query printouts, i.e. the properties to show per subject
Separate values with '|'
Maximum number of values 50 (500 for bots)
Default:
parameters - The query parameters, i.e. all non-condition and non-printout arguments
Separate values with '|'
Maximum number of values 50 (500 for bots)
Default:
Example:
api.php?action=askargs&conditions=Modification%20date::%2B&printouts=Modification%20date¶meters=|sort%3DModification%20date|order%3Ddesc
* action=sfautocomplete *
Autocompletion call used by the Semantic Forms extension (www.mediawiki.org/Extension:Semantic_Forms)
This module requires read rights
Parameters:
limit -
No more than 500 (5000 for bots) allowed
Default: 10
substr - Search substring
property - Semantic property for which to search values
category - Category for which to search values
concept - Concept for which to search values
namespace - Namespace for which to search values
external_url - Alias for external URL from which to get values
baseprop - A previous property in the form to check against
basevalue - The value to check for the previous property
Examples:
api.php?action=sfautocomplete&substr=te
api.php?action=sfautocomplete&substr=te&property=Has_author
api.php?action=sfautocomplete&substr=te&category=Authors
* action=sfautoedit *
This module is used to remotely create or edit pages using Semantic Forms.
Add "template-name[field-name]=field-value" to the query string parameter, to set the value for a specific field.
To set values for more than one field use "&", or rather its URL encoded version "%26": "template-name[field-name-1]=field-value-1%26template-name[field-name-2]=field-value-2".
See the first example below.
In addition to the query parameter, any parameter in the URL of the form "template-name[field-name]=field-value" will be treated as part of the query. See the second example.
This module requires read rights
This module requires write rights
Parameters:
form - The form to use.
target - The target page.
query - The query string.
Examples:
With query parameter: api.php?action=sfautoedit&form=form-name&target=page-name&query=template-name[field-name-1]=field-value-1%26template-name[field-name-2]=field-value-2
Without query parameter: api.php?action=sfautoedit&form=form-name&target=page-name&template-name[field-name-1]=field-value-1&template-name[field-name-2]=field-value-2
* action=ext.srf.slideshow.show *
API module used by the SlideShow result printer to retrieve formatted results.
This module is should not be called directly.
This module requires read rights
Parameters:
pageid - Id of the page (subject) to be displayed
This parameter is required
template - Template to use for formatting
This parameter is required
printouts - Printouts to send to the template
Default: []
Help page:
semantic-mediawiki.org/wiki/Help:Slideshow_format
* action=geocode *
API module for geocoding.
This module requires read rights
Parameters:
locations - The locations to geocode
This parameter is required
Separate values with '|'
Maximum number of values 50 (500 for bots)
service - The geocoding service to use
One value: google
props -
Values (separate with '|'): lat, lon, alt
Default: lat|lon
Examples:
api.php?action=geocode&locations=new york
api.php?action=geocode&locations=new york|brussels|london
api.php?action=geocode&locations=new york&service=geonames
* action=login (lg) *
Log in and get the authentication tokens.
In the event of a successful log-in, a cookie will be attached
to your session. In the event of a failed log-in, you will not
be able to attempt another log-in through this method for 5 seconds.
This is to prevent password guessing by automated password crackers
This module only accepts POST requests
Parameters:
lgname - User Name
lgpassword - Password
lgdomain - Domain (optional)
lgtoken - Login token obtained in first request
Example:
api.php?action=login&lgname=user&lgpassword=password
Help page:
https://www.mediawiki.org/wiki/API:Login
* action=logout *
Log out and clear session data
Example:
Log the current user out:
api.php?action=logout
Help page:
https://www.mediawiki.org/wiki/API:Logout
* action=query *
Query API module allows applications to get needed pieces of data from the MediaWiki databases,
and is loosely based on the old query.php interface.
All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites
This module requires read rights
Parameters:
titles - A list of titles to work on
Separate values with '|'
Maximum number of values 50 (500 for bots)
pageids - A list of page IDs to work on
Separate values with '|'
Maximum number of values 50 (500 for bots)
revids - A list of revision IDs to work on
Separate values with '|'
Maximum number of values 50 (500 for bots)
prop - Which properties to get for the titles/revisions/pageids. Module help is available below
Values (separate with '|'): categories, categoryinfo, duplicatefiles, extlinks, images, imageinfo, info, links, iwlinks,
langlinks, pageprops, revisions, stashimageinfo, templates
list - Which lists to get. Module help is available below
Values (separate with '|'): allcategories, allimages, alllinks, allpages, allusers, backlinks, blocks, categorymembers,
deletedrevs, embeddedin, exturlusage, filearchive, imageusage, iwbacklinks, langbacklinks,
logevents, protectedtitles, querypage, random, recentchanges, search, tags, usercontribs, users,
watchlist, watchlistraw, gadgetcategories, gadgets
meta - Which metadata to get about the site. Module help is available below
Values (separate with '|'): allmessages, siteinfo, userinfo
generator - Use the output of a list as the input for other prop/list/meta items
NOTE: generator parameter names must be prefixed with a 'g', see examples
One value: categories, duplicatefiles, images, links, templates, allcategories, allimages, alllinks, allpages,
backlinks, categorymembers, embeddedin, exturlusage, imageusage, iwbacklinks, langbacklinks,
protectedtitles, querypage, random, recentchanges, search, watchlist, watchlistraw
redirects - Automatically resolve redirects
converttitles - Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion.
Languages that support variant conversion include gan, iu, kk, ku, shi, sr, tg, uz, zh
indexpageids - Include an additional pageids section listing all returned page IDs
export - Export the current revisions of all given or generated pages
exportnowrap - Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with export
iwurl - Whether to get the full URL if the title is an interwiki link
Examples:
api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment
api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions
Help pages:
https://www.mediawiki.org/wiki/API:Meta
https://www.mediawiki.org/wiki/API:Properties
https://www.mediawiki.org/wiki/API:Lists
--- --- --- --- --- --- --- --- --- --- --- --- Query: Prop --- --- --- --- --- --- --- --- --- --- --- ---
* prop=categories (cl) *
List all categories the page(s) belong to
This module requires read rights
Parameters:
clprop - Which additional properties to get for each category
sortkey - Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category
timestamp - Adds timestamp of when the category was added
hidden - Tags categories that are hidden with __HIDDENCAT__
Values (separate with '|'): sortkey, timestamp, hidden
clshow - Which kind of categories to show
Values (separate with '|'): hidden, !hidden
cllimit - How many categories to return
No more than 500 (5000 for bots) allowed
Default: 10
clcontinue - When more results are available, use this to continue
clcategories - Only list these categories. Useful for checking whether a certain page is in a certain category
Separate values with '|'
Maximum number of values 50 (500 for bots)
cldir - The direction in which to list
One value: ascending, descending
Default: ascending
Examples:
Get a list of categories [[Albert Einstein]] belongs to:
api.php?action=query&prop=categories&titles=Albert%20Einstein
Get information about all categories used in the [[Albert Einstein]]:
api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info
Help page:
https://www.mediawiki.org/wiki/API:Properties#categories_.2F_cl
Generator:
This module may be used as a generator
* prop=categoryinfo (ci) *
Returns information about the given categories
This module requires read rights
Parameters:
cicontinue - When more results are available, use this to continue
Example:
api.php?action=query&prop=categoryinfo&titles=Category:Foo|Category:Bar
Help page:
https://www.mediawiki.org/wiki/API:Properties#categoryinfo_.2F_ci
* prop=duplicatefiles (df) *
List all files that are duplicates of the given file(s) based on hash values
This module requires read rights
Parameters:
dflimit - How many duplicate files to return
No more than 500 (5000 for bots) allowed
Default: 10
dfcontinue - When more results are available, use this to continue
dfdir - The direction in which to list
One value: ascending, descending
Default: ascending
dflocalonly - Look only for files in the local repository
Examples:
api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles
api.php?action=query&generator=allimages&prop=duplicatefiles
Help page:
https://www.mediawiki.org/wiki/API:Properties#duplicatefiles_.2F_df
Generator:
This module may be used as a generator
* prop=extlinks (el) *
Returns all external urls (not interwikies) from the given page(s)
This module requires read rights
Parameters:
ellimit - How many links to return
No more than 500 (5000 for bots) allowed
Default: 10
eloffset - When more results are available, use this to continue
elprotocol - Protocol of the url. If empty and elquery set, the protocol is http.
Leave both this and elquery empty to list all external links
Can be empty, or One value: http, https, ftp, irc, ircs, gopher, telnet, nntp, worldwind, mailto, news, svn, git, mms
Default:
elquery - Search string without protocol. Useful for checking whether a certain page contains a certain external url
Example:
Get a list of external links on the [[Main Page]]:
api.php?action=query&prop=extlinks&titles=Main%20Page
Help page:
https://www.mediawiki.org/wiki/API:Properties#extlinks_.2F_el
* prop=images (im) *
Returns all images contained on the given page(s)
This module requires read rights
Parameters:
imlimit - How many images to return
No more than 500 (5000 for bots) allowed
Default: 10
imcontinue - When more results are available, use this to continue
imimages - Only list these images. Useful for checking whether a certain page has a certain Image.
Separate values with '|'
Maximum number of values 50 (500 for bots)
imdir - The direction in which to list
One value: ascending, descending
Default: ascending
Examples:
Get a list of images used in the [[Main Page]]:
api.php?action=query&prop=images&titles=Main%20Page
Get information about all images used in the [[Main Page]]:
api.php?action=query&generator=images&titles=Main%20Page&prop=info
Help page:
https://www.mediawiki.org/wiki/API:Properties#images_.2F_im
Generator:
This module may be used as a generator
* prop=imageinfo (ii) *
Returns image information and upload history
This module requires read rights
Parameters:
iiprop - What image information to get:
timestamp - Adds timestamp for the uploaded version
user - Adds the user who uploaded the image version
userid - Add the user ID that uploaded the image version
comment - Comment on the version
parsedcomment - Parse the comment on the version
url - Gives URL to the image and the description page
size - Adds the size of the image in bytes and the height, width and page count (if applicable)
dimensions - Alias for size
sha1 - Adds SHA-1 hash for the image
mime - Adds MIME type of the image
thumbmime - Adds MIME type of the image thumbnail (requires url and param iiurlwidth)
mediatype - Adds the media type of the image
metadata - Lists EXIF metadata for the version of the image
archivename - Adds the file name of the archive version for non-latest versions
bitdepth - Adds the bit depth of the version
Values (separate with '|'): timestamp, user, userid, comment, parsedcomment, url, size, dimensions, sha1, mime, thumbmime,
mediatype, metadata, archivename, bitdepth
Default: timestamp|user
iilimit - How many image revisions to return
No more than 500 (5000 for bots) allowed
Default: 1
iistart - Timestamp to start listing from
iiend - Timestamp to stop listing at
iiurlwidth - If iiprop=url is set, a URL to an image scaled to this width will be returned.
Only the current version of the image can be scaled
Default: -1
iiurlheight - Similar to iiurlwidth. Cannot be used without iiurlwidth
Default: -1
iimetadataversion - Version of metadata to use. if 'latest' is specified, use latest version.
Defaults to '1' for backwards compatibility
Default: 1
iiurlparam - A handler specific parameter string. For example, pdf's
might use 'page15-100px'. iiurlwidth must be used and be consistent with iiurlparam
Default:
iicontinue - If the query response includes a continue value, use it here to get another page of results
iilocalonly - Look only for files in the local repository
Examples:
api.php?action=query&titles=File:Albert%20Einstein%20Head.jpg&prop=imageinfo
api.php?action=query&titles=File:Test.jpg&prop=imageinfo&iilimit=50&iiend=20071231235959&iiprop=timestamp|user|url
Help page:
https://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii
* prop=info (in) *
Get basic page information such as namespace, title, last touched date, ...
This module requires read rights
Parameters:
inprop - Which additional properties to get:
protection - List the protection level of each page
talkid - The page ID of the talk page for each non-talk page
watched - List the watched status of each page
notificationtimestamp - The watchlist notification timestamp of each page
subjectid - The page ID of the parent page for each talk page
url - Gives a full URL to the page, and also an edit URL
readable - Whether the user can read this page
preload - Gives the text returned by EditFormPreloadText
displaytitle - Gives the way the page title is actually displayed
Values (separate with '|'): protection, talkid, watched, notificationtimestamp, subjectid, url, readable, preload, displaytitle
intoken - Request a token to perform a data-modifying action on a page
Values (separate with '|'): edit, delete, protect, move, block, unblock, email, import, watch
incontinue - When more results are available, use this to continue
Examples:
api.php?action=query&prop=info&titles=Main%20Page
api.php?action=query&prop=info&inprop=protection&titles=Main%20Page
Help page:
https://www.mediawiki.org/wiki/API:Properties#info_.2F_in
* prop=links (pl) *
Returns all links from the given page(s)
This module requires read rights
Parameters:
plnamespace - Show links in this namespace(s) only
Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 108, 109, 170, 171, 274, 275, 106,
107, 420, 421
Maximum number of values 50 (500 for bots)
pllimit - How many links to return
No more than 500 (5000 for bots) allowed
Default: 10
plcontinue - When more results are available, use this to continue
pltitles - Only list links to these titles. Useful for checking whether a certain page links to a certain title.
Separate values with '|'
Maximum number of values 50 (500 for bots)
pldir - The direction in which to list
One value: ascending, descending
Default: ascending
Examples:
Get links from the [[Main Page]]::
api.php?action=query&prop=links&titles=Main%20Page
Get information about the link pages in the [[Main Page]]::
api.php?action=query&generator=links&titles=Main%20Page&prop=info
Get links from the Main Page in the User and Template namespaces::
api.php?action=query&prop=links&titles=Main%20Page&plnamespace=2|10
Help page:
https://www.mediawiki.org/wiki/API:Properties#links_.2F_pl
Generator:
This module may be used as a generator
* prop=iwlinks (iw) *
Returns all interwiki links from the given page(s)
This module requires read rights
Parameters:
iwurl - Whether to get the full URL
iwlimit - How many interwiki links to return
No more than 500 (5000 for bots) allowed
Default: 10
iwcontinue - When more results are available, use this to continue
iwprefix - Prefix for the interwiki
iwtitle - Interwiki link to search for. Must be used with iwprefix
iwdir - The direction in which to list
One value: ascending, descending
Default: ascending
Example:
Get interwiki links from the [[Main Page]]:
api.php?action=query&prop=iwlinks&titles=Main%20Page
* prop=langlinks (ll) *
Returns all interlanguage links from the given page(s)
This module requires read rights
Parameters:
lllimit - How many langlinks to return
No more than 500 (5000 for bots) allowed
Default: 10
llcontinue - When more results are available, use this to continue
llurl - Whether to get the full URL
lllang - Language code
lltitle - Link to search for. Must be used with lllang
lldir - The direction in which to list
One value: ascending, descending
Default: ascending
Example:
Get interlanguage links from the [[Main Page]]:
api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=
Help page:
https://www.mediawiki.org/wiki/API:Properties#langlinks_.2F_ll
* prop=pageprops (pp) *
Get various properties defined in the page content
This module requires read rights
Parameters:
ppcontinue - When more results are available, use this to continue
ppprop - Page prop to look on the page for. Useful for checking whether a certain page uses a certain page prop.
Example:
api.php?action=query&prop=pageprops&titles=Category:Foo
Help page:
https://www.mediawiki.org/wiki/API:Properties#pageprops_.2F_pp
* prop=revisions (rv) *
Get revision information
May be used in several ways:
1) Get data about a set of pages (last revision), by setting titles or pageids parameter
2) Get revisions for one given page, by using titles/pageids with start/end/limit params
3) Get data about a set of revisions by setting their IDs with revids parameter
All parameters marked as (enum) may only be used with a single page (#2)
This module requires read rights
Parameters:
rvprop - Which properties to get for each revision:
ids - The ID of the revision
flags - Revision flags (minor)
timestamp - The timestamp of the revision
user - User that made the revision
userid - User id of revision creator
size - Length (bytes) of the revision
sha1 - SHA-1 (base 16) of the revision
comment - Comment by the user for revision
parsedcomment - Parsed comment by the user for the revision
content - Text of the revision
tags - Tags for the revision
Values (separate with '|'): ids, flags, timestamp, user, userid, size, sha1, comment, parsedcomment, content, tags
Default: ids|timestamp|flags|comment|user
rvlimit - Limit how many revisions will be returned (enum)
No more than 500 (5000 for bots) allowed
rvstartid - From which revision id to start enumeration (enum)
rvendid - Stop revision enumeration on this revid (enum)
rvstart - From which revision timestamp to start enumeration (enum)
rvend - Enumerate up to this timestamp (enum)
rvdir - In which direction to enumerate (enum)
newer - List oldest first. Note: rvstart has to be before rvend.
older - List newest first (default). Note: rvstart has to be later than rvend.
One value: newer, older
Default: older
rvuser - Only include revisions made by user (enum)
rvexcludeuser - Exclude revisions made by user (enum)
rvtag - Only list revisions tagged with this tag
rvexpandtemplates - Expand templates in revision content
rvgeneratexml - Generate XML parse tree for revision content
rvparse - Parse revision content. For performance reasons if this option is used, rvlimit is enforced to 1.
rvsection - Only retrieve the content of this section number
rvtoken - Which tokens to obtain for each revision
Values (separate with '|'): rollback
rvcontinue - When more results are available, use this to continue
rvdiffto - Revision ID to diff each revision to.
Use "prev", "next" and "cur" for the previous, next and current revision respectively
rvdifftotext - Text to diff each revision to. Only diffs a limited number of revisions.
Overrides rvdiffto. If rvsection is set, only that section will be diffed against this text
Examples:
Get data with content for the last revision of titles "API" and "Main Page"
api.php?action=query&prop=revisions&titles=API|Main%20Page&rvprop=timestamp|user|comment|content
Get last 5 revisions of the "Main Page"
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment
Get first 5 revisions of the "Main Page"
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer
Get first 5 revisions of the "Main Page" made after 2006-05-01
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvdir=newer&rvstart=20060501000000
Get first 5 revisions of the "Main Page" that were not made made by anonymous user "127.0.0.1"
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvexcludeuser=127.0.0.1
Get first 5 revisions of the "Main Page" that were made by the user "MediaWiki default"
api.php?action=query&prop=revisions&titles=Main%20Page&rvlimit=5&rvprop=timestamp|user|comment&rvuser=MediaWiki%20default
Help page:
https://www.mediawiki.org/wiki/API:Properties#revisions_.2F_rv
* prop=stashimageinfo (sii) *
Returns image information for stashed images
This module requires read rights
Parameters:
siifilekey - Key that identifies a previous upload that was stashed temporarily.
Separate values with '|'
Maximum number of values 50 (500 for bots)
siisessionkey - DEPRECATED! Alias for filekey, for backward compatibility.
Separate values with '|'
Maximum number of values 50 (500 for bots)
siiprop - What image information to get:
timestamp - Adds timestamp for the uploaded version
url - Gives URL to the image and the description page
size - Adds the size of the image in bytes and the height, width and page count (if applicable)
dimensions - Alias for size
sha1 - Adds SHA-1 hash for the image
mime - Adds MIME type of the image
thumbmime - Adds MIME type of the image thumbnail (requires url and param siiurlwidth)
metadata - Lists EXIF metadata for the version of the image
bitdepth - Adds the bit depth of the version
Values (separate with '|'): timestamp, url, size, dimensions, sha1, mime, thumbmime, metadata, bitdepth
Default: timestamp|url
siiurlwidth - If siiprop=url is set, a URL to an image scaled to this width will be returned.
Default: -1
siiurlheight - Similar to siiurlwidth. Cannot be used without siiurlwidth
Default: -1
siiurlparam - A handler specific parameter string. For example, pdf's
might use 'page15-100px'. siiurlwidth must be used and be consistent with siiurlparam
Default:
Examples:
api.php?action=query&prop=stashimageinfo&siifilekey=124sd34rsdf567
api.php?action=query&prop=stashimageinfo&siifilekey=b34edoe3|bceffd4&siiurl&siiprop=url
Help page:
https://www.mediawiki.org/wiki/API:Properties#imageinfo_.2F_ii
* prop=templates (tl) *
Returns all templates from the given page(s)
This module requires read rights
Parameters:
tlnamespace - Show templates in this namespace(s) only
Values (separate with '|'): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 108, 109, 170, 171, 274, 275, 106,
107, 420, 421
Maximum number of values 50 (500 for bots)
tllimit - How many templates to return
No more than 500 (5000 for bots) allowed
Default: 10
tlcontinue - When more results are available, use this to continue
tltemplates - Only list these templates. Useful for checking whether a certain page uses a certain template.
Separate values with '|'
Maximum number of values 50 (500 for bots)
tldir - The direction in which to list
One value: ascending, descending
Default: ascending
Examples:
Get templates from the [[Main Page]]::
api.php?action=query&prop=templates&titles=Main%20Page
Get information about the template pages in the [[Main Page]]::
api.php?action=query&generator=templates&titles=Main%20Page&prop=info
Get templates from the Main Page in the User and Template namespaces::
api.php?action=query&prop=templates&titles=Main%20Page&tlnamespace=2|10
Help page:
https://www.mediawiki.org/wiki/API:Properties#templates_.2F_tl
Generator:
This module may be used as a generator
--- --- --- --- --- --- --- --- --- --- --- --- Query: List --- --- --- --- --- --- --- --- --- --- --- ---
* list=allcategories (ac) *
Enumerate all categories
This module requires read rights
Parameters:
acfrom - The category to start enumerating from
accontinue - When more results are available, use this to continue
acto - The category to stop enumerating at
acprefix - Search for all category titles that begin with this value
acdir - Direction to sort in
One value: ascending, descending
Default: ascending
acmin - Minimum number of category members
acmax - Maximum number of category members
aclimit - How many categories to return
No more than 500 (5000 for bots) allowed
Default: 10
acprop - Which properties to get
size - Adds number of pages in the category
hidden - Tags categories that are hidden with __HIDDENCAT__
Values (separate with '|'): size, hidden
Default:
Examples:
api.php?action=query&list=allcategories&acprop=size
api.php?action=query&generator=allcategories&gacprefix=List&prop=info
Help page:
https://www.mediawiki.org/wiki/API:Allcategories
Generator:
This module may be used as a generator
* list=allimages (ai) *
Enumerate all images sequentially
This module requires read rights
Parameters:
aisort - Property to sort by
One value: name, timestamp
Default: name
aidir - The direction in which to list
One value: ascending, descending, newer, older
Default: ascending
aifrom - The image title to start enumerating from. Can only be used with aisort=name
aito - The image title to stop enumerating at. Can only be used with aisort=name
aicontinue - When more results are available, use this to continue
aistart - The timestamp to start enumerating from. Can only be used with aisort=timestamp
aiend - The timestamp to end enumerating. Can only be used with aisort=timestamp
aiprop - What image information to get:
timestamp - Adds timestamp for the uploaded version
user - Adds the user who uploaded the image version
userid - Add the user ID that uploaded the image version
comment - Comment on the version
parsedcomment - Parse the comment on the version
url - Gives URL to the image and the description page
size - Adds the size of the image in bytes and the height, width and page count (if applicable)
dimensions - Alias for size
sha1 - Adds SHA-1 hash for the image
mime - Adds MIME type of the image
mediatype - Adds the media type of the image
metadata - Lists EXIF metadata for the version of the image
bitdepth - Adds the bit depth of the version
Values (separate with '|'): timestamp, user, userid, comment, parsedcomment, url, size, dimensions, sha1, mime, mediatype,
metadata, bitdepth
Default: timestamp|url
aiprefix - Search for all image titles that begin with this value. Can only be used with aisort=name
aiminsize - Limit to images with at least this many bytes
aimaxsize - Limit to images with at most this many bytes
aisha1 - SHA1 hash of image. Overrides aish
gipoco.com
is neither affiliated with the authors of this page nor responsible
for its contents. This is a safe-cache copy of the original web site.
gipoco.com
is neither affiliated with the authors of this page nor responsible
for its contents. This is a safe-cache copy of the original web site.