Skip to content
OpenSEO
Get started

Docs

Documentation

Start with how OpenSEO works and what it costs, then follow a tutorial for the feature you need. The reference pages cover the REST API, the MCP server and every audit check.

Start here

Set up your account and understand the model: where the data comes from and what it costs.

  1. Getting started

    Create a YepAPI account, paste your key into OpenSEO and run your first research.

  2. How OpenSEO works

    Projects, markets, where the data comes from, what runs in the background, and what is stored.

  3. Costs, caching and limits

    How prices are worked out before anything runs, when results are free, and the controls that stop spending.

Tutorials

One walkthrough per feature, from an empty project to results you can act on.

  1. Build a keyword list

    Find keywords from a seed term, filter them, save the ones worth targeting and keep their figures fresh.

  2. Track your rankings

    Set up a tracker for a city or an exact point, price a check, run it, and read positions and changes.

  3. Size up a competitor

    Domain overview, organic and SERP competitors, the keyword gap and the backlinks behind it.

  4. Audit a site

    Crawl a site for free, work through the issues by severity, and test pages with Lighthouse.

  5. Measure AI visibility

    Track whether ChatGPT, Claude, Gemini and Perplexity mention and cite your brand for the questions buyers ask.

  6. Use your Search Console and Analytics data

    Connect Google read-only, find striking-distance queries, and rank pages by where a push is most worth it.

  7. Map local rankings

    Find your Google Business listing, check its profile and reviews, and run a geo-grid around it.

  8. Work with an AI agent

    Hand research to Claude, Cursor or Codex over MCP, with a spending ceiling on every paid call.

Run it yourself

Run the whole stack on your own machine or server.

  1. Self-hosting

    Run the OpenSEO app, API and site on your own machine with Postgres.

  2. Set up Google sign-in

    Create the Google OAuth client that lets users connect Search Console and Analytics to your install.

  3. Run the free tools

    Turn on the public free tools, pay for them from an operator key, and keep abuse and spending in check.

Reference

The details: every API route, MCP tool, audit check and error code.

  1. Connect an agent over MCP

    Give Claude, Cursor, Codex or another agent access to OpenSEO with an API key.

  2. MCP tools

    All 60 tools the MCP server offers, what each one does, and which ones spend.

  3. REST API

    Authentication, the response envelope, every route, and how dry runs, refreshes and ceilings work.

  4. Site audit checks

    Every issue the crawler reports, its severity, what it means and how to fix it, and how the health score is worked out.

  5. Errors and troubleshooting

    What each error code means and what to do about it.

OpenSEO is an early project in active development. The docs describe what the current version does.