Binance Web3 Connector JS
    Preparing search index...

    Class ConfigurationRestAPI

    Represents the configuration options for the REST API.

    Hierarchy

    • ConfigurationRestAPI
      • ConfigurationRestAPI
    Index

    Constructors

    constructor

    Properties

    apiKey apiSecret? backoff? basePath? compression? customHeaders? httpsAgent? keepAlive? privateKey? privateKeyPassphrase? proxy? retries? timeout? timeUnit?

    Constructors

    Properties

    apiKey: string

    The API key used for authentication.

    apiSecret?: string

    The API secret used for authentication.

    backoff?: number

    delay between retry attempts in milliseconds

    1000

    ConfigurationRestAPI

    basePath?: string

    The base URL of the REST API.

    compression?: boolean

    enables response compression

    true

    ConfigurationRestAPI

    customHeaders?: Record<string, string | string[]>

    Optional custom headers to include in every request.

    httpsAgent?: boolean | Agent

    https agent

    false

    ConfigurationRestAPI

    keepAlive?: boolean

    enables keep-alive functionality for the connection (if httpsAgent is set then we use httpsAgent.keepAlive instead)

    true

    ConfigurationRestAPI

    privateKey?: string | Buffer<ArrayBufferLike>

    private key

    ConfigurationRestAPI

    privateKeyPassphrase?: string

    private key passphrase

    ConfigurationRestAPI

    proxy?: {
        auth?: { password: string; username: string };
        host: string;
        port: number;
        protocol?: string;
    }

    HTTP/HTTPS proxy configuration

    false

    ConfigurationRestAPI

    retries?: number

    number of retry attempts for failed requests

    3

    ConfigurationRestAPI

    timeout?: number

    set a timeout (in milliseconds) for the request

    1000

    ConfigurationRestAPI

    timeUnit?: TimeUnit

    timeUnit (used only on SPOT API)

    ConfigurationRestAPI

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties