# MyScanity

> MyScanity is a stock scanner and screener for trading setups: it scans thousands of stocks and ETFs daily, detects setups, and builds concrete trade plans with entry, stop-loss, and targets. It also exposes a read-first API for AI agents.

MyScanity is an informational tool, not an investment adviser or broker. Output is algorithmic and based on historical price patterns; trading carries a risk of loss.

## Product facts

- Setup types: 13
- Country markets: 38
- Named indices: 18
- Instruments: stocks and ETFs
- Languages: German at /, English at /en/

## Pricing

- Monthly: 17,00 € (incl. VAT, cancel monthly)
- Yearly: 160,00 € (incl. VAT, cancel monthly)
- Free trial: 14 days, no payment details required
- Payment: Stripe Checkout with 3-D Secure; subscriptions renew until cancelled

## Public pages

- / — landing page (German)
- /en/ — landing page (English)
- /impressum — legal notice
- /privacy — privacy policy
- /terms — terms of service
- /disclaimer — risk disclaimer
- /widerruf — withdrawal rights

## Agent API

Base URL: https://www.myscanity.de/api/v1
OpenAPI: https://www.myscanity.de/api/openapi.json (curated, bearerAuth)
Guide: https://www.myscanity.de/entwickler/api

Authentication: personal access token (`mys_...`), minted by a logged-in human under Settings → Agent access and sent as `Authorization: Bearer mys_...`. Cookies are ignored on agent routes. New tokens also send `X-MyScanity-Client: <client>`.

| Method | Path | Scope | Returns |
|---|---|---|---|
| GET | /api/v1/agent/me | any | Token probe: username, token name, scopes |
| GET | /api/v1/agent/setups | setups:read | Ranked stored setups with status and compact plan |
| GET | /api/v1/agent/trade-plan/{ticker} | setups:read | Entry, stop, targets, or the skip reason |
| GET | /api/v1/agent/portfolio | portfolio:read | Pending, open, and closed positions vs today's setups |
| GET | /api/v1/agent/watchlist | watchlist:write | Custom watchlist for the active profile |
| PUT | /api/v1/agent/watchlist | watchlist:write | add / remove / replace tickers |
| POST | /api/v1/agent/book-review | book:review | Ephemeral book overlay on the rotation board |

## Scopes

- `setups:read` — stored setups, trade plans
- `portfolio:read` — pending / open / closed positions
- `watchlist:write` — read and write the custom watchlist
- `book:review` — overlay an external depot on today's rotation (ephemeral)

## Limits and errors

- Rate limits: 60 requests/minute per token; watchlist writes and book reviews 10/minute; failed token attempts 20/minute per IP
- Successful responses carry `RateLimit` and `RateLimit-Remaining`; `GET /agent/me` also returns the budget in its body.
- 401/403 carry `WWW-Authenticate: Bearer realm="myscanity"` with `error` and `resource_metadata` (RFC 9728: /.well-known/oauth-protected-resource).
- 401 — missing/invalid token
- 402 — account not entitled (trial expired, no subscription)
- 404 — unknown ticker or profile
- 429 — rate limited (respect `Retry-After`)
- Writes accept `Idempotency-Key` (currently `PUT /api/v1/agent/watchlist`): same key + body replays the stored response for 24 h, a different body returns 409.
- The agent surface does not expose raw OHLCV, scan triggers, or settings writes.

## Machine-readable surface

- /llms.txt — this file
- /llms-full.txt — extended fact sheet and API notes
- /entwickler/api — API guide (auth flow, scopes, endpoints, errors)
- /api/openapi.json — curated OpenAPI 3.1 document with securitySchemes
- /.well-known/oauth-protected-resource — RFC 9728 resource metadata
- /robots.txt, /sitemap.xml — crawl map

Last updated: 2026-10-29