api documentation

ReconnectedCC · Oct 6, 2024 · ff06c14 · ff06c14
1 parent 1b292b5
commit ff06c14
Showing 1 changed file with 15 additions and 0 deletions.
diff --git a/faq/api.md b/faq/api.md
@@ -0,0 +1,15 @@
+---
+title: HTTP api
+layout: home
+parent: FAQ
+---
+
+# HTTP api
+The server exposes an HTTP api with various bits of information for people to access
+
+The root URL is `https://api.reconnected.cc`
+
+## Endpoints
+- `tps`: Returns the TPS as a float.
+- `mspt`: Returns the current MSPT as a float.
+- `player`: Returns the amount of players online on the server as an integer.