Inconsistent return data types

[vitaly-t]

Using the latest 1.0.2, I have started coming across some invalid TypeScript signatures, like the following two...

    /**
     * @see https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Kline-Candlestick-Data
    */
    async futuresCandles(symbol: string, interval: Interval = "30m", params: Dict = {}): Promise<Candle[]> {
        params.symbol = symbol;
        params.interval = interval;
        return await this.publicFuturesRequest('v1/klines', params);
    }

    /**
     * @see https://developers.binance.com/docs/derivatives/usds-margined-futures/market-data/rest-api/Kline-Candlestick-Data
    */
    async futuresCandlesticks(symbol: string, interval: Interval = "30m", params: Dict = {}): Promise<Candle[]> {
        params.symbol = symbol;
        params.interval = interval;
        return await this.publicFuturesRequest('v1/klines', params);
    }

Neither of those methods resolve with Candle[], they both resolve with data like this:

[
  [
    1744718400000, '85545.6',
    '85560.0',     '85502.0',
    '85516.2',     '9.836',
    1744718459999, '841315.7610',
    252,           '4.436',
    '379415.8702', '0'
  ],
  [
    1744718460000, '85517.2',
    '85554.9',     '85502.1',
    '85551.4',     '7.689',
    1744718519999, '657637.5901',
    185,           '5.194',
    '444217.0751', '0'
  ],
  [
    1744718520000, '85554.0',
    '85587.9',     '85542.5',
    '85542.5',     '5.833',
    1744718579999, '499120.9303',
    187,           '2.826',
    '241819.0299', '0'
  ]
]

I don't know if there are more methods like these, I've only got started with this library.

UPDATE

Upon closer look, I see that those two functions both do exact same thing, the difference only in the method name. How come? :)

[vitaly-t]

Only a little related.... I am looking at some streaming methods, like futuresAggTradeStream, all of which return a string. How are supposed to use a string to close the stream?

Internally, you have WebSocket object there, which has disconnect method, but you do not expose that object. So how are we supposed to stop streaming properly?

[carlosmiei]

Hello @vitaly-t, thanks once again.

Regarding the futuresCandles, we recently refactored the package (it was really outdated) and some of the methods are "duplicated" to match the spot counter-party, eg if in the spot method the name was candles now we might also have futuresCandles to make it consistent but at the same time keeping candlesticks to make it backwards compatible. I will check the return type asap.

(Due to the refactor we might have some edges to polish but we will work hard to resolve them as fast as possible after them being reported.)

Regarding the stream, you should be able to call close using that string/id, I will come up with an example and post it here.

[carlosmiei]

@vitaly-t I released a new version (1.0.3) that fixes the return types reported above, please upgrade and let me know if it is working properly now.

Regarding stopping a stream, you can do something like this:

    const callback = (e) => console.log(e);
    const url = binance.futuresAggTradeStream('BTCUSDT', callback);
    console.log('WebSocket URL:', url);
    await new Promise(r => setTimeout(r, 5000));
    console.log('after sleep, will stop the stream')
    binance.futuresTerminate(url);

[vitaly-t]

@carlosmiei That all works fine now, thank you!!!!