diff --git a/README.md b/README.md index 2371bb1..70b4ef0 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # tfleaderboard A free API for The Finals ranking data. You can find data such as rank, name, total player cashouts, etc... . Feel free to use the api for your projects. You can also quote the depot when you use it. Thanks + +# API Endpoints + +> [https://soraclee.github.io/tfleaderboard/leaderboard.json](https://soraclee.github.io/tfleaderboard/leaderboard.json) + +Returns the latest leaderboard data + +## Example Response + +```json +[ + { + "name": "TwitchTvPookOut#5437", + "rank": 1, + "fame": 414045, + "old_fame": 404880, + "old_rank": 1, + "cashouts": 94420202, + "networks": { + "steam": "PookOut", + "psn": "", + "xbox": "" + } + }, + {...} +] +```