Intro to the Halo Public API

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:

• The 'Developer Access' product is limited to 10 queries per 10 seconds.
• The 'Production Access' product is limited to 200 queries per 10 seconds.

Blow these and expect a 429.


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*.

Node.js

• Beginnings (chrisfried) [HaloWaypoint] [Gist] - Sample Code.
• haloapi.js (Der Flatulator) [HaloWaypoint] [GitHub] [NPM] [Website] [Documentation] - Incomplete*.

PHP

• PHP-HaloAPI (BananasSplitter) [HaloWaypoint] [GitHub] [Composer] - Incomplete*.
• PHP Halo API (dirtybolle) [HaloWaypoint] [GitHub] - Complete.

Python

• 16807 PIOUS ACADEMIC (ROFL A WET SOCK) [HaloWaypoint] [GitHub] - Incomplete*.
• PyHalo (AppliedLight) [HaloWaypoint] [GitHub Fork] - Incomplete*.
• HaloPy (themaxpowa) [GitHub] [Documentation] - Incomplete*.

R

• h5api (CLWakaLaka) [GitHub] - Incomplete*.

Ruby

• halo-api (Xarly Bovi) [GitHub] - Complete.

* At one point these projects were feature complete and implemented all API endpoints/features. They have not been updated with recent changes.

thelastelephant wrote:

I've got one I'm working on for iOS/Objective-C. Should be wrapped up by this weekend.

Sweet. Let us know when it's available and I'll have a look :)

Null Parameter wrote:

Quote:

A: The 'Developer Access' product is limited to 100 queries in 10 seconds. Blow this and expect a 429.

Sadly, this is already out of date. Down to 10 per 10 seconds.

Yup, looks like you're right. They don't seem to have updated their documentation to reflect this though.

I'm guessing it's because people were abusing the 'Developer Access' product. It's not really that clear, but it's not meant to be used for production i.e. any scripts people have running etc. it's to be used while building your app. 10/10 is pretty slow, but it's serviceable for it's intended use.

Once your app is built, you submit it, they'll give you a new product with different rates.

Null Parameter wrote:

Quote:

I'm guessing it's because people were abusing the 'Developer Access' product. It's not really that clear, but it's not meant to be used for production i.e. any scripts people have running etc. it's to be used while building your app. 10/10 is pretty slow, but it's serviceable for it's intended use.

Once your app is built, you submit it, they'll give you a new product with different rates.

Is this documented or mentioned anywhere? As far as I could ever tell, "Developer Access" was the only option ever available, but I probably just missed it.
Edit: Never mind, I realized you meant the application in the sticky thread.

I actually missed that post.

You can submit applications through your profile on developer.haloapi.com. Seems like they want you to send an email instead (?).

After you register an application, you can submit it.

Thanks for listing our librairies !
I just released the beta version of my PHP-HaloAPI :)
Now available as a composer package as requested by users.

Thanks for putting this together Furiousn00b and company! The team is reading your requests and feedback, so keep 'em coming!

Quote:

Thanks for putting this together Furiousn00b and company! The team is reading your requests and feedback, so keep 'em coming!

You're welcome Tashi :) Good to see so many excited to contribute.

ROFL A WET SOCK wrote:

Thanks for making this thread! I've just finished my first full release of 16807 PIOUS ACADEMIC, so if you could update the original post with that, I'd be thankful!

Sweet as! Updated as requested.

Heads up. Updated API today with a CacheManager, more tests. RateHandling, more tests. And more endpoints :)

I gave up on the last one. Any ideas?

For any R users out there I've put together a small package. It's available on github at cluoma/h5api

Nothing fancy, just some basic functions to easily access all current endpoints. Cheers!