Skip to main content
POST
/
api
/
wikidata
/
items
/
cirrus
/wikidata/items/cirrus
curl --request POST \
  --url https://api.anysite.io/api/wikidata/items/cirrus \
  --header 'Content-Type: application/json' \
  --header 'access-token: <api-key>' \
  --data '
{
  "count": 2,
  "timeout": 300,
  "keyword": "physicist",
  "statement_filters": [],
  "exclude_statement_filters": [],
  "in_label": "Einstein",
  "sort": "relevance"
}
'
[
  {
    "id": "<string>",
    "@type": "@wikidata_cirrus_result",
    "word_count": 123,
    "size": 123,
    "snippet": "<string>",
    "last_edited_at": "<string>"
  }
]

Authorizations

​
access-token
string
header
required

API token from the dashboard

Headers

​
access-token
string
required

Body

application/json
​
count
integer
required

Max number of results to return

Required range: x >= 1
​
timeout
integer
default:300

Max scrapping execution timeout (in seconds)

Required range: 20 <= x <= 1500
​
keyword
string | null

Free-text query searched across the entity full text

Example:

"physicist"

​
statement_filters
string[]

Require statements matching 'P=' (e.g. P31=Q5 for humans); all must hold

Examples:
["P31=Q5"]
["P106=Q169470", "P27=Q30"]
​
exclude_statement_filters
string[]

Exclude entities with statements matching 'P='

Example:
["P31=Q4167410"]
​
in_label
string | null

Require the given text to appear in the entity label

Example:

"Einstein"

​
sort
enum<string>
default:relevance

Result ordering

Available options:
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

Response

Successful Response

​
id
string
required
​
@type
string
default:@wikidata_cirrus_result
​
word_count
integer | null
​
size
integer | null
​
snippet
string | null
​
last_edited_at
string | null