Configuration

Config

The Config class (sealed) is the central SDK configuration object. Create a Config instance with your credentials:

using SsiSdk;

var config = new Config("YOUR_CLIENT_ID")
{
    ApiKey = "YOUR_API_KEY",
    ApiSecret = "YOUR_API_SECRET",
    PrivateKey = "YOUR_PRIVATE_KEY",
};

Config has 2 constructors: Config() (empty, set properties afterwards) and Config(string clientId) (pre-fills ClientId).

All Configuration Parameters

All durations are integer milliseconds (suffix Ms).

Read-only properties, derived from the parameters above:

ToString() masks sensitive values: ApiKey is masked, ApiSecret and PrivateKey show ***. Even so, avoid logging Config.

Changes from the old version: TimeoutSeconds became TimeoutMs, RetryDelay (seconds, double) became RetryDelayMs (milliseconds, int), and Config.DeviceId was removed (the SDK uses the OS machine id as deviceId when sending batches).

Retry and rate limit

• Only GET requests are retried. On a 429 for a GET, the SDK waits per Retry-After, otherwise 1 second doubling each time, up to 3 retries and at most 30 seconds per wait.
• POST, PUT and DELETE are never resent (place order, cancel, batch, FCO), because a repeated order could be created twice. After a timeout the outcome is unknown: check the order book before resending.
• RateLimitPerSecond is a client-side limit; the server's rate-limit info is in auth.RateLimit and in RateLimitException.

TradingWsOptions

Options for TradingWs.ConnectAsync(auth, options) (namespace SsiSdk). If you pass none, the defaults apply. For behaviour details see Trading WebSocket.

Note: the XML comment of RequestTimeoutMs in the SDK source still says "10000 when unset"; the table above reflects the code.

Advanced Configuration

Debug logging

var config = new Config("YOUR_CLIENT_ID")
{
    ApiKey = "YOUR_API_KEY",
    ApiSecret = "YOUR_API_SECRET",
    LogLevel = "DEBUG",
};

Custom retry & rate limit

var config = new Config("YOUR_CLIENT_ID")
{
    ApiKey = "YOUR_API_KEY",
    ApiSecret = "YOUR_API_SECRET",
    MaxRetries = 3,
    RetryDelayMs = 1000,
    RateLimitPerSecond = 5,
};

Smart OTP and batch

var config = new Config("YOUR_CLIENT_ID")
{
    ApiKey = "YOUR_API_KEY",
    ApiSecret = "YOUR_API_SECRET",
    PrivateKey = "YOUR_PRIVATE_KEY",
    OtpPollIntervalMs = 3000,   // poll Smart OTP every 3 seconds
    OtpPollMaxWaitMs = 90000,   // wait for approval for at most 90 seconds
    MaxBatchOrders = 20,        // orders per batch limit
};

The API reference states a server-side batch limit of 50 orders per request, while the SDK default is 20. Raising MaxBatchOrders is the caller's decision: see Batch Orders.

Proxy

var config = new Config("YOUR_CLIENT_ID")
{
    ApiKey = "YOUR_API_KEY",
    ApiSecret = "YOUR_API_SECRET",
    Proxy = "http://proxy.example.com:8080",
};

Recommendations

• Keep credentials (ApiKey, ApiSecret, PrivateKey) in environment variables or a secret manager (Azure Key Vault, AWS Secrets Manager, etc.) — never hardcode them or commit to Git.
• Missing ApiKey/ApiSecret will cause authentication to fail (AuthenticationException).
• Missing PrivateKey will affect order signing operations (REST and Trading WebSocket).
• Set RateLimitPerSecond according to platform policy.
• Only enable LogLevel = "DEBUG" in development environments.
• Tune TimeoutMs, MaxRetries, and RetryDelayMs according to actual workload.