< User:J4
more docs |
add csv endpoint docs |
||
Line 4: | Line 4: | ||
Accessing the data is simple, and only one endpoint is available: | Accessing the data is simple, and only one endpoint is available: | ||
* https://plainapi.resostats.j4.lc/ - As a plain string formatted as below | * https://plainapi.resostats.j4.lc/ - As a plain, string formatted as below | ||
* https://plainapi.resostats.j4.lc/csv - As a CSV file, formatted as below | |||
This endpoint will return a week worth of data. | This endpoint will return a week worth of data. | ||
Line 30: | Line 31: | ||
** Minute of the day (0 to 1440) | ** Minute of the day (0 to 1440) | ||
** Number of registered players online (inc. headlesses) | ** Number of registered players online (inc. headlesses) | ||
This order also applies to the CSV endpoint. |
Revision as of 16:33, 25 September 2024
This page describes basic documentation for the plain API of Resostats. It is made to provide a week-long history of Resonite stats that is easily parseable with ProtoFlux to make graphs in-game.
Accessing the data
Accessing the data is simple, and only one endpoint is available:
- https://plainapi.resostats.j4.lc/ - As a plain, string formatted as below
- https://plainapi.resostats.j4.lc/csv - As a CSV file, formatted as below
This endpoint will return a week worth of data.
Description of the data
The data is formatted as follows:
[[3,811,276],[3,871,274]] ^^^ ^ ^ ^ ^ Data stop ||| | | - Stat delimiter ||| | - Stats (number of registered players online) ||| - Minute of day (0,1440) ||- Day number (0,6) |- Data block start delimiter - Data start
As text:
- The main data body starts with
[
and ends with]
- Individual data blocks are contained in brackets (
[data]
) within the body - The data body is formatted in the following order:
- Number of day (0 to 6)
- Minute of the day (0 to 1440)
- Number of registered players online (inc. headlesses)
This order also applies to the CSV endpoint.