REST API

From MediaWiki.org
Jump to: navigation, search

The Wikimedia REST API offers access to Wikimedia's content and metadata in machine-readable formats. Focused on high-volume use cases, it tightly integrates with Wikimedia's globally distributed caching infrastructure. As a result, API users benefit from reduced latencies and support for high request volumes.

The REST API along with its documentation is available for all major Wikimedia projects at the location /api/rest_v1/. For example, for the English wikipedia it is available at https://en.wikipedia.org/api/rest_v1/.

While the functionality offered by most projects closely matches that on English wikipedia, there are some noteworthy exceptions:

Versioning[edit]

The REST API follows this API versioning policy.

Terms and conditions[edit]

  • By using the REST API, you agree to Wikimedia's general Terms of Use and Privacy Policy.
  • To avoid impacting other API users, limit your clients to no more than 200 requests/s to this API overall. Many entry points additionally specify and enforce more restrictive rate limits.
  • We ask you to set a unique User-Agent or Api-User-Agent header that allows us to contact you quickly. Email addresses or URLs of contact pages work well.

See also[edit]

  • Blog post announcing the 1.0 release. Describes several important production use cases, discusses how the REST API fits into Wikimedia's larger technical strategy, and provides pointers to some implementation details.
  • The API is implemented using Node.js. This blog post describes our experience upgrading the REST API and other services to Node 6.
  • Wikimedia Services team, product owners for the REST API.