Skip to content
API
Managing your game
Introduction

Your game on Beam

Your game registration within Beam consists of information that is managed by Beam, and information manageable by you. When we register your api key, we'll also be in touch about the assets you want to register in your game. We can either provide contract templates for generic in-game currencies, but are also happy to help you with bridging over assets from one chain to another - be in touch!

Here are some of the key pieces of info you'll need to get started with implementing with Beam:

Retrieving your game

If you're just interested in the currently registered information of your game in the Beam accounts API, simply call the getGame method. You'll find an example on how to do this below.

Note: we don't expose your API keys in this request, as we don't want people to accidentally expose them in application logs.

import { Beam } from "@onbeam/automation-api-client";
 
const beam = new Beam("x-api-key");
 
const game = await beam.game.getGame();
 
// {
//   "id": "string",
//   "name": "string",
//   "contracts": [
//     {
//       "type": "ERC20",
//      ...
//     }
//   ],
//   "policies": [
//     {
//       "id": "string",
//       ...
//     }
//   ]
// }
Player or Automation APIAPI keys