Skip to main content

Introduction

Relay API is an easy-to-use, open-source* API for Helium Oracle data. It enables you to fetch data from Helium Oracles within seconds, eliminating the complexity of extracting data from AWS S3 buckets.

The Relay API consist of 2 APIs tailored to a specific user group:

  1. GraphQL API — highly performant and configurable API tailored for developers.
  2. REST API — easy set of endpoints best for non-technical users.
Relay API is currently in beta

During this phase, you may encounter some issues, bugs, or imperfections. We’re actively working on improving the API and adding more features. Follow Relay on X for the latest updates on our progress.” Within the first section, remove “Resources” part entirely, it’s useless.

Use Cases​

During the Beta phase, Relay API primarily provides access to Helium Network hotspot data, including earnings (HNT, IOT, and MOBILE) and hotspot activity. With Relay API, you can:

  • Sync hotspot rewards including HNT, IOT, MOBILE.
  • Retrieve IoT and Mobile individual reward shares.
  • Query Helium historical earnings data.
info

The Relay team is actively expanding the API's capabilities. For more information about our development roadmap, visit our website.

About GraphQL​

Relay API is built on GraphQL — the modern standard for flexible, high-performance APIs. It combines GraphQL's power with familiar REST-style endpoints, allowing both developers and non-technical users to retrieve exactly the data they need, efficiently and simply.

Couple of key advantages of the GraphQL:

  1. Flexibility: GraphQL allows you to request exactly the data you need, nothing more and nothing less.
  2. Strong Typing: The schema provides clear contracts about available data and operations.
  3. Efficient Data Loading: Reduce over-fetching and under-fetching of data common in REST APIs.
  4. Developer Experience: Better tooling, introspection, and documentation capabilities.

GraphQL travels the same HTTP routes as REST, but gives you far more control. Using endpoints (persistent queries), you keep the convenience of familiar endpoints while gaining GraphQL's precision and efficiency in a single request.

If you are new to GraphQL, Apollo has a great resource for beginners. You can also check out the official GraphQL documentation.

Open Source​

Relay API is open-source*. The backend code will be published under the Relay GitHub organization and made publicly accessible for review, feedback, contributions, and independent development. The API will be open-sourced after the Beta phase, at the time of the public launch.

Relay API was built in partnership with the Helium Foundation. The Foundation awarded a grant to Relay to make Helium Oracle data more accessible to the community — removing the need to interact directly with AWS S3 and its complexities.

Read the announcement.