The get() method of the cookies API retrieves information about a single cookie, given its name and URL.

If more than one cookie with the same name exists for a given URL, the one with the longest path will be returned. For cookies with the same path length, the cookie with the earliest creation time will be returned. If no matching cookie could be found, null is returned.


// callback version

  details,               // object
  function(cookie) {...} // function

// promise version

var getCookie = browser.cookies.get(
  details                // object

  function(cookie) {},   // function
  function(error) {}     // function


An object containing details that can be used to match a cookie to be retrieved. It can include the following properties:
A string representing the URL with which the cookie to retrieve is associated. This argument may be a full URL, in which case any data following the URL path (e.g. the query string) is simply ignored. If host permissions for this URL are not specified in the WebExtension's manifest file, the API call will fail.
A string representing the name of the cookie to retrieve.
A string representing the ID of the cookie store in which to look for the cookie (as returned by cookies.getAllCookieStores()). By default, the current execution context's cookie store will be used.
callback (callback version only)
A callback function, which is passed a Cookie object containing details about the cookie, or null if the cookie was not found.

Browser compatibility

Chrome Edge Firefox Firefox for Android Opera
Basic support Yes Yes 45.0 48.0 33


In the following snippet (taken from our cookie-bg-picker example), we are using an event listener to check for the tabs.onUpdated event occurring (i.e. a change has occurred, like a new URL being loaded into the tab).

When this happens, we run the cookieUpdate() function. Inside here we get the current tab using tabs.query(), and inject our content script into the current tab using tabs.executeScript().

We then try to get the "bgpicker" cookie for the URL for the current tab using get():

  • If it exists already in the browser, background customization will have previously been set on the current page using the extension, so we get the customization preferences out of the cookie value and send them to the content script using tabs.sendMessage().
  • If the cookie does not already exist, no preferences have been set, so no action is needed.

function cookieUpdate(tabId, changeInfo, tab) {
  chrome.tabs.query({active: true, currentWindow: true}, function(tabs) {
    /* inject content script into current tab */

    chrome.tabs.executeScript(null, {
      file: "/content_scripts/updatebg.js"

    // get any previously set cookie for the current tab

      url: tabs[0].url,
      name: "bgpicker"
    }, function(cookie) {
      if(cookie) {
        var cookieVal = JSON.parse(cookie.value);
        chrome.tabs.sendMessage(tabs[0].id, {image: cookieVal.image});
        chrome.tabs.sendMessage(tabs[0].id, {color: cookieVal.color});

Example add-ons


This API is based on Chromium's chrome.cookies API. This documentation is derived from cookies.json in the Chromium code.

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

Document Tags and Contributors

 Contributors to this page: Makyen, wbamberg, chrisdavidmills
 Last updated by: Makyen,