From 83b3ad01c47fe72b97446171da0554bc87c6205a Mon Sep 17 00:00:00 2001 From: Katalina Okano Date: Tue, 20 Dec 2022 20:09:47 -0500 Subject: [PATCH] README.md --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..9531565 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +# https://agg.ps2.live/population + +A Planetside 2 population aggreggation API between + +- https://ps2.fisu.pw +- https://wt.honu.pw +- https://saerro.ps2.live +- https://voidwell.com + +Has some jank filters and will average between all 4 sources with as much data as can be used. + +If you have a population API to add to this aggreggator, open an issue with your API details. The more sources, the merrier, but we usually need to make some performance considerations. + +This API is hosted on Cloudflare Workers, and makes use of aggressive caching with a 3 minute TTL. + +Need help? Talk to us on the [Planetside Community Developers Discord](https://discord.gg/yVzGEg3RKV) in `#ps2live` + +## API + +- [/$worldID](https://agg.ps2.live/population/1) - Single world +- [/all](https://agg.ps2.live/population/all) - All worlds at once +- [~/flags](https://agg.ps2.live/population~/flags) - Feature flags that help limit useless requests and add speed. +- [~/health](https://agg.ps2.live/population~/health) - Tests reachability + +## Developing + +``` +npm install + +npm run dev +```