Home | Documentation (v4) | Documentation (v3) | Community forum

gRPC

ChirpStack provides a gRPC API interface which can be used to integrate ChirpStack with external application and / or to integrate ChirpStack into other platforms.

gRPC

gRPC is a high-performance, open-source universal RPC framework. Protocol Buffers definitions are used to define this API. All definitions are hosted in the chirpstack repository.

Using the gRPC toolsets, it is possible to generate API clients for various programming languages. The following languages are officially supported by gRPC but there are additional community-based implementations:

  • C++
  • Go
  • Node.js
  • Java
  • Ruby
  • Android Java
  • PHP
  • Python
  • C#
  • Objective-C

Authentication

In order to use the gRPC API methods, you must provide per-RPC credentials. The key for this metadata is authorization, the value Bearer <API TOKEN> (replace <API TOKEN> with the API TOKEN obtained using the web-interface).

ChirpStack SDKs

The ChirpStack project provides SDKs for the following programming languages:

API console / UI

ChirpStack itself does not provide an API console / UI interface, but it is compatible third-party gRPC GUI applications. See for example: