## Description Use the `chrome.cookies` API to query and modify cookies, and to be notified when they change.

## Permissions `cookies`


To use the cookies API, declare the `"cookies"` permission in your manifest along with [host permissions](https://developer.chrome.com/docs/extensions/develop/concepts/declare-permissions) for any hosts whose cookies you want to access. For example: { "name": "My extension", ... "host_permissions": [ "*://*.google.com/" ], "permissions": [ "cookies" ], ... } ## Partitioning [Partitioned cookies](https://developer.chrome.com/docs/privacy-sandbox/chips) allow a site to mark that certain cookies should be keyed against the origin of the top-level frame. This means that, for example, if site A is embedded using an iframe in site B and site C, the embedded versions of a partitioned cookie from A can have different values on B and C. By default, all API methods operate on unpartitioned cookies. The [`partitionKey`](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-CookiePartitionKey) property can be used to override this behavior. For details on the general impact of partitioning for extensions, see [Storage and Cookies](https://developer.chrome.com/docs/extensions/develop/concepts/storage-and-cookies#cookies-partitioning). ## Examples You can find a simple example of using the cookies API in the [examples/api/cookies](https://github.com/GoogleChrome/chrome-extensions-samples/tree/main/api-samples/cookies/cookie-clearer) directory. For other examples and for help in viewing the source code, see [Samples](https://developer.chrome.com/docs/extensions/samples).
## Types ### Cookie Represents information about an HTTP cookie. #### Properties - domain string The domain of the cookie (e.g. "www.google.com", "example.com"). - expirationDate number optional The expiration date of the cookie as the number of seconds since the UNIX epoch. Not provided for session cookies. - hostOnly boolean True if the cookie is a host-only cookie (i.e. a request's host must exactly match the domain of the cookie). - httpOnly boolean True if the cookie is marked as HttpOnly (i.e. the cookie is inaccessible to client-side scripts). - name string The name of the cookie. - partitionKey [CookiePartitionKey](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-CookiePartitionKey) optional Chrome 119+ browser.\* since Chrome 148 The partition key for reading or modifying cookies with the Partitioned attribute. - path string The path of the cookie. - sameSite [SameSiteStatus](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-SameSiteStatus) Chrome 51+ browser.\* since Chrome 148 The cookie's same-site status (i.e. whether the cookie is sent with cross-site requests). - secure boolean True if the cookie is marked as Secure (i.e. its scope is limited to secure channels, typically HTTPS). - session boolean True if the cookie is a session cookie, as opposed to a persistent cookie with an expiration date. - storeId string The ID of the cookie store containing this cookie, as provided in getAllCookieStores(). - value string The value of the cookie. ### CookieDetails Chrome 88+ browser.\* since Chrome 148 Details to identify the cookie. #### Properties - name string The name of the cookie to access. - partitionKey [CookiePartitionKey](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-CookiePartitionKey) optional Chrome 119+ browser.\* since Chrome 148 The partition key for reading or modifying cookies with the Partitioned attribute. - storeId string optional The ID of the cookie store in which to look for the cookie. By default, the current execution context's cookie store will be used. - url string The URL with which the cookie to access 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 manifest file, the API call will fail. ### CookiePartitionKey Chrome 119+ browser.\* since Chrome 148 Represents a partitioned cookie's partition key. #### Properties - hasCrossSiteAncestor boolean optional Chrome 130+ browser.\* since Chrome 148 Indicates if the cookie was set in a cross-cross site context. This prevents a top-level site embedded in a cross-site context from accessing cookies set by the top-level site in a same-site context. - topLevelSite string optional The top-level site the partitioned cookie is available in. ### CookieStore Represents a cookie store in the browser. An incognito mode window, for instance, uses a separate cookie store from a non-incognito window. #### Properties - id string The unique identifier for the cookie store. - tabIds number\[\] Identifiers of all the browser tabs that share this cookie store. ### FrameDetails Chrome 132+ browser.\* since Chrome 148 Details to identify the frame. #### Properties - documentId string optional The unique identifier for the document. If the frameId and/or tabId are provided they will be validated to match the document found by provided document ID. - frameId number optional The unique identifier for the frame within the tab. - tabId number optional The unique identifier for the tab containing the frame. ### OnChangedCause Chrome 44+ browser.\* since Chrome 148 The underlying reason behind the cookie's change. If a cookie was inserted, or removed via an explicit call to "chrome.cookies.remove", "cause" will be "explicit". If a cookie was automatically removed due to expiry, "cause" will be "expired". If a cookie was removed due to being overwritten with an already-expired expiration date, "cause" will be set to "expired_overwrite". If a cookie was automatically removed due to garbage collection, "cause" will be "evicted". If a cookie was automatically removed due to a "set" call that overwrote it, "cause" will be "overwrite". Plan your response accordingly. #### Enum "evicted" "expired" "explicit" "expired_overwrite" "overwrite"
### SameSiteStatus Chrome 51+ browser.\* since Chrome 148 A cookie's 'SameSite' state (https://tools.ietf.org/html/draft-west-first-party-cookies). 'no_restriction' corresponds to a cookie set with 'SameSite=None', 'lax' to 'SameSite=Lax', and 'strict' to 'SameSite=Strict'. 'unspecified' corresponds to a cookie set without the SameSite attribute. #### Enum "no_restriction" "lax" "strict" "unspecified"
## Methods ### get() ```typescript browser.cookies.get(   details: CookieDetails, ): Promise ``` Retrieves information about a single cookie. If more than one cookie of the same name exists for the 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. #### Parameters - details [CookieDetails](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-CookieDetails) #### Returns - Promise\<[Cookie](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-Cookie) \| undefined\> Chrome 88+ browser.\* since Chrome 148 ### getAll() ```typescript browser.cookies.getAll(   details: object, ): Promise ``` Retrieves all cookies from a single cookie store that match the given information. The cookies returned will be sorted, with those with the longest path first. If multiple cookies have the same path length, those with the earliest creation time will be first. This method only retrieves cookies for domains that the extension has host permissions to. #### Parameters - details object Information to filter the cookies being retrieved. - domain string optional Restricts the retrieved cookies to those whose domains match or are subdomains of this one. - name string optional Filters the cookies by name. - partitionKey [CookiePartitionKey](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-CookiePartitionKey) optional Chrome 119+ browser.\* since Chrome 148 The partition key for reading or modifying cookies with the Partitioned attribute. - path string optional Restricts the retrieved cookies to those whose path exactly matches this string. - secure boolean optional Filters the cookies by their Secure property. - session boolean optional Filters out session vs. persistent cookies. - storeId string optional The cookie store to retrieve cookies from. If omitted, the current execution context's cookie store will be used. - url string optional Restricts the retrieved cookies to those that would match the given URL. #### Returns - Promise\<[Cookie](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-Cookie)\[\]\> Chrome 88+ browser.\* since Chrome 148 ### getAllCookieStores() ```typescript browser.cookies.getAllCookieStores(): Promise ``` Lists all existing cookie stores. #### Returns - Promise\<[CookieStore](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-CookieStore)\[\]\> Chrome 88+ browser.\* since Chrome 148 ### getPartitionKey() Chrome 132+ browser.\* since Chrome 148 ```typescript browser.cookies.getPartitionKey(   details: FrameDetails, ): Promise ``` The partition key for the frame indicated. #### Parameters - details [FrameDetails](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-FrameDetails) #### Returns - Promise\ ### remove() ```typescript browser.cookies.remove(   details: CookieDetails, ): Promise ``` Deletes a cookie by name. #### Parameters - details [CookieDetails](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-CookieDetails) #### Returns - Promise\ Chrome 88+ browser.\* since Chrome 148 ### set() ```typescript browser.cookies.set(   details: object, ): Promise ``` Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist. #### Parameters - details object Details about the cookie being set. - domain string optional The domain of the cookie. If omitted, the cookie becomes a host-only cookie. - expirationDate number optional The expiration date of the cookie as the number of seconds since the UNIX epoch. If omitted, the cookie becomes a session cookie. - httpOnly boolean optional Whether the cookie should be marked as HttpOnly. Defaults to false. - name string optional The name of the cookie. Empty by default if omitted. - partitionKey [CookiePartitionKey](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-CookiePartitionKey) optional Chrome 119+ browser.\* since Chrome 148 The partition key for reading or modifying cookies with the Partitioned attribute. - path string optional The path of the cookie. Defaults to the path portion of the url parameter. - sameSite [SameSiteStatus](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-SameSiteStatus) optional Chrome 51+ browser.\* since Chrome 148 The cookie's same-site status. Defaults to "unspecified", i.e., if omitted, the cookie is set without specifying a SameSite attribute. - secure boolean optional Whether the cookie should be marked as Secure. Defaults to false. - storeId string optional The ID of the cookie store in which to set the cookie. By default, the cookie is set in the current execution context's cookie store. - url string The request-URI to associate with the setting of the cookie. This value can affect the default domain and path values of the created cookie. If host permissions for this URL are not specified in the manifest file, the API call will fail. - value string optional The value of the cookie. Empty by default if omitted. #### Returns - Promise\<[Cookie](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-Cookie) \| undefined\> Chrome 88+ browser.\* since Chrome 148 ## Events ### onChanged ```typescript browser.cookies.onChanged.addListener(   callback: function, ) ``` Fired when a cookie is set or removed. As a special case, note that updating a cookie's properties is implemented as a two step process: the cookie to be updated is first removed entirely, generating a notification with "cause" of "overwrite" . Afterwards, a new cookie is written with the updated values, generating a second notification with "cause" "explicit". #### Parameters - callback function The `callback` parameter looks like: ```typescript (changeInfo: object) => void ```
- changeInfo object - cause [OnChangedCause](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-OnChangedCause) The underlying reason behind the cookie's change. - cookie [Cookie](https://developer.chrome.com/docs/extensions/reference/api/cookies#type-Cookie) Information about the cookie that was set or removed. - removed boolean True if a cookie was removed.