MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=wbgetentities
(main | wbgetentities)
- This module requires read rights.
- Source: WikibaseClient
- License: GPL-2.0-or-later
Gets the data for multiple Wikibase entities.
Parameters:
- ids
The IDs of the entities to get the data from
- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients allowed higher limits).
- sites
Identifier for the site on which the corresponding page resides Use together with
title, but only give one site for several titles or several sites for one title.- Values (separate with | or alternative):
- Maximum number of values is 50 (500 for clients allowed higher limits).
- titles
The title of the corresponding page Use together with
sites, but only give one site for several titles or several sites for one title.- Separate values with | or alternative.
- Maximum number of values is 50 (500 for clients allowed higher limits).
- redirects
Whether redirects shall be resolved. If set to "no", redirects will be treated like deleted entities.
- One of the following values: no, yes
- Default: yes
- props
The names of the properties to get back from each entity. Will be further filtered by any languages given.
- Values (separate with | or alternative): aliases, claims, datatype, descriptions, info, labels, sitelinks, sitelinks/urls
- Default: info|sitelinks|aliases|labels|descriptions|claims|datatype
- languages
By default the internationalized values are returned in all available languages. This parameter allows filtering these down to one or more languages by providing one or more language codes.
- Values (separate with | or alternative): aa, ab, abs, ace, ady, ady-cyrl, aeb, aeb-arab, aeb-latn, af, ak, aln, als, alt, am, ami, an, ang, anp, ar, arc, arn, arq, ary, arz, as, ase, ast, atj, av, avk, awa, ay, az, azb, ba, ban, bar, bat-smg, bbc, bbc-latn, bcc, bcl, be, be-tarask, be-x-old, bg, bgn, bh, bho, bi, bjn, bm, bn, bo, bpy, bqi, br, brh, bs, btm, bto, bug, bxr, ca, cbk-zam, cdo, ce, ceb, ch, cho, chr, chy, ckb, co, cps, cr, crh, crh-cyrl, crh-latn, cs, csb, cu, cv, cy, da, de, de-at, de-ch, de-formal, din, diq, dsb, dtp, dty, dv, dz, ee, egl, el, eml, en, en-ca, en-gb, eo, es, es-419, es-formal, et, eu, ext, fa, ff, fi, fit, fiu-vro, fj, fo, fr, frc, frp, frr, fur, fy, ga, gag, gan, gan-hans, gan-hant, gcr, gd, gl, glk, gn, gom, gom-deva, gom-latn, gor, got, grc, gsw, gu, gv, ha, hak, haw, he, hi, hif, hif-latn, hil, ho, hr, hrx, hsb, ht, hu, hu-formal, hy, hyw, hz, ia, id, ie, ig, ii, ik, ike-cans, ike-latn, ilo, inh, io, is, it, iu, ja, jam, jbo, jut, jv, ka, kaa, kab, kbd, kbd-cyrl, kbp, kea, kg, khw, ki, kiu, kj, kjp, kk, kk-arab, kk-cn, kk-cyrl, kk-kz, kk-latn, kk-tr, kl, km, kn, ko, ko-kp, koi, kr, krc, kri, krj, krl, ks, ks-arab, ks-deva, ksh, ku, ku-arab, ku-latn, kum, kv, kw, ky, la, lad, lb, lbe, lez, lfn, lg, li, lij, liv, lki, lld, lmo, ln, lo, loz, lrc, lt, ltg, lus, luz, lv, lzh, lzz, mai, map-bms, mdf, mg, mh, mhr, mi, min, mk, ml, mn, mni, mnw, mo, mr, mrj, ms, mt, mus, mwl, my, myv, mzn, na, nah, nan, nap, nb, nds, nds-nl, ne, new, ng, niu, nl, nl-informal, nn, no, nod, nov, nqo, nrm, nso, nv, ny, nys, oc, olo, om, or, os, ota, pa, pag, pam, pap, pcd, pdc, pdt, pfl, pi, pih, pl, pms, pnb, pnt, prg, ps, pt, pt-br, qqq, qu, qug, rgn, rif, rm, rmy, rn, ro, roa-rup, roa-tara, ru, rue, rup, ruq, ruq-cyrl, ruq-latn, rw, rwr, sa, sah, sat, sc, scn, sco, sd, sdc, sdh, se, sei, ses, sg, sgs, sh, shi, shi-latn, shi-tfng, shn, shy-latn, si, simple, sje, sk, skr, skr-arab, sl, sli, sm, sma, smj, smn, sn, so, sq, sr, sr-ec, sr-el, srn, srq, ss, st, stq, sty, su, sv, sw, szl, szy, ta, tay, tcy, te, tet, tg, tg-cyrl, tg-latn, th, ti, tk, tl, tly, tn, to, tokipona, tpi, tr, tru, trv, ts, tt, tt-cyrl, tt-latn, tum, tw, ty, tyv, tzm, udm, ug, ug-arab, ug-latn, uk, ur, uz, uz-cyrl, uz-latn, ve, vec, vep, vi, vls, vmf, vo, vot, vro, wa, war, wo, wuu, xal, xh, xmf, xsy, yi, yo, yue, za, zea, zgh, zh, zh-classical, zh-cn, zh-hans, zh-hant, zh-hk, zh-min-nan, zh-mo, zh-my, zh-sg, zh-tw, zh-yue, zu
- Maximum number of values is 50 (500 for clients allowed higher limits).
- languagefallback
Apply language fallback for languages defined in the languages parameter, with the current context of API call.
- Type: boolean (details)
- normalize
Try to normalize the page title against the client site. This only works if exactly one site and one page have been given.
- Type: boolean (details)
- sitefilter
Filter sitelinks in entities to those with these site IDs.
- Values (separate with | or alternative):
- Maximum number of values is 50 (500 for clients allowed higher limits).
Examples:
- Get entities with ID Q42 with all available attributes in all available languages
- api.php?action=wbgetentities&ids=Q42 [open in sandbox]
- Get entities with ID P17 with all available attributes in all available languages
- api.php?action=wbgetentities&ids=P17 [open in sandbox]
- Get entities with IDs Q42 and P17 with all available attributes in all available languages
- api.php?action=wbgetentities&ids=Q42|P17 [open in sandbox]
- Get entities with ID Q42 with all available attributes in English language
- api.php?action=wbgetentities&ids=Q42&languages=en [open in sandbox]
- Get entities with ID Q42 with all available attributes in any possible fallback language for the ii language
- api.php?action=wbgetentities&ids=Q42&languages=ii&languagefallback= [open in sandbox]
- Get entities with ID Q42 showing all labels in all available languages
- api.php?action=wbgetentities&ids=Q42&props=labels [open in sandbox]
- Get entities with IDs P17 and P3 showing only datatypes
- api.php?action=wbgetentities&ids=P17|P3&props=datatype [open in sandbox]
- Get entities with ID Q42 showing all aliases in English language
- api.php?action=wbgetentities&ids=Q42&props=aliases&languages=en [open in sandbox]
- Get entities with IDs Q1 and Q42 showing descriptions in English, German and French languages
- api.php?action=wbgetentities&ids=Q1|Q42&props=descriptions&languages=en|de|fr [open in sandbox]
- Get the item for page "Berlin" on the site "enwiki", with language attributes in English language
- api.php?action=wbgetentities&sites=enwiki&titles=Berlin&languages=en [open in sandbox]
- Get the item for page "Berlin" on the site "enwiki" after normalizing the title from "berlin"
- api.php?action=wbgetentities&sites=enwiki&titles=berlin&normalize= [open in sandbox]
- Get the sitelinks for item Q42
- api.php?action=wbgetentities&ids=Q42&props=sitelinks [open in sandbox]
- Get entities with ID Q42 showing only sitelinks from "enwiki"
- api.php?action=wbgetentities&ids=Q42&sitefilter=enwiki [open in sandbox]