API:Blocks

This page is part of the MediaWiki action API documentation.

MediaWiki APIsAPI:Main page

• Web APIs showcaseAPI:Web APIs hub
• REST content API

MediaWiki action API

• Introduction and quick startAPI:Main page
• FAQAPI:FAQ
  • Etiquette and usage limitsAPI:Etiquette
• TutorialAPI:Tutorial
• FormatsAPI:Data formats
• Error reportingAPI:Errors and warnings
• Restricting usageAPI:Restricting API usage
• Cross-site requestsAPI:Cross-site requests
• Authentication
  • LoginAPI:Login
  • LogoutAPI:Logout
  • Account creationAPI:Account creation
• QueriesAPI:Query
  • Meta informationAPI:Meta
  • PropertiesAPI:Properties
  • ListsAPI:Lists
• Searching (by title, content, coordinates...)API:Search and discovery
• Parsing wikitext and expanding templatesAPI:Parsing wikitext
• Purging pages' cachesAPI:Purge
• Parameter informationAPI:Parameter information
• Changing wiki contentAPI:Changing wiki content
  • Create and edit pagesAPI:Edit
  • Move pagesAPI:Move
  • RollbackAPI:Rollback
  • Delete pagesAPI:Delete
  • Restore deleted revisionsAPI:Undelete
  • (Un)protect pagesAPI:Protect
  • (Un)block usersAPI:Block
  • (Un)watch pagesAPI:Watch
  • Mark revisions of watched pages as visitedAPI:SetNotificationTimestamp
  • Send emailAPI:Email
  • Patrol changesAPI:Patrol
  • Import pagesAPI:Import
  • Change user group membershipAPI:User group membership
  • Upload filesAPI:Upload
  • User optionsAPI:Options
  • TokensAPI:Tokens
  • Page languageAPI:PageLanguage
• Watchlist feedAPI:Watchlist feed
• WikidataWikibase/API
• ExtensionsAPI:Extensions
• Using the API in MediaWiki and extensionsAPI:Calling internally
• MiscellaneousAPI:Other services
• ImplementationAPI:Implementation Strategy
  • LocalisationAPI:Localisation
• Client codeAPI:Client code
• AssertingAPI:Assert

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

Blocks
This module cannot be used as a GeneratorAPI: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)
  • 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.

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

• API:Globalblocks