Skip to content

Interface: RestClientOptions ​

Properties ​

PropertyTypeDescription
apiKey?stringYour API key
apiPass?stringThe passphrase you set when creating the API Key (NOT your account password)
apiSecret?stringYour API secret
baseUrl?stringOptionally override API protocol + domain e.g baseUrl: 'https://api.bitget.com'
customSignMessageFn?(message: string, secret: string) => Promise<string>Provide a custom signing function. The SDK passes the serialized signing payload and API secret to this function and uses its returned signature.
demoTrading?booleanSet to true to use Bitget demo trading. Disabled by default. Requires demo API credentials; the SDK adds the REST demo header. See https://www.bitget.com/docs/uta/demo-trading/rest-api.
encodeQueryStringValues?booleanDefault: true. If true, query string values will be URI Encoded (encodeURIComponent). This prevents sign errors with GET requests containing unusual parameters (spaces, symbols, etc).
keepAlive?booleanEnable keep alive for REST API requests (via axios).
keepAliveMsecs?numberDelay before the first TCP keep-alive probe on an idle socket, in milliseconds. Applies only when keepAlive is enabled. Default: 1000.
parseExceptions?booleanDefault: true. whether to try and post-process request exceptions (and throw them).
recvWindow?numberReceive-window option in the REST client configuration.
strictParamValidation?booleanQuery serialization setting for signed GET requests. Validate required request fields in your application.

Built by Siebly. Open source SDKs for exchange APIs.