Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
78 lines (51 sloc) 2.94 KB

QGK Public Ripple Resources

The QuickGatewayKit project assists developers by providing Rippled and Ripple-REST servers for public use.
This file documents the steps to take to access these services.


For the latest API information, visit:

Ripple-REST is available through To interface with this service, you can send GET requests from your web browser by navigating to any of the available endpoints, I.E. will provide information about the rippled server that REST connects to for accessing the requested information about the Ripple Network.

It is not suggested to send POST requests to this server unless it is a test account.
To POST via the command line, you can use the curl package. A curl command starts with the syntax:

curl -H "Content-Type: application/json" -X POST -d '{"method": ...

Where you specify the method and what accompanying JSON you wish to POST.


For the latest information about the rippled api, visit:

rippled is available through the ws and rpc protocols.

Web socket

There is a websocket client for Chrome available @ called the Simple Websocket Client. Within your browser, click the Ws icon by the address bar and enter the web socket address:


and then click on Open. If the response is 'undefined' then this server may be down for maintenance at the time.
If the response is OPEN, then you may enter whatever JSON you wish to execute into the text field directly below the URL.
I.E. if you wanted to fetch a new Ripple wallet, you would enter:

{ "command": "wallet_propose", "passphrase": "test" }

Please remember that in this specific case you should use a randomly generated string of alphanumeric characters (at least 12-35 characters in length).


The JSON-RPC client that works the best with Chrome is the Postman extension found @

Within this extension, select POST and then enter the URL:


to access the rippled server. For example, if you wanted to receive account information about a specific Ripple address, click on the Body tab below the URL field and click on the Raw button. In the text field below, input:

{ "method": "account_info", "params": [ { "account": "rGgS5Hw3PhSp3VNT43PDTXze9YfdthHUH", "strict": true, "ledger_index": "validated" } ] }

To receive more information about this account.

For any issues you face with either of these APIs, you can ask for assistance @ on the Developers board.
Before posting a new thread regarding your issue, please use the search function as your answer might already exist.