API:Etiquette

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.

get help?

 * 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.

keep in mind
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 first request to finish before sending the second request, such that you're never making more than one request at the same time), you should definitely be fine. You should also try to combine things into one request where you can.

query for revisions sparingly
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, I.E.


 * http://en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=254862759
 * http://en.wikipedia.org/w/api.php?action=parse&format=xml&prop=images&oldid=462841413

use the maxlag parameter for non-interactive tasks
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.

See: Manual:Maxlag_parameter