Instoryview CLI
Run the same six operations from your terminal and scripts.
Install
The CLI is published on npm as instoryview and requires Node.js 20 or later. Install it once, or run it without installing:
npm install --global instoryview
instoryview --version
# or, without installing
npx instoryview tracking listSign in
Create a Key in Developer settings, then run:
instoryview auth login
instoryview auth statusauth login reads the Key without echoing it. On macOS the CLI keeps it in Keychain. On Linux, Windows or CI, provide INSTORYVIEW_API_KEY through your shell or secret manager; no plaintext credential file is written automatically.
Read data
| Command | What it reads |
|---|---|
instoryview tracking list | Your tracked accounts. |
instoryview account <username> | An account's existing profile and totals. |
instoryview followers <username> | An available follower list. |
instoryview following <username> | An available following list. |
instoryview changes <username> | Detected changes. |
These commands read existing data.
| Flag | Works with | Description |
|---|---|---|
--limit, --cursor | All except account | Page through results. |
--include-archived | tracking list | Include removed tracking items. |
--list, --from, --to, --timezone | changes | Choose the list and the date range. |
--json | All commands | Print the API's data and meta to stdout. |
Online queries
instoryview followers bob --live --max-credits 2
instoryview account bob --live --max-credits 2--live works with account, followers and following, needs a Key with data:fetch, and fetches one bounded page; the CLI never fetches every page automatically. It keeps the idempotency key for retries, and --idempotency-key with the original arguments recovers a query manually.
Scripting
instoryview followers alice --limit 25 --json
instoryview changes alice --list following \
--from 2026-10-01 --to 2026-10-07 --timezone UTC --json--json prints the API's data and meta to stdout; errors and recovery instructions go to stderr. Keep source, asOf, coverage, creditsUsed and the cursor in your pipeline.
Exit codes
| Code | Meaning |
|---|---|
0 | Success. |
1 | Service or network error. |
2 | Invalid arguments. |
3 | Authentication or permission problem. |
4 | Data unavailable. |
5 | Budget limit or pending result. |
Update or uninstall
To update, run npm install --global instoryview@latest. instoryview auth logout removes your saved login, and npm uninstall --global instoryview removes the CLI.
Uninstalling does not revoke your Key. Revoke it in Developer settings to stop it working on every machine.
Questions about the API? Email support@instoryview.com