Skip to content

PageRangers SEO API integration for AI assistants - keyword rankings, SERP analysis, KPIs

License

Notifications You must be signed in to change notification settings

netresearch/pagerangers-skill

Repository files navigation

PageRangers SEO Skill

License: MIT Python 3.10+

AI agent skill for querying the PageRangers Monitoring API. Works with Claude Code, Codex CLI, and other AI assistants supporting the Agent Skills specification.

Features

  • Keyword Analysis: SERP data, search volume, competition levels
  • Rankings: Current keyword positions and ranking URLs
  • KPIs: Ranking index, top 10/100 counts, average position
  • Prospects: High-opportunity keyword identification

Quick Start

# 1. Create credentials file
cat > ~/.env.pagerangers << 'EOF'
PAGERANGERS_API_TOKEN=your_api_key_here
PAGERANGERS_PROJECT_HASH=your_project_hash_here
EOF

# 2. Run commands (--json flag must come before subcommand)
python3 scripts/pagerangers.py --json kpis
python3 scripts/pagerangers.py --json rankings --limit 10
python3 scripts/pagerangers.py --json keyword "SEO tools" --top 5
python3 scripts/pagerangers.py --json prospects --limit 10

Installation

Claude Code (via Marketplace)

# 1. Add Netresearch marketplace (once)
/plugin marketplace add https://github.com/netresearch/claude-code-marketplace.git

# 2. The skill auto-activates when you mention PageRangers or SEO rankings

Codex CLI

# Install skill directly from GitHub
$skill-installer https://github.com/netresearch/pagerangers-skill

# Or clone manually
git clone https://github.com/netresearch/pagerangers-skill ~/.codex/skills/pagerangers-seo

Manual Installation

# Clone repository
git clone https://github.com/netresearch/pagerangers-skill
cd pagerangers-skill

# Install dependencies (optional, for development)
uv pip install -e ".[dev]"

# Run directly with Python 3.10+
python3 scripts/pagerangers.py --help

Development

Setup

# Install dev dependencies
uv pip install -e ".[dev]"

# Run tests
pytest

# Run tests with coverage
pytest --cov=scripts --cov-report=html

# Lint code
ruff check scripts tests

# Format code
ruff format scripts tests

Project Structure

pagerangers-seo/
├── .claude-plugin/     # Claude Code plugin manifest
│   └── plugin.json
├── scripts/            # CLI scripts
│   └── pagerangers.py
├── references/         # API documentation
│   ├── pagerangers-api.json
│   └── pagerangers-api.md
├── tests/              # Pytest test suite
│   ├── conftest.py
│   └── test_pagerangers.py
├── SKILL.md            # Skill definition
├── AGENTS.md           # Agent documentation
├── pyproject.toml      # Python project config
└── README.md           # This file

Configuration

Environment Variables

Variable Required Description
PAGERANGERS_API_TOKEN Yes API key from PageRangers profile
PAGERANGERS_PROJECT_HASH Yes Project identifier
PAGERANGERS_BASE_URL No Override API URL
PAGERANGERS_TIMEOUT No Request timeout (default: 30s)

Getting Credentials

  1. Log in to PageRangers
  2. Go to Profile → API Settings
  3. Copy API Token and Project Hash
  4. Store in ~/.env.pagerangers

API Reference

See references/pagerangers-api.md for complete API documentation.

Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Write tests for new functionality
  4. Ensure all tests pass: pytest
  5. Ensure code is formatted: ruff format
  6. Submit a pull request

License

MIT License - see LICENSE for details.

Author

Netresearch DTT GmbH

About

PageRangers SEO API integration for AI assistants - keyword rankings, SERP analysis, KPIs

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •  

Languages