@statsanytime/trade-bots-csgofloat v1.0.0-alpha.26

@statsanytime/trade-bots-csgofloat

Official CSGOFloat plugin for the StatsAnytime Trade Bots framework.

Installation

pnpm install @statsanytime/trade-bots-csgofloat

Usage

For information on how to use this in the context of the framework, we recommend reading the official framework documentation here.

This package exports the following functions:

createCSGOFloatPlugin

Creates a new CSGOFloat plugin instance. This takes a single options argument:

export interface CSGOFloatPluginOptions {
    apiKey: string;
    version?: 'v1';
}

scheduleDeposit

Schedules the deposit of a new item. The item in question is the one currently in the context (for example, the item that was just withdrawn). This function takes a single options argument:

export interface CSGOFloatScheduleDepositOptions {
    amountUsd: number;
    type?: 'buy_now' | 'auction';
    maxOfferDiscount?: number;
    reservePrice?: number;
    durationDays?: 1 | 3 | 5 | 7 | 14;
    description?: string;
    private?: boolean;
}

deposit

This function makes a deposit request right away. It takes a single options argument:

export interface ScheduledDeposit {
    marketplace: string;
    withdrawMarketplace: string;
    amountUsd: number;
    assetId: string;
    marketplaceData?: Record<string, any>;
    withdrawalId: string;
}

Under the hood, scheduleDeposit uses this function to make the deposit request once the item is tradable.