CINXE.COM

<!DOCTYPE html> <html class="client-nojs" lang="en" dir="ltr"> <head> <meta charset="UTF-8"> <title>MediaWiki API help - MediaWiki</title> <script>document.documentElement.className="client-js";RLCONF={"wgBreakFrames":true,"wgSeparatorTransformTable":["",""],"wgDigitTransformTable":["",""],"wgDefaultDateFormat":"dmy","wgMonthNames":["","January","February","March","April","May","June","July","August","September","October","November","December"],"wgRequestId":"a3fe2c15-9179-451b-b776-2ac5ebeac352","wgCanonicalNamespace":"Special","wgCanonicalSpecialPageName":"ApiHelp","wgNamespaceNumber":-1,"wgPageName":"Special:ApiHelp","wgTitle":"ApiHelp","wgCurRevisionId":0,"wgRevisionId":0,"wgArticleId":0,"wgIsArticle":false,"wgIsRedirect":false,"wgAction":"view","wgUserName":null,"wgUserGroups":["*"],"wgCategories":[],"wgPageViewLanguage":"en","wgPageContentLanguage":"en","wgPageContentModel":"wikitext","wgRelevantPageName":"Special:ApiHelp","wgRelevantArticleId":0,"wgIsProbablyEditable":false,"wgRelevantPageIsProbablyEditable":false,"wgNoticeProject":"mediawiki","wgCiteReferencePreviewsActive":true,"wgMediaViewerOnClick":true, "wgMediaViewerEnabledByDefault":true,"wgVisualEditor":{"pageLanguageCode":"en","pageLanguageDir":"ltr","pageVariantFallbacks":"en"},"wgMFDisplayWikibaseDescriptions":{"search":true,"watchlist":true,"tagline":false,"nearby":true},"wgWMESchemaEditAttemptStepOversample":false,"wgWMEPageLength":0,"wgCentralAuthMobileDomain":false,"wgEditSubmitButtonLabelPublish":true};RLSTATE={"user.options":"loading","mediawiki.hlist":"ready","mediawiki.apipretty":"ready","mediawiki.skinning.interface":"ready","ext.visualEditor.desktopArticleTarget.noscript":"ready","ext.wikimediaBadges":"ready"};RLPAGEMODULES=["mediawiki.page.ready","ext.centralNotice.geoIP","ext.urlShortener.toolbar","ext.centralauth.centralautologin","ext.visualEditor.desktopArticleTarget.init","ext.visualEditor.targetLoader","ext.echo.centralauth","ext.eventLogging","ext.wikimediaEvents","ext.navigationTiming"];</script> <script>(RLQ=window.RLQ||[]).push(function(){mw.loader.impl(function(){return["user.options@12s5i",function($,jQuery,require,module){mw.user.tokens.set({"patrolToken":"+\\","watchToken":"+\\","csrfToken":"+\\"}); }];});});</script> <link rel="stylesheet" href="/w/load.php?lang=en&modules=ext.visualEditor.desktopArticleTarget.noscript%7Cext.wikimediaBadges%7Cmediawiki.apipretty%2Chlist%7Cmediawiki.skinning.interface&only=styles&skin=apioutput"> <script async="" src="/w/load.php?lang=en&modules=startup&only=scripts&raw=1&safemode=1&skin=apioutput"></script> <meta name="generator" content="MediaWiki 1.44.0-wmf.5"> <meta name="referrer" content="origin"> <meta name="referrer" content="origin-when-cross-origin"> <meta name="robots" content="noindex,nofollow,max-image-preview:standard"> <meta name="format-detection" content="telephone=no"> <meta name="viewport" content="width=1120"> <meta property="og:site_name" content="MediaWiki"> <meta property="og:title" content="MediaWiki API help - MediaWiki"> <meta property="og:type" content="website"> <link rel="alternate" media="only screen and (max-width: 640px)" href="//m.mediawiki.org/wiki/Special:ApiHelp"> <link rel="apple-touch-icon" href="/static/apple-touch/mediawiki.png"> <link rel="icon" href="/static/favicon/mediawiki.ico"> <link rel="search" type="application/opensearchdescription+xml" href="/w/rest.php/v1/search" title="MediaWiki (en)"> <link rel="EditURI" type="application/rsd+xml" href="//www.mediawiki.org/w/api.php?action=rsd"> <link rel="canonical" href="https://www.mediawiki.org/wiki/Special:ApiHelp"> <link rel="license" href="https://www.mediawiki.org/wiki/Special:MyLanguage/Copyright"> <link rel="alternate" type="application/atom+xml" title="MediaWiki Atom feed" href="/w/index.php?title=Special:RecentChanges&feed=atom"> <link rel="dns-prefetch" href="//login.wikimedia.org"> </head> <body class="mediawiki ltr sitedir-ltr mw-hide-empty-elt ns--1 ns-special mw-special-ApiHelp page-Special_ApiHelp rootpage-Special_ApiHelp skin-apioutput action-view"><div class="mw-body" role="main"> <h1 id="firstHeading">MediaWiki API help</h1> <div class="mw-body-content"> <div id="mw-content-text" class="mw-body-content"><p>This is an auto-generated MediaWiki API documentation page. </p><p>Documentation and examples: <a class="external free" href="https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page">https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page</a> </p><h2 class="apihelp-header apihelp-module-name" dir="ltr" lang="en" id="query+checkuser">list=checkuser (cu)</h2><div class="apihelp-linktrail">(<a href="/wiki/Special:ApiHelp/main" class="apihelp-linktrail" dir="ltr" lang="en">main</a> | <a href="/wiki/Special:ApiHelp/query" class="apihelp-linktrail" dir="ltr" lang="en">query</a> | <b dir="ltr" lang="en">checkuser</b>)</div> <div class="apihelp-block apihelp-flags"><ul><li><span class="apihelp-flag-readrights">This module requires read rights.</span></li><li><span class="apihelp-flag-writerights">This module requires write rights.</span></li><li><span class="apihelp-flag-mustbeposted">This module only accepts POST requests.</span></li><li><span class="apihelp-source">Source: <span dir="ltr" lang="en">CheckUser</span></span></li><li><span class="apihelp-license">License: <a href="/wiki/Special:Version/License/CheckUser" title="Special:Version/License/CheckUser"><span dir="ltr" lang="en">GPL-2.0-or-later</span></a></span></li></ul></div> <p>Check which IP addresses are used by a given username or which usernames are used by a given IP address. </p> <div class="apihelp-block apihelp-help-urls"><ul><li><a href="https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:CheckUser#API" dir="ltr">https://www.mediawiki.org/wiki/Special:MyLanguage/Extension:CheckUser#API</a></li></ul></div> <div class="apihelp-block apihelp-parameters"><div class="apihelp-block-head">Specific parameters:</div><div class="apihelp-block-header">Other general parameters are available.</div><dl><dt><span dir="ltr" lang="en" id="query+checkuser:curequest">curequest</span></dt><dd class="description"><p>Type of CheckUser request: </p><dl><dt><span dir="ltr" lang="en">userips</span></dt> <dd>Get IP address of target user.</dd> <dt><span dir="ltr" lang="en">edits</span></dt> <dd><span class="apihelp-deprecated">Deprecated.</span> Get actions performed by target IP address or range.</dd> <dt><span dir="ltr" lang="en">actions</span></dt> <dd>Get actions performed by target IP address or range.</dd> <dt><span dir="ltr" lang="en">ipusers</span></dt> <dd>Get users from target IP address or range.</dd></dl></dd><dd class="info">This parameter is required.</dd><dd class="info">One of the following values: actions, ipusers, userips, edits</dd><dt><span dir="ltr" lang="en" id="query+checkuser:cutarget">cutarget</span></dt><dd class="description"><p>Username, IP address, or CIDR range to check. </p></dd><dd class="info">This parameter is required.</dd><dd class="info">Type: user, by any of username, IP, Temporary user and IP range</dd><dt><span dir="ltr" lang="en" id="query+checkuser:cureason">cureason</span></dt><dd class="description"><p>Reason to check. </p></dd><dd class="info">This parameter is required.</dd><dd class="info">Default: <span class="apihelp-empty">(empty)</span></dd><dt><span dir="ltr" lang="en" id="query+checkuser:culimit">culimit</span></dt><dd class="description"><p>Limit of rows. </p></dd><dd class="info">Type: integer or <kbd>max</kbd></dd><dd class="info">The value must be between 1 and 500.</dd><dd class="info">Default: 500</dd><dt><span dir="ltr" lang="en" id="query+checkuser:cutimecond">cutimecond</span></dt><dd class="description"><p>Time limit of user data (like "-2 weeks" or "2 weeks ago"). </p></dd><dd class="info">Default: -2 weeks</dd><dt><span dir="ltr" lang="en" id="query+checkuser:cuxff">cuxff</span></dt><dd class="description"><p>Use XFF data instead of IP address. </p></dd><dt><span dir="ltr" lang="en" id="query+checkuser:cutoken">cutoken</span></dt><dd class="description"><p>A "csrf" token retrieved from <a href="/w/api.php?action=help&modules=query%2Btokens">action=query&meta=tokens</a> </p></dd><dd class="info">This parameter is required.</dd></dl></div> <div class="apihelp-block apihelp-examples"><div class="apihelp-block-head">Examples:</div><dl><dt>Get IP addresses for <a href="/wiki/User:Example" title="User:Example">User:Example</a></dt><dd><a href="/w/api.php?action=query&list=checkuser&curequest=userips&cutarget=Jimbo_Wales" dir="ltr" rel="nofollow">api.php?action=query&list=checkuser&curequest=userips&cutarget=Jimbo_Wales</a> <a href="/wiki/Special:ApiSandbox#action=query&list=checkuser&curequest=userips&cutarget=Jimbo_Wales"><small>[open in sandbox]</small></a></dd><dt>Get actions performed by 192.0.2.0/24</dt><dd><a href="/w/api.php?action=query&list=checkuser&curequest=actions&cutarget=127.0.0.1/16&xff=1&cureason=Some_check" dir="ltr" rel="nofollow">api.php?action=query&list=checkuser&curequest=actions&cutarget=127.0.0.1/16&xff=1&cureason=Some_check</a> <a href="/wiki/Special:ApiSandbox#action=query&list=checkuser&curequest=actions&cutarget=127.0.0.1/16&xff=1&cureason=Some_check"><small>[open in sandbox]</small></a></dd></dl></div> <noscript><img src="https://login.wikimedia.org/wiki/Special:CentralAutoLogin/start?type=1x1" alt="" width="1" height="1" style="border: none; position: absolute;"></noscript> <div class="printfooter" data-nosnippet="">Retrieved from "<a dir="ltr" href="https://www.mediawiki.org/wiki/Special:ApiHelp">https://www.mediawiki.org/wiki/Special:ApiHelp</a>"</div></div> </div> </div> <script>(RLQ=window.RLQ||[]).push(function(){mw.log.warn("This page is using the deprecated ResourceLoader module \"mediawiki.skinning.interface\".\n[1.43] The use of the `interface-message-box` feature with SkinModule is deprecated in favor of CodexModule. Please remove this feature.More information can be found at [[mw:Manual:ResourceLoaderSkinModule]]. ");mw.config.set({"wgHostname":"mw-api-ext.codfw.main-67468f59cb-fkht5","wgBackendResponseTime":135});});</script> </body> </html>