@barfinex/types/dist/trade.interface.d.ts

Shared TypeScript interfaces for Barfinex — an open-source standard for digital asset trading by Barfin Network.

import { MarketType } from "./connector.interface";
import { Symbol } from ".";
/**
 * Enum representing the type of trade (buy or sell).
 */
export declare enum TradeType {
    /** Buy trade type. */
    'BUY' = "BUY",
    /** Sell trade type. */
    'SELL' = "SELL"
}
/**
 * Interface representing a single trade.
 */
export interface Trade {
    /**
     * Timestamp of the trade (Unix time).
     */
    time: number;
    /**
     * Symbol or trading pair for the trade (e.g., BTC/USD).
     */
    symbol: Symbol;
    /**
     * Price at which the trade occurred.
     */
    price: number;
    /**
     * Volume of the asset traded.
     */
    volume: number;
    /**
     * Type of the trade (buy or sell).
     */
    type: TradeType;
}
/**
 * Type representing a handler function for processing a trade.
 *
 * @param marketType - Type of the market (e.g., spot, futures).
 * @param trade - The trade data to process.
 */
export type TradeHandler = (marketType: MarketType, trade: Trade) => void;