---
title: "RivalNote API and rn CLI for Pro plans"
description: "API keys, read and write scopes and the rn command-line client for RivalNote Pro. Output as a table, JSON or CSV, with webhooks and CSV export."
image: "https://rivalnote.com/og-image.png"
---

# API keys and the rn command-line client

Pro includes API keys and rn, a client over the public REST API. Growth and Pro can also export insights as CSV or JSON.

[Talk to the founder on WhatsApp](https://wa.me/5548992091242?text=Hi!%20I%20would%20like%20to%20talk%20about%20early%20access%20to%20RivalNote.%20%28From%3A%20api-header%29)

## API keys

API keys are created in the dashboard under Settings, API keys, and look like `rn_live_...`. A key is shown once. A **read** key can list and read. A **write** key can also add, update, scan and remove competitors and sources, send signals, triage insights and manage webhooks. API access is a Pro feature. Keys can be rotated and revoked.

## The rn client

`rn` is a thin client over the public `/api/v1` REST API. It signs in with an API key, not with your Google account.

```
# competitors and sources
rn competitors list
rn competitors add <url> --name NAME
rn competitors scan <competitor-id>
rn sources add <competitor-id> <url>

# insights and digests
rn insights list --min-importance 70 --category pricing-change
rn insights get <insight-id>
rn insights mark <insight-id> saved
rn watch --min-importance 70
rn digests list

# alerts to your own endpoint
rn webhooks add <url>
rn webhooks rotate-secret <subscription-id> --generate
```

- List commands print a table by default, or JSON or CSV with `--format`. `--json` is the short form.
- Transient errors (429, 502, 503, 504) are retried twice by default, honoring `Retry-After`.
- It exits non-zero on any error, so a failed call fails the cron job or CI step.
- `rn insights list --all` follows every page, for a full-history export.

## Export without the API

On Growth and Pro, the dashboard exports insights as CSV or JSON. Spreadsheet formulas in exported text are neutralized so a hostile page cannot inject one into your file.

## Talk to the founder

Early access starts with a WhatsApp conversation. Say which competitors you track.

[Talk to the founder on WhatsApp](https://wa.me/5548992091242?text=Hi!%20I%20would%20like%20to%20talk%20about%20early%20access%20to%20RivalNote.%20%28From%3A%20api%29)