API:Etiquette

''' This page is a work in progress. '''

Also read the main>Special:MyLanguage/API:Main page|quick start guide.

It answers some questions not answered here and points to other useful pages.

Help

 * 1) faq>Special:MyLanguage/API:FAQ|Read this FAQ.


 * 1) Try to find the answer to your question in the main>Special:MyLanguage/API:Main page|API documentation here, in the API sandbox or on the [http://en.wikipedia.org/w/api.php self-documenting API home page].


 * 1) If you can't find the answer to your question on the web, you can ask your question on the [https://lists.wikimedia.org/mailman/listinfo/mediawiki-api mediawiki-api mailing list].

Request limit
There is no hard and fast limit on read requests, but we ask that you be considerate and try not to take a site down.

Most sysadmins reserve the right to unceremoniously block you if you do endanger the stability of their 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. For example: specify multiple '|'-separated titles in a   parameter instead of making a new request for each title; use a "query>Special:MyLanguage/API:Query#Generators|generator" instead of making a request for each result from another request.

Parsing of revisions
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:


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

Use maxlag parameter
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 behavior, lower values are nicer.

See:

User-Agent header
Use a descriptive   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 main>Special:MyLanguage/API:Main page#Identifying your client|API:Main page#Identifying your client and meta>m:User-Agent policy|m:User-Agent policy for details.

Thinking about performance generally
If you are trying to figure out why you are getting results more slowly than you would like, try  to help you think about performance generally.

If you are finding that reading via the API rather than directly reading from databases is impeding your client's performance, consider whether to [<tvar|url>http://tools.wmflabs.org/</> put it into Wikimedia's Tool Labs].