MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

list=blocks (bk)

(main | query | blocks)

List all blocked users and IP addresses.

Parameters:
bkstart

The timestamp to start enumerating from.

Type: timestamp (allowed formats)
bkend

The timestamp to stop enumerating at.

Type: timestamp (allowed formats)
bkdir

In which direction to enumerate:

newer
List oldest first. Note: bkstart has to be before bkend.
older
List newest first (default). Note: bkstart has to be later than bkend.
One of the following values: newer, older
Default: older
bkids

List of block IDs to list (optional).

Type: list of integers
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
bkusers

List of users to search for (optional).

Type: list of users, by any of user name, IP and IP range
Separate values with | or alternative.
Maximum number of values is 50 (500 for clients allowed higher limits).
bkip

Get all blocks applying to this IP address or CIDR range, including range blocks. Cannot be used together with bkusers. CIDR ranges broader than IPv4/16 or IPv6/19 are not accepted.

bklimit

The maximum number of blocks to list.

Type: integer or max
The value must be between 1 and 500.
Default: 10
bkprop

Which properties to get:

id
Adds the ID of the block.
user
Adds the username of the blocked user.
userid
Adds the user ID of the blocked user.
by
Adds the username of the blocking user.
byid
Adds the user ID of the blocking user.
timestamp
Adds the timestamp of when the block was given.
expiry
Adds the timestamp of when the block expires.
reason
Adds the reason given for the block.
range
Adds the range of IP addresses affected by the block.
flags
Tags the ban with (autoblock, anononly, etc.).
restrictions
Adds the partial block restrictions if the block is not sitewide.
Values (separate with | or alternative): by, byid, expiry, flags, id, range, reason, restrictions, timestamp, user, userid
Default: id|user|by|timestamp|expiry|reason|flags
bkshow

Show only items that meet these criteria. For example, to see only indefinite blocks on IP addresses, set bkshow=ip|!temp.

Values (separate with | or alternative): !account, !ip, !range, !temp, account, ip, range, temp
bkcontinue

When more results are available, use this to continue.

Examples:
List blocks.
api.php?action=query&list=blocks [open in sandbox]
List blocks of users Alice and Bob.
api.php?action=query&list=blocks&bkusers=Alice|Bob [open in sandbox]

Retrieved from Special:ApiHelp – Max-EuP 2012 on 27 April 2025.

Terms of Use

The Max Planck Encyclopedia of European Private Law, published as a print work in 2012, has been made freely available in 2021 as an online edition at <max-eup2012.mpipriv.de>.

The materials published here are subject to exclusive rights of use as held by the Max Planck Institute for Comparative and International Private Law and the publisher Oxford University Press; they may only be used for non-commercial purposes. Users may download, print, and make copies of the text files being made freely available to the public. Further, users may translate excerpts of the entries and cite them in the context of academic work, provided that the following requirements are met:

  • Use for non-commercial purposes
  • The textual integrity of each entry and its elements is maintained
  • Citation of the online reference according to academic standards, indicating the author, keyword title, work name, and date of retrieval (see Suggested Citation Style).