# ScrollLaunch CLI and public API

> Official command-line client and OpenAPI 3.1 REST API for the live product catalog. No API key for reads.

```yaml
url: "https://www.scrolllaunch.com/cli"
openapi: "https://www.scrolllaunch.com/openapi.json"
openapi_yaml: "https://www.scrolllaunch.com/api/openapi.yaml"
rest: "https://www.scrolllaunch.com/v1"
cli: npx scrolllaunch
auth: none - public read-only GET
```

## Install

- `npx scrolllaunch --help` - run without installing
- `npm install -g scrolllaunch` then `scrolllaunch --help`
- Requires Node.js 18 or newer. Package: scrolllaunch on npm.

## Commands

- `scrolllaunch search <query>` - live product search
- `scrolllaunch product <slug>` - product detail JSON
- `scrolllaunch leaderboard [--week YYYY-Www]` - this week's board
- `scrolllaunch directories [--limit N]` - Domain Rating directory board
- `scrolllaunch openapi` - print the OpenAPI 3.1 document

## Examples

```bash
npx scrolllaunch search "ai writer" --json
```

```bash
curl -sS "https://www.scrolllaunch.com/v1/leaderboard?limit=5"
```

## REST

- [OpenAPI 3.1 JSON](https://www.scrolllaunch.com/openapi.json) - machine-readable contract
- [OpenAPI YAML](https://www.scrolllaunch.com/api/openapi.yaml) - same contract as YAML
- [GET /v1](https://www.scrolllaunch.com/v1) - public endpoint index
- GET /v1/products - paginated live products
- GET /v1/products/{slug} - product detail
- GET /v1/search?q= - search
- GET /v1/leaderboard - weekly board
- GET /v1/directories/leaderboard - directories by Ahrefs DR

## Errors

Error responses use RFC 9457 Problem Details as `application/json` with `code`, `detail`, `hint`, and `retryable`. Agents should read `hint` before retrying. Rate-limit headers (`RateLimit-Limit`, `RateLimit-Remaining`, `RateLimit-Reset`, `Retry-After` on 429) are on every public `/v1` response.

## Related

- [MCP docs](https://www.scrolllaunch.com/mcp) - JSON-RPC tools
- [llms.txt](https://www.scrolllaunch.com/llms.txt) - site map
- [AI snapshot](https://www.scrolllaunch.com/api/ai) - bounded JSON