API:Iwlinks

This page is part of the MediaWiki Action API documentation.

MediaWiki version:

≥ 1.17

GET request to list interwiki links from a given page.

API documentation

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

prop=iwlinks (iw)

(main | query | iwlinks)

This module requires read rights.
Source: MediaWiki
License: GPL-2.0-or-later

Returns all interwiki links from the given pages.

https://www.mediawiki.org/wiki/Special:MyLanguage/API:Iwlinks

Specific parameters:

Other general parameters are available.

iwprop

Which additional properties to get for each interwiki link:

url: Adds the full URL.

Values (separate with | or alternative): url

iwprefix

Only return interwiki links with this prefix.

iwtitle

Interwiki link to search for. Must be used with iwprefix.

iwdir

The direction in which to list.

One of the following values: ascending, descending

Default: ascending

iwlimit

How many interwiki links to return.

Type: integer or max

The value must be between 1 and 500.

Default: 10

iwcontinue

When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.

iwurl

Deprecated.

Whether to get the full URL (cannot be used with iwprop).

Type: boolean (details)

Example:

Get interwiki links from the page MediaWiki.: api.php?action=query&prop=iwlinks&titles=MediaWiki [open in sandbox]

Example

GET request

Get a list of interwiki links from Albert Einstein.

api.php?action=query&format=json&prop=iwlinks&titles=Albert%20Einstein [try in ApiSandbox]

Response

{
    "query": {
        "pages": [
            {
                "pageid": 736,
                "ns": 0,
                "title": "Albert Einstein",
                "iwlinks": [
                    {
                        "prefix": "b",
                        "title": "Introduction_to_Astrophysics/Albert_Einstein"
                    },
                    {
                        "prefix": "c",
                        "title": "Special:Search/Albert_Einstein"
                    },
                    {
                        "prefix": "commons",
                        "title": "Special:Search/Albert_Einstein"
                    },
                    ...                   
                ]
            }
        ]
    }
}

Sample code

Python

#!/usr/bin/python3

"""
    python/get_iwlinks.py

    MediaWiki API Demos
    Demo of `Iwlinks` module: Get the interwiki links from a given page.

    MIT License
"""

import requests

S = requests.Session()

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

PARAMS = {
    "action": "query",
    "format": "json",
    "prop": "iwlinks",
    "titles": "Albert Einstein"
}

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

PAGES = DATA["query"]["pages"]

for k, v in PAGES.items():
    print(v["iwlinks"])

PHP

<?php
/*
    get_iwlinks.php

    MediaWiki API Demos
    Demo of `Iwlinks` module: Get the interwiki links from a given page.

    MIT License
*/

$endPoint = "https://en.wikipedia.org/w/api.php";
$params = [
    "action" => "query",
    "format" => "json",
    "prop" => "iwlinks",
    "titles" => "Albert Einstein"
];

$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"]["pages"] as $k => $v ) {
    var_dump( $v["iwlinks"] );
}

JavaScript

/*
    get_iwlinks.js

    MediaWiki API Demos
    Demo of `Iwlinks` module: Get the interwiki links from a given page.

    MIT License
*/

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

var params = {
    action: "query",
    format: "json",
    prop: "iwlinks",
    titles: "Albert Einstein"
};

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 pages = response.query.pages;
        for (var p in pages) {
            console.log(pages[p].iwlinks);
        }
    })
    .catch(function(error){console.log(error);});

MediaWiki JS

/*
	get_iwlinks.js

	MediaWiki API Demos
	Demo of `Iwlinks` module: Get the interwiki links from a given page.

	MIT License
*/

var params = {
		action: 'query',
		format: 'json',
		prop: 'iwlinks',
		titles: 'Albert Einstein'
	},
	api = new mw.Api();

api.get( params ).done( function ( data ) {
	var pages = data.query.pages,
		p;
	for ( p in pages ) {
		console.log( pages[ p ].iwlinks );
	}
} );

Possible errors


Code	Info
invalidparammix	The `title` parameter may only be used with `prefix`.

Parameter history

v1.24:
- Introduced iwprop, url
- Deprecated iwurl
v1.19: Introduced iwdir
v1.18: Introduced iwprefix, iwtitle