API

This page is for developers and describes BGS-Tally's API for sending data to web services.

The API defines three endpoints:

• GET /discovery: Requests information from the server about its requirements and configuration. This allows the server to declare which endpoints it supports, to declare which events it is interested in receiving, to further filter those events based on RegEx pattern matching, and to define general parameters such as how often it would like to receive data and the size of event batches.
• PUT /activities: Sends aggregated and collated BGS and Thargoid War data for all activity by the user within the current tick.
• POST /events: Sends journal events from the E:D game journal. Events are primarily raw data directly from the journal, but are slightly enhanced by BGS-Tally with some additional useful fields.

The latest published version of the API is documented here:

• v1.5.0 - Implemented in BGS-Tally 4.0.0

Earlier versions of the API are documented here:

• v1.4.0 - Implemented in BGS-Tally 3.6.0
• v1.3.0 - Implemented in BGS-Tally 3.3.0
• v1.2.0 - Implemented in BGS-Tally 3.2.0
• v1.1.0 - Implemented in BGS-Tally 3.1.0
• v1.0.0 - Implemented in BGS-Tally 3.0.0

Note

Developers: The latest bleeding-edge version is documented here, which is under development and subject to change and therefore may include as-yet unreleased features. Also, the OpenAPI YAML defining the API is published as a separate GitHub project here, which is kept synchronised with API version releases from the Apicurio project.