Use when working with Google Search Console API - search analytics, URL inspection, indexing requests, sitemap management, or SEO performance data. Also use when querying search impressions, clicks, CTR, or position data.
| Model | Source |
|---|
| sonnet | pack: google-apis |
Full Reference
┏━ 🔧 google-search-console-api ━━━━━━━━━━━━━━━━━┓
┃ Use when working with Google Search Console AP… ┃
┗━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┛
Programmatic access to search performance data, URL inspection, and index management. Two distinct API services — use the correct one or calls will fail.
| Item | Value |
|---|
| Base URL (Search Analytics, Sitemaps, Sites) | https://www.googleapis.com/webmasters/v3 |
| Base URL (URL Inspection) | https://searchconsole.googleapis.com/v1 |
| Auth | OAuth 2.0 or Service Account (required) |
| Python client | pip install google-api-python-client google-auth |
| Node.js client | npm install googleapis google-auth-library |
| Readonly scope | https://www.googleapis.com/auth/webmasters.readonly |
| Read/write scope | https://www.googleapis.com/auth/webmasters |
| Data freshness | 2–3 day delay |
| Historical data | 16 months |
| Task | Python | Node.js |
|---|
| Search Analytics, Sitemaps, Sites | build('webmasters', 'v3', ...) | searchconsole({ version: 'v1', auth }) |
| URL Inspection | build('searchconsole', 'v1', ...) | google.searchconsole({ version: 'v1', auth }) |
| Endpoint | Purpose |
|---|
searchanalytics.query | Search performance data (clicks, impressions, CTR, position) |
urlInspection.index.inspect | Check URL indexing status, mobile usability, rich results |
sitemaps.list/submit/delete | Manage sitemaps |
sites.list/add/delete | Manage properties |
| I want to… | File |
|---|
| OAuth 2.0 setup, service accounts, code examples | reference/auth.md |
| Query performance data, dimensions, filters, pagination | reference/search-analytics.md |
| Index status, mobile usability, rich results, AMP | reference/url-inspection.md |
| Submit, list, and delete sitemaps | reference/sitemaps.md |
| Add, list, and remove properties | reference/sites.md |
| JobPosting/BroadcastEvent URL change notifications | reference/indexing.md |
| BigQuery bulk export, schemas, SQL examples | reference/bigquery-export.md |
| QPM/QPD quotas, backoff strategy | reference/rate-limits.md |
| 2024–2026 API additions and deprecations | reference/changelog.md |
Usage: Read the reference file matching your current task from the index above. Each file is self-contained with code examples and inline gotchas.