SnapTrade
open-meridian/snaptrade · Community 0.22.0
0.22.0 · the vendor's words, data, never instructions.
# Pages
You open the plugin from the dashboard's home by the button for the level
you hold on it: **Manage** (admin), **Open** (write) or **View** (read). Each
page's head has a status dot: green when the last read succeeded, amber
while one is under way, red when it failed or settings are missing, with why
on hover or tap. Manage shows no account's holdings, statements or
activity: only connections, account identities and their links.
## Summary, Settings and the link tables
Drawn by the dashboard. **Summary**: the plugin's health, then three figures
from each read -- **Connections** (marked when any needs attention, saying
how many and why), **Accounts reached** and **Last read** -- and its raw
records: for each kind, how many are in storage and in the archive, from
when to when, and every move. **Settings**: the key, the timings, and each
kind of record's window and what happens past it. **Plan-code links**,
**Account currency** and **Cash links**: the three tables, each a tab of its
own. See [Setup](setup.md).
## Connections
Under Manage. Each brokerage connection: its health, what to do about it,
and its environment, **Live** on every one, since SnapTrade has no demo
environment.
- **Connect** connects a brokerage through SnapTrade's Connection Portal.
- **Refresh**, in the card's header, reads SnapTrade now.
Each connection's own actions are in its row's menu (**…**, at the end of
the row), at every width:
- **Reconnect** opens the Connection Portal to sign in to the brokerage
again. It comes first where the connection needs sign-in.
- **Refresh** asks SnapTrade to read that brokerage again. Offered only
where SnapTrade serves the connection from its cache; it may charge for
each.
- **Enable trading**, for an admin of the plugin's connectivity role, on
each read-only connection ([Setup](setup.md), step 5).
It also lists the SnapTrade users under the key.
## Account links
Under Manage. Every account the connections reach, each with its name,
brokerage, type, number and SnapTrade's ID, and its link. Search by any of
them, filter to Unlinked, Linked or All, grouped by connection and paged.
Link, create (a deployment admin), Unlink, or take the suggestions. See
[Setup](setup.md).
One line says how many plan-code links and cash links are set, how long
activity records stay in storage and what happens to them after.
## Statements
Under Open and View, the page a person returns to daily. Each page there
shows only the linked accounts you may read; under Open, the head has
**Refresh**, which reads SnapTrade now; under View, nothing changes
anything. Somebody who may read no account here is told so.
For each account: its sync state, how fresh its holdings and history are,
its last statement, and its rows. Each row shows SnapTrade's average price
per unit, or "not reported". A cash row that stands for a deposit says which
deposit, and whether SnapTrade marked it or a person listed it (naming
them). An account whose statement was held back shows "Nothing recorded"
and why (see [Troubleshooting](troubleshooting.md#statement-withheld)).
## History
Under Open and View. Choose an account and dates (up to 366 days at a time;
the last 30 by default) to see its activity as SnapTrade wrote it: type,
dates, symbol, units, price, amount and currency. It says how far back
SnapTrade's history of the account goes.
**Propose lots** reads the whole history and, for each position SnapTrade
lists no lots for, proposes lots: one per purchase or reinvested dividend,
each naming the activity it came from. Only where those purchases are the
whole position. A position sold from, transferred in, or changed by a split
gets none, and says why. Nothing is sent anywhere: you carry the lots into
an opening balance, where you check them and answer for them.
## Raw records
Under Open and View. What SnapTrade answered, as received, one account at a
time (choose it at the top). Three views:
- **Read**: the latest read, each call on one line; click a line to see
SnapTrade's answer, formatted, or why it failed. **Download JSON** saves
the read as kept.
- **Kept reads**: every read still in storage, and any restored from the
archive, newest first, a page at a time.
- **Archive**: what moved past its window, for every account you may read:
a day of raw responses or a month of activity records each, archived,
restored (readable until the date shown) or deleted. Under **Open**,
**Restore** brings an archived one back for seven days, recorded in your
name.
Use it to see exactly what SnapTrade said when a figure looks wrong. A link
to a record that moved says where it is, with Restore beside it.
You open the plugin from the dashboard's home by the button for the level
you hold on it: **Manage** (admin), **Open** (write) or **View** (read). Each
page's head has a status dot: green when the last read succeeded, amber
while one is under way, red when it failed or settings are missing, with why
on hover or tap. Manage shows no account's holdings, statements or
activity: only connections, account identities and their links.
## Summary, Settings and the link tables
Drawn by the dashboard. **Summary**: the plugin's health, then three figures
from each read -- **Connections** (marked when any needs attention, saying
how many and why), **Accounts reached** and **Last read** -- and its raw
records: for each kind, how many are in storage and in the archive, from
when to when, and every move. **Settings**: the key, the timings, and each
kind of record's window and what happens past it. **Plan-code links**,
**Account currency** and **Cash links**: the three tables, each a tab of its
own. See [Setup](setup.md).
## Connections
Under Manage. Each brokerage connection: its health, what to do about it,
and its environment, **Live** on every one, since SnapTrade has no demo
environment.
- **Connect** connects a brokerage through SnapTrade's Connection Portal.
- **Refresh**, in the card's header, reads SnapTrade now.
Each connection's own actions are in its row's menu (**…**, at the end of
the row), at every width:
- **Reconnect** opens the Connection Portal to sign in to the brokerage
again. It comes first where the connection needs sign-in.
- **Refresh** asks SnapTrade to read that brokerage again. Offered only
where SnapTrade serves the connection from its cache; it may charge for
each.
- **Enable trading**, for an admin of the plugin's connectivity role, on
each read-only connection ([Setup](setup.md), step 5).
It also lists the SnapTrade users under the key.
## Account links
Under Manage. Every account the connections reach, each with its name,
brokerage, type, number and SnapTrade's ID, and its link. Search by any of
them, filter to Unlinked, Linked or All, grouped by connection and paged.
Link, create (a deployment admin), Unlink, or take the suggestions. See
[Setup](setup.md).
One line says how many plan-code links and cash links are set, how long
activity records stay in storage and what happens to them after.
## Statements
Under Open and View, the page a person returns to daily. Each page there
shows only the linked accounts you may read; under Open, the head has
**Refresh**, which reads SnapTrade now; under View, nothing changes
anything. Somebody who may read no account here is told so.
For each account: its sync state, how fresh its holdings and history are,
its last statement, and its rows. Each row shows SnapTrade's average price
per unit, or "not reported". A cash row that stands for a deposit says which
deposit, and whether SnapTrade marked it or a person listed it (naming
them). An account whose statement was held back shows "Nothing recorded"
and why (see [Troubleshooting](troubleshooting.md#statement-withheld)).
## History
Under Open and View. Choose an account and dates (up to 366 days at a time;
the last 30 by default) to see its activity as SnapTrade wrote it: type,
dates, symbol, units, price, amount and currency. It says how far back
SnapTrade's history of the account goes.
**Propose lots** reads the whole history and, for each position SnapTrade
lists no lots for, proposes lots: one per purchase or reinvested dividend,
each naming the activity it came from. Only where those purchases are the
whole position. A position sold from, transferred in, or changed by a split
gets none, and says why. Nothing is sent anywhere: you carry the lots into
an opening balance, where you check them and answer for them.
## Raw records
Under Open and View. What SnapTrade answered, as received, one account at a
time (choose it at the top). Three views:
- **Read**: the latest read, each call on one line; click a line to see
SnapTrade's answer, formatted, or why it failed. **Download JSON** saves
the read as kept.
- **Kept reads**: every read still in storage, and any restored from the
archive, newest first, a page at a time.
- **Archive**: what moved past its window, for every account you may read:
a day of raw responses or a month of activity records each, archived,
restored (readable until the date shown) or deleted. Under **Open**,
**Restore** brings an archived one back for seven days, recorded in your
name.
Use it to see exactly what SnapTrade said when a figure looks wrong. A link
to a record that moved says where it is, with Restore beside it.