View source for Wikidata:Data access/sw

<languages />
__NOEDITSECTION__
{| style="margin:0 auto; border-spacing:0;"
|-
| style="padding:10px;" | [[File:Noun Project knowledge icon 2805247.svg|100px|link=|class=skin-invert-image]]
| style="height:1%; font:45px/1.3 FreeSans, Gill Sans MT, GillSansSA, Calibri, sans-serif; color:var(--color-subtle, #54595d); padding:20px 0 5px; vertical-align:middle;" | <span lang="en" dir="ltr" class="mw-content-ltr">Wikidata For Developers: Data access</span>
|}

{{Wikidata:For developers/Header}}

----

<div lang="en" dir="ltr" class="mw-content-ltr">
Wikidata currently contains over 120 million Items and over 1,3 million Lexemes, and these numbers will keep on growing. There are many methods available to access all that data—this document lays them out and helps prospective users choose the best method to suit their needs.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
It's crucial to choose an access method that gives you the data you need in the quickest, most efficient way while not putting unnecessary load on Wikidata; this page is here to help you do just that.
</div>

__TOC__

== <span lang="en" dir="ltr" class="mw-content-ltr">Before we begin</span> <span id="beforewebegin"></span> ==
<section begin=bpsection />
=== <span lang="en" dir="ltr" class="mw-content-ltr">Using Wikidata's data</span> ===

[[{{LM|Wikidata-logo|svg|-}}|thumb|<span lang="en" dir="ltr" class="mw-content-ltr">Our logo</span>]]

<div lang="en" dir="ltr" class="mw-content-ltr">
Wikidata offers a wide range of general data about everything under the sun.  All that data is licensed [https://creativecommons.org/about/cc0 CC0], "No rights reserved", for the public domain.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Changes to APIs and other methods of accessing Wikidata are subject to the [[Special:MyLanguage/Wikidata:Stable Interface Policy|Stable Interface Policy]]. Data sources on this page are '''not guaranteed''' to be stable interfaces.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Wikimedia projects</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
This document is about accessing data from outside Wikimedia projects. If you need to present data from Wikidata in another Wikimedia project, where you can employ parser functions, Lua and/or other internal-only methods, refer to [[Special:MyLanguage/Wikidata:How to use data on Wikimedia projects|How to use data on Wikimedia projects]].
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Data best practices</span> ===

[[File:14-08-10-wikimania-gruppenfoto-01.jpg|thumb|Wenye hiari kama hawa watu - na wewe - huijenga Wikidata]]

<div lang="en" dir="ltr" class="mw-content-ltr">
We offer the data in Wikidata freely and with no requirement for attribution under [https://creativecommons.org/publicdomain/zero/1.0/ CC-0]. In return, we would greatly appreciate it if, in your project, you mention Wikidata as the origin of your data. In so doing you help ensure that Wikidata will stay around for a long time to provide up-to-date and high-quality data. We also promote the best projects that use Wikidata's data.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Some examples for attributing Wikidata: "Powered by Wikidata", "Powered by Wikidata data", "Powered by the magic of Wikidata", "Using Wikidata data", "With data from Wikidata", "Data from Wikidata", "Source: Wikidata", "Including data from Wikidata" and so forth. You can also use one of our [[c:Category:Powered by Wikidata|ready-made files]].
</div>

<gallery>
Wikidata stamp.png
Wikidata Stamp Rec Dark.svg
Wikidata Stamp Rec Light.svg
</gallery>

<div lang="en" dir="ltr" class="mw-content-ltr">
You may use the Wikidata logo shown above, but in so doing you should not in any way imply endorsement by Wikidata or by the Wikimedia Foundation.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Please offer your users a way to report issues in the data, and find a way to feed this back to Wikidata's editor community, for example through the [[Special:MyLanguage/Wikidata:Mismatch Finder|Mismatch Finder]]. Please share the location where you collect these issues on the [[Wikidata:Project chat|Project chat]].
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Access best practices</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
When accessing Wikidata's data, observe the following best practices:
</div>

* <span lang="en" dir="ltr" class="mw-content-ltr">Follow the [[foundation:Policy:Wikimedia Foundation User-Agent Policy|User-Agent policy]] – send a good User-Agent header.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Follow the robot policy: send <code>Accept-Encoding: gzip,deflate</code> and don’t make too many requests at once.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">If you get a 429 Too Many Requests response, stop sending further requests for a while (see the [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Retry-After Retry-After] response header). Please also refer to the [[mw:Wikimedia APIs/Rate_limits|global rate limits]] set for all Wikimedia APIs.</span> 
* <span lang="en" dir="ltr" class="mw-content-ltr">When available (such as with the Wikidata Query Service), set the lowest timeout that makes sense for your data.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">When using the MediaWiki Action API, make liberal use of the <code>maxlag</code> parameter and consult the rest of the guidelines laid out in [[mw:Special:MyLanguage/API:Etiquette|API:Etiquette]].</span><section end=bpsection />

== <span lang="en" dir="ltr" class="mw-content-ltr">Search</span> ==

=== <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Wikidata offers an [https://www.elastic.co/elastic-stack/ Elasticsearch] index for traditional searches through its data: [[Special:Search]]
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Use search when you need to look for a text string, or when you know the names of the entities you're looking for but not the exact entities themselves. It's also suitable for cases in which you can specify your search based on some very simple relations in the data.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Don't use search when the relations in your data are better described as complex.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
You can make your search more powerful with these additional keywords specific to Wikidata: <code>haswbstatement</code>, <code>inlabel</code>, <code>wbstatementquantity</code>, <code>hasdescription</code>, <code>haslabel</code>. This search functionality is documented [[mw:Special:MyLanguage/Help:Extension:WikibaseCirrusSearch|on the CirrusSearch extension page]]. It also has its own [https://wikidata.org/w/api.php?action=query&list=search API action].
</div>

== <span lang="en" dir="ltr" class="mw-content-ltr">Linked Data Interface (URI)</span> <span id="LDI"></span> ==

=== <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
The Linked Data Interface provides access to individual entities via URI: <code><nowiki>http://www.wikidata.org/entity/Q???</nowiki></code>. Such URIs are called concept URIs. Note concept URIs use HTTP, not HTTPS.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Use the Linked Data Interface when you need to obtain individual, complete entities that are already known to you.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Don't use it when you're not clear on which entities you need – first try searching or querying. It's also not suitable for requesting large quantities of data.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===

[[File:Douglas adams portrait cropped.jpg|thumb|<span lang="en" dir="ltr" class="mw-content-ltr">Meet [[Q42]]</span>]]

<div lang="en" dir="ltr" class="mw-content-ltr">
Each Item or Property has a persistent [[wikt:uniform resource identifier|URI]] made up of the Wikidata concept namespace and the Item or Property ID (e.g., <code>Q42</code>, <code>P31</code>) as well as concrete data that can be accessed by that Item's or Property's data [[wikt:Uniform Resource Locator|URL]].
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The namespace for Wikidata's data about entities is <code>https://wikidata.org/wiki/Special:EntityData</code>.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Appending an entity's ID to this prefix (you can use <code>/entity/</code> for short) creates the abstract (format-neutral) form of the entity's data URL. When accessing a resource in the Special:EntityData namespace, the special page applies [[w:content negotiation|content negotiation]] to determine the output format. If you opened the resource in a browser, you'll see an HTML page containing data about the entity, because web browsers prefer HTML. However, a linked-data client would receive the entity data in a format like JSON or RDF – whatever the client specifies in its HTTP <code>Accept:</code> header.
</div>

:<span lang="en" dir="ltr" class="mw-content-ltr">For example, take this ''concept URI'' for Douglas Adams – that's a reference to the real-world person, not to Wikidata's concrete description:</span>

:<code><nowiki>http://www.wikidata.org/entity/Q42</nowiki></code>

:<span lang="en" dir="ltr" class="mw-content-ltr">As a human being with eyes and a browser, you will likely want to access data ''about'' Douglas Adams by using the concept URI as a [[wikt:Uniform Resource Locator|URL]]. Doing so triggers an HTTP redirect and forwards the client to the data URL that contains Wikidata's data ''about'' Douglas Adams: https://www.wikidata.org/wiki/Special:EntityData/Q42.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
When you need to bypass content negotiation, say, in order to view non-HTML content in a web browser, you can specify the format of the entity data by appending the corresponding extension to the data URL; examples include <code>.json</code>, <code>.rdf</code>, <code>.ttl</code>, <code>.nt</code> or <code>.jsonld</code>. For example, <code>https://www.wikidata.org/wiki/Special:EntityData/Q42.json</code> gives you Item Q42 in JSON format.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Less verbose RDF output</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
By default, the RDF data that the Linked Data interface returns is meant to be complete in itself, so it includes descriptions of other entities it refers to. If you want to exclude that information, you can append the query parameter <code>?flavor=dump</code> to the URL(s) you request.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
By appending <code>&flavor=</code> to the URL, you can control exactly what kind of data gets returned.
</div>

* <code>?flavor=dump</code>: <span lang="en" dir="ltr" class="mw-content-ltr">Excludes descriptions of entities referred to in the data.</span>
* <code>?flavor=simple</code>: <span lang="en" dir="ltr" class="mw-content-ltr">Provides only truthy statements (best-ranked statements without [[Special:MyLanguage/Wikidata:Tours/Qualifiers|qualifiers]] or [[Special:MyLanguage/Wikidata:Tours/References|references]]), along with sitelinks and version information.</span>
* <code>?flavor=full</code> (default): <span lang="en" dir="ltr" class="mw-content-ltr">An argument of "full" returns all data. (You don't need to specify this because it's the default.)</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
If you want a deeper insight into exactly what each option entails, you can take a peek into the [https://gerrit.wikimedia.org/r/plugins/gitiles/mediawiki/extensions/Wikibase/+/refs/heads/master/repo/includes/LinkedData/EntityDataSerializationService.php source code].
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Revisions and caching</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
You can request specific revisions of an entity with the <code>revision</code> query parameter: <code>https://www.wikidata.org/wiki/Special:EntityData/Q42.json?revision=112</code>.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The following URL formats are used by the user interface and by the query service updater, respectively, so if you use one of the same URL formats there’s a good chance you’ll get faster (cached) responses:
</div>
* [https://www.wikidata.org/wiki/Special:EntityData/Q42.json?revision=1600533266 https://www.wikidata.org/wiki/Special:EntityData/<var>Q42</var>.json?revision=<var>1600533266</var>] (JSON)
* [https://www.wikidata.org/wiki/Special:EntityData/Q42.ttl?flavor=dump&revision=1600533266 https://www.wikidata.org/wiki/Special:EntityData/<var>Q42</var>.ttl?flavor=dump&revision=<var>1600533266</var>] (<span lang="en" dir="ltr" class="mw-content-ltr">RDF, without descriptions of other entities</span>)

== <span lang="en" dir="ltr" class="mw-content-ltr">Wikidata Query Service</span> ==

{{main|Wikidata:SPARQL query service/Wikidata Query Help}}

=== <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
The Wikidata Query Service (WDQS) is Wikidata's own SPARQL endpoint. It returns the results of queries made in the SPARQL query language: <code>https://query.wikidata.org</code>
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Use WDQS when you know only the characteristics of your desired data.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Don't use WDQS for performing text or fuzzy search – FILTER(REGEX(...)) is an antipattern. (Use [[#Search|search]] in such cases.)
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
WDQS is also not suitable when your desired data is likely to be large, a substantial percentage of all Wikidata's data. (Consider using a [[#Dumps|dump]] in such cases.)
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
You can query the data in Wikidata through our SPARQL endpoint, the [https://query.wikidata.org/ Wikidata Query Service]. The service can be used both as an interactive web interface, or programmatically by submitting <code>GET</code> or <code>POST</code> requests to <code>https://query.wikidata.org/sparql</code>.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The query service is best used when your intended result set is scoped narrowly, i.e., when you have a query you're pretty sure already specifies your resulting data set accurately. If your idea of the result set is less well defined, then the kind of work you'll be doing against the query service will more resemble a search; frequently you'll first need to do this kind of search-related work to sharpen up your query. See the [[#Search|Search]] section.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The query service at query.wikidata.org only contains the main graph of Wikidata. The Items related to scholarly articles are in a separate query service at query-scholarly.wikidata.org. For more details see [[Wikidata:SPARQL query service/WDQS graph split]].
</div>

== <span lang="en" dir="ltr" class="mw-content-ltr">Wikibase REST API</span> {{anchor|wikibase-rest-api}} ==

{{main|Wikidata:REST API}}

=== <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
The Wikibase REST API is an OpenAPI-based interface that allows users to interact with, retrieve and edit items and statements on Wikibase instances – including of course Wikidata: [[Special:MyLanguage/Wikidata:REST API|Wikidata REST API]]
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
The Wikibase REST API is still under development, but for Wikidata it's intended to functionally replace the [[#MediaWiki Action API|Action API]] as it's a dedicated interface made just for Wikibase/Wikidata.
</div> 

<div lang="en" dir="ltr" class="mw-content-ltr">
The use cases for the Action API apply to the Wikibase REST API as well. Use it when your work involves:
</div>

* <span lang="en" dir="ltr" class="mw-content-ltr">Editing Wikidata</span> 
* <span lang="en" dir="ltr" class="mw-content-ltr">Getting direct data about entities themselves</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Don't use the Wikibase REST API when your result set is likely to be large. (Consider using a [[#Dumps|dump]] in such cases.)
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
It's better not to use the Wikibase REST API when you'll need to further narrow the result of your API request. In such cases it's better to frame your work as a [[#Search|search]] (for Elasticsearch) or a [[#Wikidata Query Service|query]] (for WDQS).
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
The Wikibase REST API has [https://doc.wikimedia.org/Wikibase/master/js/rest-api/ OpenAPI documentation] using [https://swagger.io/ Swagger]. You can also review the [https://doc.wikimedia.org/Wikibase/master/php/repo_rest-api_README.html developer documentation] or try the endpoints out with the [https://www.wikidata.org/w/index.php?api=mw-extra&title=Special%3ARestSandbox REST Sandbox].
</div>

== <span lang="en" dir="ltr" class="mw-content-ltr">MediaWiki Action API</span> {{anchor|mediawiki-api}} ==

=== <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
The Wikidata API is MediaWiki's own Action API, extended to include some Wikibase-specific actions: <code>https://wikidata.org/w/api.php</code>
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Use the API when your work involves:
</div>

* <span lang="en" dir="ltr" class="mw-content-ltr">Editing Wikidata</span> 
* <span lang="en" dir="ltr" class="mw-content-ltr">Getting data about entities themselves such as their revision history</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Getting all of the data of an entity in JSON format, in small groups of entities (up to 50 entities per request).</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
Don't use the API when your result set is likely to be large. (Consider using a [[#Dumps|dump]] in such cases.)
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The API is also poorly suited to situations in which you want to request the current state of entities in JSON. (For such cases consider using the [[#Linked Data Interface (URI)|Linked Data Interface]], which is likelier to provide faster responses.)
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Finally, it's probably a bad idea to use the API when you'll need to further narrow the result of your API request. In such cases it's better to frame your work as a [[#Search|search]] (for Elasticsearch) or a [[#Wikidata_Query_Service|query]] (for WDQS).
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===

<span lang="en" dir="ltr" class="mw-content-ltr">The MediaWiki Action API used for Wikidata is meticulously documented [https://www.wikidata.org/w/api.php on Wikidata's API page]. You can explore and experiment with it using the [[Special:ApiSandbox|API Sandbox]].</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
There are multiple Wikibase specific endpoints. Here is an example request:
* [https://www.wikidata.org/wiki/Special:ApiSandbox#action=wbsearchentities&format=json&search=New%20York%2C%20NY&language=en&limit=1&formatversion=2 wbsearchentities search for ''New York, NY'' with limit=1] gives: {{q|Q60}}.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Bots</span> ===

[[File:Bot operator's barnstar.png|thumb|<span lang="en" dir="ltr" class="mw-content-ltr">We welcome well-behaved bots</span>]]

<div lang="en" dir="ltr" class="mw-content-ltr">
You can also access the API by using a bot. For more on bots, see {{ll|Wikidata:Bots}}.
</div>

== <span lang="en" dir="ltr" class="mw-content-ltr">Wikibase GraphQL</span> ==
{{main|Wikidata:Wikibase_GraphQL}}

=== <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===

<span lang="en" dir="ltr" class="mw-content-ltr">Wikibase GraphQL is a GraphQL API for Wikidata.</span> <span lang="en" dir="ltr" class="mw-content-ltr">GraphQL is a flexible data query and manipulation language that enables fetching data declaratively and synthesizing data from multiple sources in a single graph.</span> <span lang="en" dir="ltr" class="mw-content-ltr">The Wikibase GraphQL API optimizes for developer experience, discoverability, and efficient data retrieval.</span>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===

<span lang="en" dir="ltr" class="mw-content-ltr">The Wikibase GraphQL API allows more flexible data retrieval in a single request.</span> <span lang="en" dir="ltr" class="mw-content-ltr">It aims to reduce load on the Wikidata Query Service by handling common read use cases well:</span>

* <span lang="en" dir="ltr" class="mw-content-ltr">Labels of linked entities</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Bulk GET (batch reading Items)</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">Search items by statement property and value</span>

<span lang="en" dir="ltr" class="mw-content-ltr">Use the Wikibase GraphQL API when you have a well-specified result set in mind, especially when those results involve traversing relationships and requesting labels of linked entities.</span>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===

<span lang="en" dir="ltr" class="mw-content-ltr">You can find the Wikibase GraphQL schema file in the wikibase code repository or generate it from the GraphQL endpoint using tools such as <code>get-graphql-schema</code>.</span>

<span lang="en" dir="ltr" class="mw-content-ltr">The easiest way to explore the Wikibase GraphQL API is via interactive GraphQL clients, which provide schema documentation, auto-completion, and immediate feedback.</span> <span lang="en" dir="ltr" class="mw-content-ltr">We list two web-based clients below, but any generic GraphQL-conversant client can be used.</span>

* '''GraphiQL''': <span lang="en" dir="ltr" class="mw-content-ltr">An interactive GraphiQL client available on doc.wikimedia.org.</span>
* '''Apollo Sandbox Explorer''': <span lang="en" dir="ltr" class="mw-content-ltr">A web-based GraphQL explorer provided by Apollo.</span>

== <span lang="en" dir="ltr" class="mw-content-ltr">Recent Changes stream</span> ==

=== <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
The Recent Changes stream provides a continuous stream of changes of all Wikimedia wikis, including Wikidata: <code>https://stream.wikimedia.org</code>
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Use the Recent Changes stream when your project requires you to react to changes in real time or when you need all the latest changes coming from Wikidata – for example, when running your own query service.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
The Recent Changes stream contains all updates from all wikis using the [[wikipedia:Server-sent events|server-sent events]] protocol. You'll need to filter Wikidata's updates out on the client side.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You can find the web interface [https://stream.wikimedia.org at stream.wikimedia.org] and read all about it on the [[wikitech:Event Platform/EventStreams|EventStreams]] page.
</div>

== <span lang="en" dir="ltr" class="mw-content-ltr">Wikidata Vector Database</span> ==
{{main|Wikidata:Vector Database}}

=== <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===
<div lang="en" dir="ltr" class="mw-content-ltr">
The Wikidata Vector Database stores high-dimensional vector representations of Wikidata entities. It enables semantic search based on meaning and context rather than keyword matching, and supports natural-language queries against entities.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===
<div lang="en" dir="ltr" class="mw-content-ltr">
Use vector search for exploration purposes, for example, when you want to uncover entities without explicitly knowing their labels, or when you need to narrow a search down to a smaller, more relevant subgraph of Wikidata as a starting point for further research before moving on to more structured tools.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
The vector database can also be used in AI/ML pipelines, such as enabling semantic search in RAG workflows or applying vector distances to tasks like classification and other types of analysis.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===
<div lang="en" dir="ltr" class="mw-content-ltr">
You can find more information on the [[Wikidata:Vector_Database|Wikidata Vector Database page]].  
The Wikidata Vector Database is available at [https://wd-vectordb.wmcloud.org/ wd-vectordb.wmcloud.org], and the API documentation can be found at [https://wd-vectordb.wmcloud.org/docs wd-vectordb.wmcloud.org/docs].
</div>  

== <span lang="en" dir="ltr" class="mw-content-ltr">Wikidata MCP</span> ==
{{main|Wikidata:MCP}}

=== <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===
<div lang="en" dir="ltr" class="mw-content-ltr">
The Wikidata MCP ([[:en:Model Context Protocol|Model Context Protocol]]) provides a set of standardized tools that allow large language models (LLMs) to explore and query Wikidata programmatically. It is designed for agentic AI or AI workflows that need to search, inspect, and query Wikidata, without relying on hardcoded assumptions about its structure or content.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===
<div lang="en" dir="ltr" class="mw-content-ltr">
Use the Wikidata MCP when you want to integrate Wikidata directly into a GenAI model or into AI/ML workflows. The MCP provides a set of tools for exploring and accessing Wikidata, but it is limited to read-only use and does not include editing functionality.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===
<div lang="en" dir="ltr" class="mw-content-ltr">
The Wikidata MCP is implemented as an HTTP service available at [https://wd-mcp.wmcloud.org/ wd-mcp.wmcloud.org]. To use it, add [https://wd-mcp.wmcloud.org/mcp/ https://wd-mcp.wmcloud.org/mcp/] as a connector in your AI client.
</div> 

== <span lang="en" dir="ltr" class="mw-content-ltr">Dumps</span> ==

{{main|Wikidata:Database download}}

=== <span lang="en" dir="ltr" class="mw-content-ltr">What are they?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Wikidata dumps are complete exports of all the Entities in Wikidata: <code>https://dumps.wikimedia.org</code>
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">When to use them?</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
Use a dump when your result set is likely to be very large. You'll also find a dump important when setting up your own query service.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Don't use a dump if you need current data: the dumps take a very long time to export and even longer to sync to your own query service. Dumps are also unsuitable when you have significant limits on your available bandwidth, storage space and/or computing power.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===

<div lang="en" dir="ltr" class="mw-content-ltr">
If the records you need to traverse are many, or if your result set is likely to be very large, it's time to consider working with a database dump: ([https://dumps.wikimedia.org/wikidatawiki/latest/ link to the latest complete dump]).
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
You'll find detailed documentation about all Wikimedia dumps [[m:Special:MyLanguage/Data dumps|on the "Data dumps" page on Meta]] and about Wikidata dumps in particular on the [[Special:MyLanguage/Wikidata:Database download|database download]] page.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Local query service</span> ===
<div lang="en" dir="ltr" class="mw-content-ltr">
It's no small task to procure a Wikidata dump and implement the above tools for working with it, but you can take a further step. If you have the capacity and resources to do so, you can host your own instance of the Wikidata Query Service and query it as much as you like, out of contention with any others.
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
To set up your own query service, follow [[mw:Special:MyLanguage/Wikidata Query Service/User Manual#Standalone service|these instructions]] from the query service team, which include procuring your own local copy of the data. You may also find useful information in Adam Shorland's [https://addshore.com/2019/10/your-own-wikidata-query-service-with-no-limits/ blog post] on the topic.
</div>

=== <span lang="en" dir="ltr" class="mw-content-ltr">Tools</span> ===

* <span lang="en" dir="ltr" class="mw-content-ltr">[https://github.com/JeroenDeDauw/JsonDumpReader JsonDumpReader] is a PHP library for reading dumps.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">[https://gitlab.com/tozd/go/mediawiki A Go library exists] for processing Wikipedia and Wikidata dumps.</span>
* <span lang="en" dir="ltr" class="mw-content-ltr">You can use [https://github.com/bennofs/wdumper wdumper] to get partial custom RDF dumps.</span>

==  <span lang="en" dir="ltr" class="mw-content-ltr">Wikidata API (Enterprise)</span> {{anchor|wikidata-api-enterprise}} ==

{{hatnote|1=<span lang="en" dir="ltr" class="mw-content-ltr">Main article:</span> [https://enterprise.wikimedia.com/project-data/wikidata-api Wikidata Enterprise API]}}

===  <span lang="en" dir="ltr" class="mw-content-ltr">What is it?</span> ===


<div lang="en" dir="ltr" class="mw-content-ltr">
Users of [https://enterprise.wikimedia.com/ Wikimedia Enterprise] can access Wikidata's data through the Enterprise APIs. Community members with mission-aligned use cases may also qualify for [[meta:Wikimedia_Enterprise#Exceptional_access|exceptional access]]. Access is read-only; as of May 2026, the endpoints are still in beta.
</div> 

===  <span lang="en" dir="ltr" class="mw-content-ltr">When to use it?</span> ===

<span lang="en" dir="ltr" class="mw-content-ltr">Use the Enterprise API when your project only needs to read from Wikidata. Enterprise users whose work pulls data from other Wikimedia projects can access direct data about Wikidata entities over the same API.</span> <span lang="en" dir="ltr" class="mw-content-ltr">Also, use the Enterprise API when you know your project will read at high volumes, and/or when your project requires or would benefit from having a service-level agreement.</span>

===  <span lang="en" dir="ltr" class="mw-content-ltr">Details</span> ===
<span lang="en" dir="ltr" class="mw-content-ltr">Enterprise users have access to Wikidata endpoints in both the [https://enterprise.wikimedia.com/docs/on-demand on-demand] and [https://enterprise.wikimedia.com/docs/realtime/ realtime] APIs.</span>

<div lang="en" dir="ltr" class="mw-content-ltr">
On-demand endpoints:  
* [https://enterprise.wikimedia.com/docs/on-demand/#wikidata-item-lookup-beta Item lookup]
* [https://enterprise.wikimedia.com/docs/on-demand/#wikidata-property-lookup-beta Property lookup]
* [https://enterprise.wikimedia.com/docs/on-demand/#wikidata-labels-list-beta List entity labels]
</div>

<div lang="en" dir="ltr" class="mw-content-ltr">
Realtime endpoint:
* [https://enterprise.wikimedia.com/docs/realtime/#streaming-wikidata-updates-beta Streaming Wikidata updates]
</div>

<span lang="en" dir="ltr" class="mw-content-ltr">For more information, consult the Wikimedia Enterprise [https://enterprise.wikimedia.com/docs/ API documentation].</span>

{{#ifeq:{{PAGENAME}}|Data access|[[Category:Wikidata]]}}
{{Translation categories}}