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 GitHubwebextensions-desktop | webextensions-mobile | |||||
---|---|---|---|---|---|---|
MostVisitedURL | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support52 | OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo support52 — 79 |
MostVisitedURL.favicon | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support63 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo support63 — 79 |
get | ChromeFull supportYes | EdgeFull support79 | FirefoxFull support78
| OperaFull supportYes | SafariNo supportNo | Firefox for AndroidNo support52 — 79 |
get.options | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support63 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo support63 — 79 |
options.includeBlocked | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support63 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo support63 — 79 |
options.includeFavicon | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support63 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo support63 — 79 |
options.includePinned | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support69 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo supportNo |
options.includeSearchShortcuts | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support69 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo supportNo |
options.limit | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support63 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo support63 — 79 |
options.newtab | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support63 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo support63 — 79 |
options.onePerDomain | ChromeNo supportNo | EdgeNo supportNo | FirefoxFull support63 | OperaNo supportNo | SafariNo supportNo | Firefox for AndroidNo support63 — 79 |
Legend
- Full support
- Full support
- No support
- No support
- See implementation notes.
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
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.