XRP Ledger (Ripple)
XRP Ledger JSON-RPC API (rippled and Clio servers): accounts, XRP and token balances, trust lines, transactions, ledgers, DEX order books, AMMs, NFTs, MPTs, fees and server status, plus simulating and submitting signed transactions.
Authentication
This connector uses Token-based authentication.
info
Set up your connection in the Abstra Console before using it in your workflows.
How to use
Using the Smart Chat
Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".
Using the Web Editor
from abstra.connectors import run_connection_action
result = run_connection_action(
connection_name="your_connection_name",
action_name="your_action_name",
params={
"param1": "value1",
"param2": "value2"
})
Available Actions
This connector provides 44 actions:
| Action | Purpose | Parameters |
|---|---|---|
| account_channels | Returns information about an account's Payment Channels where the account is the channel's source/owner not the destination, relative to a particular ledger version. | account (string) required destination_account (string) ledger_hash (string) ledger_index limit (integer) marker |
| account_currencies | Retrieves a list of currencies that an account can send or receive, based on its trust lines. | account (string) required ledger_hash (string) ledger_index |
| account_info | Retrieves information about an account, its activity, and its XRP balance account_data.Balance, in drops relative to a particular ledger version. | account (string) required ledger_hash (string) ledger_index queue (boolean) signer_lists (boolean) |
| account_lines | Returns information about an account's trust lines, which contain balances in all non-XRP currencies and assets, relative to a particular ledger version. | account (string) required ignore_default (boolean) ledger_hash (string) ledger_index limit (integer) marker peer (string) |
| account_nfts | Returns a list of NFToken objects owned by the specified account. | account (string) required ledger_hash (string) ledger_index limit (integer) marker |
| account_objects | Returns all ledger entries owned by an account offers, escrows, checks, trust lines, payment channels, tickets, etc., in their raw ledger format. | account (string) required deletion_blockers_only (boolean) ledger_hash (string) ledger_index limit (integer) marker sponsored (boolean) type (string) |
| account_offers | Retrieves a list of offers made by a given account that are outstanding as of a particular ledger version. | account (string) required ledger_hash (string) ledger_index limit (integer) marker |
| account_tx | Retrieves a list of validated transactions that involve a given account, newest first by default. Paginate with marker. | account (string) required tx_type (string) mpt_issuance_id (string) ledger_index_min (integer) ledger_index_max (integer) ledger_hash (string) ledger_index binary (boolean) forward (boolean) limit (integer) marker delegate: { . delegate_filter (string) . counter_party (string) } (object) |
| gateway_balances | Calculates the total balances of trust line tokens issued by a given account, optionally excluding amounts held by operational addresses. Does not support MPTs. | account (string) required strict (boolean) hotwallet ledger_hash (string) ledger_index |
| noripple_check | Checks the Default Ripple setting of an account and the No Ripple flag of its trust lines against the recommended settings for its role. | account (string) required role (string) required transactions (boolean) limit (integer) ledger_hash (string) ledger_index |
| ledger | Retrieves information about a ledger version: header, and optionally its transactions. | ledger_hash (string) ledger_index transactions (boolean) expand (boolean) owner_funds (boolean) binary (boolean) queue (boolean) diff (boolean) |
| ledger_closed | Returns the hash and index of the most recently closed ledger not necessarily validated yet. | No parameters |
| ledger_current | Returns the index of the current in-progress ledger. Mostly useful for testing, since that ledger is still in flux. | No parameters |
| ledger_data | Retrieves the contents ledger entries of the specified ledger, one page at a time. Paginate with marker. | ledger_hash (string) ledger_index binary (boolean) limit (integer) marker type (string) |
| ledger_entry | Returns a single ledger entry in its raw format. Provide exactly one selector field index, account_root, offer, ripple_state, escrow, check, payment_channel, amm, ... to choose which entry to retrieve. | binary (boolean) ledger_hash (string) ledger_index include_deleted (boolean) index (string) account_root (string) amendments amm bridge: { . IssuingChainDoor (string) . IssuingChainIssue (object) . LockingChainDoor (string) . LockingChainIssue (object) } (object) bridge_account (string) check (string) credential deposit_preauth did (string) directory escrow fee hashes loan loan_broker mptoken mpt_issuance (string) nunl nft_page (string) nft_offer (string) offer oracle: { . account (string) . oracle_document_id (integer) } (object) payment_channel (string) permissioned_domain ripple_state: { . accounts (array) . currency (string) } (object) signer_list (string) sponsorship ticket xchain_owned_claim_id xchain_owned_create_account_claim_id vault (string) |
| simulate | Executes a dry run of any transaction type and returns the expected result and metadata without submitting it to the network no fees. Provide either tx_json or tx_blob. | tx_blob (string) tx_json (object) binary (boolean) |
| submit | Submits an already signed transaction hex blob to the network to be confirmed and included in future ledgers. The response is only the preliminary result; check the final outcome with tx. Sign the transaction before calling this action; server-side signing is not exposed. | tx_blob (string) required fail_hard (boolean) |
| submit_multisigned | Submits a multi-signed transaction in JSON format with its Signers array to the network. | tx_json (object) required fail_hard (boolean) |
| transaction_entry | Retrieves a single transaction from a specific ledger version. Prefer tx, which searches all ledgers. | ledger_hash (string) ledger_index tx_hash (string) required |
| tx | Retrieves a single transaction by its hash or its CTID, with its metadata and whether it is validated. Provide either transaction or ctid. | transaction (string) ctid (string) binary (boolean) min_ledger (integer) max_ledger (integer) |
| amm_info | Gets information about an Automated Market Maker AMM instance. Identify it by asset + asset2 or by amm_account. | account (string) amm_account (string) asset: { . currency (string) . issuer (string) . mpt_issuance_id (string) } (object) asset2: { . currency (string) . issuer (string) . mpt_issuance_id (string) } (object) ledger_hash (string) ledger_index |
| book_changes | Reports changes to the order books in the decentralized exchange DEX compared with the previous ledger version volumes, high/low/open/close rates. Useful for candlestick charts. | ledger_hash (string) ledger_index |
| book_offers | Retrieves the order book between two currencies offers that take taker_pays and give taker_gets. Unfunded offers are omitted. | taker_gets: { . currency (string) . issuer (string) . mpt_issuance_id (string) } (object) required taker_pays: { . currency (string) . issuer (string) . mpt_issuance_id (string) } (object) required domain (string) ledger_hash (string) ledger_index limit (integer) taker (string) |
| deposit_authorized | Indicates whether one account is authorized to send payments directly to another Deposit Authorization. | source_account (string) required destination_account (string) required ledger_hash (string) ledger_index credentials (array) |
| get_aggregate_price | Retrieves the aggregate price mean, median and trimmed mean of the given price Oracle objects. | base_asset (string) required quote_asset (string) required trim (integer) trim_threshold (integer) oracles (array) required |
| nft_buy_offers | Returns a list of buy offers for a given NFToken. | nft_id (string) required ledger_hash (string) ledger_index limit (integer) marker |
| nft_sell_offers | Returns a list of sell offers for a given NFToken. | nft_id (string) required ledger_hash (string) ledger_index limit (integer) marker |
| ripple_path_find | Finds a payment path between two accounts for a cross-currency payment, in a single response. | source_account (string) required destination_account (string) required destination_amount required domain (string) ledger_hash (string) ledger_index send_max source_currencies (array) |
| channel_verify | Checks the validity of a signature that can be used to redeem a specific amount of XRP from a payment channel. | amount (string) required channel_id (string) required public_key (string) required signature (string) required |
| feature | Returns information about amendments this server knows about, including whether they are enabled. | feature (string) |
| fee | Reports the current transaction cost requirements base, median, minimum and open-ledger fees in drops and queue state. | No parameters |
| manifest | Reports the current manifest information for a given validator public key. | public_key (string) required |
| server_definitions | Returns an SDK-compatible definitions.json used to serialize/deserialize the binary format of this network. | hash (string) |
| server_info | Returns human-readable status of the server rippled or Clio: version, validated ledger, complete ledger range, load and reserves. | counters (boolean) |
| server_state | Returns machine-readable status of the server; like server_info, but with integer drops and milliseconds. | No parameters |
| version | Returns the range of API versions supported by the server. | No parameters |
| ping | Returns an acknowledgement, to test connection status and latency. | No parameters |
| random | Returns a random 256-bit number from the server, as a source of entropy. | No parameters |
| ledger_index | Clio only Looks up the last closed ledger at a given real-world time, to correlate off-chain events with ledger history. | date (string) |
| mpt_holders | Clio only Returns all holders of a Multi-Purpose Token MPT and their balances. Paginate with marker. | mpt_issuance_id (string) required ledger_index ledger_hash (string) marker limit (integer) |
| nft_history | Clio only Returns past transaction metadata mints, transfers, offers, burns for an NFT. | nft_id (string) required ledger_index_min (integer) ledger_index_max (integer) ledger_hash (string) ledger_index binary (boolean) forward (boolean) limit (integer) marker |
| nft_info | Clio only Returns information about an NFT: owner, issuer, flags, transfer fee, taxon, URI and whether it is burned. | nft_id (string) required ledger_hash (string) ledger_index |
| nfts_by_issuer | Clio only Returns the NFTs issued by an account, optionally filtered by taxon. Paginate with marker. | issuer (string) required marker nft_taxon (integer) ledger_hash (string) ledger_index limit (integer) |
| vault_info | Retrieves information about a vault: owner, available assets and issued shares. Identify it by vault_id or by owner + seq. | vault_id (string) owner (string) seq (integer) |