Wikibase/API

This page is a translated version of the page Wikibase/API and the translation is 7% complete.

Other languages:

Versão MediaWiki:

≥ 1.9

O que é a API Wikibase

Wikibase provides a general mechanism for storing statements as structured data. The statements about items live on the server at wikidata.org. See Wikidata:Glossary for more information on Wikibase and other concepts.

A statement

The Wikibase API allows querying, adding, removing and editing information on Wikidata or any other Wikibase instance.

It is provided via a set of extensions to MediaWiki API modules. So, to use the Wikibase API, you should have a basic familiarity with the MediaWiki Action API: actions, queries, etc., as well as with generic parameters such as curtimestamp and requestid.

How to use the Wikibase api

Send requests to the API through HTTP, the same as with the MediaWiki Action API. See API:Tutorial#How to use it for information about how to use the MediaWiki Action API.

Request Format

The endpoint for the API is https://wikidata.org/w/api.php.

In the query string, add the action parameter, which tells the API which action to perform. For example, action=wbgetentities tells the API to get the data for Wikibase entities. For meta and property submodules, use action=query&meta=yourmodule and action=query&prop=modulename respectively.

Some parameters are nearly always available. Plural forms are used in those cases in which a parameter can take several values. The parameters are:

id/ids: Identifies a specific entity or entities, typically an item. The plural form is used in wbgetentities. Lists of ids should be separated by the pipe character
site ∩ title/sites ∩ titles: Identifies a single item or multiple items. The plural form is used in wbgetentities. Only one of sites and titles can have multiple values at the same time.
language/languages: The language parameter filters labels and descriptions in get actions or identifies a specific language for a set of actions.
format: Should always be set to json (or jsonfm for debugging), or xml (or xmlfm for debugging). No other form is supported.
summary: Adds a user-specified summary in addition to the system-generated one.
token: An encrypted string the requester must pass for the request to be fulfilled.
baserevid: An id for the last known revision that must be passed so that the server can detect edit collisions.

A simple query

GET request

Get the item for page "Berlin" on English Wikipedia.

api.php?action=wbgetentities&sites=enwiki&titles=Berlin&props=descriptions&languages=en&format=json [tente no ApiSandbox]

Explanation of each part of the URL:

http://www.wikidata.org/w/api.php is the main endpoint.
action=wbgetentities tells the API to get the data for Wikibase entities.
sites=enwiki means get the data from English Wikipedia.
titles=Berlin indicates the title of the page to get data from.
props=descriptions indicates properties to get from the entities, in this case the property is the descriptions of the entities.
languages=en means filter the results down to the English language.
format=json indicates JSON output, which is the recommended output format.

Response

{
    "entities": {
        "Q64": {
            "type": "item",
            "id": "Q64",
            "descriptions": {
                "en": {
                    "language": "en",
                    "value": "capital and largest city of Germany"
                }
            }
        }
    },
    "success": 1
}

The response of a request will usually contain:

A success key with a boolean cast as an integer if the request is successful. If the integer is zero, any additional values might be wrong.
An error key with an object of two, optionally three keys, code, info and *, if the request is unsuccessful.
Information about the action. The information is either passed on the top level or under item if it is one single item or items if it is several. If it is several items, each is found under a key with its own item id.

Empty objects are returned as JSON arrays and not as objects, while empty parameters remove the actual entry from the item.

Documentação da API e módulos Wikibase

Source-generated documentation for the MediaWiki Action API including Wikibase 'wb' API modules is available at wikidata.org/w/api.php

Meta submodules

wikibase: Obtenha informações sobre o cliente Wikibase e o repositório Wikibase associado.
wbcontentlanguages: Devolve informação sobre os idiomas de conteúdo que a extensão Wikibase aceita em diferentes contextos.

Property submodules

pageterms: Obtenha os termos Wikidata (geralmente rótulos, descrições e alias) associados a uma página por meio de um link de site.
wbentityusage: Retorna todas as IDs de entidade usadas nas páginas fornecidas.

API modules

wbgetentities: Obtém os dados para várias entidades Wikibase.
wbavailablebadges: Consulta os itens de emblema disponíveis.
wbcreateclaim: Cria um reinvindicação Wikibase.
wbcreateredirect: Cria redirecionamentos de entidade.
wbeditentity: Cria uma única nova entidade Wikibase e a modifica com informações serializadas.
wbformatvalue: Formata DataValues.
wbgetclaims: Obtém as reinvindicação Wikibase.
wblinktitles: Associa dois artigos em duas wikis diferentes com um item da Wikibase.
wbmergeitems: Mesclar vários itens.
wbparsevalue: Analisar valores usando um ValueParser.
wbremoveclaims: Remover reinvindicação Wikibase.
wbremovequalifiers: Remover um qualificador de uma reinvindicação.
wbremovereferences: Remove uma ou mais referências da mesma instrução.
wbsearchentities: Pesquisa por entidades usando rótulos e nomes alternativos.
wbsetaliases: Define os nomes alternativos para uma entidade Wikibase.
wbsetclaim: Cria ou atualiza uma declaração ou reivindicação inteira.
wbsetclaimvalue: Define o valor de uma reivindicação Wikibase.
wbsetdescription: Define uma descrição para uma única entidade Wikibase.
wbsetlabel: Define uma rótulo para uma única entidade Wikibase.
wbsetqualifier: Criar um qualificador ou definir o valor de um existente.
wbsetreference: Criar uma referência ou definir o valor de uma existente.
wbsetsitelink: Associa uma página em uma wiki com um item Wikibase ou remove uma associação já feita.
wbsgetsuggestions: Módulo API para obter sugestões de propriedades adicionais para adicionar a uma entidade Wikibase. O módulo API está principalmente destinado a uso do widget de sugestões quando usuários estão editando entidades Wikibase.
wbcheckconstraints: Executa verificações de restrição em qualquer entidade que deseja e retorna o resultado.
wbcheckconstraintparameters: Verifica os parâmetros de restrição das instruções de restrição.

Possíveis erros

Possíveis erros para qualquer módulo pode ser encontrado usando action=paraminfo&modules=modulename. The error format corresponds to that of the MediaWiki Action API. See API:Errors and warnings#Legacy format.

All error messages from the Wikibase modules should be internationalized (i18n) and localized (l10n). The user language for the logged-in user will be the default for error messages, but you can override this by adding uselang=languageCode to the URL query string.


Error type	Code	Info
An internationalized error message that isn't localized.	no-such-item	<wikibase-api-no-such-item>
A correctly localized error message.	no-such-item	There are no such item to be found
A localized variant.(Norwegian)	no-such-item	Det finnes ingen slik item

Additional notes

Many Wikimedia wikis run the Wikibase Client extension. This lets API clients on them to query the wikibase meta submodule to determine URLs for the full Wikibase repo, and the pageterms property submodule to get some Wikidata information about pages on the local wiki.

The calender models that can be used with Wikibase are the Gregorian calendar(d:Q1985727) and the Julian calendar(d:Q1985786).

The API uses revision ids for edit collision detection. If there is an edit collision, the requester must acquire a newer revision id to be able to continue. This typically involves requesting wbgetentities for the item in question, and then storing (and using) the revision from the entry.

Any MediaWiki installation can run Wikibase. On the Wikimedia cluster, most wikis do not run the full set of Wikibase extensions.

Wikimedia Commons has its own Wikibase for properties of the files on Commons.

Do not test the info value for a particular error, instead use the code value as this will remain independent of localization.