API:Blocks

MediaWiki Action API
Basics All Query modules Get properties of pages List pages matching a criterion Get module parameters information Get meta information about the wiki and user Authentication Get tokens for data modifying operations Login Logout Assert user Accounts and Users Create an account Block or unblock a user Get the current user's watchlist as a feed Change user options Change user group membership Send an email Page Operations Parse content of a page Create and edit a page Upload a file Import a page Delete a page Watch or unwatch a page Purge cache for page(s) Rollback a page Move a page Patrol a page or revision Restore revisions of a deleted page Change a page's protection level Change a page's language More... Search Search for a title or text Fetch results in an OpenSearch format Search for wiki pages near a location Search for a language Perform a prefix search for page titles Developer Utilities Access libraries Cross-site requests Creating an API module in an extension Using the API in MediaWiki and extensions Restricting API usage Localisation Implementation strategy

For the API for handing out blocks, see API:Block.

Blocks
This module cannot be used as a Generator .
Prefix	bk
Required rights	none
Post only?	No
Generated help	Current
Version added	≥ 1.12

List all blocks, à la Special:Ipblocklist. This module cannot be used as a generator.

Parameters

• bkstart: The timestamp to start listing from
• bkend: The timestamp to end listing at
• bkdir: Direction to list in. (Default: older)
  • older: List newest blocks first. Note: bkstart has to be later than bkend.
  • newer: List oldest blocks first. Note: bkstart has to be before bkend.
• bkids: Only list blocks with these IDs
• bkusers: Only list blocks of these user names
• bkip: List all blocks, including range blocks, that apply to this IP address. You can also specify a CIDR range here, in which case only blocks applying to the entire range will be listed. Cannot be used together with bkusers. CIDR ranges broader than /16 are not allowed, as range blocks cannot cross /16 boundaries
• bklimit: Maximum number of blocks to list (Default: 10)
• bkprop: A pipe-separated list of properties to get. They appear as keys of returned dictionary. (Default: id|user|by|timestamp|expiry|reason|flags)
  • id: The ID of the block
  • user: The IP address or username that was blocked (does not appear in output for autoblocks)
  • userid: The id of user who was blocked (does not appear in output for autoblocks) 1.18+
  • by: The user who applied the block
  • byid: The id of user who applied the block
  • timestamp: When the block was applied
  • expiry: When the block will expire
  • reason: The reason for the block
  • range: If an IP range was blocked, the first and last IP the block applies to

    Will appear as rangestart and rangeend in the answer, both 0.0.0.0 for registered users. Same as user for standalone IPs.

  • flags: Flags that apply to the block

    The appropriate flags will appear as keys of returned dictionary with an empty value. No key if the flag is not valid for the block.

    • automatic: Automatically blocked because of an autoblock (see also action=block)
    • anononly: Only anonymous edits are blocked
    • nocreate: Account creation is disabled
    • autoblock: Automatic blocking is enabled for this block
    • noemail: Sending e-mail through the wiki is disabled for the blocked user
    • allowusertalk: The user is allowed to edit his/her own talk page
    • hidden: This block is hidden from Special:Ipblocklist. Only users with oversight permissions can see these blocks.
• bkshow: Show only items that meet these criteria. Conflicting options, like account|ip, are allowed, but won't return any results. 1.19+
  • account: Only show account blocks.
  • !account: Show everything except account blocks.
  • temp: Only show temporary blocks.
  • !temp: Show everything except temporary blocks.
  • ip: Only show single IP blocks.
  • !ip: Show everything except single IP blocks.
  • range: Only show range blocks.
  • !range: Show everything except range blocks.

Example

Listing the 3 most recent blocks

api.php?action=query&list=blocks&bkprop=id|user|by|timestamp|expiry|reason|range|flags&bklimit=3 [try in ApiSandbox]

Error Codes

None.

See also

• Extension:GlobalBlocking/API

---

list=blocks (bk)

(main | query | blocks)

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

List all blocked users and IP addresses.

• https://www.mediawiki.org/wiki/Special:MyLanguage/API:Blocks

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 bots).

bkusers

List of users to search for (optional).

Type: list of user names

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).

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.

No more than 500 (5,000 for bots) allowed.

Type: integer or max

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): id, user, userid, by, byid, timestamp, expiry, reason, range, flags, restrictions

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, !account, temp, !temp, ip, !ip, range, !range

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]