How to communicate with this API

Tokens are required for consuming most services in this API.

Supplying Your Token

Tokens must be included in your request via a X-API-Token header.

Requesting Tokens

Contact HITMAPS directly to request a token. We aim to respond to all token requests within 72 hours. This token lasts permanently and will not be recycled / replaced unless requested.


When requesting a token, you may request one (or more) scopes. These scopes currently are:

  • read:rawcontract - Returns raw contract JSON, suitable for the in-game client
  • read:contract - Returns contract JSON, but formatted in a friendly way for display
  • read:leaderboard - Returns leaderboard JSON