AchStats verfügt über eine RESTful API ähnlich der Steam Web API. Gesammelte Daten stehen darüber für interessierte Entwickler zum Abruf bereit. Die Benutzung erfordert einen Zugangsschlüssel, welcher hier angefordert werden kann. Eine Dokumentation sämtlicher Features ist weiter unten zu finden.
Zugangschlüssel sind geheim und an E-Mail-Adressen gebunden. Bitte geben Sie ihre Adresse ein, um einen 25-stelligen Schlüssel zu erhalten. Falls Sie ihn verloren haben, können Sie ihn auf diesem Wege erneut abrufen.
Zugangsschlüssel können durch längere Inaktivität oder massive Anfragen entzogen werden. In solchen Fällen werden Sie darüber informiert. Alternativ können Sie ihren Schlüssel auch jederzeit selber löschen.
Alle Aufrufe erfolgen über die URL api.achievementstats.com/ bzw. api.achstats.com/ und die Abbildung der weiteren Fachlichkeit. Die URL muss immer mit der Angabe des 25-stelligen Zugangsschlüssel enden in Form von "/?key=…".
Die Antwort ist immer im JSON-Format. Aufrufe mit einem ungültigen Zugangsschlüssel enden mit HTTP-Statuscode 403 und unbekannte Aufrufe enden mit HTTP-Statuscode 404.
| Abschnitt der URL | Methode | Erklärung | Beispiel |
|---|---|---|---|
| profiles/<Steam64ID>/ | GET | Daten eines Profils unter Angabe der Steam64ID. | profiles/76561197968240913/ |
| profiles/<Steam64ID>/games/ | GET | Besitzende Spiele als AppIDs eines Profils unter Angabe der Steam64ID. | profiles/76561197968240913/games/ |
| profiles/<Steam64ID>/achievements/ | GET | Erreichte Errungenschaften als API Name und ihrer AppID eines Profils unter Angabe der Steam64ID. Verwendet einen optionalen Parameter "appIds" als Filter für bestimmte Spiele. | |
| profiles/<Steam64ID>/friends/ | GET | Freunde als Steam64IDs eines Profils unter Angabe der Steam64ID. | profiles/76561197968240913/friends/ |
| profiles/<Steam64ID>/badges/ | GET | Erreichte Abzeichen mit BadgeID eines Profils unter Angabe der Steam64ID. | profiles/76561197968240913/badges/ |
| profiles/<Steam64ID>/update/ | POST | Aktualisierung eines Profils unter Angabe der Steam64ID anstoßen. | profiles/76561197968240913/update/ |
| games/ | GET | Liste verfügbarer Spiele als AppIDs. | games/ |
| games/<AppID>/ | GET | Daten eines Spiels unter Angabe der AppID. Diese gilt auch für DLCs, allerdings haben externe DLCs (die es nicht bei Steam gibt) negative AppIDs. | |
| games/<AppID>/achievements/ | GET | Errungenschaften eines Spiels oder DLCs unter Angabe der AppID. | games/1250/achievements/ |
| games/<AppID>/badges/ | GET | Abzeichen eines Spiels unter Angabe der AppID. | games/1250/badges/ |
| games/<AppID>/dlcs/ | GET | DLCs als AppIDs eines Spiels unter Angabe der AppID. | games/1250/dlcs/ |
| badges/ | GET | Liste verfügbarer Abzeichen als BadgeIDs und AppIDs. | badges/ |
| badges/<BadgeID>/ | GET | Daten eines Abzeichens anhand der BadgeID, nicht auf Sammelkarten von Spielen bezogen. | badges/1/ |
| badges/<BadgeID>/stages/ | GET | Stufen eines Abzeichens anhand der BadgeID. | badges/1/stages/ |