Arkane SDK

TypeScript client for the Arkane prediction, trade-decision, and runtime bot APIs.

What it provides

• ArkaneClient with:
  • predict → /predict
  • tradeDecision → /trade-decision?include_intent=1|0
  • bot namespace (status, start, stop, tick, applyLatest, positions, clearPositions, tradeDecision, health)
• Fully typed request/response models (see src/types/*).
• Structured ArkaneApiError when the backend returns an error envelope.

How to run

cd sdk
npm install
npm run build

• Build output lands in dist/ and is used for publishing.

Usage

import { ArkaneClient, type PredictRequest } from "@arkane_absolute/sdk";

const client = new ArkaneClient({
	apiKey: process.env.ARKANE_API_KEY!,
	baseUrl: "http://localhost:8080",
});

const payload: PredictRequest = {
	pair: {/* PairData */},
	timeframe: "1h",
	bars: [...],
};

const prediction = await client.predict(payload);
const decision = await client.tradeDecision(payload, true); // include intent
const status = await client.bot.status();

Errors

• All methods throw ArkaneApiError with message, optional code, status, and data from the server’s { error: { code, message } } envelope.
• Network/unknown errors are wrapped into ArkaneApiError as well.

Gotchas

• axios is a peer dependency; install it in the consuming app.
• Keep API keys out of source; load from env/secret manager.
• Endpoints are relative to baseUrl you pass to the client.