/wikidata/items/cirrus

POST /api/wikidata/items/cirrus

Price: 1 credit

Structural and full-text search over Wikidata entities (find entities by their statements)

How to use it

Discover Wikidata entities by structural conditions and full text — far more powerful than label search. Use statement_filters like 'P31=Q5' (is a human) or 'P106=Q169470' (occupation physicist) to require facts; combine several to AND them; use exclude_statement_filters to drop matches; use in_label to require text in the entity name; use keyword for free-text. Returns matching entity ids with size, word count, a snippet and last-edit time, ordered by the chosen sort. Answers 'find all X that are Y'.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Free-text query searched across the entity full text (examples: "physicist", "river")
• statement_filters array — Require statements matching 'P<number>=<value>' (e.g. P31=Q5 for humans); all must hold (default: []; examples: ["P31=Q5"], ["P106=Q169470","P27=Q30"])
• exclude_statement_filters array — Exclude entities with statements matching 'P<number>=<value>' (default: []; examples: ["P31=Q4167410"])
• in_label string nullable — Require the given text to appear in the entity label (examples: "Einstein")
• sort string — Result ordering (default: "relevance"; one of: "relevance", "incoming_links_desc", "incoming_links_asc", "create_timestamp_desc", "create_timestamp_asc", "last_edit_desc", "last_edit_asc", "title_natural_asc", "title_natural_desc", "random")
• count integer required — Max number of results to return (min: 1)

Response

• @type string (default: "WikidataCirrusResult")
• id string required
• word_count integer nullable
• size integer nullable
• snippet string nullable
• last_edited_at string nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.