UFC - Unified Finance Client/com.ulalax.ufc.api/Ufc/Companion/create

create

suspend fun create(): Ufc(source)

Creates a new UFC client instance with default configuration.

This factory method initializes all underlying clients (Yahoo Finance, Business Insider, and WebSocket streaming) with default settings. FRED client will not be available without an API key.

Return

A new Ufc instance with default configuration

Throws

if client initialization fails

Samples

suspend fun create(config: UfcConfig): Ufc(source)

Creates a new UFC client instance with custom configuration.

This factory method allows you to configure all aspects of the client including:

  • FRED API key for economic data access

  • Request and connection timeouts

  • Client-specific configurations

Return

A new Ufc instance with the specified configuration

Parameters

config

UfcConfig containing configuration settings for all underlying clients

Throws

if client initialization fails or configuration is invalid

Samples