GruntAPI

An open-source Command Line Interface (CLI) for Halo Infinite data, powered by OpenSpartan tooling.

Overview

GruntAPI is a cross-platform CLI that allows anyone who plays Halo Infinite to query their Halo Infinite data, such as match stats, inventory, battle pass progress, and more.

📕 Learn More - Official Documentation

Getting started

Before you can query the data, you need to log in:

gruntapi login

You will be prompted to enter your Microsoft account credentials. Once you authenticate, you can run a range of commands to test that you're logged into the right account, such as:

gruntapi servicerecord

This should return the current player's service record. If the call is successful, you are authenticated.

Commands

For a full list of commands and capabilities of GruntAPI, refer to the official documentation.

Get service record

gruntapi servicerecord

To get another player's service record:

gruntapi servicerecord --player-id GAMERTAG_OR_XUID

In the example above, --player-id can be either a player gamertag or their Xbox User ID (XUID) in the format xuid(PLAYER_XUID).

Get match history

gruntapi matchhistory

Get specific match stats

gruntapi match --match-id MATCH_ID

Get current inventory

gruntapi inventory

Get season calendar

gruntapi seasoncalendar

Get store offerings

gruntapi store --type generic

Get HCS store offerings

gruntapi store --type hcs

Get items on The Exchange

gruntapi store --type exchange

Origins

GruntAPI started as a .NET-based wrapper for Halo Infinite. Since then, the library was made private, however the name got transferred to this project, providing Halo Infinite enthusiasts an avenue to query their game data from their favorite terminal application.