The getKey() method of the IDBObjectStore interface returns an IDBRequest object, and, in a separate thread, returns the key selected by the specified query. This is for retrieving specific records from an object store.

If a key is successfully found, then a structured clone of it is created and set as the result of the request object.

Note: This feature is available in Web Workers.


var request = objectStore.getKey(key);


The key or key range that identifies the record to be retrieved.

Return Value

An IDBRequest object on which subsequent events related to this operation are fired.


This method may raise a DOMException of one of the following types:

Exception Description
TransactionInactiveError This IDBObjectStore's transaction is inactive.

The key or key range provided contains an invalid key.

InvalidStateError The IDBObjectStore has been deleted or removed.


let openRequest ="telemetry");
openRequest.onsuccess = (event) => {
  let db =;
  let store = db.transaction("netlogs").objectStore("netlogs");

  let today = new Date();
  let yesterday = new Date(today);
  yesterday.setDate(today.getDate() - 1);
  let request = store.getKey(IDBKeyRange(yesterday, today));
  request.onsuccess = (event) => {
    let when =;
    alert("The 1st activity in last 24 hours was occurred at " + when);


Specification Status Comment
Indexed Database API 2.0
The definition of 'getKey()' in that specification.
Recommendation Initial definition

Browser compatibility

We're converting our compatibility data into a machine-readable JSON format. This compatibility table still uses the old format, because we haven't yet converted the data it contains. Find out how you can help!

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Basic support 58 51.0 (51.0) ? 45 ?
Available in workers 58 ? ? 45 ?
Feature Android Webview Chrome for Android Firefox Mobile (Gecko) IE Phone Opera Mobile Safari Mobile
Basic support 58 58 51.0 (51.0) ? 45 ?
Available in workers 58 58 (Yes) ? 45 ?

See also

Document Tags and Contributors

 Contributors to this page: jpmedley, teoli
 Last updated by: jpmedley,