Greasemonkey / Wiki / GM_xmlhttpRequest
Menu ▾ ▴

GM_xmlhttpRequest

mmartz
There is a newer version of this page. You can find it here.

Description

This API method provides access to the chrome-privileged XMLHttpRequest object. This means that it is possible to issue requests to domains other than that of the current page.

Additional reference may be found at:

⬆ ⬇ | Examples | See Also | Notes

Syntax

GM_xmlhttpRequest( details )

Value: Function
Compatibility: Greasemonkey 0.2.5+
Access: @grant
Returns:

details Object

Properties Event Handler Callbacks Methods
method onload abort
url onreadystatechange
headers onerror
overrideMimeType ontimeout
data onprogress
binary onabort
user
password
upload
synchronous
timeout
  • All properties and event handler callbacks are optional except method and url.

⬆ ⬇

Properties


method

Value: String
Usage: details.method = "GET";

⬆ ⬇ ⇧

url

Value: String
Usage: details.url = "http://www.example.com/";

  • The URL may be relative but it is strongly recommended to make it an absolute URL to avoid incorrect domain requests depending on the complexity of a user script.

⬆ ⬇ ⇧

headers

Value: Object
Usage: details.headers = {"User-Agent":"Mozilla/5.0"};

  • The headers property is an object which is typically used to override the default browser generated headers, also known as atoms. It should contain the atom-value pairs of the headers to send.2

⬆ ⬇ ⇧

overrideMimeType

Value: String
Compatibility: Greasemonkey 0.6.8+
Usage: details.overrideMimeType = "text/html; charset=ISO-8859-1";

  • While each character set name may have multiple aliases defined, there may be a preferred name which can be found at IANA

⬆ ⬇ ⇧

data

Value: String
Usage: details.data = null; /* some code */ if (details.data) { /* some code */ }

  • Note that if the data field contains form-encoded data, you must also set the header 'Content-Type': 'application/x-www-form-urlencoded' in the headers field.
  • 1

⬆ ⬇ ⇧

binary

Value: Boolean
Compatibility: Greasemonkey 0.8.3+
Usage: details.binary = true;

  • Sends data as type binary in Firefox 3.0.x or above.

⬆ ⬇ ⇧

user

Value: String
Compatibility: Greasemonkey 0.9.0+
Usage: details.user = "johndoe";

⬆ ⬇ ⇧

password

Value: String
Compatibility: Greasemonkey 0.9.0+
Usage:

details.password = "password";

⬆ ⬇ ⇧

upload

Value: Object
Compatibility: Greasemonkey 0.9.9+

⬆ ⬇ ⇧

synchronous

Value: Boolean
Default: false
Compatibility: Greasemonkey 0.9.9+
Usage: details.synchronous = true;

  • Sets transfers to synchronous mode possibly freezing the browser during uploading and downloading.

⬆ ⬇ ⇧

timeout

Value: Number
Default: 0
Compatibility: Greasemonkey 1.0.0+
Usage: details.timeout = 60000;

  • Set the the timeout delay in milliseconds. Zero means use platform defaults for timeout.

⬆ ⬇ ⇧

Event Handler Callbacks


onload

Usage: details.onload = function (response) { /* some code */ };
Returns: undefined, response Object

⬆ ⬇ ⇧

onreadystatechange

Usage: details.onreadystatechange = function (response) { /* some code */ };
Returns: undefined, response Object

⬆ ⬇ ⇧

onerror

Usage: details.onerror = function (response) { /* some code */ };
Returns: undefined, response Object

⬆ ⬇ ⇧

ontimeout

Usage: details.ontimeout = function (response) { /* some code */ };
Compatibility: Greasemonkey 0.9.9+*
Returns: undefined, response Object

⬆ ⬇ ⇧

onprogress

Usage: details.onprogress = function (response) { /* some code */ };
Compatibility: Greasemonkey 0.9.9+*
Returns: undefined, response Object

⬆ ⬇ ⇧

onabort

Usage: details.onabort = function (response) { /* some code */ };
Compatibility: Greasemonkey 0.9.9+*
Returns: undefined, response Object

⬆ ⬇ ⇧

Methods


abort

Usage: var req = GM_xmlhttpRequest({ /* Some intialization */ }); req.abort();
Compatibility: Greasemonkey 0.9.9+*

⬆ ⬇ ⇧

response Object

Properties
status
statusText
readyState
responseText
responseHeaders
finalUrl
  • Note: there is no responseXML property, contrary to what people used to XMLHttpRequest might expect. This is due to security restrictions imposed on the XMLDocument created in the privileged GM core context. One can easily create its own document object out of responseText using a DOMParser.

⬆ ⬇

Properties


status

Value: Number
Usage: if (response.status == 200) { /* some code */ }

⬆ ⬇ ⇧⇧

statusText

Value: String
Usage: if (response.statusText == "OK") { /* some code */ }

⬆ ⬇ ⇧

readyState

Value: Number
Usage: if (response.readyState == 4) { /* some code */ }

⬆ ⬇ ⇧

responseText

Value: String
Usage: alert(response.responseText);

⬆ ⬇ ⇧

responseHeaders

Value: String
Usage: if (response.responseHeaders) { /* some code */ }

  • The responseHeaders is the string representation of response headers returned by XMLHTTPRequest.getAllResponseHeaders().

⬆ ⬇ ⇧

finalUrl

Value: String
Compatibility: Greasemonkey 0.8.0+
Usage: if (response.finalUrl) { /* some code */ }

⬆ ⬇ ⇧

Examples

⬆ ⬇ | GET request | POST request | HEAD request

Core

GET request

GM_xmlhttpRequest({
  method: "GET",
  url: "http://www.example.net/",
  headers: {
    "User-Agent": "Mozilla/5.0", // If not specified, navigator.userAgent will be used.
    "Accept": "text/xml" // If not specified, browser defaults will be used.
  },
  onload: function (response) {
    GM_log([
      response.status,
      response.statusText,
      response.readyState,
      response.responseHeaders,
      response.responseText,
      response.finalUrl
    ].join("\n"));
  }
});

⬆ ⬇ ⇧

POST request

When making a POST request, some sites require the Content-Type header to be included as such:

GM_xmlhttpRequest({
  method: "POST",
  url: "http://www.example.net/login",
  data: "username=johndoe&password=xyz123",
  headers: {
    "Content-Type": "application/x-www-form-urlencoded"
  },
  onload: function (response) {
    if (response.responseText.indexOf("Logged in as") > -1)
      location.href = "http://www.example.net/dashboard";
  }
});

⬆ ⬇ ⇧

HEAD request

Sometimes responseText may be unnecessary, in which case a "HEAD" request is more advisable.

GM_xmlhttpRequest({
  url: "http://www.example.com",
  method: "HEAD",
  onload: function (response) {
    GM_log(response.responseHeaders);
  }
});

⬆ ⬇ ⇧

Notes

1Some users have reported problems with international character sets. See these [Mailing_list] threads

Resolved: Greasemonkey exposed the overrideMimeType method to allow changing of the desired charset.

2Some header atoms may not actually work through GM_xmlhttpRequest. The Referer atom is one that is known to be recognized but appears to be content filtered by the browser. This may be due to security restrictions to keep user scripts from doing unsafe things.

⬆ ⬇