
Security News
Deno 2.4 Brings Back deno bundle, Improves Dependency Management and Observability
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.
wikibase-rest-api-ts
Advanced tools
Typescript model and API code for interacting with the REST API of a Wikibase instance (like Wikidata)
Typescript model and API code for interacting with the REST API of a Wikibase instance (like Wikidata).
Read the official OpenAPI specification for the Wikibase REST API at this link. Depending on the tags of the method you want to use, initialize an object of the relevant API class and call the appropriate method:
AliasesApi
DescriptionsApi
ItemsApi
LabelsApi
PropertiesApi
SitelinksApi
StatementsApi
Suppose you want to get the label of Wikidata item Q1 in english.
From the OpenAPI specification you find out that the appropriate method is GET /entities/items/{item_id}/labels/{language_code}
, under the tag labels
(=> LabelsApi
).
You don't need to specify which instance to use because Wikidata is the default.
import { LabelsApi } from "wikibase-rest-api-ts";
const api = new LabelsApi();
api.getItemLabel({
itemId: "Q1", languageCode: "en"
}).then(
label => console.log(`English label for Q1 is ${label}`)
);
If instead of Wikidata you want to use another Wikibase instance you need to pass its REST API base URL while initializing the API:
import { Configuration, DescriptionsApi } from "wikibase-rest-api-ts";
const api = new DescriptionsApi(new Configuration({
basePath: "https://url-to-my-wikibase-instance/w/rest.php/wikibase",
}));
api.getItemDescription({
itemId: "Q1", languageCode: "en"
}).then(
desc => console.log(`English description for Q1 is ${desc}`)
);
If you need to upload changes to the data you will need first to create an OAuth access token following the instructions at this link. Then you will need to pass the Authorization header for each call:
import { Configuration, DescriptionsApi } from "wikibase-rest-api-ts";
const api = new DescriptionsApi(new Configuration({
headers: { Authorization: "Bearer " + YOUR_TOKEN }
}));
api.replaceItemDescription({
itemId: "Qxxx",
languageCode: "en",
replaceItemDescriptionRequest: {
description: "New description of the item",
comment: "Comment of your edit"
}
});
For further info and to contribute, see CONTRIBUTING.md.
FAQs
Typescript model and API code for interacting with the REST API of a Wikibase instance (like Wikidata)
The npm package wikibase-rest-api-ts receives a total of 2 weekly downloads. As such, wikibase-rest-api-ts popularity was classified as not popular.
We found that wikibase-rest-api-ts demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.4 brings back bundling, improves dependency updates and telemetry, and makes the runtime more practical for real-world JavaScript projects.
Security News
CVEForecast.org uses machine learning to project a record-breaking surge in vulnerability disclosures in 2025.
Security News
Browserslist-rs now uses static data to reduce binary size by over 1MB, improving memory use and performance for Rust-based frontend tools.