skills$openclaw/sharesight
lextoumbourou3.7k

by lextoumbourou

sharesight – OpenClaw Skill

sharesight is an OpenClaw Skills integration for coding workflows. Manage Sharesight portfolios, holdings, and custom investments via the API

3.7k stars481 forksSecurity L1
Updated Feb 7, 2026Created Feb 7, 2026coding

Skill Snapshot

namesharesight
descriptionManage Sharesight portfolios, holdings, and custom investments via the API OpenClaw Skills integration.
ownerlextoumbourou
repositorylextoumbourou/sharesight-skill
languageMarkdown
licenseMIT
topics
securityL1
installopenclaw add @lextoumbourou/sharesight-skill
last updatedFeb 7, 2026

Maintainer

lextoumbourou

lextoumbourou

Maintains sharesight in the OpenClaw Skills directory.

View GitHub profile
File Explorer
11 files
.
sharesight
__init__.py
92 B
__main__.py
135 B
api.py
23.8 KB
auth.py
3.2 KB
cli.py
30.0 KB
client.py
5.8 KB
_meta.json
304 B
pyproject.toml
502 B
README.md
3.7 KB
SKILL.md
6.0 KB
SKILL.md

name: sharesight version: 1.0.0 description: Manage Sharesight portfolios, holdings, and custom investments via the API metadata: {"openclaw": {"category": "finance", "requires": {"env": ["SHARESIGHT_CLIENT_ID", "SHARESIGHT_CLIENT_SECRET"]}, "optional_env": ["SHARESIGHT_ALLOW_WRITES"]}}

Sharesight Skill

Manage Sharesight portfolios, holdings, custom investments, prices, and coupon rates. Supports full CRUD operations.

Prerequisites

Set these environment variables:

  • SHARESIGHT_CLIENT_ID - Your Sharesight API client ID
  • SHARESIGHT_CLIENT_SECRET - Your Sharesight API client secret
  • SHARESIGHT_ALLOW_WRITES - Set to true to enable create, update, and delete operations (disabled by default for safety)

Commands

Authentication

# Authenticate (required before first use)
sharesight auth login

# Check authentication status
sharesight auth status

# Clear saved token
sharesight auth clear

Portfolios

# List all portfolios
sharesight portfolios list
sharesight portfolios list --consolidated

# Get portfolio details
sharesight portfolios get <portfolio_id>

# List holdings in a portfolio
sharesight portfolios holdings <portfolio_id>

# Get performance report
sharesight portfolios performance <portfolio_id>
sharesight portfolios performance <portfolio_id> --start-date 2024-01-01 --end-date 2024-12-31
sharesight portfolios performance <portfolio_id> --grouping market --include-sales

# Get performance chart data
sharesight portfolios chart <portfolio_id>
sharesight portfolios chart <portfolio_id> --benchmark SPY.NYSE

Holdings

# List all holdings across portfolios
sharesight holdings list

# Get holding details
sharesight holdings get <holding_id>
sharesight holdings get <holding_id> --avg-price --cost-base
sharesight holdings get <holding_id> --values-over-time true

# Update holding DRP settings
sharesight holdings update <holding_id> --enable-drp true --drp-mode up
# drp-mode options: up, down, half, down_track

# Delete a holding
sharesight holdings delete <holding_id>

Custom Investments

# List custom investments
sharesight investments list
sharesight investments list --portfolio-id <portfolio_id>

# Get custom investment details
sharesight investments get <investment_id>

# Create a custom investment
sharesight investments create --code TEST --name "Test Investment" --country AU --type ORDINARY
# type options: ORDINARY, TERM_DEPOSIT, FIXED_INTEREST, PROPERTY, ORDINARY_UNLISTED, OTHER

# Update a custom investment
sharesight investments update <investment_id> --name "New Name"

# Delete a custom investment
sharesight investments delete <investment_id>

Prices (Custom Investment Prices)

# List prices for a custom investment
sharesight prices list <instrument_id>
sharesight prices list <instrument_id> --start-date 2024-01-01 --end-date 2024-12-31

# Create a price
sharesight prices create <instrument_id> --price 100.50 --date 2024-01-15

# Update a price
sharesight prices update <price_id> --price 101.00

# Delete a price
sharesight prices delete <price_id>

Coupon Rates (Fixed Interest)

# List coupon rates for a fixed interest investment
sharesight coupon-rates list <instrument_id>
sharesight coupon-rates list <instrument_id> --start-date 2024-01-01

# Create a coupon rate
sharesight coupon-rates create <instrument_id> --rate 5.5 --date 2024-01-01

# Update a coupon rate
sharesight coupon-rates update <coupon_rate_id> --rate 5.75

# Delete a coupon rate
sharesight coupon-rates delete <coupon_rate_id>

Reference Data

# List country codes
sharesight countries
sharesight countries --supported

Output Format

All commands output JSON. Example portfolio list response:

{
  "portfolios": [
    {
      "id": 12345,
      "name": "My Portfolio",
      "currency_code": "AUD",
      "country_code": "AU"
    }
  ]
}

Date Format

All dates use YYYY-MM-DD format (e.g., 2024-01-15).

Grouping Options

Performance reports support these grouping options:

  • country - Group by country
  • currency - Group by currency
  • market - Group by market (default)
  • portfolio - Group by portfolio
  • sector_classification - Group by sector
  • industry_classification - Group by industry
  • investment_type - Group by investment type
  • ungrouped - No grouping

Write Protection

Write operations (create, update, delete) are disabled by default for safety. To enable them:

export SHARESIGHT_ALLOW_WRITES=true

Without this, write commands will fail with:

{"error": "Write operations are disabled by default. Set SHARESIGHT_ALLOW_WRITES=true to enable create, update, and delete operations.", "hint": "export SHARESIGHT_ALLOW_WRITES=true"}

Common Workflows

View Portfolio Performance

# Get current year performance
sharesight portfolios performance 12345 --start-date 2024-01-01

# Compare against S&P 500
sharesight portfolios chart 12345 --benchmark SPY.NYSE

Analyze Holdings

# List all holdings with cost information
sharesight holdings get 67890 --avg-price --cost-base

Track Custom Investments

# Create a custom investment for tracking unlisted assets
sharesight investments create --code REALESTATE --name "Property Investment" --country AU --type PROPERTY

# Add price history for the investment
sharesight prices create 123456 --price 500000.00 --date 2024-01-01
sharesight prices create 123456 --price 520000.00 --date 2024-06-01

Manage Fixed Interest Investments

# Create a term deposit
sharesight investments create --code TD001 --name "Term Deposit ANZ" --country AU --type TERM_DEPOSIT

# Set the coupon rate
sharesight coupon-rates create 123456 --rate 4.5 --date 2024-01-01

# Update rate when it changes
sharesight coupon-rates update 789 --rate 4.75

Configure Dividend Reinvestment

# Enable DRP and round up purchases
sharesight holdings update 67890 --enable-drp true --drp-mode up

# Disable DRP
sharesight holdings update 67890 --enable-drp false
README.md

Sharesight Skill for OpenClaw

Manage Sharesight portfolios, holdings, trades, and custom investments via the API.

Features

  • Portfolios - List, view, and analyze portfolio performance
  • Holdings - View, update DRP settings, delete holdings
  • Trades - Create, view, update, and delete trades
  • Custom Investments - Full CRUD for custom investments, prices, and coupon rates
  • Write Protection - Safe by default, write operations require explicit opt-in

Installation

Manual Installation

# Clone into your skills directory
cd ~/.claude/skills  # or your preferred skills location
git clone https://github.com/your-username/sharesight-skill.git sharesight

# Install dependencies
cd sharesight
uv sync

Verify Installation

cd ~/.claude/skills/sharesight
uv run sharesight --help

Setup

1. Get Sharesight API Credentials

  1. Email Sharesight to request API access (see Getting Started)
  2. Once enabled, find your credentials under Account > Sharesight API
  3. Copy your Client ID and Client Secret

2. Set Environment Variables

For OpenClaw, add to ~/.openclaw/.env:

SHARESIGHT_CLIENT_ID=your_client_id
SHARESIGHT_CLIENT_SECRET=your_client_secret

Or add to ~/.openclaw/openclaw.json:

{
  "env": {
    "SHARESIGHT_CLIENT_ID": "your_client_id",
    "SHARESIGHT_CLIENT_SECRET": "your_client_secret"
  }
}

See OpenClaw Environment Configuration for more options.

For shell usage, add to ~/.bashrc or ~/.zshrc:

export SHARESIGHT_CLIENT_ID="your_client_id"
export SHARESIGHT_CLIENT_SECRET="your_client_secret"

3. Enable Write Operations (Optional)

Write operations (create, update, delete) are disabled by default for safety. To enable, add to your environment:

For OpenClaw (~/.openclaw/.env):

SHARESIGHT_ALLOW_WRITES=true

For shell:

export SHARESIGHT_ALLOW_WRITES=true

4. Authenticate

uv run sharesight auth login

Usage

CLI Commands

# List portfolios
uv run sharesight portfolios list

# Get portfolio performance
uv run sharesight portfolios performance 12345 --start-date 2024-01-01

# List holdings
uv run sharesight holdings list

# Create a trade (requires SHARESIGHT_ALLOW_WRITES=true)
uv run sharesight trades create 12345 --symbol AAPL --market NASDAQ --date 2024-01-15 --quantity 10 --price 185.50

# Create a custom investment
uv run sharesight investments create --code XTM --name "MinoTari" --country US --type ORDINARY --portfolio-id 12345

# Get help
uv run sharesight --help

In OpenClaw/Claude

Just ask naturally:

  • "Show me my Sharesight portfolios"
  • "What's the performance of my crypto portfolio this year?"
  • "Add a buy trade for 100 shares of AAPL at $150"
  • "Create a custom investment for XTM Tari"

API Reference

See SKILL.md for complete API documentation.

Output

All commands output JSON to stdout. Errors are written to stderr.

Token Storage

Access tokens are cached in ~/.config/sharesight-cli/config.json and automatically refreshed when expired (tokens are valid for 30 minutes).

Development

# Install dev dependencies
uv sync --extra dev

# Run tests
uv run pytest tests/ -v

# Run directly
uv run sharesight portfolios list

Troubleshooting

ErrorSolution
Missing credentialsSet SHARESIGHT_CLIENT_ID and SHARESIGHT_CLIENT_SECRET
Write operations disabledSet SHARESIGHT_ALLOW_WRITES=true
401 UnauthorizedRun sharesight auth login to refresh token
404 Not FoundCheck the resource ID exists

License

MIT

Permissions & Security

Security level L1: Low-risk skills with minimal permissions. Review inputs and outputs before running in production.

Requirements

Set these environment variables: - `SHARESIGHT_CLIENT_ID` - Your Sharesight API client ID - `SHARESIGHT_CLIENT_SECRET` - Your Sharesight API client secret - `SHARESIGHT_ALLOW_WRITES` - Set to `true` to enable create, update, and delete operations (disabled by default for safety)

Configuration

```bash

FAQ

How do I install sharesight?

Run openclaw add @lextoumbourou/sharesight-skill in your terminal. This installs sharesight into your OpenClaw Skills catalog.

Does this skill run locally or in the cloud?

OpenClaw Skills execute locally by default. Review the SKILL.md and permissions before running any skill.

Where can I verify the source code?

The source repository is available at https://github.com/openclaw/skills/tree/main/skills/lextoumbourou/sharesight-skill. Review commits and README documentation before installing.