Binance Web3 Connector JS
    Preparing search index...

    Interface GetCandlesRequest

    Request parameters for getCandles operation in GeneralDataApi. GetCandlesRequest

    interface GetCandlesRequest {
        after?: number | bigint;
        bar?: GetCandlesBarEnum;
        before?: number | bigint;
        binanceChainId: string;
        limit?: number;
        nonce?: string;
        recvWindow?: number | bigint;
        tokenContractAddress: string;
    }
    Index
    after? bar? before? binanceChainId limit? nonce? recvWindow? tokenContractAddress
    after?: number | bigint

    End time for the query, Unix millisecond timestamp. Returns candles earlier than this time (exclusive).

    GeneralDataApiGetCandles

    bar?: GetCandlesBarEnum

    Candlestick time granularity, default "1m" (1 minute). Available values: 1s (1 second), 5s (5 seconds), 30s (30 seconds), 1m (1 minute), 3m (3 minutes), 5m (5 minutes), 15m (15 minutes), 30m (30 minutes), 1h (1 hour), 2h (2 hours), 4h (4 hours), 6h (6 hours), 8h (8 hours), 12h (12 hours), 1d (1 day), 3d (3 days), 1w (1 week), 1M (1 month).

    GeneralDataApiGetCandles

    before?: number | bigint

    Start time for the query, Unix millisecond timestamp. Returns candles later than this time (exclusive).

    GeneralDataApiGetCandles

    binanceChainId: string

    Unique chain identifier (e.g. "1"=Ethereum, "56"=BSC, "CT_501"=Solana).

    GeneralDataApiGetCandles

    limit?: number

    Number of candles to return. Defaults to 100.

    GeneralDataApiGetCandles

    nonce?: string

    Unique request identifier for anti-replay; falls back to X-OC-SIGN if omitted.

    GeneralDataApiGetCandles

    recvWindow?: number | bigint

    Allowed time deviation in milliseconds (default: 5000, max: 60000).

    GeneralDataApiGetCandles

    tokenContractAddress: string

    Token contract address.

    GeneralDataApiGetCandles

    Settings
    Member Visibility

    On This Page
    Properties