JavaScript APIs

Chrome provides extensions with many special-purpose APIs like chrome.runtime and chrome.alarms.

Stable APIs

NameDescriptionSince
alarms Use the chrome.alarms API to schedule code to run periodically or at a specified time in the future. 22
bookmarks Use the chrome.bookmarks API to create, organize, and otherwise manipulate bookmarks. Also see Override Pages, which you can use to create a custom Bookmark Manager page. 5
browserAction Use browser actions to put icons in the main Google Chrome toolbar, to the right of the address bar. In addition to its icon, a browser action can also have a tooltip, a badge, and a popup. 5
browsingData Use the chrome.browsingData API to remove browsing data from a user's local profile. 19
commands Use the commands API to add keyboard shortcuts that trigger actions in your extension, for example, an action to open the browser action or send a command to the extension. 25
contentSettings Use the chrome.contentSettings API to change settings that control whether websites can use features such as cookies, JavaScript, and plug-ins. More generally speaking, content settings allow you to customize Chrome's behavior on a per-site basis instead of globally. 16
contextMenus Use the chrome.contextMenus API to add items to Google Chrome's context menu. You can choose what types of objects your context menu additions apply to, such as images, hyperlinks, and pages. 6
cookies Use the chrome.cookies API to query and modify cookies, and to be notified when they change. 6
debugger The chrome.debugger API serves as an alternate transport for Chrome's remote debugging protocol. Use chrome.debugger to attach to one or more tabs to instrument network interaction, debug JavaScript, mutate the DOM and CSS, etc. Use the Debuggee tabId to target tabs with sendCommand and route events by tabId from onEvent callbacks. 18
declarativeContent Use the chrome.declarativeContent API to take actions depending on the content of a page, without requiring permission to read the page's content. 33
desktopCapture Desktop Capture API that can be used to capture content of screen, individual windows or tabs. 34
devtools.inspectedWindow Use the chrome.devtools.inspectedWindow API to interact with the inspected window: obtain the tab ID for the inspected page, evaluate the code in the context of the inspected window, reload the page, or obtain the list of resources within the page. 18
devtools.network Use the chrome.devtools.network API to retrieve the information about network requests displayed by the Developer Tools in the Network panel. 18
devtools.panels Use the chrome.devtools.panels API to integrate your extension into Developer Tools window UI: create your own panels, access existing panels, and add sidebars. 18
downloads Use the chrome.downloads API to programmatically initiate, monitor, manipulate, and search for downloads. 31
events The chrome.events namespace contains common types used by APIs dispatching events to notify you when something interesting happens. 21
extension The chrome.extension API has utilities that can be used by any extension page. It includes support for exchanging messages between an extension and its content scripts or between extensions, as described in detail in Message Passing. 5
fileBrowserHandler Use the chrome.fileBrowserHandler API to extend the Chrome OS file browser. For example, you can use this API to enable users to upload files to your website. 12
fontSettings Use the chrome.fontSettings API to manage Chrome's font settings. 22
history Use the chrome.history API to interact with the browser's record of visited pages. You can add, remove, and query for URLs in the browser's history. To override the history page with your own version, see Override Pages. 5
i18n Use the chrome.i18n infrastructure to implement internationalization across your whole app or extension. 5
identity Use the chrome.identity API to get OAuth2 access tokens. 29
idle Use the chrome.idle API to detect when the machine's idle state changes. 6
input.ime Use the chrome.input.ime API to implement a custom IME for Chrome OS. This allows your extension to handle keystrokes, set the composition, and manage the candidate window. 21
management The chrome.management API provides ways to manage the list of extensions/apps that are installed and running. It is particularly useful for extensions that override the built-in New Tab page. 8
notifications Use the chrome.notifications API to create rich notifications using templates and show these notifications to users in the system tray. 28
omnibox The omnibox API allows you to register a keyword with Google Chrome's address bar, which is also known as the omnibox. 9
pageAction Use the chrome.pageAction API to put icons inside the address bar. Page actions represent actions that can be taken on the current page, but that aren't applicable to all pages. 5
pageCapture Use the chrome.pageCapture API to save a tab as MHTML. 18
permissions Use the chrome.permissions API to request declared optional permissions at run time rather than install time, so users understand why the permissions are needed and grant only those that are necessary. 16
power Use the chrome.power API to override the system's power management features. 27
privacy Use the chrome.privacy API to control usage of the features in Chrome that can affect a user's privacy. This API relies on the ChromeSetting prototype of the type API for getting and setting Chrome's configuration. 18
proxy Use the chrome.proxy API to manage Chrome's proxy settings. This API relies on the ChromeSetting prototype of the type API for getting and setting the proxy configuration. 13
pushMessaging Use chrome.pushMessaging to enable apps and extensions to receive message data sent through Google Cloud Messaging. 24
runtime Use the chrome.runtime API to retrieve the background page, return details about the manifest, and listen for and respond to events in the app or extension lifecycle. You can also use this API to convert the relative path of URLs to fully-qualified URLs. 22
storage Use the chrome.storage API to store, retrieve, and track changes to user data. 20
system.cpu Use the system.cpu API to query CPU metadata. 32
system.memory The chrome.system.memory API. 32
system.storage Use the chrome.system.storage API to query storage device information and be notified when a removable storage device is attached and detached. 30
tabCapture Use the chrome.tabCapture API to interact with tab media streams. 31
tabs Use the chrome.tabs API to interact with the browser's tab system. You can use this API to create, modify, and rearrange tabs in the browser. 5
topSites Use the chrome.topSites API to access the top sites that are displayed on the new tab page. 19
tts Use the chrome.tts API to play synthesized text-to-speech (TTS). See also the related ttsEngine API, which allows an extension to implement a speech engine. 14
ttsEngine Use the chrome.ttsEngine API to implement a text-to-speech(TTS) engine using an extension. If your extension registers using this API, it will receive events containing an utterance to be spoken and other parameters when any extension or Chrome App uses the tts API to generate speech. Your extension can then use any available web technology to synthesize and output the speech, and send events back to the calling function to report the status. 14
types The chrome.types API contains type declarations for Chrome. 13
webNavigation Use the chrome.webNavigation API to receive notifications about the status of navigation requests in-flight. 16
webRequest Use the chrome.webRequest API to observe and analyze traffic and to intercept, block, or modify requests in-flight. 17
webstore Use the chrome.webstore API to initiate app and extension installations "inline" from your site. 15
windows Use the chrome.windows API to interact with browser windows. You can use this API to create, modify, and rearrange windows in the browser. 5

Beta APIs

These APIs are only available in the Chrome Beta and Dev channels:

NameDescription
accessibilityFeatures Use the chrome.accessibilityFeatures API to manage Chrome's accessibility features. This API relies on the ChromeSetting prototype of the type API for getting and setting individual accessibility features. In order to get feature states the extension must request accessibilityFeatures.read permission. For modifying feature state, the extension needs accessibilityFeatures.modify permission. Note that accessibilityFeatures.modify does not imply accessibilityFeatures.read permission.
declarativeWebRequest Use the chrome.declarativeWebRequest API to intercept, block, or modify requests in-flight. It is significantly faster than the chrome.webRequest API because you can register rules that are evaluated in the browser rather than the JavaScript engine with reduces roundtrip latencies and allows higher efficiency.
gcm Use chrome.gcm to enable apps and extensions to send and receive messages through Google Cloud Messaging.

Dev APIs

These APIs are only available in the Chrome Dev channel:

NameDescription
infobars Use the chrome.infobars API to add a horizontal panel just above a tab's contents. See the screenshot below.
location Use the chrome.location API to retrieve the geographic location of the host machine. This API is a version of the HTML Geolocation API that is compatible with event pages.
processes Use the chrome.processes API to interact with the browser's processes.
sessions Use the chrome.sessions API to query and restore tabs and windows from a browsing session.
signedInDevices Use the chrome.signedInDevices API to get a list of devices signed into chrome with the same account as the current profile.

Experimental APIs

Chrome also has experimental APIs, some of which will become supported APIs in future releases of Chrome.

API conventions

Unless the doc says otherwise, methods in the chrome.* APIs are asynchronous: they return immediately, without waiting for the operation to finish. If you need to know the outcome of an operation, then you pass a callback function into the method. For more information, watch this video: