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
This permission triggers a warning.

Manifest

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

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

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

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


          
          
            chrome.topSites.get(

        callback?:
  function,

      
    )

Promise

Gets a list of top sites.

callback
function optional
The callback parameter looks like: (data: MostVisitedURL[]) => void
- data
  MostVisitedURL[]

Promise<MostVisitedURL[]>
Chrome 96+
Promises are supported in Manifest V3 and later, but callbacks are provided for backward compatibility. You cannot use both on the same function call. The promise resolves with the same type that is passed to the callback.

Table of contents