Skip to content

API Reference

A consolidated reference for the extension APIs. Status legend:

  • Functional — works as expected.
  • 🟡 Partial — works with caveats (see notes).
  • Stub — present but returns defaults / no-op.

Userscript GM_*

APIStatusNotes
GM_getValue / GM_setValue / GM_deleteValue / GM_listValuesSharedPreferences-backed, per-script namespace
GM_xmlhttpRequestVia OkHttp; full callback set
GM_addStyle
GM_setClipboard
GM_openInTab
GM_log
GM_getResourceText / GM_getResourceURL
GM_registerMenuCommand / GM_unregisterMenuCommandFloating-window menu
GM_openScriptWindow / GM_updateScriptWindow / GM_closeScriptWindowWebToApp-specific
GM_info
unsafeWindowEquals window (no sandbox)
GM_notification🟡Logs only; no system notification
@grant gatingAll APIs exposed regardless of declared grants
GM.* (Promise)Mirrors all of the above

Chrome chrome.*

NamespaceStatusNotes
runtimeMessaging, lifecycle, getURL, getManifest
storagelocal/sync/session; managed no-op
tabsCore CRUD + events
scriptingDynamic content script registration
cookies
alarms
declarativeNetRequestblock/allow/redirect/modifyHeaders/upgradeScheme
downloads🟡download functional
webRequest🟡onBeforeRequest filtering via native bridge
i18n / notifications / permissions / contextMenus / commands
webNavigation / extension / idle / tabGroups🟡
action / sidePanel🟡
windows / management / topSites / fontSettingsStubs
identity / history / proxy / privacyStubs
system.cpu/memory/display/storageStubs
bookmarks / offscreen / ttsStubs
browserAction / pageAction (MV2)🟡Compatibility aliases

This table is a living document

The functional/stub status is being verified API-by-API. When in doubt, test against the current build.

Released under the Unlicense.