Skip to main content

API

This section contains the JSON-RPC API technical documentation for Ripple wallets.

info

Click here to learn how to authenticate and send JSON-RPC requests.

Endpoint​

The JSON-RPC API is exposed at https://api.coinrpc.com/ripple.

Transaction Object​

Below describes a transaction object returned by some API methods.

  • amount: (string) The amount of tokens transacted.
  • block_number: (int) The number of the block containing the transaction. null when transaction is not yet in a block.
  • category: (string) The type of transaction. SEND or RECEIVE.
  • comment: (string) Optional comment only visible to the wallet owner.
  • confirmed_at: (int) The unix timestamp of when the transaction was confirmed by the platform. null when status is PENDING.
  • created_at: (int) The unix timestamp of when the transaction was first seen by the platform.
  • currency: (string) The currency_id of tokens transacted.
  • destination_tag: (int) The destination tag on the blockchain. null if not attached to the transaction.
  • guid: (string) The unique transaction ID on the platform.
  • invoice_id: (string) The invoice ID on the blockchain. null if not attached to the transaction.
  • network_fee: (string) The network fee paid for the transaction. Paid in ETH.
  • recipient: (string) The address of the receipient.
  • sender: (string) The address of the sender.
  • service_fee: (string) The service fee paid for the transaction. Paid in currency. If SEND, the service fee is paid in addition to the amount. If RECEIVE, the service fee is paid from the amount.
  • status: (string) The status of the transaction. PENDING, SUCCESS or FAILED.
  • tx_hash: (string) The transaction hash on the blockchain.
{
  "amount": "5",
  "block_number": 41466463,
  "category": "RECEIVE",
  "comment": "my transaction",
  "confirmed_at": 1698953511,
  "created_at": 1698953511,
  "currency": "XRP",
  "destination_tag": 123,
  "guid": "ABCD1234ABCD",
  "invoice_id": null,
  "network_fee": "0.135",
  "recipient": "rpxH1mgodXi34x7GxTk6m8TmShgc8xuwSt",
  "sender": "rEaQjaTqgnRfqPe5wEofF4iXjyj7h6P8S4",
  "service_fee": "0",
  "status": "SUCCESS",
  "tx_hash": "657815F047F04B6289B1DAB76FBE1BAA251DBA671683F0A5B48B10AB26FEE353",
}