Xtreamly's Typescript SDK

Optimize and enhance your development process with this SDK, seamlessly integrating Xtreamly's advanced AI models and built-in on-chain capabilities to create fully customized trading bots tailored to your needs!

Prerequisites

1. node v20.18.1 (the version inside the .nvmrc file)

Install it as a typescript library

pnpm i @xtreamlyio/sdk

Check the examples folder for usage examples:

e.g. getVolatilityState.ts

import {VolatilityAPI} from "xtreamly-sdk";

const api = new VolatilityAPI()
api.state("ETH").then(console.log);

Configuration

Your trading bot is configured via the .env file (environment variables):

1. XTREAMLY_API_KEY: A key to Xtreamly's API model predictions, get yours here: https://xtreamly.io/api

You can just copy the .env.example file:

cp .env.example .env

Local execution

1. Set node version (if you are using nvm)

   nvm use

2. Install dependencies:

   pnpm i && pnpm postinstall

3. Run an example:

   pnpm getVolatilityState