topSites

Use the topSites API to get an array containing pages that the user has visited frequently.

Browsers maintain this to help the user get back to these places easily. For example, Firefox by default provides a list of the most-visited pages in the "New Tab" page.

To use the topSites API you must have the "topSites" API permission.

Types

topSites.MostVisitedURL
An object containing the title and URL of a website.

Methods

topSites.get()
Gets an array containing all the sites listed in the browser's "New Tab" page. Note that the number of sites returned here is browser-specific, and the particular sites returned will probably be specific to the user, based on their browsing history.

Browser compatibility

Report problems with this compatibility data on GitHub
webextensions-desktopwebextensions-mobile
ChromeEdgeFirefoxOperaSafariFirefox for Android
MostVisitedURL
MostVisitedURL.favicon
get
get.options
options.includeBlocked
options.includeFavicon
options.includePinned
options.includeSearchShortcuts
options.limit
options.newtab
options.onePerDomain

Legend

Full support
Full support
No support
No support
See implementation notes.

Example extensions

Acknowledgements

This API is based on Chromium's chrome.topSites API.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.