https://github.com/alphauslabs/blueapi
Protobuf definitions for Alphaus Blue API.
https://github.com/alphauslabs/blueapi
grpc protobuf
Last synced: 21 days ago
JSON representation
Protobuf definitions for Alphaus Blue API.
- Host: GitHub
- URL: https://github.com/alphauslabs/blueapi
- Owner: alphauslabs
- License: apache-2.0
- Created: 2021-01-18T08:56:18.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2026-03-09T10:36:31.000Z (22 days ago)
- Last Synced: 2026-03-09T15:14:26.045Z (22 days ago)
- Topics: grpc, protobuf
- Language: Go
- Homepage: https://labs.alphaus.cloud/docs/blueapi/overview/
- Size: 4.02 MB
- Stars: 3
- Watchers: 7
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/alphauslabs/blueapi/actions/workflows/main.yml)
> [!NOTE]
> `google/*` - copied from [github.com/googleapis/api-common-protos](https://github.com/googleapis/api-common-protos)
> `protoc-gen-openapiv2/*` - copied from [github.com/grpc-ecosystem/grpc-gateway/protoc-gen-openapiv2](https://github.com/grpc-ecosystem/grpc-gateway/tree/master/protoc-gen-openapiv2)
`blueapi` is the [protobuf](https://developers.google.com/protocol-buffers) definition of [Alphaus](https://alphaus.cloud/) [Blue API](https://alphauslabs.github.io/docs/blueapi/overview/).
You need to install the following tools to build locally:
* The [protoc](https://grpc.io/docs/protoc-installation/) compiler
* The following compiler plugins:
```bash
$ go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
$ go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
$ go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@latest
$ go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest
$ go install github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc@latest
```
* The [buf](https://docs.buf.build/installation) tool
This repo depends on [protos](https://github.com/alphauslabs/protos) as a [submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). To update locally, you need to:
```bash
# First time cloning the repo:
$ git submodule update --init --recursive
# Otherwise:
$ git submodule update --remote --merge
```
Then run:
```bash
$ ./build.sh
```
Generated SDKs from updates to this repository:
* [blue-sdk-go](https://github.com/alphauslabs/blue-sdk-go)
* [blue-sdk-python](https://github.com/alphauslabs/blue-sdk-python)
* [blue-sdk-ts](https://github.com/alphauslabs/blue-sdk-ts)
The generated OpenAPI documentation can be found [here](https://alphauslabs.github.io/blueapidocs/).