Skip to content

Bin-Huang/reddit-ads-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

reddit-ads-cli

Reddit Ads CLI for AI agents (and humans). Analyze campaign performance, explore subreddit and interest targeting options, track conversion pixels, and more.

Works with: OpenClaw, Claude Code, Cursor, Codex, and any agent that can run shell commands.

Installation

Tell your AI agent (e.g. OpenClaw):

Install this CLI and skills from https://github.com/Bin-Huang/reddit-ads-cli

Or install manually:

npm install -g reddit-ads-cli # Add skills for AI agents (Claude Code, Cursor, Codex, etc.) npx skills add Bin-Huang/reddit-ads-cli

Or run directly: npx reddit-ads-cli --help

How it works

Built on the official Reddit Ads API v3. Handles OAuth2 token exchange automatically. Every command outputs structured JSON to stdout, ready for agents to parse without extra processing.

The Reddit Ads API is open to all developers and does not require allowlisting or approval from Reddit.

Core endpoints covered:

  • Ad Accounts -- list and inspect ad accounts
  • Campaigns -- list campaigns under an account
  • Ad Groups -- list ad groups under an account
  • Ads -- list ads (promotions) under an account
  • Reports -- generate performance reports

Setup

Step 1: Create a Reddit developer application

  1. Go to Reddit App Preferences and sign in.
  2. Click "create another app..." at the bottom.
  3. Choose "script" or "web app" type depending on your use case.
  4. Note your Client ID (under the app name) and Client Secret.

Step 2: Get an OAuth2 access token

Exchange your client credentials for an access token:

curl -X POST https://www.reddit.com/api/v1/access_token \ -u 'CLIENT_ID:CLIENT_SECRET' \ -d 'grant_type=client_credentials&scope=adsread'

For user-level access (managing specific advertiser accounts), use the authorization code flow. See Reddit OAuth2 docs.

Step 3: Place the credentials file

Choose one of these options:

# Option A: Default path (recommended) mkdir -p ~/.config/reddit-ads-cli cat > ~/.config/reddit-ads-cli/credentials.json << EOF {  "access_token": "YOUR_ACCESS_TOKEN",  "client_id": "YOUR_CLIENT_ID",  "client_secret": "YOUR_CLIENT_SECRET",  "username": "your_reddit_username" } EOF # Option B: Environment variables export REDDIT_ADS_ACCESS_TOKEN=your_access_token export REDDIT_ADS_CLIENT_ID=your_client_id # optional export REDDIT_ADS_CLIENT_SECRET=your_client_secret # optional export REDDIT_ADS_USERNAME=your_reddit_username # optional, for User-Agent # Option C: Pass per command reddit-ads-cli --credentials /path/to/credentials.json accounts

The username field is used to build the required User-Agent string (cli:reddit-ads-cli:v<version> (by /u/your_username)). The version is read from package.json at runtime. Reddit rate-limits requests without a proper User-Agent.

Credentials are resolved in this order:

  1. --credentials <path> flag
  2. REDDIT_ADS_ACCESS_TOKEN env var
  3. ~/.config/reddit-ads-cli/credentials.json (auto-detected)

Step 4: Find your Ad Account ID

reddit-ads-cli accounts

Usage

All commands output pretty-printed JSON by default. Use --format compact for compact single-line JSON.

accounts

List all ad accounts accessible by the authenticated user.

reddit-ads-cli accounts

account

Get details of a specific ad account.

reddit-ads-cli account t2_abc123

campaigns

List campaigns for an ad account.

reddit-ads-cli campaigns t2_abc123 reddit-ads-cli campaigns t2_abc123 --status ACTIVE

Options:

  • --status <status> -- filter by status (ACTIVE, PAUSED, etc.)

adgroups

List ad groups for an ad account.

reddit-ads-cli adgroups t2_abc123 reddit-ads-cli adgroups t2_abc123 --campaign-id campaign_abc

Options:

  • --campaign-id <id> -- filter by campaign ID
  • --status <status> -- filter by status

ads

List ads for an ad account.

reddit-ads-cli ads t2_abc123 reddit-ads-cli ads t2_abc123 --ad-group-id adgroup_abc

Options:

  • --ad-group-id <id> -- filter by ad group ID
  • --campaign-id <id> -- filter by campaign ID
  • --status <status> -- filter by status

report

Generate a performance report. Uses a POST request to the reporting endpoint.

# Campaign-level report reddit-ads-cli report t2_abc123 \ --start-date 2026-03-01 \ --end-date 2026-03-15 \ --level CAMPAIGN \ --metrics impressions,clicks,spend,ecpm,ctr # Ad group level with timezone reddit-ads-cli report t2_abc123 \ --start-date 2026-03-01 \ --end-date 2026-03-15 \ --level AD_GROUP \ --metrics impressions,clicks,spend \ --campaign-id campaign_abc \ --timezone America/New_York

Options:

  • --start-date <date> -- start date, YYYY-MM-DD (required)
  • --end-date <date> -- end date, YYYY-MM-DD (required)
  • --level <level> -- report level: ACCOUNT, CAMPAIGN, AD_GROUP, AD (default CAMPAIGN)
  • --metrics <metrics> -- comma-separated metrics (default: impressions,clicks,spend)
  • --campaign-id <id> -- filter by campaign ID
  • --ad-group-id <id> -- filter by ad group ID
  • --timezone <tz> -- timezone (e.g. America/New_York)

creatives

List ad creatives for an ad account.

reddit-ads-cli creatives t2_abc123 reddit-ads-cli creatives t2_abc123 --limit 50 --offset 10

Options:

  • --limit <n> -- results per page (default 25)
  • --offset <n> -- start index (default 0)

creative

Get a specific ad creative.

reddit-ads-cli creative t2_abc123 creative_xyz

custom-audiences

List custom audiences for an ad account.

reddit-ads-cli custom-audiences t2_abc123 reddit-ads-cli custom-audiences t2_abc123 --limit 50

Options:

  • --limit <n> -- results per page (default 25)
  • --offset <n> -- start index (default 0)

pixels

List conversion pixels for an ad account.

reddit-ads-cli pixels t2_abc123

pixel-events

List events for a conversion pixel.

reddit-ads-cli pixel-events t2_abc123 pixel_xyz

subreddits

Search for subreddits available for targeting.

reddit-ads-cli subreddits --query gaming reddit-ads-cli subreddits --query technology --limit 50

Options:

  • --query <q> -- search query (required)
  • --limit <n> -- results per page (default 25)

interests

List available interest targeting categories.

reddit-ads-cli interests

geos

List available geographic targeting options.

reddit-ads-cli geos reddit-ads-cli geos --query "United States"

Options:

  • --query <q> -- search query

Error output

Errors are written to stderr as JSON with an error field and a non-zero exit code:

{"error": "No bearer token or a bad bearer token was provided"}

API Reference

Related

License

Apache-2.0

About

Reddit Ads CLI and skills for AI agents (and humans)

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors