API:Redirects
From MediaWiki.org
For resolving redirects in API queries, see API:Query#Resolving redirects.
| Redirects | ||
|---|---|---|
| Returns all redirects to the given pages. This module can be used as a Generator. |
||
| Prefix | rd | |
| Required rights | none | |
| Post only? | No | |
| Generated help | Current | |
| Version added |
|
|
Returns all redirects to the given pages. This module can be used as a generator.
Parameters[edit]
rdprop: Which properties to get. (Default:pageid|title)pageid: Get the page id of each page.title: Get the title of each page.fragment: Fragment of each redirect, if any.
rdnamespace: Only include pages in these namespaces.rdshow: Show only items that meet these criteria.fragment: Only show redirects with a fragment.!fragment: Only show redirects without a fragment.
rdlimit: The number of results to return. No more than 500 (5000 for bots) allowed. (Default: 10)rdcontinue: When more results are available, use this to continue.
Example[edit]
Get a list of redirects linking to the Main Page.
| Result |
|---|
{
"query": {
"pages": {
"15580374": {
"pageid": 15580374,
"ns": 0,
"title": "Main Page",
"linkshere": [
{
"pageid": 354,
"ns": 1,
"title": "Talk:Algeria"
},
{
"pageid": 672,
"ns": 1,
"title": "Talk:Arc de Triomphe"
},
{
"pageid": 1039,
"ns": 1,
"title": "Talk:Aarhus"
},
{
"pageid": 1054,
"ns": 1,
"title": "Talk:All Saints' Day"
},
{
"pageid": 1284,
"ns": 1,
"title": "Talk:Alabama"
},
{
"pageid": 1390,
"ns": 1,
"title": "Talk:Alan Turing"
},
{
"pageid": 1463,
"ns": 1,
"title": "Talk:Apollo program"
},
{
"pageid": 1720,
"ns": 1,
"title": "Talk:Aleksandr Solzhenitsyn"
},
{
"pageid": 1868,
"ns": 1,
"title": "Talk:The Ashes"
},
{
"pageid": 2066,
"ns": 1,
"title": "Talk:HIV/AIDS"
}
]
}
}
}
}
|
Possible errors[edit]
| Code | Info |
|---|---|
| rdshow | Incorrect parameter - mutually exclusive values may not be supplied |
 |
The following documentation is the output of Special:ApiHelp/query+redirects, automatically generated by the pre-release version of MediaWiki that is running on this site (MediaWiki.org). |
prop=redirects (rd)
- This module requires read rights.
- This module can be used as a generator.
- Source: MediaWiki
- License: GPL-2.0+
Returns all redirects to the given pages.
Parameters:
- rdprop
-
Which properties to get:
- pageid
- Page ID of each redirect.
- title
- Title of each redirect.
- fragment
- Fragment of each redirect, if any.
- Values (separate with | or alternative): pageid, title, fragment
- Default: pageid|title
- rdnamespace
-
Only include pages in these namespaces.
Note: Due to miser mode, using this may result in fewer than rdlimit results returned before continuing; in extreme cases, zero results may be returned.
- Values (separate with | or alternative): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 90, 91, 92, 93, 100, 101, 102, 103, 104, 105, 106, 107, 486, 487, 828, 829, 1198, 1199, 2300, 2301, 2302, 2303, 2600
- To specify all values, use *.
- rdshow
-
Show only items that meet these criteria:
- fragment
- Only show redirects with a fragment.
- !fragment
- Only show redirects without a fragment.
- Values (separate with | or alternative): fragment, !fragment
- rdlimit
-
How many redirects to return.
- No more than 500 (5,000 for bots) allowed.
- Type: integer or max
- Default: 10
- rdcontinue
-
When more results are available, use this to continue.
Examples:
- Get a list of redirects to the Main Page.
- api.php?action=query&prop=redirects&titles=Main%20Page [open in sandbox]
- Get information about all redirects to the Main Page.
- api.php?action=query&generator=redirects&titles=Main%20Page&prop=info [open in sandbox]
