Interface: RestClientOptions
Properties
| Property | Type | Description |
|---|---|---|
apiKey? | string | - |
apiPass? | string | - |
apiSecret? | string | - |
baseUrl? | string | - |
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 OKX's demo trading functionality |
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. |
market? | APIMarket | The API group this client should connect to: - market: 'prod' (default: connects to OKX global) https://www.okx.com/docs-v5/en/#overview-production-trading-services - market: 'OPENAPI_GLOBAL' // OKX Global REST at https://openapi.okx.com - market: 'EEA' // also known as "my.okx.com" https://my.okx.com/docs-v5/en/#overview-production-trading-services - market: 'US' // also known as "app.okx.com" https://app.okx.com/docs-v5/en/#overview-production-trading-services |
parse_exceptions? | boolean | - |
strict_param_validation? | boolean | - |