AchStats dispose d'une API RESTful similaire à l'API Steam Web. Les données recueillies sont mises à la disposition des développeurs voulant les récupérer de cette façon. Son utilisation nécessite une clé d'accès, qui peut être demandée ici. Une documentation de toutes ses fonctionnalités peut être trouvée ci-dessous.
Les clés d'accès sont secrètes et liées à des adresses e-mail. Veuillez fournir votre adresse e-mail ci-dessous pour recevoir une clé de 25 chiffres. En cas de perte, vous pouvez l'obtenir à nouveau de la même façon.
Les clés d'accès peuvent être révoqués en raison d'une longue inactivité ou d'un nombre de requêtes massif. Vous serez informé si tel est le cas. Vous pouvez également supprimer votre clé à tout moment.
Toutes les requêtes sont effectuées via les URL api.achievementstats.com/ et api.achstats.com/. L'URL doit toujours se terminer avec les 25 chiffres de la clé d'accés sous la forme "/?key=…".
La réponse est toujours au format JSON. Les requêtes avec une clé d'accès invalide aboutissent à un code de statut HTTP 403 et les requêtes inconnues requêtes aboutissent à un code de statut HTTP 404.
| Partie de URL | Méthode | Explication | Exemple |
|---|---|---|---|
| profiles/<Steam64ID>/ | GET | Données d'un profil avec le Steam64ID indiqué. | profiles/76561197968240913/ |
| profiles/<Steam64ID>/games/ | GET | Jeux possédés en AppIDs d'un profil avec le Steam64ID indiqué. | profiles/76561197968240913/games/ |
| profiles/<Steam64ID>/achievements/ | GET | Succès débloqués avec leurs noms API et leurs AppID d'un profil avec le Steam64ID indiqué. Utilise le paramètre optionnel "appIds" comme filtre pour certains jeux uniquement. | |
| profiles/<Steam64ID>/friends/ | GET | Amis en Steam64IDs d'un profil avec le Steam64ID indiqué. | profiles/76561197968240913/friends/ |
| profiles/<Steam64ID>/badges/ | GET | Badges débloqués avec BadgeID d'un profil avec le Steam64ID indiqué. | profiles/76561197968240913/badges/ |
| profiles/<Steam64ID>/update/ | POST | Déclenche la mise à jour d'un profil avec le Steam64ID indiqué. | profiles/76561197968240913/update/ |
| games/ | GET | Liste des jeux disponibles en AppIDs. | games/ |
| games/<AppID>/ | GET | Données d'un jeu avec l'AppID indiqué. Cela s'applique aussi pour les DLCs, cependant les DLCs externes (non disponibles sur Steam) ont des AppIDs négatifs. | |
| games/<AppID>/achievements/ | GET | Succès d'un jeu ou d'un DLC avec l'AppID indiqué. | games/1250/achievements/ |
| games/<AppID>/badges/ | GET | Badges d'un jeu avec l'AppID indiqué. | games/1250/badges/ |
| games/<AppID>/dlcs/ | GET | DLCs en AppIDs d'un jeu avec l'AppID indiqué. | games/1250/dlcs/ |
| badges/ | GET | Liste des badges en BadgeIDs et AppIDs. | badges/ |
| badges/<BadgeID>/ | GET | Données d'un badge avec le BadgeID indiqué, ne sont pas liées aux cartes à échanger des jeux. | badges/1/ |
| badges/<BadgeID>/stages/ | GET | Étapes d'un badge avec le BadgeID indiqué. | badges/1/stages/ |