Foreword: The API is currently in BETA, expect breaking changes.
FAQ:
Q: Who is this for?
A: Developers, Developers, Developers
Q: Where do I start?
A: Head over to developer.haloapi.com. Sign up, get an API Key, and read some documentation.
Q: Where do I get an API Key?
A: After signing up at developer.haloapi.com, you can enroll into the 'Developer Access' product, and get a key (check your profile).
Q: Where is the documentation?
A: You can read the official documentation for all endpoints at developer.haloapi.com/docs/services/.
Q: What games are supported?
A: Halo 5 (Xbox One), Halo 5: Forge (PC), Halo Wars 2 (Xbox One, PC)
Q: Can I query Halo 4 (etc.) data?
A: No. There is no sign to suggest this will change.
Q: How fast can I make queries.
A:
UNOFFICIAL LIBRARIES:
The following are developed by members of the Halo community, they are here to make the world a better place. If you want your project added (or removed) sound out here, or shoot me a message, and I'll get it sorted.
C#
FAQ:
Q: Who is this for?
A: Developers, Developers, Developers
Q: Where do I start?
A: Head over to developer.haloapi.com. Sign up, get an API Key, and read some documentation.
Q: Where do I get an API Key?
A: After signing up at developer.haloapi.com, you can enroll into the 'Developer Access' product, and get a key (check your profile).
Q: Where is the documentation?
A: You can read the official documentation for all endpoints at developer.haloapi.com/docs/services/.
Q: What games are supported?
A: Halo 5 (Xbox One), Halo 5: Forge (PC), Halo Wars 2 (Xbox One, PC)
Q: Can I query Halo 4 (etc.) data?
A: No. There is no sign to suggest this will change.
Q: How fast can I make queries.
A:
- The 'Developer Access' product is limited to 10 queries per 10 seconds.
- The 'Production Access' product is limited to 200 queries per 10 seconds.
UNOFFICIAL LIBRARIES:
The following are developed by members of the Halo community, they are here to make the world a better place. If you want your project added (or removed) sound out here, or shoot me a message, and I'll get it sorted.
C#
- HaloEzAPI (Glitch100) [HaloWaypoint] [GitHub] [NuGet] - Incomplete*.
- HaloSharp (Furiousn00b) [HaloWaypoint] [GitHub] [NuGet] - Incomplete*.
- Beginnings (chrisfried) [HaloWaypoint] [Gist] - Sample Code.
- haloapi.js (Der Flatulator) [HaloWaypoint] [GitHub] [NPM] [Website] [Documentation] - Incomplete*.
- PHP-HaloAPI (BananasSplitter) [HaloWaypoint] [GitHub] [Composer] - Incomplete*.
- PHP Halo API (dirtybolle) [HaloWaypoint] [GitHub] - Complete.
- 16807 PIOUS ACADEMIC (ROFL A WET SOCK) [HaloWaypoint] [GitHub] - Incomplete*.
- PyHalo (AppliedLight) [HaloWaypoint] [GitHub Fork] - Incomplete*.
- HaloPy (themaxpowa) [GitHub] [Documentation] - Incomplete*.
- h5api (CLWakaLaka) [GitHub] - Incomplete*.
- halo-api (Xarly Bovi) [GitHub] - Complete.