# patternfetch Api API

**Canonical:** https://apis.io/apis/patternfetch-com/patternfetch-api-api/  
**Provider:** patternfetch-com — https://apis.io/providers/patternfetch-com/  
**Base URL:** https://patternfetch.com  
**Documentation:** https://patternfetch.com/docs

patternfetch Api API is one of 2 APIs that [patternfetch-com](https://apis.io/providers/patternfetch-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Agent-first API + MCP: a stock, ETF, or crypto ticker + timeframe -> a token-compact market-state brief (compact candles, chart/candlestick patterns, support/resistance, regime, interpreted indicators, and a one-line summary). Covers US stocks & ETFs (Yahoo, split & dividend adjusted, delayed/EOD) a

## Operations (25)

| Method | Path | Summary |
|---|---|---|
| POST | `/v1/brief` | Token-compact market-state brief for a stock, ETF, or crypto ticker + timeframe ($0.01) |
| POST | `/v1/multi` | Multi-timeframe market-state view + cross-timeframe alignment ($0.025) |
| POST | `/v1/delta` | Only what changed since your last brief ($0.008, $0.001 when nothing changed) |
| POST | `/v1/candles` | Compact candle codec only — rows + SAX shape signature ($0.005) |
| POST | `/v1/analogs` | Historical analogs as a full outcome distribution — not a prediction ($0.05) |
| POST | `/v1/scan` | Screener — scan US stocks, ETFs & crypto for tickers in a regime or printing a pattern, RANKED by honest backtested base rate ($0.02) |
| POST | `/v1/demo` | Free no-signup demo brief (rate-limited, never billed) |
| POST | `/v1/keys` | Self-serve free API key with $3.00 starter credit (300 briefs) |
| POST | `/v1/recover` | Mail a single-use link that issues a replacement API key |
| GET | `/v1/recover` | Redeem a recovery link and receive the replacement key (HTML) |
| GET | `/v1/topup` | Read the x402 payment requirements for a credit top-up |
| POST | `/v1/topup` | Top up credit with x402 (USDC on Base, no account) |
| POST | `/v1/checkout` | Create a Stripe hosted-checkout URL to top up credit |
| POST | `/v1/subscribe` | Create a Stripe checkout URL for the Studio subscription ($19/month, 2,500 briefs included) |
| POST | `/v1/portal` | Create a Stripe billing-portal URL to manage your own billing |
| GET | `/v1/platforms` | Capabilities matrix (assets, timeframes, endpoints) |
| GET | `/v1/status` | Service status (product, version, sources, assets) |
| GET | `/healthz` | Liveness check |
| POST | `/mcp` | MCP (Model Context Protocol) over Streamable HTTP |
| GET | `/v1/watch` | List watchlist subscriptions |
| POST | `/v1/watch` | Watch a ticker and get an HTTPS callback when its state changes |
| DELETE | `/v1/watch/{id}` | Delete a watchlist subscription |
| GET | `/v1/newsletter` | Read the changelog subscription state for this account |
| POST | `/v1/newsletter` | Subscribe to or unsubscribe from the changelog |
| POST | `/v1/demo-multi` | Multi-timeframe demo — no key required |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/patternfetch-com/openapi/_original/patternfetch-com-api-openapi.json
- **JSONSchema** — https://artifacts.apis.io/patternfetch-com/json-schema/patternfetch-com-brief-schema.json
- **JSONSchema** — https://artifacts.apis.io/patternfetch-com/json-schema/patternfetch-com-scan-request-schema.json
- **JSONSchema** — https://artifacts.apis.io/patternfetch-com/json-schema/patternfetch-com-watch-subscription-schema.json
- **JSONSchema** — https://artifacts.apis.io/patternfetch-com/json-schema/patternfetch-com-query-schema.json
- **JSONSchema** — https://artifacts.apis.io/patternfetch-com/json-schema/patternfetch-com-multi-query-schema.json
- **JSONSchema** — https://artifacts.apis.io/patternfetch-com/json-schema/patternfetch-com-multi-response-schema.json

## Other patternfetch-com APIs (1)

- [Patternfetch API](https://apis.io/apis/patternfetch-com/patternfetch-api/)

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/patternfetch-com/patternfetch-api-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/patternfetch-com/.