Sites: get
Stay organized with collections
Save and categorize content based on your preferences.
Requires authorization
Retrieves information about specific site.
Try it now.
Request
HTTP request
GET https://www.googleapis.com/webmasters/v3/sites/siteUrl
Parameters
| Parameter name |
Value |
Description |
| Path parameters |
siteUrl |
string |
The URL of the property to retrieve, as defined by Search Console. Examples:
http://www.example.com/ (for a URL-prefix property) or
sc-domain:example.com (for a Domain property)
|
Authorization
This request requires authorization with at least one of the following scopes (read more about authentication and authorization).
| Scope |
|---|
https://www.googleapis.com/auth/webmasters.readonly |
https://www.googleapis.com/auth/webmasters |
Request body
Do not supply a request body with this method.
Response
If successful, this method returns a Sites resource in the response body.
Try it!
Use the APIs Explorer below to call this method on live data and see the response.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-23 UTC.
[null,null,["Last updated 2024-07-23 UTC."],[[["\u003cp\u003eRetrieves information for a specific website using its URL.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with \u003ccode\u003ewebmasters.readonly\u003c/code\u003e or \u003ccode\u003ewebmasters\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUses a \u003ccode\u003eGET\u003c/code\u003e request to the \u003ccode\u003e/webmasters/v3/sites/siteUrl\u003c/code\u003e endpoint.\u003c/p\u003e\n"],["\u003cp\u003eReturns a \u003ccode\u003eSites\u003c/code\u003e resource with details about the specified website upon success.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esiteUrl\u003c/code\u003e parameter accepts the URL or domain of the site for retrieval.\u003c/p\u003e\n"]]],["This resource allows retrieving information about a specific site using its URL. The request is a `GET` method to the specified endpoint, requiring the `siteUrl` as a path parameter. The `siteUrl` can be either a URL-prefix (e.g., `http://www.example.com/`) or a domain property (e.g., `sc-domain:example.com`). Authorization is necessary, using either `webmasters.readonly` or `webmasters` scopes. No request body is needed; a successful response returns a `Sites` resource.\n"],null,["# Sites: get\n\n**Requires [authorization](#auth)**\n\nRetrieves information about specific site.\n[Try it now](#try-it).\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/webmasters/v3/sites/siteUrl\n```\n\n### Parameters\n\n| Parameter name | Value | Description |\n|----------------|----------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| **Path parameters** |||\n| `siteUrl` | `string` | The URL of the property to retrieve, as defined by Search Console. **Examples:** `http://www.example.com/` (for a URL-prefix property) or `sc-domain:example.com` (for a Domain property) |\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/webmaster-tools/v1/how-tos/authorizing)).\n\n| Scope |\n|-------------------------------------------------------|\n| `https://www.googleapis.com/auth/webmasters.readonly` |\n| `https://www.googleapis.com/auth/webmasters` |\n\n### Request body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a [Sites resource](/webmaster-tools/v1/sites#resource) in the response body.\n\nTry it!\n-------\n\n\nUse the APIs Explorer below to call this method on live data and see the response."]]
