# Wikibase Entity Extractor (`datamule/wikibase-entity-extractor`) Actor Point at ANY Wikibase instance (Wikidata, MaRDI, self-hosted) and extract items & properties via the modern REST v1 API: full typed entities, per-statement rows, or labels + descriptions. One runner for every install. Pay per entity. - **URL**: https://apify.com/datamule/wikibase-entity-extractor.md - **Developed by:** [Datamule](https://apify.com/datamule) (community) - **Categories:** Developer tools, Business - **Stats:** 2 total users, 1 monthly users, 100.0% runs succeeded, 0 bookmarks - **User rating**: No ratings yet ## Pricing from $0.70 / 1,000 entities This Actor is paid per event. You are not charged for the Apify platform usage, but only a fixed price for specific events. Since this Actor supports Apify Store discounts, the price gets lower the higher subscription plan you have. Learn more: https://docs.apify.com/platform/actors/running/actors-in-store#pay-per-event ## What's an Apify Actor? Actors are a software tools running on the Apify platform, for all kinds of web data extraction and automation use cases. In Batch mode, an Actor accepts a well-defined JSON input, performs an action which can take anything from a few seconds to a few hours, and optionally produces a well-defined JSON output, datasets with results, or files in key-value store. In Standby mode, an Actor provides a web server which can be used as a website, API, or an MCP server. Actors are written with capital "A". ## How to integrate an Actor? If asked about integration, you help developers integrate Actors into their projects. You adapt to their stack and deliver integrations that are safe, well-documented, and production-ready. The best way to integrate Actors is as follows. In JavaScript/TypeScript projects, use official [JavaScript/TypeScript client](https://docs.apify.com/api/client/js/docs.md): ```bash npm install apify-client ``` In Python projects, use official [Python client library](https://docs.apify.com/api/client/python/docs.md): ```bash pip install apify-client ``` In shell scripts, use [Apify CLI](https://docs.apify.com/cli/docs.md): ````bash # MacOS / Linux curl -fsSL https://apify.com/install-cli.sh | bash # Windows irm https://apify.com/install-cli.ps1 | iex ```bash In AI frameworks, you might use the [Apify MCP server](https://docs.apify.com/integrations/mcp.md). If your project is in a different language, use the [REST API](https://docs.apify.com/api/v2.md). For usage examples, see the [API](#api) section below. For more details, see Apify documentation as [Markdown index](https://docs.apify.com/llms.txt) and [Markdown full-text](https://docs.apify.com/llms-full.txt). # README ## Wikibase Entity Extractor Point at **any Wikibase instance** and extract its items and properties through the modern **Wikibase REST API v1** — the typed successor to the MediaWiki Action `wbgetentities` API. One runner for every conformant install: Wikidata, MaRDI, Wikimedia Commons, `wikibase.world`, and the growing population of self-hosted institutional / GLAM / research knowledge graphs. Every Wikibase answers the identical REST v1 grammar and returns the identical typed envelope, so a single actor covers them all — no per-site scraper. ### What it does Give it one or more **instance URLs** (e.g. `https://www.wikidata.org`) and a list of **entity IDs** (`Q…` items, `P…` properties), pick a **mode**, and it emits clean flat rows. | Mode | One row per… | Columns | |------|--------------|---------| | **entity** (default) | entity | id, type, data type, labels, descriptions, aliases, a statements summary (count + property IDs used), sitelink count | | **statements** | statement / claim | property, property data type, rank, value type + content, qualifiers, references count | | **labels** | entity | just the multilingual labels + descriptions (cheapest way to translate / label thousands of IDs) | Optional `languages` filters labels / descriptions / aliases to a subset. Each `entityIds` value may be a bare `Q42` / `P31` **or** a full URL — a REST URL (`…/entities/items/Q42`) or a human entity page (`…/wiki/Q42`) — from which the instance and ID are parsed automatically. Every row keeps a lossless `_raw` copy of the untouched API object plus `_instanceUrl` provenance. ### Endpoints used ```` {instance}/w/rest.php/wikibase/v1/entities/items/{Qid} {instance}/w/rest.php/wikibase/v1/entities/properties/{Pid} …/statements …/labels …/descriptions ```` ### Example input ```json { "instanceUrls": ["https://www.wikidata.org", "https://portal.mardi4nfdi.de"], "entityIds": ["Q42", "P31", "Q1"], "mode": "entity", "languages": ["en", "de"], "maxEntities": 1000 } ```` ### Honesty & edge cases - A host that is **bot-gated**, returns an **HTML shell**, or is **not a Wikibase REST endpoint** is skipped with a warning — its entities are simply not emitted. (Note: the hosted `*.wikibase.cloud` fleet often bot-gates the REST path; the addressable population is self-hosted Wikibase + MediaWiki installs.) - If **every** requested instance is unreachable, the run fails fast (non-zero exit) so an empty dataset can never masquerade as success. - A reachable instance on which a requested entity does not exist emits **0 rows** for that entity and exits cleanly — never an invented row. ### Authentication None required for public read. An optional **bearer token** and/or **extra headers** are supported for a private deployment and are never logged. ### Pricing Pay-per-event: one **entity** charge per Wikibase entity successfully returned. # Actor input Schema ## `instanceUrls` (type: `array`): One or more Wikibase base URLs to query, e.g. https://www.wikidata.org (the central hub), https://portal.mardi4nfdi.de (MaRDI, a self-hosted math knowledge graph), https://commons.wikimedia.org, or any self-hosted Wikibase + MediaWiki install. The actor appends the REST v1 path (/w/rest.php/wikibase/v1/…) itself — give the site root. Every bare entity ID is fetched from each instance listed here. NOT required if every entityIds value is already a full URL. Note: the \*.wikibase.cloud hosted fleet bot-gates the REST path and will be skipped with a warning. ## `entityIds` (type: `array`): The Wikibase entities to fetch: items (Q…) and/or properties (P…), e.g. Q42, P31. Each value may instead be a full URL — a REST URL (https://www.wikidata.org/w/rest.php/wikibase/v1/entities/items/Q42) or a human entity page (https://www.wikidata.org/wiki/Q42) — from which the instance and ID are parsed (then instanceUrls is optional for that value). Q… → item, P… → property. ## `mode` (type: `string`): What to extract per entity. entity = the full typed entity as one flat row (labels, descriptions, aliases, a statements summary, sitelink count). statements = one row per statement (property, rank, value type + content, qualifiers, references) — flattens the knowledge graph's claims into a table. labels = only the lightweight labels + descriptions sub-resources, one row per entity (cheapest way to translate/label thousands of IDs). ## `languages` (type: `array`): Optionally restrict labels, descriptions and aliases to these language codes (e.g. en, de, fr). Leave empty to return every language the entity has. Applies to entity and labels modes. ## `maxEntities` (type: `integer`): Maximum number of entities to process across all instances. Each entity successfully returned is one billable event. Default 1000. ## `bearer` (type: `string`): Optional bearer token for a private / access-gated Wikibase. Sent as Authorization: Bearer \*\*\* — NOT required for public instances (Wikidata, MaRDI, Commons) — leave empty. Never logged. ## `extraHeaders` (type: `object`): Optional extra HTTP headers to send with every request, as a JSON object, e.g. {"x-api-key": "..."} for an instance behind an API gateway. Leave empty for public instances. ## Actor input object example ```json { "instanceUrls": [ "https://www.wikidata.org" ], "entityIds": [ "Q42" ], "mode": "entity", "maxEntities": 1000 } ``` # Actor output Schema ## `results` (type: `string`): No description # API You can run this Actor programmatically using our API. Below are code examples in JavaScript, Python, and CLI, as well as the OpenAPI specification and MCP server setup. ## JavaScript example ```javascript import { ApifyClient } from 'apify-client'; // Initialize the ApifyClient with your Apify API token // Replace the '' with your token const client = new ApifyClient({ token: '', }); // Prepare Actor input const input = { "instanceUrls": [ "https://www.wikidata.org" ], "entityIds": [ "Q42" ], "maxEntities": 1000 }; // Run the Actor and wait for it to finish const run = await client.actor("datamule/wikibase-entity-extractor").call(input); // Fetch and print Actor results from the run's dataset (if any) console.log('Results from dataset'); console.log(`💾 Check your data here: https://console.apify.com/storage/datasets/${run.defaultDatasetId}`); const { items } = await client.dataset(run.defaultDatasetId).listItems(); items.forEach((item) => { console.dir(item); }); // 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/js/docs ``` ## Python example ```python from apify_client import ApifyClient # Initialize the ApifyClient with your Apify API token # Replace '' with your token. client = ApifyClient("") # Prepare the Actor input run_input = { "instanceUrls": ["https://www.wikidata.org"], "entityIds": ["Q42"], "maxEntities": 1000, } # Run the Actor and wait for it to finish run = client.actor("datamule/wikibase-entity-extractor").call(run_input=run_input) # Fetch and print Actor results from the run's dataset (if there are any) print("💾 Check your data here: https://console.apify.com/storage/datasets/" + run["defaultDatasetId"]) for item in client.dataset(run["defaultDatasetId"]).iterate_items(): print(item) # 📚 Want to learn more 📖? Go to → https://docs.apify.com/api/client/python/docs/quick-start ``` ## CLI example ```bash echo '{ "instanceUrls": [ "https://www.wikidata.org" ], "entityIds": [ "Q42" ], "maxEntities": 1000 }' | apify call datamule/wikibase-entity-extractor --silent --output-dataset ``` ## MCP server setup ```json { "mcpServers": { "apify": { "command": "npx", "args": [ "mcp-remote", "https://mcp.apify.com/?tools=datamule/wikibase-entity-extractor", "--header", "Authorization: Bearer " ] } } } ``` ## OpenAPI specification ```json { "openapi": "3.0.1", "info": { "title": "Wikibase Entity Extractor", "description": "Point at ANY Wikibase instance (Wikidata, MaRDI, self-hosted) and extract items & properties via the modern REST v1 API: full typed entities, per-statement rows, or labels + descriptions. One runner for every install. Pay per entity.", "version": "0.1", "x-build-id": "tXGgOMb4bPOP6xhru" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/datamule~wikibase-entity-extractor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-datamule-wikibase-entity-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/datamule~wikibase-entity-extractor/runs": { "post": { "operationId": "runs-sync-datamule-wikibase-entity-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/datamule~wikibase-entity-extractor/run-sync": { "post": { "operationId": "run-sync-datamule-wikibase-entity-extractor", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "entityIds" ], "properties": { "instanceUrls": { "title": "Wikibase instance URLs", "type": "array", "description": "One or more Wikibase base URLs to query, e.g. https://www.wikidata.org (the central hub), https://portal.mardi4nfdi.de (MaRDI, a self-hosted math knowledge graph), https://commons.wikimedia.org, or any self-hosted Wikibase + MediaWiki install. The actor appends the REST v1 path (/w/rest.php/wikibase/v1/…) itself — give the site root. Every bare entity ID is fetched from each instance listed here. NOT required if every entityIds value is already a full URL. Note: the *.wikibase.cloud hosted fleet bot-gates the REST path and will be skipped with a warning.", "items": { "type": "string" } }, "entityIds": { "title": "Entity IDs", "type": "array", "description": "The Wikibase entities to fetch: items (Q…) and/or properties (P…), e.g. Q42, P31. Each value may instead be a full URL — a REST URL (https://www.wikidata.org/w/rest.php/wikibase/v1/entities/items/Q42) or a human entity page (https://www.wikidata.org/wiki/Q42) — from which the instance and ID are parsed (then instanceUrls is optional for that value). Q… → item, P… → property.", "items": { "type": "string" } }, "mode": { "title": "Mode", "enum": [ "entity", "statements", "labels" ], "type": "string", "description": "What to extract per entity. entity = the full typed entity as one flat row (labels, descriptions, aliases, a statements summary, sitelink count). statements = one row per statement (property, rank, value type + content, qualifiers, references) — flattens the knowledge graph's claims into a table. labels = only the lightweight labels + descriptions sub-resources, one row per entity (cheapest way to translate/label thousands of IDs).", "default": "entity" }, "languages": { "title": "Language filter", "type": "array", "description": "Optionally restrict labels, descriptions and aliases to these language codes (e.g. en, de, fr). Leave empty to return every language the entity has. Applies to entity and labels modes.", "items": { "type": "string" } }, "maxEntities": { "title": "Max entities", "minimum": 1, "type": "integer", "description": "Maximum number of entities to process across all instances. Each entity successfully returned is one billable event. Default 1000.", "default": 1000 }, "bearer": { "title": "Bearer token (optional)", "type": "string", "description": "Optional bearer token for a private / access-gated Wikibase. Sent as Authorization: Bearer *** — NOT required for public instances (Wikidata, MaRDI, Commons) — leave empty. Never logged." }, "extraHeaders": { "title": "Extra request headers", "type": "object", "description": "Optional extra HTTP headers to send with every request, as a JSON object, e.g. {\"x-api-key\": \"...\"} for an instance behind an API gateway. Leave empty for public instances." } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } } ```