API:Etiquette

From MediaWiki.org
Jump to: navigation, search
Tools clipart.png This page is part of the MediaWiki API documentation.
Language: English  • Deutsch • 日本語
MediaWiki API

Quick overview:

v · d · e

NOTE: This page is a work in progress

Also read the quick start guide. It answers some questions not answered here and points to other useful pages.

Help[edit | edit source]

  1. Read this FAQ.
  2. Try to find the answer to your question in the API documentation here or on the self-documenting API home page.
  3. If you can't find the answer to your question on the web, you can ask your question on the mediawiki-api mailing list.

Behavior[edit | edit source]

Request limit[edit | edit source]

There is no hard and fast limit on read requests, but we ask that you be considerate and try not to take the site down. We also reserve the right to unceremoniously block you if you do endanger the stability of the site.

If you make your requests in series rather than in parallel (i.e. wait for the one request to finish before sending a new request, such that you're never making more than one request at the same time), then you should definitely be fine. Also try to combine things into one request where you can (e.g. use multiple titles in a titles parameter instead of making a new request for each title. Or use "generator" if possible instead of making a request for each result from another request).

Parsing of revisions[edit | edit source]

While it is possible to query for results from a specific revision number this is an expensive operation for the servers. To retrieve a specific revision use the 'oldid' parameter, example:

Use maxlag parameter[edit | edit source]

If your task is not interactive (i.e. A user is not waiting for the result) you should use the maxlag parameter. This will prevent your task from running when the load on the servers is high. Higher values mean more aggressive behaviour, lower values are nicer.

See: Manual:Maxlag_parameter

User-Agent header[edit | edit source]

Use a descriptive User-Agent header that includes your application's name and potentially your email address if appropriate. Do not simply copy the user-agent of a popular web browser (Unless your API client is a JavaScript application running through said web browser via Ajax, in which case one cannot modify the user-agent). This ensures that if a problem does arise it is easy to track down where it originates. See API:Quick_start_guide#Identifying_your_client and meta:User-Agent_policy for details.