Want to fiddle around with FLS Data but dont want to fight Steam, Playfab, FLS weirdnes or processing all the (possibly invalid) data? Dont look any further, the AwooPI is here!

Or maybe you just want to build something custom, I dont know, whatever boats your float

Find the API Documentation here: https://api.awoo.tools/scalar/

In order to get access to the API message me on Discord.

Rate Limiting

Please keep it civil.

Default Rate Limits are 60 Requests per Minute, if you have a case where this is not enough message me.

EVERY response to the API will return the following Headers for the Bucket* you are hitting:

RateLimit-Bucket

: The Bucket* that is currently being used. Value could be "SeabassConnection", "ServerBrowser", "Exchange", "SteamUpdates" or anything I implemented after that and didnt update this page. Useful for automated RateLimit handling related to buckets

RateLimit-Limit

: The maximum requests you can send in 1 Minute

RateLimit-Remaining

: The remaining requests you can send

RateLimit-Reset

: Amount of seconds until

RateLimit-Remaining

is reset

Retry-After

: Only sent when the RateLimit is hit! Seconds when you are allowed to hit the API again, which should override

RateLimit-Reset

on your end.

This is following https://www.ietf.org/archive/id/draft-polli-ratelimit-headers-02.html

*A "Bucket" is a separation of Rate Limits. For instance hitting 'api/seabassconnection' wont count towards the rate limit of 'api/serverbrowser'. Every Resource (ex.: ServerBrowser, Exchange or SteamUpdates) has its own Bucket

Possible error cases:

-400 Bad Request*

-You sent a API-Key, but its somehow malformed

-When a regionId or battlegroupId was required you sent null or whitespace. Dont do that

-401 Unauthorized*

-Self-Explanatory, either you´re not sending the API-Key, your Access has been disabled or you´re trying to access a section you´re not unlocked for

-404 Not found*

-Self-Explanatory, you were asking for a region/battlegroup/dimension but it couldnt be found

-424 Failed Dependency

-The Cache of the API is not ready yet. Usually only happens mere ms after the API started, try again in a second or two

-429 Too Many Requests

-Congrats, you triggered the rate limit. Read the Rate Limiting part again, dummy

-You should stop sending requests at this point. The system will automatically disable your access after you try to go too far over RateLimit-Limit

-500 Internal Server Error*

-Either I was too stupid to code or no public SeabassServerConnection could be found (this is terrible). Check the Discord, this shouldnt happen without an announcement

-503 Service Unavailable*

-Your Request cant be internally redirected from the Gateway to the API. Only happens during Downtimes, check the Discord

-???

-Im currently updating awoo.tools. I have no idea which HTTP Error you would get, good luck I guess?

*Check the documentation, I return a valid Model with a message about what happened

FAQ

-My Battlegroup/Dimension randomly shows up as offline and online again. Are Server crashing that much?

-No, I honestly have no idea whats going on but the FLS likes to sometimes just throw a fit and close connections or run into a 30 second timeout when I collect Data. At that point I mark the affected Region/Battlegroup/Dimension as offline. (I retry to get data 3 times if it fails though)

-Sometimes the FLS also says something is offline while it isnt... welcome to my life, its hell.

-I´ve been using the API for a private server and it just started returning 404 Errors?

-Ah, private servers. They really like to shuffle things around from time to time. Check if your private server hasnt moved in the backend, after 7 days offline-time I hide the affected Battlegroup/Dimension

-How can I figure out which regionId / battlegroupId / dimensionIndex to use?

-You can either use the ServerBrowser here or go through the data yourself using the API.

-

regionId

is just the name of the Region (ex: "Europe")

-

battlegroupId

is NOT the visible Name of the Battlegroup/World, but the ID in the background (ex: "prd-i3d-eu-montreuil-1-damp-bar" for "Cycliadas" in "Europe"). This ID is unique across all Regions.

-

dimensionIndex

is the index of the dimension inside the battlegroup. The dimension index is only unique inside the battlegroup