Skip to content
OpenParablePublic APIs

Google Search Console API API

by googleapis.com

OAuthHTTPSAnalytics
Open documentation ↗

Overview

The Search Console API provides access to both Search Console data (verified users only) and to public information on an URL basis (anyone)

Google Search Console API is an analytics API from googleapis.com. Requests are authenticated with OAuth. It is served over HTTPS. Its OpenAPI description documents 11 endpoints.

At a glance

Authentication
OAuth
HTTPS
Yes
CORS
Unknown
Category
Analytics
Base URL
https://searchconsole.googleapis.com/
Version
v1
Endpoints
11
OpenAPI
Specification ↗
Spec updated
2023-04-21

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://searchconsole.googleapis.com/webmasters/v3/sites" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_TOKEN"
JavaScript
const response = await fetch("https://searchconsole.googleapis.com/webmasters/v3/sites", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://searchconsole.googleapis.com/webmasters/v3/sites",
    headers={
    "Accept": "application/json",
    "Authorization": "Bearer YOUR_TOKEN",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/v1/urlInspection/index:inspectIndex inspection.
POST/v1/urlTestingTools/mobileFriendlyTest:runRuns Mobile-Friendly Test for a given URL.
GET/webmasters/v3/sitesLists the user's Search Console sites.
GET/webmasters/v3/sites/{siteUrl}Retrieves information about specific site.
PUT/webmasters/v3/sites/{siteUrl}Adds a site to the set of the user's sites in Search Console.
DELETE/webmasters/v3/sites/{siteUrl}Removes a site from the set of the user's Search Console sites.
POST/webmasters/v3/sites/{siteUrl}/searchAnalytics/queryQuery your data with filters and parameters that you define. Returns zero or more rows grouped by the row keys that you define. You must define a date range of
GET/webmasters/v3/sites/{siteUrl}/sitemapsLists the [sitemaps-entries](/webmaster-tools/v3/sitemaps) submitted for this site, or included in the sitemap index file (if `sitemapIndex` is specified in the
GET/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}Retrieves information about a specific sitemap.
PUT/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}Submits a sitemap for a site.
DELETE/webmasters/v3/sites/{siteUrl}/sitemaps/{feedpath}Deletes a sitemap from the Sitemaps report. Does not stop Google from crawling this sitemap or the URLs that were previously crawled in the deleted sitemap.

Questions

Does the Google Search Console API API need an API key?

Yes. The Google Search Console API API uses OAuth authentication; the documentation explains how to get credentials.

Does the Google Search Console API API support HTTPS?

Yes, the Google Search Console API API is served over HTTPS.

How many endpoints does the Google Search Console API API have?

Its OpenAPI description lists 11 endpoints in version v1. All of them are shown on this page.

What are alternatives to the Google Search Console API API?

Other Analytics APIs include Google Play Integrity API, versionhistory.googleapis.com API, Doc Converter, Perspective Comment Analyzer API, Safe Browsing API.

Compare alternatives →

Google Play Integrity API

Analytics

The Play Integrity API helps you check that you're interacting with your genuine app on a genuine Android device powered by Google Play services. The Play Integrity API has replaced SafetyNet Attestation and Android Device Verification.

OAuth1 endpoints

versionhistory.googleapis.com API

Analytics

Version History API - Prod

No auth4 endpoints

Doc Converter

Analytics

This api converts file formats of OpenXml and OpenOffice documents formats to vector files (e.g., svg)

No auth1 endpoints

Perspective Comment Analyzer API

Analytics

The Perspective Comment Analyzer API provides information about the potential impact of a comment on a conversation (e.g. it can provide a score for the "toxicity" of a comment). Users can leverage the "SuggestCommentScore" method to submit corrections to improve Perspective over time. Users can set the "doNotStore" flag to ensure that all submitted comments are automatically deleted after scores are returned.

OAuth2 endpoints

Safe Browsing API

Analytics

Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources. The Safe Browsing APIs are for non-commercial use only. If you need to use APIs to detect malicious URLs for commercial purposes – meaning “for sale or revenue-generating purposes” – please refer to the Web Risk API.

No auth7 endpoints

Web Fonts Developer API

Analytics

The Google Web Fonts Developer API lets you retrieve information about web fonts served by Google.

No auth1 endpoints

Listed from APIs.guru (CC0).