Trading Assistant API Documentation - v0.1.0
    Preparing search index...

    Variable portfolioStoreConst

    portfolioStore: {
        subscribe: (
            this: void,
            run: Subscriber<PortfolioState>,
            invalidate?: Invalidator<PortfolioState>,
        ) => Unsubscriber;
        loadPortfolios(activeOnly?: boolean, token?: string | null): Promise<void>;
        selectPortfolio(portfolioId: string, token?: string | null): Promise<void>;
        createPortfolio(
            data: CreatePortfolioRequest,
            token?: string | null,
        ): Promise<Portfolio>;
        updatePortfolio(
            portfolioId: string,
            data: UpdatePortfolioRequest,
            token?: string | null,
        ): Promise<Portfolio>;
        deletePortfolio(portfolioId: string, token?: string | null): Promise<void>;
        setDefault(portfolioId: string, token?: string | null): Promise<void>;
        loadPositions(portfolioId: string, token?: string | null): Promise<void>;
        loadTrades(
            portfolioId: string,
            startDate?: string,
            endDate?: string,
            token?: string | null,
        ): Promise<void>;
        loadPerformance(
            portfolioId: string,
            days?: number,
            token?: string | null,
        ): Promise<void>;
        loadAllocation(portfolioId: string, token?: string | null): Promise<void>;
        loadRecommendations(
            portfolioId: string,
            token?: string | null,
        ): Promise<void>;
        refreshCurrentPortfolio(token?: string | null): Promise<void>;
        setFilter(key: keyof PortfolioState, value: any): void;
        clearError(): void;
        reset(): void;
    } = ...

    Type Declaration

    • subscribe: (
          this: void,
          run: Subscriber<PortfolioState>,
          invalidate?: Invalidator<PortfolioState>,
      ) => Unsubscriber
    • loadPortfolios: function
      • Load all portfolios for current user

        Parameters

        • activeOnly: boolean = true
        • Optionaltoken: string | null

        Returns Promise<void>

    • selectPortfolio: function
      • Select a portfolio (load its data)

        Parameters

        • portfolioId: string
        • Optionaltoken: string | null

        Returns Promise<void>

    • createPortfolio: function
    • updatePortfolio: function
    • deletePortfolio: function
      • Delete portfolio

        Parameters

        • portfolioId: string
        • Optionaltoken: string | null

        Returns Promise<void>

    • setDefault: function
      • Set portfolio as default

        Parameters

        • portfolioId: string
        • Optionaltoken: string | null

        Returns Promise<void>

    • loadPositions: function
      • Load positions for portfolio

        Parameters

        • portfolioId: string
        • Optionaltoken: string | null

        Returns Promise<void>

    • loadTrades: function
      • Load trades for portfolio

        Parameters

        • portfolioId: string
        • OptionalstartDate: string
        • OptionalendDate: string
        • Optionaltoken: string | null

        Returns Promise<void>

    • loadPerformance: function
      • Load performance metrics

        Parameters

        • portfolioId: string
        • Optionaldays: number
        • Optionaltoken: string | null

        Returns Promise<void>

    • loadAllocation: function
      • Load allocation data

        Parameters

        • portfolioId: string
        • Optionaltoken: string | null

        Returns Promise<void>

    • loadRecommendations: function
      • Load trading recommendations

        Parameters

        • portfolioId: string
        • Optionaltoken: string | null

        Returns Promise<void>

    • refreshCurrentPortfolio: function
      • Refresh all data for current portfolio

        Parameters

        • Optionaltoken: string | null

        Returns Promise<void>

    • setFilter: function
    • clearError: function
    • reset: function