index.md

---

title: topSites
slug: Mozilla/Add-ons/WebExtensions/API/topSites
page-type: webextension-api
tags:
  - API
  - Add-ons
  - Extensions
  - Interface
  - Non-standard
  - Reference
  - WebExtensions
  - topSites
browser-compat: webextensions.api.topSites

---

{{AddonSidebar}}

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

• {{WebExtAPIRef("topSites.MostVisitedURL")}}

  • : An object containing the title and URL of a website.

Methods

• {{WebExtAPIRef("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

{{Compat}}

{{WebExtExamples("h2")}}

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