SheetsFinance Docs
Brokerage

Account summary

šŸšØ Important: If you haven't yet connected your brokerage accounts via SheetsFinance then you won't have access to this function, please refer to the Brokerage docs page to get started.

Pull in a one-row summary of your brokerage account's details and total value with the SF_BROKERAGE() function and the "summary" type.

=SF_BROKERAGE(account, "summary", metrics, "", "", "", options)

  • account is the nickname of the brokerage account connection you want to pull data from. You can find the nickname of your connected brokerage accounts from the Brokerage Sidebar in Google Sheets (Extensions > SheetsFinance > Brokerage). You can set custom nicknames for your brokerage accounts, see Set brokerage account nicknames for more information.

  • type is the type of data you want to pull in, in this case "summary".

  • metrics selects what data you want to pull in. You can leave this blank or set it to "all" to output ALL available metrics. See the full list of available metrics below.

  • options adjusts the formatting and ordering of the output. The available options are:

    • "NH" - No header row.

    • "ob=<metric>" - Order the output by a specific metric.

    • "-" - Reverse the output order. This is especially useful when combined with ob.

šŸ§ Why are there empty quotes in this function? The SF_BROKERAGE() function is used for a variety of types. The "transactions" and "orders" types have additional optional arguments. For the "summary" type, these arguments aren't needed and can be left blank ("").

Metrics

  • "all" - All available summary data.

  • "accountName" - The account name.

  • "institution" - The institution the account is held with.

  • "accountNumber" - The account number.

  • "accountType" - The account type.

  • "status" - The connection status.

  • "totalValue" - The total value of the account.

  • "currency" - The currency of the account.

  • "lastSync" - When the account last synced.

Examples

šŸ¤“ Reminder for the below examples:"alpaca" is the nickname of our example brokerage account, you will need to replace this with the nickname of your own brokerage account.

Example 1: Pulling in the full summary for an account

=SF_BROKERAGE("alpaca", "summary")

Example 2: Pulling in specific metrics from an account summary

=SF_BROKERAGE("alpaca", "summary", "accountName")
Was this helpful?
Was this helpful?