UFC - Unified Finance Client/com.ulalax.ufc.api/UfcConfig

UfcConfig

data class UfcConfig(val fredApiKey: String? = null, val yahooConfig: YahooClientConfig = YahooClientConfig(), val fredConfig: FredClientConfig = FredClientConfig(), val businessInsiderConfig: BusinessInsiderClientConfig = BusinessInsiderClientConfig(), val streamingConfig: StreamingClientConfig = StreamingClientConfig())(source)

Configuration for the UFC (US Free Financial Data Collector) client.

This class centralizes all configuration settings for the UFC library, including:

  • Yahoo Finance API client settings

  • FRED (Federal Reserve Economic Data) API settings and authentication

  • Business Insider API client settings

  • WebSocket streaming configuration for real-time data

Usage Examples

Basic usage with defaults

val config = UfcConfig()
val ufc = Ufc.create(config)
Content copied to clipboard

With FRED API key

val config = UfcConfig(fredApiKey = "your-fred-api-key")
val ufc = Ufc.create(config)
Content copied to clipboard

Custom timeout and logging settings

val config = UfcConfig(
    yahooConfig = YahooClientConfig(
        connectTimeoutMs = 60_000,
        requestTimeoutMs = 120_000,
        enableLogging = true
    ),
    fredConfig = FredClientConfig(
        enableLogging = true
    )
)
val ufc = Ufc.create(config)
Content copied to clipboard

Custom rate limiting

val config = UfcConfig(
    yahooConfig = YahooClientConfig(
        rateLimitConfig = RateLimitConfig(
            maxRequestsPerSecond = 30,
            maxBurstSize = 10
        )
    )
)
val ufc = Ufc.create(config)
Content copied to clipboard

Custom WebSocket streaming configuration

val config = UfcConfig(
    streamingConfig = StreamingClientConfig(
        connectTimeoutMs = 15_000,
        heartbeatIntervalMs = 20_000,
        enableLogging = true
    )
)
val ufc = Ufc.create(config)
Content copied to clipboard

See also

com.ulalax.ufc.Ufc.create

Constructors

Link copied to clipboard
constructor(fredApiKey: String? = null, yahooConfig: YahooClientConfig = YahooClientConfig(), fredConfig: FredClientConfig = FredClientConfig(), businessInsiderConfig: BusinessInsiderClientConfig = BusinessInsiderClientConfig(), streamingConfig: StreamingClientConfig = StreamingClientConfig())

Properties

Link copied to clipboard
val businessInsiderConfig: BusinessInsiderClientConfig

Configuration for Business Insider API client. Controls HTTP timeouts, logging, and rate limiting for Business Insider requests. Primarily used for ISIN to ticker symbol conversion. Default: BusinessInsiderClientConfig() with 30s connect timeout, 60s request timeout, logging disabled, and 10 requests per second rate limit

Link copied to clipboard
val fredApiKey: String? = null

Optional API key for FRED (Federal Reserve Economic Data) API. Required for accessing FRED economic data endpoints. You can obtain a free API key from https://fred.stlouisfed.org/docs/api/api_key.html Default: null (FRED functionality will be unavailable without a key)

Link copied to clipboard
val fredConfig: FredClientConfig

Configuration for FRED API client. Controls HTTP timeouts, logging, and rate limiting for FRED requests. Default: FredClientConfig() with 30s connect timeout, 60s request timeout, logging disabled, and 2 requests per second rate limit (as per FRED guidelines)

Link copied to clipboard
val streamingConfig: StreamingClientConfig

Configuration for WebSocket streaming client. Controls WebSocket connection settings, heartbeat intervals, reconnection behavior, and event buffering for real-time Yahoo Finance data streaming. Default: StreamingClientConfig() with 10s connect timeout, 15s heartbeat interval, 30s ping timeout, automatic reconnection enabled, 64-event buffer, and logging disabled

Link copied to clipboard
val yahooConfig: YahooClientConfig

Configuration for Yahoo Finance API client. Controls HTTP timeouts, logging, and rate limiting for Yahoo Finance requests. Default: YahooClientConfig() with 30s connect timeout, 60s request timeout, logging disabled, and 50 requests per second rate limit