GRVT Python SDK

Project description

GRVT Python SDK

GRVT Python SDK

What's in the library

GRVT Python SDK library provides Python classes and utility methods for easy access to GRVT API endpoints across all environments.

Environments

prod - Production environment.
testnet - Testnet environment.
staging - Development Integration environment.
dev - Development environment.

SDK Library provides two types of classes:

Raw - thin wrapper classes around Rest API.
Ccxt-compatible - classes with ccxt-like methods. Provide access to both Rest API and WebSockets.

Files

Raw access:

grvt_raw_base.py - base classes for Rest API access.
grvt_raw_env.py - definitions of environments for raw access.
grvt_raw_signing.py - utility methods for signing orders.
grvt_raw_sync.py - class for raw synchronous calls to Rest API.
grvt_raw_async.py - class for raw asynchronous calls to Rest API.

CCXT-compatible access:

grvt_ccxt_utils.py - utility methods for signing orders.
grvt_ccxt_env.py - definitions of environments for ccxt-like access.
grvt_ccxt_base.py - base class for Rest API access.
grvt_ccxt.py - class for synchronous calls to Rest API.
grvt_ccxt_pro.py - class for asynchronous calls to Rest API.
grvt_ccxt_ws.py - class for WebSocket calls.

Installation via pip

pip install grvt-pysdk

Configuration

Setup these environment variables:

export GRVT_PRIVATE_KEY="`Secret Private Key` in API setup"
export GRVT_API_KEY="`API Key` in API setup"
export GRVT_TRADING_ACCOUNT_ID=<`Trading account ID` in API>
export GRVT_ENV="testnet"
export GRVT_END_POINT_VERSION="v1"
export GRVT_WS_STREAM_VERSION="v1"

Usage

Examples of how to use various methods to connect to GRVT API:

GRVT CCXT - Example of usage of CCXT-compatible Python class GrvtCcxt with synchronous Rest API calls.
GRVT CCXT Pro - Example of usage of CCXT.PRO-compatible Python class GrvtCcxtPro with asynchronous Rest API calls.
GRVT CCXT WS - Example of usage of CCXT.PRO-compatible Python class GrvtCcxtWS with asynchronous Rest API calls + Web Socket subscriptions + JSON RPC calls over Web Sockets.
GRVT API Sync - Synchronous API client for GRVT
GRVT API Async - Asynchronous API client for GRVT

Contributor's guide

Prerequisites

Python >=3.10.0 < 3.13 (tested with 3.10.15)
pre-commit
uv >=0.3.3 (tested with 0.4.0)
docker (optional)

Installation of a source code

Clone the git repository

git clone https://github.com/grvt-technologies/grvt-pysdk.git

Go into the project directory
```
cd grvt-pysdk/
```
Checkout working branch
```
git checkout <branch>
```
Install dependencies
```
make install
```
Enable pre-commit hooks
```
pre-commit install
```

Manually run example files

Example files run extensive testing of the SDK API classes and log details about details of using GRVT API.

Change to tests folder
```
cd tests/pysdk
```
Run example of using synchronous CCXT-compatible calls to Rest API via grvt_ccxt.py, class GrvtCcxt
```
uv run python3 test_grvt_ccxt.py
```
Run example of using asynchronous CCXT-compatible calls to Rest API via grvt_ccxt_pro.py, class GrvtCcxtPro
```
uv run python3 test_grvt_ccxt_pro.py
```
Run example of using WebSockets subscriptions and JSON RPC calls via grvt_ccxt_ws.py, class GrvtCcxtWS
```
uv run python3 test_grvt_ccxt_ws.py
```

What's in the box ?

uv

uv is an extremely fast Python package and project manager, written in Rust.

pyproject.toml file (pyproject.toml): orchestrate your project and its dependencies uv.lock file (uv.lock): ensure that the package versions are consistent for everyone working on your project