Application programming interfaces (APIs) are what developers, fansite operators, and bots use to retrieve information about the game and the wiki. API can be tested on the wiki through Special:ApiSandbox.
Semantic MediaWiki API
Semantic MediaWiki API is available on some pages that has Semantic properties set. Additional documentation is available on the Semantic MediaWiki's API page.
To check a list of data available on the page, click the three dot menu and select Browse properties.
Mediawiki REST API
The Star Citizen Wiki provides an REST API that can be accessed here. Additional documentation is available on the Mediawiki REST API page. It is recommended over the Action API if you only need to fetch information. Commonly used endpoints can be found here.
Mediawiki Action API
The Star Citizen Wiki provides an action API that can be accessed here. Additional documentation is available on the Mediawiki Action API page. Some features are limited to logged in users, administrators, and bureaucrats. The API Sandbox special page may be useful for users new to creating requests.
Below are a few useful modules under the query action:
Module | Use |
---|---|
prefixsearch | Take user input and return the best-matching titles. Should be used with generator. |
description | Returns a short description of the given pages. |
pageimages | Returns information about images on the page, such as thumbnail and presence of photos. |
extracts | Returns plain-text or limited HTML extracts of the given pages. |