chrome.topSites (original) (raw)

chrome.topSites

Description

Use the chrome.topSites API to access the top sites (i.e. most visited sites) that are displayed on the new tab page. These do not include shortcuts customized by the user.

Permissions

topSites

You must declare the "topSites" permission in your extension's manifest to use this API.

{
  "name": "My extension",
  ...
  "permissions": [
    "topSites",
  ],
  ...
}

Examples

To try this API, install the topSites API example from the chrome-extension-samplesrepository.

Types

MostVisitedURL

An object encapsulating a most visited URL, such as the default shortcuts on the new tab page.

Properties

• The title of the page
• The most visited URL.

Methods

get()

chrome.topSites.get(): Promise<MostVisitedURL[]>

Gets a list of top sites.

Returns

• Promise<MostVisitedURL[]>

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 2025-08-11 UTC.