Home

Awesome

Halo::Reach::API

Ruby gem for interacting with the Halo:Reach API

Requirements

Install

gem install halo-reach-api

Example

require 'halo-reach-api'
=> true
halo_reach_api = Halo::Reach::API.new('xxx') # Where 'xxx' is your Halo:Reach API Key
=> #<Halo::Reach::API:0x1015ec2c8 @token="xxx", @api_url="http://www.bungie.net/api/reach/reachapijson.svc/">

Look at the unofficial wiki for complete descriptions of the API calls.

FAQ

Q: How do I get an API key?

A: You must register with Bungie.net and you can then generate an API key at http://www.bungie.net/Account/reachapikey.aspx

Q: Dates are funky and not parsed as dates. For example:

 { "Credits" : 1000,
 "Description" : "Earn 20 assists today in multiplayer Matchmaking.",
 "ExpirationDate" : "/Date(1290510000000-0800)/",
 "IsWeeklyChallenge" : false,
 "Name" : "Pass the Rock"
 },

A: Yes they are funky. Yes. They. Are. You can now parse them out with the Halo::Reach::Util class.

parsed_time, parsed_timezone = Halo::Reach::Util::parse_timestamp(api_timestamp)

Contributing to halo-reach-api

Copyright

Copyright (c) 2010-2014 David Czarnecki. See LICENSE.txt for further details.