Public Docs
AI Tools
This is the public quick-start for AI Tools. Save your key locally, run the downloader, and paste the starter instructions into your LLM.
Installation Guide
Save your API key once in a standard local config file, then let your own script or agent fetch the latest snapshot manifest from
/api/llm/v1/snapshots/latest.
Step 1 - Save Key Locally
macOS/Linux - ~/.config/marketscanner/llm-bundle.env
CONFIG_FILE="${XDG_CONFIG_HOME:-$HOME/.config}/marketscanner/llm-bundle.env"
mkdir -p "$(dirname "$CONFIG_FILE")"
umask 077
cat > "$CONFIG_FILE" <<'EOF'
MARKETSCANNER_API_KEY=PASTE_API_KEY_HERE
EOF
echo "Saved key to $CONFIG_FILE"
Windows - $env:APPDATA\MarketScanner\llm-bundle.env
$configFile = Join-Path $env:APPDATA 'MarketScanner\llm-bundle.env' New-Item -ItemType Directory -Force -Path (Split-Path -Parent $configFile) | Out-Null @" MARKETSCANNER_API_KEY=PASTE_API_KEY_HERE "@ | Set-Content $configFile Write-Host "Saved key to $configFile"
Step 2 - Run Downloader
macOS/Linux - download.sh
#!/usr/bin/env bash
set -euo pipefail
CONFIG_FILE="${MARKETSCANNER_CONFIG_FILE:-${XDG_CONFIG_HOME:-$HOME/.config}/marketscanner/llm-bundle.env}"
if [ -f "$CONFIG_FILE" ]; then
set -a
. "$CONFIG_FILE"
set +a
fi
: "${MARKETSCANNER_API_KEY:?Set MARKETSCANNER_API_KEY or create $CONFIG_FILE first}"
BASE_URL="${MARKETSCANNER_BASE_URL:-https://app.stratalerts.com}"
OUTPUT_DIR="${1:-$HOME/marketscanner-data/latest}"
mkdir -p "$OUTPUT_DIR"
MANIFEST_URL="$BASE_URL/api/llm/v1/snapshots/latest"
curl --fail --silent --show-error \
-H "Authorization: Bearer $MARKETSCANNER_API_KEY" \
"$MANIFEST_URL" -o "$OUTPUT_DIR/manifest.json"
echo "Saved manifest to $OUTPUT_DIR/manifest.json"
Windows - download.ps1
$ErrorActionPreference = 'Stop'
$configFile = if ($env:MARKETSCANNER_CONFIG_FILE) { $env:MARKETSCANNER_CONFIG_FILE } elseif ($env:APPDATA) { Join-Path $env:APPDATA 'MarketScanner\llm-bundle.env' } else { Join-Path $HOME 'AppData\Roaming\MarketScanner\llm-bundle.env' }
if ((-not $env:MARKETSCANNER_API_KEY) -and (Test-Path $configFile)) {
Get-Content $configFile | ForEach-Object {
if ($_ -match '^\s*MARKETSCANNER_API_KEY=(.+)$') { $env:MARKETSCANNER_API_KEY = $matches[1].Trim() }
}
}
if (-not $env:MARKETSCANNER_API_KEY) { throw "Set MARKETSCANNER_API_KEY or create $configFile first." }
$baseUrl = if ($env:MARKETSCANNER_BASE_URL) { $env:MARKETSCANNER_BASE_URL } else { 'https://app.stratalerts.com' }
$outputDir = if ($args.Length -gt 0) { $args[0] } else { Join-Path $HOME 'marketscanner-data/latest' }
New-Item -ItemType Directory -Force -Path $outputDir | Out-Null
$manifestUrl = "$baseUrl/api/llm/v1/snapshots/latest"
$headers = @{ Authorization = "Bearer $($env:MARKETSCANNER_API_KEY)" }
Invoke-WebRequest -Headers $headers -Uri $manifestUrl -OutFile (Join-Path $outputDir 'manifest.json')
Write-Host "Saved manifest to $outputDir/manifest.json"
Step 3 - LLM
Copy and paste this into your LLM