API:Watchlistraw/ru
 | Эта страница является частью документации по API действий MediaWiki. |
| Версия MediaWiki: | ≥ 1.14 |
GET request to list all the pages on the logged in user's watchlist, regardless of whether they were recently changed or not.
This module can be used as a generator.
API documentation
Example
GET request
Get three pages on the logged-in user's watchlist from the main namespace.
api.php?
Response
{
"batchcomplete": "",
"continue": {
"continue": "-||",
"wrcontinue": "0|Software"
},
"watchlistraw": [
{
"ns": 0,
"title": "Free and open-source software"
},
{
"ns": 0,
"title": "Free software"
},
{
"ns": 0,
"title": "Proprietary software"
}
]
}
Sample code
Python
#!/usr/bin/python3
"""
get_watchlistraw.py
MediaWiki API Demos
Demo of `Watchlistraw` module: Get three pages on the logged-in user's
watchlist from the main namespace.
MIT License
"""
import requests
S = requests.Session()
URL = "https://en.wikipedia.org/w/api.php"
# Step 1: Retrieve a login token
PARAMS_1 = {
"action": "query",
"meta": "tokens",
"type": "login",
"format": "json"
}
R = S.get(url=URL, params=PARAMS_1)
DATA = R.json()
LOGIN_TOKEN = DATA['query']['tokens']['logintoken']
# Step 2: Send a post request to log in. For this login
# method, Obtain bot credentials by visiting
# https://en.wikipedia.org/wiki/Special:BotPasswords/
# See https://www.mediawiki.org/wiki/API:Login for more
# information on log in methods.
PARAMS_2 = {
"action": "login",
"lgname": "username",
"lgpassword": "password",
"format": "json",
"lgtoken": LOGIN_TOKEN
}
R = S.post(URL, data=PARAMS_2)
# Step 3: While logged in, get the watchlist
PARAMS_3 = {
"action": "query",
"list": "watchlistraw",
"format": "json",
"wrnamespace": "0",
"wrlimit": "3"
}
R = S.get(url=URL, params=PARAMS_3)
DATA = R.json()
print(DATA)
PHP
<?php
/*
get_watchlistraw.php
MediaWiki API Demos
Demo of `Watchlistraw` module: Get three pages on the logged-in user's
watchlist from the main namespace.
MIT license
*/
$endPoint = "https://test.wikipedia.org/w/api.php";
$login_Token = getLoginToken(); // Step 1
loginRequest( $login_Token ); // Step 2
watchlist(); // Step 3
// Step 1: GET request to fetch login token
function getLoginToken() {
global $endPoint;
$params1 = [
"action" => "query",
"meta" => "tokens",
"type" => "login",
"format" => "json"
];
$url = $endPoint . "?" . http_build_query( $params1 );
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
$result = json_decode( $output, true );
return $result["query"]["tokens"]["logintoken"];
}
// Step 2: POST request to log in. Use of main account for login is not
// supported. Obtain credentials via Special:BotPasswords
// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
function loginRequest( $logintoken ) {
global $endPoint;
$params2 = [
"action" => "login",
"lgname" => "bot_user_name",
"lgpassword" => "bot_password",
"lgtoken" => $logintoken,
"format" => "json"
];
$ch = curl_init();
curl_setopt( $ch, CURLOPT_URL, $endPoint );
curl_setopt( $ch, CURLOPT_POST, true );
curl_setopt( $ch, CURLOPT_POSTFIELDS, http_build_query( $params2 ) );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
}
// Step 3: GET request to get the watchlist
function watchlist() {
global $endPoint;
$params3 = [
"action" => "query",
"list" => "watchlistraw",
"wrnamespace" => "0",
"wrlimit" => "3",
"format" => "json"
];
$url = $endPoint . "?" . http_build_query( $params3 );
$ch = curl_init( $url );
curl_setopt( $ch, CURLOPT_RETURNTRANSFER, true );
curl_setopt( $ch, CURLOPT_COOKIEJAR, "cookie.txt" );
curl_setopt( $ch, CURLOPT_COOKIEFILE, "cookie.txt" );
$output = curl_exec( $ch );
curl_close( $ch );
echo ( $output );
}
JavaScript
/*
get_watchlistraw.js
MediaWiki API Demos
Demo of `Watchlistraw` module: Get three pages on the logged-in user's
watchlist from the main namespace.
MIT license
*/
var request = require('request').defaults({jar: true}),
url = "https://test.wikipedia.org/w/api.php";
// Step 1: GET request to fetch login token
function getLoginToken() {
var params_0 = {
action: "query",
meta: "tokens",
type: "login",
format: "json"
};
request.get({ url: url, qs: params_0 }, function (error, res, body) {
if (error) {
return;
}
var data = JSON.parse(body);
loginRequest(data.query.tokens.logintoken);
});
}
// Step 2: POST request to log in.
// Use of main account for login is not
// supported. Obtain credentials via Special:BotPasswords
// (https://www.mediawiki.org/wiki/Special:BotPasswords) for lgname & lgpassword
function loginRequest(login_token) {
var params_1 = {
action: "login",
lgname: "bot_username",
lgpassword: "bot_password",
lgtoken: login_token,
format: "json"
};
request.post({ url: url, form: params_1 }, function (error, res, body) {
if (error) {
return;
}
get_watchlistraw();
});
}
// Step 3: POST request to get the watchlist
function get_watchlistraw() {
var params_3 = {
action: "query",
list: "watchlistraw",
wrnamespace: "0",
wrlimit: "3",
format: "json"
};
request.post({ url: url, form: params_3 }, function (error, res, body) {
if (error) {
return;
}
console.log(body);
});
}
// Start From Step 1
getLoginToken();
MediaWiki JS
/*
get_watchlistraw.js
MediaWiki API Demos
Demo of `Watchlistraw` module: Get three pages on the logged-in user's
watchlist from the main namespace.
MIT License
*/
var params = {
action: 'query',
list: 'watchlistraw',
wrnamespace: '0',
wrlimit: '3',
format: 'json'
},
api = new mw.Api();
api.get( params ).done( function ( data ) {
console.log( data );
} );
Possible errors
| Code | Info |
|---|---|
| bad_wlowner | Specified user does not exist. |
| bad_wltoken | Предоставлен некорректный токен списка наблюдения. Пожалуйста, установите корректный токен в Special:Preferences. |
| notloggedin | You must be logged-in to have a watchlist. |
| show | Некорректный параметр — вручную исключённые значения не могут быть обработаны. |
Parameter history
- v1.20: Introduced
wrdir - v1.17: Introduced
wrowner,wrtoken
Additional notes
- This module should not be confused with API:Список наблюдения, which returns pages on the current user's watchlist that were changed within the given time period, ordered by time of the last change of the watched page.
- The results of this query module are returned as part of the
apinode, not thequerynode.
См. также
- API:Список наблюдения - Get pages on a user's watchlist that were changed within the given time period, ordered by time of the last change of the watched page.
- API:Лента списка наблюдения - Get the RSS feed of a user's watchlist.