View source for Help:Contributing/api

The full Wikibase API is available at <code>https://wikibase.ronzz.org/api.php</code>. It requires login and a CSRF token. This page is for editors who want to script or bulk-edit; for interactive editing, see [[Help:Contributing/entities]].

Log in and get a CSRF token (adjust the credentials):

<syntaxhighlight lang="bash" copy>
# 1) Log in
curl -s -c /tmp/wb.cookies "https://wikibase.ronzz.org/api.php" \
  --data-urlencode "action=query" --data-urlencode "meta=tokens" \
  --data-urlencode "type=login" --data-urlencode "format=json"
# …POST action=login with lgname/lgpassword/lgtoken, then:
TOKEN=$(curl -s -b /tmp/wb.cookies "https://wikibase.ronzz.org/api.php?action=query&meta=tokens&format=json" \
  | python3 -c "import json,sys; print(json.load(sys.stdin)['query']['tokens']['csrftoken'])")

# 2) Create an item (wbeditentity)
curl -s -b /tmp/wb.cookies "https://wikibase.ronzz.org/api.php" \
  --data-urlencode "action=wbeditentity" --data-urlencode "new=item" \
  --data-urlencode "token=$TOKEN" \
  --data-urlencode 'data={"labels":{"en":{"language":"en","value":"My first item"}}}' \
  --data-urlencode "format=json"
</syntaxhighlight>

Key API actions: <code>wbeditentity</code> (create/update), <code>wbgetentities</code> (read), <code>wbcreateclaim</code>/<code>wbsetclaim</code> (statements), <code>wbsearchentities</code> (find by label), <code>wbremoveclaims</code>. A REST API is also available under <code>/w/rest.php/wikibase/</code>.

== Bulk tools ==

These tools are not installed on the instance — run them from your own machine:
* [https://github.com/LeMyst/WikibaseIntegrator WikibaseIntegrator] (Python)
* [https://www.mediawiki.org/wiki/Manual:Pywikibot Pywikibot] (official manual)
* [https://www.wikidata.org/wiki/Help:QuickStatements QuickStatements] (spreadsheet-style batch)

== See also ==

* [[Help:Contributing]] — the hub
* [https://www.mediawiki.org/wiki/Wikibase Wikibase documentation] (official)
* [https://www.wikidata.org/w/api.php action=wb…] API reference (Wikidata)