Overview

This section contains the API reference for the Qatium SDK. The SDK is a library that lets you build extensions on the Qatium platform.

Packages

• @qatium/sdk: Methods and type definitions available in the SDK.
• @qatium/sdk/plugin: Methods to create your plugin.
• @qatium/sdk/ui: Methods to work with the Panel UI of your plugin.

Installation

In order to install the package, you can use npm:

npm install @qatium/sdk

If using python, you should also install the PyPi dependency:

pip install qatiumsdk

Usage

Plugins

TypeScript

Inside plugins you can use the sdk object directly as a global variable:

sdk.network.getAssets()

Python

Inside plugins you should import sdk from qatiumsdk:

from qatiumsdk import sdk
sdk.network.get_assets()

Browser

Another way of using the SDK is using the browser console. It can be found in window.qatium:

window.qatium.network.getAssets()