Tink.Investments (Tink v1.0.0)

Copy Markdown View Source

Investment account data. Requires investments:read or investment-accounts:readonly scope.

List and holdings calls are cached 5 minutes per user.

Summary

Functions

Get a single investment account.

Get holdings for an investment account. Cached 5 min.

List all investment accounts. Cached 5 min.

List transactions for an investment account.

List all investment accounts (v1 legacy). Requires investments:read.

Functions

get(client, account_id)

@spec get(Tink.Client.t(), String.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

Get a single investment account.

get_holdings(client, account_id)

@spec get_holdings(Tink.Client.t(), String.t()) ::
  {:ok, map()} | {:error, Tink.Error.t()}

Get holdings for an investment account. Cached 5 min.

list(client)

@spec list(Tink.Client.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

List all investment accounts. Cached 5 min.

list_transactions(client, account_id, opts \\ [])

@spec list_transactions(Tink.Client.t(), String.t(), keyword()) ::
  {:ok, map()} | {:error, Tink.Error.t()}

List transactions for an investment account.

list_v1(client)

@spec list_v1(Tink.Client.t()) :: {:ok, map()} | {:error, Tink.Error.t()}

List all investment accounts (v1 legacy). Requires investments:read.