Skip to main content
In development

The API is currently being developed, please check back soon, and keep an eye on the blog for an "API v1 release" announcement.

Hypermass API

The Hypermass API lets you publish, manage, and subscribe to data streams directly. We recommend giving the CLI a try initially because it handles failure, recovery and so on for you. The CLI documentation can be found here and is intended to be run in both local, dev and production environments as a simple link to Hypermass.

If you need something more advanced, the API is the right way to go. For example;

  • only fetching data when you need it
  • dynamically subscribing to streams
  • listing, searching and account actions

The trade-off is that you'll have to handle much of the subscription logic in your code, and bear the burden of refactoring for future API changes (we will communicate these changes and try to be considerate with upgrade pathways).

No Library (yet)

If your interested in the reasoning, please see our detailed article CLI Design Rationale.

We have guidance notes on how to integrate popular languages to the CLI; Building a Client.