<br />

<br />

## Description

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](https://developer.chrome.com/extensions/develop/ui/override-chrome-pages).

<br />

<br />

## Permissions

`history`  

<br />

<br />

To interact with the user's browser history, use the history API.

<br />

To use the history API, declare the `"history"` permission in the [extension manifest](https://developer.chrome.com/docs/extensions/mv3/manifest). For
example:

    {
      "name": "My extension",
      ...
      "permissions": [
        "history"
      ],
      ...
    }

## Concepts and usage

### Transition types

The history API uses transition types to describe how the browser navigated to a particular URL
on a particular visit. For example, if a user visits a page by clicking a link on another page, the
transition type is "link". See the [reference content](https://developer.chrome.com/docs/extensions/reference/api/history#type-TransitionType) for a list of
transition types.

## Examples

To try this API, install the [history API example](https://github.com/GoogleChrome/chrome-extensions-samples/tree/main/api-samples/history) from the [chrome-extension-samples](https://github.com/GoogleChrome/chrome-extensions-samples/tree/main/api-samples)
repository.

<br />

## Types

### HistoryItem

An object encapsulating one result of a history query.

#### Properties

- id string

  The unique identifier for the item.
- lastVisitTime number optional

  When this page was last loaded, represented in milliseconds since the epoch.
- title string optional

  The title of the page when it was last loaded.
- typedCount number optional

  The number of times the user has navigated to this page by typing in the address.
- url string optional

  The URL navigated to by a user.
- visitCount number optional

  The number of times the user has navigated to this page.

### TransitionType

Chrome 44+ browser.\* since Chrome 148

The [transition type](https://developer.chrome.com/docs/extensions/reference/history/#transition_types) for this visit from its referrer.

#### Enum

"link"   
The user arrived at this page by clicking a link on another page.
"typed"   
The user arrived at this page by typing the URL in the address bar. This is also used for other explicit navigation actions.
"auto_bookmark"   
The user arrived at this page through a suggestion in the UI, for example, through a menu item.
"auto_subframe"   
The user arrived at this page through subframe navigation that they didn't request, such as through an ad loading in a frame on the previous page. These don't always generate new navigation entries in the back and forward menus.
"manual_subframe"   
The user arrived at this page by selecting something in a subframe.
"generated"   
The user arrived at this page by typing in the address bar and selecting an entry that didn't look like a URL, such as a Google Search suggestion. For example, a match might have the URL of a Google Search result page, but it might appear to the user as "Search Google for ...". These are different from typed navigations because the user didn't type or see the destination URL. They're also related to keyword navigations.
"auto_toplevel"   
The page was specified in the command line or is the start page.
"form_submit"   
The user arrived at this page by filling out values in a form and submitting the form. Not all form submissions use this transition type.
"reload"   
The user reloaded the page, either by clicking the reload button or by pressing Enter in the address bar. Session restore and Reopen closed tab also use this transition type.
"keyword"   
The URL for this page was generated from a replaceable keyword other than the default search provider.
"keyword_generated"   
Corresponds to a visit generated for a keyword.

<br />

### UrlDetails

Chrome 88+ browser.\* since Chrome 148

#### Properties

- url string

  The URL for the operation. It must be in the format as returned from a call to `history.search()`.

### VisitItem

An object encapsulating one visit to a URL.

#### Properties

- id string

  The unique identifier for the corresponding [`history.HistoryItem`](https://developer.chrome.com/docs/extensions/reference/api/history#type-HistoryItem).
- isLocal boolean
  Chrome 115+ browser.\* since Chrome 148

  True if the visit originated on this device. False if it was synced from a different device.
- referringVisitId string

  The visit ID of the referrer.
- transition [TransitionType](https://developer.chrome.com/docs/extensions/reference/api/history#type-TransitionType)

  The [transition type](https://developer.chrome.com/docs/extensions/reference/history/#transition_types) for this visit from its referrer.
- visitId string

  The unique identifier for this visit.
- visitTime number optional

  When this visit occurred, represented in milliseconds since the epoch.

## Methods

### addUrl()

```typescript
browser.history.addUrl(
  details: UrlDetails,
): Promise<void>
```

Adds a URL to the history at the current time with a [transition type](https://developer.chrome.com/docs/extensions/reference/history/#transition_types) of "link".

#### Parameters

- details [UrlDetails](https://developer.chrome.com/docs/extensions/reference/api/history#type-UrlDetails)

#### Returns

- Promise\<void\>
  Chrome 96+ browser.\* since Chrome 148

### deleteAll()

```typescript
browser.history.deleteAll(): Promise<void>
```

Deletes all items from the history.

#### Returns

- Promise\<void\>
  Chrome 96+ browser.\* since Chrome 148

### deleteRange()

```typescript
browser.history.deleteRange(
  range: object,
): Promise<void>
```

Removes all items within the specified date range from the history. Pages will not be removed from the history unless all visits fall within the range.

#### Parameters

- range object
  - endTime number

    Items added to history before this date, represented in milliseconds since the epoch.
  - startTime number

    Items added to history after this date, represented in milliseconds since the epoch.

#### Returns

- Promise\<void\>
  Chrome 96+ browser.\* since Chrome 148

### deleteUrl()

```typescript
browser.history.deleteUrl(
  details: UrlDetails,
): Promise<void>
```

Removes all occurrences of the given URL from the history.

#### Parameters

- details [UrlDetails](https://developer.chrome.com/docs/extensions/reference/api/history#type-UrlDetails)

#### Returns

- Promise\<void\>
  Chrome 96+ browser.\* since Chrome 148

### getVisits()

```typescript
browser.history.getVisits(
  details: UrlDetails,
): Promise<https://developer.chrome.com/docs/extensions/reference/api/history#type-VisitItem[]>
```

Retrieves information about visits to a URL.

#### Parameters

- details [UrlDetails](https://developer.chrome.com/docs/extensions/reference/api/history#type-UrlDetails)

#### Returns

- Promise\<[VisitItem](https://developer.chrome.com/docs/extensions/reference/api/history#type-VisitItem)\[\]\>
  Chrome 96+ browser.\* since Chrome 148

### search()

```typescript
browser.history.search(
  query: object,
): Promise<https://developer.chrome.com/docs/extensions/reference/api/history#type-HistoryItem[]>
```

Searches the history for the last visit time of each page matching the query.

#### Parameters

- query object
  - endTime number optional

    Limit results to those visited before this date, represented in milliseconds since the epoch.
  - maxResults number optional

    The maximum number of results to retrieve. Defaults to 100.
  - startTime number optional

    Limit results to those visited after this date, represented in milliseconds since the epoch. If property is not specified, it will default to 24 hours.
  - text string

    A free-text query to the history service. Leave this empty to retrieve all pages.

#### Returns

- Promise\<[HistoryItem](https://developer.chrome.com/docs/extensions/reference/api/history#type-HistoryItem)\[\]\>
  Chrome 96+ browser.\* since Chrome 148

## Events

### onVisited

```typescript
browser.history.onVisited.addListener(
  callback: function,
)
```

Fired when a URL is visited, providing the `HistoryItem` data for that URL. This event fires before the page has loaded.

#### Parameters

- callback function


  The `callback` parameter looks like:

  ```typescript
  (result: HistoryItem) => void
  ```

  <br />

  - result [HistoryItem](https://developer.chrome.com/docs/extensions/reference/api/history#type-HistoryItem)

### onVisitRemoved

```typescript
browser.history.onVisitRemoved.addListener(
  callback: function,
)
```

Fired when one or more URLs are removed from history. When all visits have been removed the URL is purged from history.

#### Parameters

- callback function


  The `callback` parameter looks like:

  ```typescript
  (removed: object) => void
  ```

  <br />

  - removed object
    - allHistory boolean

      True if all history was removed. If true, then urls will be empty.
    - urls string\[\] optional

<br />