OpenAPI Specification
openapi: 3.0.1
info:
version: 1.0.0
title: Wikimedia REST Citation Recommendation API
description: "This API provides cacheable and straightforward access to Wikimedia content and data, in machine-readable formats.\n### Global Rules\n- Limit your clients to no more than 200 requests/s to this API.\n Each API endpoint's documentation may detail more specific usage limits.\n- Set a unique `User-Agent` or `Api-User-Agent` header that\n allows us to contact you quickly. Email addresses or URLs\n of contact pages work well.\n\nBy using this API, you agree to Wikimedia's [Terms of Use](https://wikimediafoundation.org/wiki/Terms_of_Use) and [Privacy Policy](https://wikimediafoundation.org/wiki/Privacy_policy). Unless otherwise specified in the endpoint documentation below, content accessed via this API is licensed under the [CC-BY-SA 3.0](https://creativecommons.org/licenses/by-sa/3.0/) and [GFDL](https://www.gnu.org/copyleft/fdl.html) licenses, and you irrevocably agree to release modifications or additions made through this API under these licenses. Check the [Wikimedia REST API documentation](https://www.mediawiki.org/wiki/Wikimedia_REST_API) for background and details.\n### Endpoint documentation\nPlease consult each endpoint's documentation for details on:\n- Licensing information for the specific type of content\n and data served via the endpoint.\n- Stability markers to inform you about development status and\n change policy, according to\n [our API version policy](https://www.mediawiki.org/wiki/API_versioning).\n- Endpoint specific usage limits.\n"
termsOfService: https://wikimediafoundation.org/wiki/Terms_of_Use
contact:
name: the Wikimedia Services team
url: http://mediawiki.org/wiki/Wikimedia_REST_API
license:
name: Apache2
url: http://www.apache.org/licenses/LICENSE-2.0
servers:
- url: /api/rest_v1
tags:
- name: Recommendation
description: contribution recommendations
paths:
/data/recommendation/article/creation/translation/{from_lang}:
get:
tags:
- Recommendation
summary: Recommend articles for translation.
description: 'Recommends articles to be translated from the source
to the domain language.
See more at [Recommendation API documentation](https://meta.wikimedia.org/wiki/Recommendation_API)
Stability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)
'
parameters:
- name: from_lang
in: path
description: The source language code
required: true
schema:
type: string
- name: count
in: query
description: The max number of articles to return
schema:
type: integer
default: 24
responses:
'200':
description: the list of articles recommended for translation
content:
application/json:
schema:
$ref: '#/components/schemas/recommendation_result'
default:
description: Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/data/recommendation/article/creation/translation/{from_lang}/{seed_article}:
get:
tags:
- Recommendation
summary: Recommend articles for translation.
description: 'Recommends articles to be translated from the source
to the domain language.
See more at [Recommendation API documentation](https://meta.wikimedia.org/wiki/Recommendation_API)
Stability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)
'
parameters:
- name: from_lang
in: path
description: The source language code
required: true
schema:
type: string
- name: seed_article
in: path
description: The article to use as a search seed
required: true
schema:
type: string
- name: count
in: query
description: The max number of articles to return
schema:
type: integer
default: 24
responses:
'200':
description: the list of articles recommended for translation
content:
application/json:
schema:
$ref: '#/components/schemas/recommendation_result'
default:
description: Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
/data/recommendation/article/creation/morelike/{seed_article}:
get:
tags:
- Recommendation
summary: Recommend missing articles
description: 'Recommends articles similar to the seed article but are missing
from the domain language Wikipedia.
Stability: [unstable](https://www.mediawiki.org/wiki/API_versioning#Unstable)
'
parameters:
- name: seed_article
in: path
description: The article title used to search similar but missing articles
required: true
schema:
type: string
responses:
'200':
description: the prioritized list of Wikidata IDs recommended for creation as Wikipedia articles
content:
application/json:
schema:
$ref: '#/components/schemas/morelike_result'
default:
description: Error
content:
application/problem+json:
schema:
$ref: '#/components/schemas/problem'
x-monitor: false
components:
schemas:
problem:
required:
- type
type: object
properties:
type:
type: string
title:
type: string
detail:
type: string
instance:
type: string
recommendation_result:
type: object
properties:
count:
type: integer
description: the number of recommendations returned
items:
type: array
description: the list of articles recommended for translation
items:
type: object
properties:
wikidata_id:
type: string
description: wikidata id for the item
title:
type: string
description: title of the article in the source language
sitelink_count:
type: integer
description: count of sites the wikidata item is linked to
morelike_result:
type: array
description: the prioritized list of Wikidata IDs recommended for creation as Wikipedia articles
items:
type: object
properties:
wikidata_id:
type: string
description: Wikidata ID for the item
score:
type: number
description: Score of the recommendation. The higher the score, the more important the recommendation is.
source_language:
type: string
description: Source of the recommendation -- which wiki is recommending the current article.
x-host-basePath: /api/rest_v1
x-default-params: {}