API Clients

We auto generate clients in few languages for our APIs to help you get started quickly. We have separate clients available for both Automation and Player APIs.

Automation API clients

All Automation API clients are meant to be used on the server side, as it is crucial to not expose any of the api keys we provided publicly. It’s meant to be used with Secret API Key.

✅ Node.js (Typescript)✅ C# (.NET 6+)

Player API clients

The Player API clients can be used in the client-side code, as the Publishable API Key that is required to interact with the self-custody services can be exposed without risk. All Player operations need to be signed by the User(or Session).

✅ Typescript (browser & server)✅ C# (.NET 6+)

If you want to use a different language, you can always use our API Reference to get started. The API is RESTful and you can use any HTTP client to make requests. Just remember to pass your API key in the x-api-key header.

⚠️

If you encounter any bugs, issues or something is missing, let us know at build@onbeam.com or post an Issue in our beam-api-clients Github repository.

Beam Dashboard API Reference