Aquarium API & modules

You can interact with Aquarium using our REST API.

Our REST API documentation is build with Bruno. It allows you to download our API and play with requests directly in the GUI or with the CLI of Bruno.

flag Introduction

Start here to get an introduction about our API.

layers REST API

Discover our REST API. All routes and methods are listed here.

book_5 How-to guides

Check our how-to guides to learn how to interact with Aquarium.

Modules

Several modules are available as an API wrapper:

code Typescript

Connect your javascript/typescript code with Aquarium.

deployed_code Python

Integrate your Aquarium with Python.

Looking for another language? Contact us and we will help you to build a module for your language.

meshQL

Aquarium's API use meshQL as language to filter data. MeshQL allows you to traverse or query your nodal data tree as you want to filter everything. It's also a way to customize the output of our API.

You don't need to learn meshQL to use our wrapper modules, especially the Python one, where we added build-in functions.

But learning meshQL can be useful if you want to optimize your queries, gain in performance and understand how Aquarium works.

Feel free to contact us if you have any questions.

arrow_back Previous Home Introduction Next arrow_forward