Core Platform Team/Initiatives/API Platform/API list: Difference between revisions

• Wikimedia REST API (aka RESTBase)
  • https://www.mediawiki.org/wiki/Wikimedia_REST_API and https://en.wikipedia.org/api/rest_v1/
  • Address: Per project at /api/rest_v1
  • Includes mobileapps service https://wikitech.wikimedia.org/wiki/Mobileapps_(service)
  • Includes Pageviews API (https://wikitech.wikimedia.org/wiki/Analytics/AQS/Pageviews)
  • Includes Wikifeeds (https://www.mediawiki.org/wiki/Wikifeeds), also proxied through the Gateway under /feed https://api.wikimedia.org/wiki/API_reference/Feed)
  • Includes (Node.js) Recommendation API (endpoints vary per wiki)
• MediaWiki Action API
  • https://www.mediawiki.org/wiki/API:Main_page
  • Reference: Per project at /w/api.php
  • Includes Wikibase API https://www.mediawiki.org/wiki/Wikibase/API
  • Includes Extension APIs https://www.mediawiki.org/wiki/API:Extensions#Module_creation_and_registration
• MediaWiki REST API
  • https://www.mediawiki.org/wiki/API:REST_API
  • Reference: Per project at /w/rest.php
  • Also proxied through the Gateway under /core (https://api.wikimedia.org/wiki/API_reference/Core)
• EventStreams API
  • Wiki page: https://wikitech.wikimedia.org/wiki/Event_Platform/EventStreams
  • Reference: https://stream.wikimedia.org/?doc
• ORES API
  • Wiki: https://www.mediawiki.org/wiki/ORES
  • Reference: https://ores.wikimedia.org/v3/#/scoring
• Link recommendations
  • Swagger: https://api.wikimedia.org/service/linkrecommendation/apidocs/#
  • Proxied through the Gateway under /service/linkrecommendation (https://api.wikimedia.org/wiki/API_reference/Service/Link_recommendation)

Wikidata

• SPARQL (query.wikidata.org)
  • https://www.mediawiki.org/wiki/Wikidata_Query_Service/User_Manual#SPARQL_endpoint
• Wikidata Linked Data Interface
  • https://www.wikidata.org/wiki/Wikidata:Data_access#Linked_Data_interface
  • Example: https://www.wikidata.org/wiki/Special:EntityData/Q7251.json
• Wikidata LDF:
  • https://query.wikidata.org/bigdata/ldf

Commons

• Wikimedia Commons Query Service (WCQS) SPARQL endpoint for commons (https://wcqs-beta.wmflabs.org/)
  • Docs: https://commons.wikimedia.org/wiki/Commons:SPARQL_query_service
  • will be pushed to production as part of task T260568

Internal

• Special:RunJobs undocumented entry point for executing jobs from the job queue. Internal use only, protected by HMAC.

Deprecated

• MediaWiki AJAX interface
  • From the old days, before the action API exists. Still used by some extensions
  • See $wgAjaxExportList, T42787

• Mobile Apps REST API
  • https://mobileapps.wmflabs.org/?doc#/
    • Page Content Service is proxied through the Gateway under /core.../description (example: https://api.wikimedia.org/wiki/API_reference/Core/Pages/Get_description)
    • This Cloud VPS instance is intended for development and testing only and should not be relied upon in production. See also https://wikifeeds.wmflabs.org/?doc#/, to which the same warning applies.
• Image recommendations
  • Swagger: https://image-suggestion-api.wmcloud.org/?doc
• Wikidata GraphQL:
  • Endpoint: https://tptools.toolforge.org/wdql.html
• Recommendation API
  • https://meta.wikimedia.org/wiki/Recommendation_API

?Questionable?

• CXServer (Content Translation)
  • https://github.com/wikimedia/mediawiki-services-cxserver
• NSFW (Not Safe For Work) API
  • https://wikitech.wikimedia.org/wiki/Tool:CommTech#NSFW
• Similar Users
  • https://github.com/wikimedia/mediawiki-services-similar-users
• Optical Character Recognition
  • https://ocr.wmcloud.org/api/doc

Research

Slides with more details on Research APIs

• Article Topic API
  • Documentation https://meta.wikimedia.org/wiki/Research:Language-Agnostic_Topic_Classification/Outlink_model_performance
  • Code: https://github.com/geohci/wikipedia-language-agnostic-topic-classification
  • Interface: https://wiki-topic.toolforge.org/
  • Example call: https://wikipedia-topic.wmcloud.org/api/v1/topic?lang=en&title=Chadwick_Boseman

• Article Region API
  • Documentation: https://meta.wikimedia.org/wiki/Research:Language-Agnostic_Topic_Classification/Countries
  • Code: https://github.com/geohci/wiki-region-groundtruth
  • Example call: https://wiki-region.wmcloud.org/api/v1/region?lang=en&titles=Chadwick_Boseman
  • Interface: https://wiki-topic.toolforge.org/countries

• Person (Occupation) API
  • Example call: https://www.google.com/url?q=https://person-wikidata.wmcloud.org/api/v1/occupation?lang%3Den%26title%3DToni_Morrison&sa=D&source=editors&ust=1631224226097000&usg=AOvVaw1EEcSFkeZ7II34eHxy5Jbz
  • Interface https://wiki-topic.toolforge.org/person

• Article Quality
  • Docs: https://meta.wikimedia.org/wiki/Research:Prioritization_of_Wikipedia_Articles/Language-Agnostic_Quality
  • Example call: https://misalignment.wmcloud.org/api/v1/quality-article?lang=en&title=Chadwick_Boseman
  • Code: https://github.com/wikimedia/research-api-endpoint-template/blob/misalignment/model/wsgi.py

• Article Gender
  • Docs: https://www.google.com/url?q=https://phabricator.wikimedia.org/T288666&sa=D&source=editors&ust=1631224474834000&usg=AOvVaw06BjYfl52iT84cmJuZCy6g
  • Example call: https://article-gender-data.wmcloud.org/api/v1/details?lang=en&title=Modern_art
  • Usage script: https://en.wikipedia.org/wiki/User:TayIorRobinson/wikigender.js

• List-Building (TODO: see what APIs this tool is using)
  • Docs: https://meta.wikimedia.org/wiki/Research:Evaluating_list_building_tools_for_ad-hoc_topic_models

• Clickstream
  • Docs & Code: https://github.com/mnzpk/wikinav
  • Example Call: https://wikinav.wmcloud.org/api/v1/en/Chocolate/sources/latest
  • Interface: https://wikinav.toolforge.org/

• Section Recommendation
  • https://meta.wikimedia.org/wiki/Research:Expanding_Wikipedia_articles_across_languages/Inter_language_approach#Section_Recommendation
  • Code: https://github.com/digitalTranshumant/wmf-interlanguage/blob/master/SecRec.ipynb
  • Example call: https://secrec.wmflabs.org/API/recommendation/en/Quilombo?verbose=True&blind=False

• Citation Needed
  • Example call: https://secrec.wmflabs.org/API/recommendation/en/Quilombo?verbose=True&blind=False
  • Documentation: https://meta.wikimedia.org/wiki/Citation_Detective
  • Code: https://github.com/AikoChou/citationdetective