WSS

Account methods

account_channels

Returns information about an account's payment channels.

wss://xrp.nownodes.io/wss/{{api-key}}

Example body (raw)

{
  "command": "account_channels",
  "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
  "destination_account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
  "ledger_index": "validated"
}

Example response: 200

{
    "result": {
        "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
        "channels": [
            {
                "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn",
                "amount": "1000",
                "balance": "0",
                "channel_id": "C7F634794B79DB40E87179A9D1BF05D05797AE7E92DF8E93FD6656E8C4BE3AE7",
                "destination_account": "ra5nK24KXen9AHvsdFTKHSANinZseWnPcX",
                "public_key": "aBR7mdD75Ycs8DRhMgQ4EMUEmBArF8SEh1hfjrT2V9DQTLNbJVqw",
                "public_key_hex": "03CFD18E689434F032A4E84C63E2A3A6472D684EAF4FD52CA67742F3E24BAE81B2",
                "settle_delay": 60
            }
        ],
        "ledger_hash": "223755E7E4297B1EBA1B29C01733080534E1A77A13909BC84FF8B8AA70E8D714",
        "ledger_index": 100669309,
        "validated": true
    },
    "status": "success",
    "type": "response"
}

account_currencies

Retrieves a list of currencies that an account can send or receive, based on its trust lines.

Example body (raw)

Example response: 200

account_info

Retrieves information about an account, its activity, and its XRP balance.

Example body (raw)

Example response: 200

account_lines

Retrieves information about an account's trust lines, including balances for all non-XRP currencies and assets.

Example body (raw)

Example response: 200

account_nfts

Retrieves NFTs owned by an account.

Example body (raw)

Example response: 200

account_objects

Returns the raw ledger format for all objects owned by an account.

Example body (raw)

Example response: 200

account_offers

Retrieves a list of offers made by a given account that are outstanding as of a particular ledger version.

Example body (raw)

Example response: 200

account_tx

Retrieves a list of transactions that affected the specified account.

Example body (raw)

Example response: 200

gateway_balances

Calculates the total balances issued by a given account, optionally excluding amounts held by operational addresses.

Example body (raw)

Example response: 200

noripple_check

Compares an account's Default Ripple and No Ripple flags to the recommended settings.

Example body (raw)

Example response: 200

Ledger methods

ledger

Retrieves information about the public ledger.

Example body (raw)

Example response: 200

ledger_closed

Returns the unique identifiers of the most recently closed ledger.

Example body (raw)

Example response: 200

ledger_current

Returns the unique identifiers of the current in-progress ledger.

Example body (raw)

Example response: 200

ledger_data

Retrieves contents of the specified ledger.

Example body (raw)

Example response: 200

Transaction methods

simulate

Executes a dry run of any transaction type, enabling you to preview the results and metadata of a transaction without committing them to the XRP Ledger.

Example body (raw)

Example response: 200

submit

Submits a transaction to the network to be confirmed and included in future ledgers.

Example body (raw)

Example response: 200

submit_multisigned

Submits a multi-signed transaction to the network to be confirmed and included in future ledgers.

Example body (raw)

Example response: 200

transaction_entry

Retrieves information on a single transaction from a specific ledger version.

Example body (raw)

Example response: 200

tx

Retrieves information on a single transaction.

Example body (raw)

Example response: 200

Path and DEX Methods

amm_info

Looks up info on an Automated Market Maker instance.

Example body (raw)

Example response: 200

book_changes

Reports changes to the order books that occurred in a specific ledger version.

Example body (raw)

Example response: 200

book_offers

Retrieves a list of offers, also known as the order book, between two currencies.

Example body (raw)

Example response: 200

deposit_authorized

Checks whether one account is authorized to send payments directly to another.

Example body (raw)

Example response: 200

get_aggregate_price

Retrieves the aggregate price of specified Oracle objects, returning three price statistics: mean, median, and trimmed mean.

Example body (raw)

Example response: 200

path_find

Returns information about a uncle of a block by number and uncle index position.

Example body (raw)

Example response: 200

Payment Channel Methods

channel_verify

Checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel.

Example body (raw)

Example response: 200

Subscription Methods

subscribe

Requests periodic notifications from the server when certain events happen.

Example body (raw)

Example response: 200

unsubscribe

Tells the server to stop sending messages for a particular subscription or set of subscriptions.

Example body (raw)

Example response: 200

Server Info Methods

fee

Reports the current state of the open-ledger requirements for the transaction cost.

Example body (raw)

Example response: 200

manifest

Look up manifest information for a given validator public key.

Example body (raw)

Example response: 200

server_definitions

Returns an SDK-compatible definitions.json, generated from the rippled server being queried.

Example body (raw)

Example response: 200

server_info

Reports a human-readable version of various information about the rippled server being queried.

Example body (raw)

Example response: 200

server_state

Reports a machine-readable version of various information about the rippled server being queried.

Example body (raw)

Example response: 200

version

Retrieves the API version information. When you connect to a cluster that includes a Clio server, the Clio method is used.

Example body (raw)

Example response: 200

feature

Returns information about amendments this server knows about. When you connect to a cluster that includes a Clio server, the Clio method is used.

Example body (raw)

Example response: 200

Last updated