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

Update compatibility data on GitHub
DesktopMobile
ChromeEdgeFirefoxOperaSafariFirefox for Android
MostVisitedURLChrome Full support YesEdge Full support 79Firefox Full support 52Opera Full support YesSafari No support NoFirefox Android Full support 52
getChrome Full support YesEdge Full support 79Firefox Full support 78
Notes
Full support 78
Notes
Notes A user may disable the browser's "Top Sites" feature by toggling the "browser.newtabpage.activity-stream.feeds.system.topsites" preference. In this case, topSites.get() will always return a list of the most-visited sites, regardless of the value of the newtab parameter.
Full support 52
Opera Full support YesSafari No support NoFirefox Android Full support 52

Legend

Full support  
Full support
No support  
No support
See implementation notes.
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.