A simplified RESTful API for interfacing with the Ripple Network.

See the Guide and the API Reference for details on how to use the API.

A test version of the API can be found at https://ripple-rest.herokuapp.com. Even though it supports HTTPS connections, only submit transactions from test accounts, we make NO GUARANTEES about the security of your secret keys on this server.

To install or update ripple-rest locally:

1. Before getting started, make sure you have Node.js and PostgreSQL installed on your computer. Also make sure you have a running PostgreSQL instance (see this page or the documentation that comes with the installer for how to do this on your operating system).
2. Run git clone https://github.com/ripple/ripple-rest.git to install for the first time or git pull to update
3. Continue with the default settings or configure the config.json or the environment variables to point to your rippled and PostgreSQL instance. Ripple Labs's rippled cluster s_west.ripple.com is used by default. If you have just installed PostgreSQL the default setting should work for you.
4. Run npm install; ./node_modules/grunt-cli/bin/grunt dbsetup to setup the database
5. Run node server.js to start the server

npm test

This API is still in beta. Please open issues for any problems you encounter.

1. Amount
2. Payment
3. Notification

1. Notifications
   • GET /api/v1/addresses/:address/next_notification
   • GET /api/v1/addresses/:address/next_notification/:prev_tx_hash
2. Payments
   • GET /api/v1/addresses/:address/payments/:dst_address/:dst_amount
   • POST /api/v1/addresses/:address/payments
   • GET /api/v1/addresses/:address/payments/:tx_hash
3. Standard Ripple Transactions
   • GET /api/v1/addresses/:address/txs/:tx_hash
4. Server Info
   • GET /api/v1/status