API:Usercontribs

This page is part of the MediaWiki Action API documentation.

MediaWiki version:

≥ 1.9

GET request to list a user's contributions.

API documentation

The following documentation is the output of Special:ApiHelp/query+usercontribs, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org).

Special:ApiHelp/query+usercontribs

Example

GET request

List contributions by User:Jimbo Wales

api.php?action=query&format=json&list=usercontribs&ucuser=Jimbo%20Wales [try in ApiSandbox]

Response

{
    "batchcomplete": "",
    "continue": {
        "uccontinue": "20190130180447|880978627",
        "continue": "-||"
    },
    "query": {
        "usercontribs": [
            {
                "userid": 24,
                "user": "Jimbo Wales",
                "pageid": 9870625,
                "revid": 881893498,
                "parentid": 881892978,
                "ns": 3,
                "title": "User talk:Jimbo Wales",
                "timestamp": "2019-02-05T14:05:11Z",
                "comment": "/* Fancy I edit Wikipedia T-Shirt */",
                "size": 29753
            },
            {
                "userid": 24,
                "user": "Jimbo Wales",
                "pageid": 9870625,
                "revid": 881282261,
                "parentid": 881270759,
                "ns": 3,
                "title": "User talk:Jimbo Wales",
                "timestamp": "2019-02-01T15:29:31Z",
                "comment": "/* Macedonian President Gorge Ivanov is now in the House arrest */",
                "size": 60166
            },
            {
                "userid": 24,
                "user": "Jimbo Wales",
                "pageid": 9513191,
                "revid": 881245934,
                "parentid": 881240310,
                "ns": 1,
                "title": "Talk:Mark Dice",
                "timestamp": "2019-02-01T09:48:38Z",
                "comment": "/* So good they names it twice */",
                "size": 74128
            },
            ...
        ]
    }
}

Sample code

Python

#!/usr/bin/python3

"""
    get_usercontribs.py

    MediaWiki API Demos
    Demo of `Usercontribs` module: List user contributions.

    MIT License
"""

import requests

S = requests.Session()

URL = "https://en.wikipedia.org/w/api.php"

PARAMS = {
    "action": "query",
    "format": "json",
    "list": "usercontribs",
    "ucuser": "Jimbo Wales"
}

R = S.get(url=URL, params=PARAMS)
DATA = R.json()

USERCONTRIBS = DATA["query"]["usercontribs"]

for uc in USERCONTRIBS:
    print(uc["title"])

PHP

<?php

//This file is autogenerated. See modules.json and autogenerator.py for details

/*
    get_usercontribs.php

    MediaWiki API Demos
    Demo of `Usercontribs` module: List user contributions.

    MIT License
*/

$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
    "action" => "query",
    "format" => "json",
    "list" => "usercontribs",
    "ucuser" => "Jimbo Wales"
];

$url = $endPoint . "?" . http_build_query( $params );

$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
$output = curl_exec( $ch );
curl_close( $ch );

$result = json_decode( $output, true );

foreach( $result["query"]["usercontribs"] as $k => $v ) {
    echo( $v["title"] . "\n" );
}

JavaScript

/*
    get_usercontribs.js

    MediaWiki API Demos
    Demo of `Usercontribs` module: List user contributions.

    MIT License
*/

var url = "https://en.wikipedia.org/w/api.php"; 

var params = {
    action: "query",
    format: "json",
    list: "usercontribs",
    ucuser: "Jimbo Wales"
};

url = url + "?origin=*";
Object.keys(params).forEach(function(key){url += "&" + key + "=" + params[key];});

fetch(url)
    .then(function(response){return response.json();})
    .then(function(response) {
        var usercontrib = response.query.usercontribs;
        for (var uc in usercontrib) {
            console.log(usercontrib[uc].title);
        }
    })
    .catch(function(error){console.log(error);});

MediaWiki JS

/*
	get_usercontribs.js

	MediaWiki API Demos
	Demo of `Usercontribs` module: List user contributions.

	MIT License
*/

var params = {
		action: 'query',
		format: 'json',
		list: 'usercontribs',
		ucuser: 'Jimbo Wales'
	},
	api = new mw.Api();

api.get( params ).done( function ( data ) {
	var usercontrib = data.query.usercontribs,
		uc;
	for ( uc in usercontrib ) {
		console.log( usercontrib[ uc ].title );
	}
} );

Possible errors


Code	Info
invaliduserid	User ID `username` is not valid.
paramempty_ucuser	The parameter `user` may not be empty.
baduser_ucuser	Invalid value "username" for user parameter `user`.
show	Incorrect parameter - mutually exclusive values may not be supplied.
permissiondenied	You need the `patrol` or `patrolmarks` right to request the patrolled flag.

Parameter history

v1.39: Introduced uciprange
v1.29: Introduced ucuserids
v1.23: Deprecated uctoponly
v1.23: Introduced ucshow=top, ucshow=!top, ucshow=new, ucshow=!new
v1.20: Introduced ucprop=sizediff
v1.18: Introduced uctoponly
v1.16: Introduced ucprop=parsedcomment, ucprop=size, ucprop=tags, uctag
v1.15: Introduced ucprop=patrolled, ucshow=patrolled, ucshow=!patrolled
v1.14: Introduced uccontinue
v1.13: Introduced ucuserprefix
v1.11: Introduced ucnamespace, ucprop, ucshow

Additional notes

The module returns page edits and moves, but not other operations, such as uploads.

Prior to MediaWiki v1.14, the start parameter was used to view additional results within the response. Between v1.14 and v1.22, start was used to continue when listing a single user's contributions; continue was used when listing contributions from multiple users. From v1.23 forwards, all queries use continue.