Skip to main content

Getting Started

The HeliumGeek API is scoped per account. Every request requires an API key (x-api-key). REST endpoints live on the https://heliumgeek.com host under the /v0 prefix (for example, /v0/gateways).

1. Obtain credentials​

  1. Review the plans published at heliumgeek.com/api.
  2. Email info@heliumgeek.com with the plan you'd like to subscribe to.
  3. We will provision the API key and share it securely with you. Keys grant full access to your tenant—store them carefully.

2. Make your first request​

curl https://heliumgeek.com/v0/gateways?name=purple \
  -H "x-api-key: <your api key>"

The response confirms connectivity and returns the gateway data visible to your API key. From here you can explore specific endpoints, apply filters, or paginate through additional results.

3. Explore the reference​

  • Review the Authentication guide to learn how keys are provisioned and how to request bespoke auth flows.
  • Learn how the cursor-based Pagination model and time-series windows work so you can page through large datasets on the time axis confidently.
  • Monitor plan limits using the Usage telemetry headers returned by gateway and radio endpoints.
  • Use the Schemas tab inside the reference to validate request payloads before shipping code.

Next, learn how to work with the OpenAPI schema so you can scaffold strongly‑typed clients.