Skip to content


Subversion checkout URL

You can clone with
Download ZIP
JSON-RPC 2.0 client for jQuery.
JavaScript CSS HTML
Branch: master

Merge pull request #16 from monmonja/master

Added headers to options.
latest commit 5db1e62087
@bendiken bendiken authored

JSON RPC 2.0 jQuery Plugin

A JSON RPC 2.0 compatible client library and jQuery (1.4, 1.5, and 1.6 compatible) plugin.

First, a quick compatibility note

If you need to support IE6 & IE7, you will need to include Douglas Crockford's JSON library in order for this plugin to work. The specific file you need from that repository is json2.js.

Getting Started

The simplest way to configure jsonRPC is via the setup method

  endPoint: '/rpc',
  namespace: 'datagraph'

This will set a default endpoint and namespace for all subsequent requests.

Once you've configured an end point, making requests is a matter of

$.jsonRPC.request('', {
  params: params,
  success: function(result) {
    // Do something with the result here
    // It comes back as an RPC 2.0 compatible response object
  error: function(result) {
    // Result is an RPC 2.0 compatible response object

Want to do batch requests? We've got you covered

      method: '',
      params: [1,2,3]
      method: 'method.two'
  ], {
    success: function(result) {
      // Handle response object here

Need to temporarily override your end point or namespace? Easy enough...

  endPoint: '/anotherRpc',
  namespace: 'somethingElse'
}, function() {

After your call, your endPoint and namespace are back to their defaults. Or you can override the end point for a single request via

$.jsonRPC.request('', {
  params: [1,2,3],
  endPoint: '/anotherEndPoint'

Running the tests

The tests currently rely on being able to successfully make local AJAX calls to load test data. This works fine in Firefox (3.6, 4, and 5), but WebKit (Chrome and Safari) does not allow file-based AJAX calls. To successfully run tests in Safari or Chrome, you will need to serve the tests from a proper web server like Apache or Nginx. The tests have been verified against jQuery 1.4, 1.5, and 1.6.

Authors, License, Development, Thanks



This plugin is free and unemcumbered software released into the public domain. For more information, see the included UNLICENSE file.

Development / Contributing

Fork it on Github and go. Please make sure you're kosher with the UNLICENSE file before contributing.

Add your tests (see test directory), make sure they all pass, and submit a pull request.


Inspiration for this plugin came from (and is partly based on) the following existing plugins:

Something went wrong with that request. Please try again.