API:Backlinks

This page is part of the MediaWiki API documentation.

MediaWiki API

Quick overview:

• Quick start guide
• FAQ
  • Etiquette and usage limits
• Tutorial
• Formats
• Error reporting
• Restricting usage
• Cross-site requests
• Authentication
  • Login
  • Logout
  • Account creation
• Queries
  • Meta information
  • Properties
  • Lists
• Search suggestions
• Parsing wikitext and expanding templates
• Purging pages' caches
• Parameter information
• Changing wiki content
  • Create and edit pages
  • Move pages
  • Rollback
  • Delete pages
  • Restore deleted revisions
  • (Un)protect pages
  • (Un)block users
  • (Un)watch pages
  • Mark revisions of watched pages as visited
  • Send email
  • Patrol changes
  • Import pages
  • Change user group membership
  • Upload files
  • User options
  • Tokens
  • Page language
• Watchlist feed
• Wikidata
• Extensions
• Using the API in MediaWiki and extensions
• Miscellaneous
• Implementation
• Client code
• Asserting

MediaWiki version:

1.9

Lists pages that link to a given page, similar to Special:Whatlinkshere. Ordered by linking page title.

Parameters

• bltitle: List pages linking to this title. The title does not need to exist.
• blnamespace: Only list pages in these namespaces
• blfilterredir: How to filter redirects (Default: all)
  • all: List all pages regardless of their redirect flag
  • redirects: Only list redirects
  • nonredirects: Don't list redirects
• bllimit: Maximum amount of pages to list. Maximum limit is halved if blredirect is set. No more than 500 (5000 for bots) allowed. (Default: 10)
• blredirect: If set, pages linking to bltitle through a redirect will also be listed. See below for more detailed information.
• blcontinue: Used to continue a previous request

Example

Find all pages that redirect to en:Main Page.

api.php?action=query&list=backlinks&bltitle=Main%20Page&bllimit=5&blfilterredir=redirects

Other links

Links through redirects

MediaWiki version:

1.12

When the blredirect parameter is set, this module behaves slightly differently. bllimit applies to both levels separately: if e.g. bllimit=10, at most 10 first-level pages (pages that link to bltitle) and 10 second-level pages (pages that link to bltitle through a redirect) will be listed. Continuing queries also works differently, as displayed in the following example.

Get a list of pages linking to Albert Einstein (note: the initial query includes a "blcontinue" parameter for purposes of illustration)

api.php?action=query&list=backlinks&bltitle=Albert_Einstein&blredirect&blcontinue=0|Albert_Einstein|8756

When continuing this request, we see that there are more pages linking to Einstein, and that some of the other first-level pages are listed again. If we continue this query again, the same first-level pages will be listed in the next response, as well. To progress beyond Energy, we have to query-continue again and again until we've had all links to Einstein (or increase bllimit, of course). Continuing the previous request:

api.php?action=query&list=backlinks&bltitle=Albert_Einstein&blredirect&blcontinue=0|Albert_Einstein|9292|11439

Links through transclusions

If you need to list pages as they appear in "What links here" on the MediaWiki sites with pages transcluding the desired page, you might want to try API:Embeddedin list.

Links through image usage

If you need to list pages as they appear in "What links here" on the MediaWiki sites with pages displaying the desired file, you might want to try API:Imageusage list. This also works on non-existent files.

Error Codes

Code	Info
blbadcontinue	Invalid continue param. You should pass the original value returned by the previous query.