.. toctree::
   :hidden:
   :maxdepth: 2

=========================================
Unofficial PlanetSide 2 API Documentation
=========================================

This project provides detailed, community-maintained documentation for all API collections specific to `PlanetSide 2 <https://www.planetside2.com/home>`_.

The latest version of this documentation is found `here <openapi.html>`_ using the `ReDoc <https://github.com/Redocly/redoc>`_ Documentation viewer.

These docs are maintained in the `OpenAPI 3.0 format <https://swagger.io/specification/>`_ and are designed to be easily consumable by CI/CD toolchains and scripts, do feel free to scrape them for your own API wrappers and utilities.

A download link to the raw OpenAPI JSON specification can be found at the top of the ReDoc version or can be downloaded from the repository's `Releases <https://github.com/leonhard-s/ps2-api-docs/releases>`_ page.

Currently, only the REST endpoint is documented. A WebSocket API reference may be added in a later version.

For more information, visit the project repository at https://github.com/leonhard-s/ps2-api-docs.