Interface: RestClientOptions
Properties
| Property | Type | Description |
|---|---|---|
apiKey? | string | Your API key |
apiPass? | string | The passphrase you set when creating the API Key (NOT your account password) |
apiSecret? | string | Your API secret |
baseUrl? | string | Optionally 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? | boolean | Set 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? | boolean | Default: 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? | boolean | Enable keep alive for REST API requests (via axios). |
keepAliveMsecs? | number | Delay before the first TCP keep-alive probe on an idle socket, in milliseconds. Applies only when keepAlive is enabled. Default: 1000. |
parseExceptions? | boolean | Default: true. whether to try and post-process request exceptions (and throw them). |
recvWindow? | number | Receive-window option in the REST client configuration. |
strictParamValidation? | boolean | Query serialization setting for signed GET requests. Validate required request fields in your application. |