2. API¶
Note
Please first review the MediaWiki API and REST API to see if they meet your needs. These will be considerably faster than XTools and allow for asynchronous requests.
2.1. Response format¶
All endpoints will return the requested parameters (such as project
, username
, etc.), the requested data,
followed by the elapsed_time
of how long the request took to process in seconds.
Check the examples in the documentation for the exact format of each endpoint. All data is returned as JSON, in addition to other formats as noted.
This API is not versioned. Make note of warnings in the response that will announce deprecations and future changes.
2.2. Errors and warnings¶
Error messages will be given error
key. Flash messages may also be shown with the keys info
, warning
or
danger
. Keep an eye out for warning
in particular, which will announce deprecations.
To ensure performance and stability, most endpoints related to users will return an error if the user has made an exceptionally high number of edits.
2.3. Endpoints¶
- 2.3.1. Project API
- 2.3.2. User API
- 2.3.2.1. Simple edit count
- 2.3.2.2. Number of pages created
- 2.3.2.3. Pages created
- 2.3.2.4. Automated edit counter
- 2.3.2.5. Non-automated edits
- 2.3.2.6. Automated edits
- 2.3.2.7. Automated tools
- 2.3.2.8. Edit summaries
- 2.3.2.9. Top edits
- 2.3.2.10. Category edit counter
- 2.3.2.11. Log counts
- 2.3.2.12. Namespace totals
- 2.3.2.13. Month counts
- 2.3.2.14. Time Card
- 2.3.3. Page API
- 2.3.4. Quote API