Nashville Plays Music

    bitmex-candle
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.1 • Public • Published

    bitmex-candle Build status npm version

    Interface for BitMEX candle

    Install

    npm install bitmex-candle

    Use

    import Candle from 'bitmex-candle'

    The Candle interface is defined as

    /**
     * An atomic unit of time-series data as returned by the BitMEX
     * exchange API.
     */
    interface Candle {
        /**
         * Time that the current Candle closed, in ISO 8601 format.
         */
        timestamp: string,
        /**
         * Opening value of current Candle.
         */
        open: number,
        /**
         * Highest value observed during current Candle.
         */
        high: number,
        /**
         * Lowest value observed during current Candle.
         */
        low: number,
        /**
         * Closing value of current Candle.
         */
        close: number
        /**
         * Volume observed during current Candle.
         */
        volume: number,
     
        /**
         * Instrument symbol.
         */
        symbol?: string,
        /**
         * Number of trades recorded during current Candle.
         */
        trades?: number,
        /**
         * Volume-weighted average price.
         */
        vwap?: number,
        /**
         *
         */
        lastSize?: number,
        /**
         * Number of contracts exchanged during current Candle.
         */
        turnover?: number,
        /**
         *
         */
        homeNotional?: number,
        /**
         *
         */
        foreignNotional?: number
    }

    Install

    npm i bitmex-candle

    DownloadsWeekly Downloads

    5

    Version

    1.0.1

    License

    ISC

    Unpacked Size

    4.67 kB

    Total Files

    4

    Last publish

    Collaborators

    • hamroctopus