Skip to content

Interface: RestClientOptions ​

Properties ​

PropertyTypeDescription
api_key?string-
api_secret?string-
baseUrl?string-
baseUrlKey?BinanceBaseUrlKey-
beautifyResponses?boolean-
customSignMessageFn?(message: string, secret: string) => Promise<string>Allows you to provide a custom "signMessage" function, e.g. to use node's much faster createHmac method Look in the examples folder for a demonstration on using node's createHmac instead.
demoTrading?booleanSet to true to use Binance's demo trading endpoints. Demo trading uses real market data but simulated trading. More info: https://demo.binance.com/
disableTimeSync?boolean-
filterUndefinedParams?boolean-
keepAlive?booleanEnable keep alive for REST API requests (via axios). See: https://github.com/tiagosiebler/bybit-api/issues/368
keepAliveMsecs?numberWhen using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. Only relevant if keepAlive is set to true. Default: 1000 (defaults comes from https agent)
parseExceptions?boolean-
recvWindow?number-
strictParamValidation?boolean-
syncIntervalMs?string | number-
testnet?booleanDefault: false. If true, use testnet when available
useMMSubdomain?booleanDefault: false. If true, use market maker endpoints when available. Eligible for high-frequency trading users who have enrolled and qualified in at least one of the Futures Liquidity Provider Programs. More info: https://www.binance.com/en/support/faq/detail/7df7f3838c3b49e692d175374c3a3283

Built by Siebly. Open source SDKs for exchange APIs.