---
title: "Serql developer documentation"
description: "Developer portal for Serql: REST API, MCP server, authentication, concepts, self-hosting, and agent resources."
canonical: https://www.serql.io/docs
markdown: https://www.serql.io/docs/index.md
last-updated: 2026-09-14
section: docs
site: "Serql"
llms: https://www.serql.io/llms.txt
---

# Serql developer documentation

Serql exposes its Google Search Console analytics through three programmable surfaces, all sharing one OAuth 2.0 identity and the same per-property authorization as the web app:

| Surface | URL | Auth | Best for |
| --- | --- | --- | --- |
| REST API | `https://app.serql.io/api` — [OpenAPI](https://www.serql.io/openapi.json) | OAuth bearer or session | Scripts, SDK generation, function calling |
| MCP server | `https://www.serql.io/mcp` (also `https://app.serql.io/api/mcp`) — [server card](https://www.serql.io/.well-known/mcp/server-card.json) | OAuth bearer | Claude, ChatGPT, Cursor, and other MCP clients |
| Docs MCP server | `https://www.serql.io/api/mcp/docs` | none | Answering questions about Serql from its docs |

## Guides

- [Authentication (auth.md)](https://www.serql.io/docs/auth) — discovery, OAuth 2.0 with PKCE, token use, errors, revocation.
- [REST API](https://www.serql.io/docs/api) — endpoints, parameters, responses, rate limits.
- [MCP server](https://www.serql.io/docs/mcp) — tools, resources, connecting from popular clients.
- [Agent guide](https://www.serql.io/docs/agents) — when to use Serql, discovery files, WebMCP, plugins and skills.
- [Concepts](https://www.serql.io/docs/concepts) — properties, classifications, segments, topic clusters, annotations, share links.
- [Integrations](https://www.serql.io/docs/integrations) — bring-your-own-key DataForSEO and Ahrefs.
- [Self-hosting](https://www.serql.io/docs/self-hosting) — run the open-source core yourself.

## Quick start (agent)

```bash
# 1. Discover how to authenticate
curl -i https://app.serql.io/api            # 401 + WWW-Authenticate: Bearer resource_metadata=...
curl https://app.serql.io/.well-known/oauth-protected-resource
# 2. Complete OAuth (authorization code + PKCE) — see https://www.serql.io/auth.md
# 3. Call the API
curl -H "Authorization: Bearer $TOKEN" "https://app.serql.io/api/properties?days=28"
```

## Machine-readable index

- llms.txt: https://www.serql.io/llms.txt · docs-only: https://www.serql.io/docs/llms.txt · API-only: https://www.serql.io/api/llms.txt
- Every docs page has a markdown twin at the same path with `.md` appended, and returns markdown for `Accept: text/markdown`.
- API catalog (RFC 9727): https://www.serql.io/.well-known/api-catalog
- Agent card: https://www.serql.io/.well-known/agent-card.json · Agent skills: https://www.serql.io/.well-known/agent-skills/index.json · ARD: https://www.serql.io/.well-known/ard.json

## Source and support

The core is AGPL-3.0-only at https://github.com/snowopsdev/serql; the repository ships `AGENTS.md` for coding agents. Support: https://www.serql.io/contact.