package org.xrpl.rpc.v1

Get desktop application:
View/edit binary Protocol Buffers messages

RPCs available to interact with the XRP Ledger. The gRPC API mimics the JSON API. Refer to xrpl.org for documentation

• rpc GetAccountInfo (GetAccountInfoRequest, GetAccountInfoResponse)

  xrp_ledger.proto:23

  Get account info for an account on the XRP Ledger.

  message GetAccountInfoRequest

  get_account_info.proto:15

  A request to get info about an account. Next field: 6

  • optional AccountAddress account = 1

    The address to get info about.

  • bool strict = 2

  • optional LedgerSpecifier ledger = 3

    Which ledger to use to retrieve data. If this field is not set, the server will use the open ledger. The open ledger includes data that is not validated or final. To retrieve the most up to date and validated data, use SHORTCUT_VALIDATED

  • bool queue = 4

  • bool signer_lists = 5

  • string client_ip = 6

  message GetAccountInfoResponse

  get_account_info.proto:38

  Response to GetAccountInfo RPC Next field: 6

  • optional AccountRoot account_data = 1

  • optional SignerList signer_list = 2

  • uint32 ledger_index = 3

  • optional QueueData queue_data = 4

  • bool validated = 5

• rpc GetAccountTransactionHistory (GetAccountTransactionHistoryRequest, GetAccountTransactionHistoryResponse)

  xrp_ledger.proto:35

  Get all validated transactions associated with a given account

  message GetAccountTransactionHistoryRequest

  get_account_transaction_history.proto:12

  Next field: 8

  • optional AccountAddress account = 1

  • oneof ledger

    What ledger to include results from. Specifying a not yet validated ledger results in an error. Not specifying a ledger uses the entire range of validated ledgers available to the server. Note, this parameter acts as a filter, and can only reduce the number of results. Specifying a single ledger will return only transactions from that ledger. This includes specifying a ledger with a Shortcut. For example, specifying SHORTCUT_VALIDATED will result in only transactions that were part of the most recently validated ledger being returned. Specifying a range of ledgers results in only transactions that were included in a ledger within the specified range being returned.

    • LedgerSpecifier ledger_specifier = 2

    • LedgerRange ledger_range = 3

  • bool binary = 4

    Return results as binary blobs. Defaults to false.

  • bool forward = 5

    If set to true, returns values indexed by older ledger first. Default to false.

  • uint32 limit = 6

    Limit the number of results. Server may choose a lower limit. If this value is 0, the limit is ignored and the number of results returned is determined by the server

  • optional Marker marker = 7

    Marker to resume where previous request left off Used for pagination

  message GetAccountTransactionHistoryResponse

  get_account_transaction_history.proto:51

  Next field: 8

  • optional AccountAddress account = 1

  • uint32 ledger_index_min = 2

  • uint32 ledger_index_max = 3

  • uint32 limit = 4

  • optional Marker marker = 5

  • repeated GetTransactionResponse transactions = 6

  • bool validated = 7

• rpc GetFee (GetFeeRequest, GetFeeResponse)

  xrp_ledger.proto:26

  Get the fee for a transaction on the XRP Ledger.

  message GetFeeRequest

  get_fee.proto:11

  A request for the current transaction fee on the ledger. Next field: 1

  • string client_ip = 1

  message GetFeeResponse

  get_fee.proto:18

  Response to a GetFee RPC Next field: 8

  • uint64 current_ledger_size = 1

  • uint64 current_queue_size = 2

  • optional Fee fee = 3

  • uint64 expected_ledger_size = 4

  • uint32 ledger_current_index = 5

  • optional FeeLevels levels = 6

  • uint64 max_queue_size = 7

• rpc GetLedger (GetLedgerRequest, GetLedgerResponse)

  xrp_ledger.proto:42

  Get a specific ledger, optionally including transactions and any modified, added or deleted ledger objects

  message GetLedgerRequest

  get_ledger.proto:9

  • optional LedgerSpecifier ledger = 1

  • bool transactions = 2

    If true, include transactions contained in this ledger

  • bool expand = 3

    If true and transactions, include full transactions and metadata If false and transactions, include only transaction hashes

  • bool get_objects = 4

    If true, include state map difference between this ledger and the previous ledger. This includes all added, modified or deleted ledger objects

  • string client_ip = 5

    If the request needs to be forwarded from a reporting node to a p2p node, the reporting node will set this field. Clients should not set this field.

  • string user = 6

    Identifying string. If user is set, client_ip is not set, and request is coming from a secure_gateway host, then the client is not subject to resource controls

  • bool get_object_neighbors = 7

    For every object in the diff, get the object's predecessor and successor in the state map. Only used if get_objects is also true.

  message GetLedgerResponse

  get_ledger.proto:41

  • bytes ledger_header = 1

  • oneof transactions

    • TransactionHashList hashes_list = 2

      Just the hashes

    • TransactionAndMetadataList transactions_list = 3

      Full transactions and metadata

  • bool validated = 4

    True if the ledger has been validated

  • optional RawLedgerObjects ledger_objects = 5

    State map difference between this ledger and the previous ledger

  • bool skiplist_included = 6

    True if the skiplist object is included in ledger_objects

  • bool is_unlimited = 7

    True if request was exempt from resource controls

  • bool objects_included = 8

    True if the response contains the state map diff

  • bool object_neighbors_included = 9

    True if the response contains key of objects adjacent to objects in state map diff

  • repeated BookSuccessor book_successors = 10

    Successor information for book directories modified as part of this ledger

• rpc GetLedgerData (GetLedgerDataRequest, GetLedgerDataResponse)

  xrp_ledger.proto:48

  Iterate through all ledger objects in a specific ledger

  message GetLedgerDataRequest

  get_ledger_data.proto:11

  Get ledger objects for a specific ledger. You can iterate through several calls to retrieve the entire contents of a single ledger version.

  • bytes marker = 1

    If set, only objects with a key greater than marker are returned. This can be used to pick up where a previous call left off. Set marker to the value of marker in the previous response.

  • optional LedgerSpecifier ledger = 2

  • bytes end_marker = 3

    If set, only objects with a key less than end_marker are returned

  • string client_ip = 4

    If the request needs to be forwarded from a reporting node to a p2p node, the reporting node will set this field. Clients should not set this field.

  • string user = 6

    Identifying string. If user is set, client_ip is not set, and request is coming from a secure_gateway host, then the client is not subject to resource controls

  message GetLedgerDataResponse

  get_ledger_data.proto:34

  • uint32 ledger_index = 1

    Sequence of the ledger containing the returned ledger objects

  • bytes ledger_hash = 2

    Hash of the ledger containing the returned ledger objects

  • optional RawLedgerObjects ledger_objects = 3

    Ledger objects

  • bytes marker = 4

    Key to be passed into a subsequent call to continue iteration. If not set, there are no more objects left in the ledger, or no more objects with key less than end_marker (if end_marker was set in the request)

  • bool is_unlimited = 7

    True if request was exempt from resource controls

• rpc GetLedgerDiff (GetLedgerDiffRequest, GetLedgerDiffResponse)

  xrp_ledger.proto:52

  Get all ledger objects that are different between the two specified ledgers. Note, this method has no JSON equivalent.

  message GetLedgerDiffRequest

  get_ledger_diff.proto:11

  Get the state map difference between the two specified ledgers

  • optional LedgerSpecifier base_ledger = 1

  • optional LedgerSpecifier desired_ledger = 2

  • bool include_blobs = 3

    If true, include the full ledger object. If false, only keys are included.

  • string client_ip = 4

    If the request needs to be forwarded from a reporting node to a p2p node, the reporting node will set this field. Clients should not set this field.

  message GetLedgerDiffResponse

  get_ledger_diff.proto:26

  • optional RawLedgerObjects ledger_objects = 1

    All ledger objects that were added, modified or deleted between base_ledger and desired_ledger

• rpc GetLedgerEntry (GetLedgerEntryRequest, GetLedgerEntryResponse)

  xrp_ledger.proto:45

  Get a specific ledger object from a specific ledger

  message GetLedgerEntryRequest

  get_ledger_entry.proto:10

  Get a single ledger object

  • bytes key = 1

    Key of the desired object

  • optional LedgerSpecifier ledger = 2

    Ledger containing the object

  • string client_ip = 3

    If the request needs to be forwarded from a reporting node to a p2p node, the reporting node will set this field. Clients should not set this field.

  message GetLedgerEntryResponse

  get_ledger_entry.proto:24

  • optional RawLedgerObject ledger_object = 1

  • optional LedgerSpecifier ledger = 2

    Ledger containing the object. Will match the value specified in the request.

• rpc GetTransaction (GetTransactionRequest, GetTransactionResponse)

  xrp_ledger.proto:32

  Get the status of a transaction

  message GetTransactionRequest

  get_transaction.proto:13

  Next field: 4

  • bytes hash = 1

    hash of the transaction. 32 bytes ATTN: this is in binary, not hex. The JSON API accepts a hex string for a transaction hash, but here we need that hex string converted into its binary form. Each pair of hex characters should be converted into its corresponding byte. For example, the 4 character hex string "00FF" should be converted to a 2 byte array: [0, 255]

  • bool binary = 2

    if true, return data in binary format. defaults to false

  • optional LedgerRange ledger_range = 3

    If the transaction was not found, server will report whether the entire specified range was searched. The value is contained in the error message. The error message is of the form: "txn not found. searched_all = [true,false]" If the transaction was found, this parameter is ignored.

  • string client_ip = 4

• rpc SubmitTransaction (SubmitTransactionRequest, SubmitTransactionResponse)

  xrp_ledger.proto:29

  Submit a signed transaction to the XRP Ledger.

  message SubmitTransactionRequest

  submit.proto:11

  A request to submit the signed transaction to the ledger. Next field: 3

  • bytes signed_transaction = 1

    The signed transaction to submit.

  • bool fail_hard = 2

  • string client_ip = 3

  message SubmitTransactionResponse

  submit.proto:23

  A response when a signed transaction is submitted to the ledger. Next field: 5

  • optional TransactionResult engine_result = 1

    Code indicating the preliminary result of the transaction.

  • int64 engine_result_code = 2

    Numeric code indicating the preliminary result of the transaction, directly correlated to engine_result.

  • string engine_result_message = 3

    Human-readable explanation of the transaction's preliminary result.

  • bytes hash = 4

    32 bytes

Used in: AccountRoot, Check, DepositPreauthObject, Escrow, Offer, PayChannel, Signer, SignerEntry, TicketObject, Transaction

• optional AccountAddress value = 1

A representation of an account address Next field: 2

Used in: Account, Authorize, Destination, GetAccountInfoRequest, GetAccountTransactionHistoryRequest, GetAccountTransactionHistoryResponse, IssuedCurrencyAmount, Issuer, NFTokenMinter, Owner, Payment.PathElement, RegularKey, Unauthorize

• string address = 1

  base58 encoding of an account

Next field: 3

Used in: Transaction

• optional Destination destination = 1

• optional DestinationTag destination_tag = 2

Next field: 19

Used in: GetAccountInfoResponse, LedgerObject

• optional Account account = 1

• optional Balance balance = 2

• optional BurnedNFTokens burned_nftokens = 16

• optional Sequence sequence = 3

• optional Flags flags = 4

• optional OwnerCount owner_count = 5

• optional PreviousTransactionID previous_transaction_id = 6

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 7

• optional AccountTransactionID account_transaction_id = 8

• optional Domain domain = 9

• optional EmailHash email_hash = 10

• optional MessageKey message_key = 11

• optional MintedNFTokens minted_nftokens = 17

• optional NFTokenMinter nftoken_minter = 18

• optional RegularKey regular_key = 12

• optional TickSize tick_size = 13

• optional TicketCount ticket_count = 15

• optional TransferRate transfer_rate = 14

Next field: 9

Used in: Transaction

• optional ClearFlag clear_flag = 1

• optional Domain domain = 2

• optional EmailHash email_hash = 3

• optional MessageKey message_key = 4

• optional SetFlag set_flag = 5

• optional TransferRate transfer_rate = 6

• optional TickSize tick_size = 7

• optional NFTokenMinter nftoken_minter = 8

Used in: AccountRoot, Transaction

• bytes value = 1

  32 bytes

Next field: 6

Used in: Meta, SubmitMetadataRequest

• LedgerEntryType ledger_entry_type = 1

• bytes ledger_index = 2

  32 bytes

• oneof node

  • CreatedNode created_node = 3

  • DeletedNode deleted_node = 4

  • ModifiedNode modified_node = 5

Next field: 4

Used in: LedgerObject

• repeated Amendments.Amendment amendments = 1

• repeated Amendments.Majority majorities = 2

• optional Flags flags = 3

Next field: 2

Used in: Amendments, Majority

• bytes value = 1

  32 bytes

Next field: 3

Used in: Amendments

• optional Amendment amendment = 1

• optional CloseTime close_time = 2

Used in: CheckCash, Escrow, EscrowCreate, NFTokenCreateOffer, NFTokenOffer, PayChannel, Payment, PaymentChannelClaim, PaymentChannelCreate, PaymentChannelFund

• optional CurrencyAmount value = 1

  Note, CurrencyAmount is a oneof, that can represent an XRP drops amount or an Issued Currency amount. However, in some transaction types/ledger objects, this value can only be in drops. For instance, the Amount field of a Payment transaction can be specified in XRP drops or an Issued Currency amount, but the Amount field of a PaymentChannelClaim transaction can only be an XRP drops amount.

Used in: DepositPreauth, DepositPreauthObject

• optional AccountAddress value = 1

Used in: AccountRoot, PayChannel, PaymentChannelClaim, RippleState

• optional CurrencyAmount value = 1

Used in: FeeSettings

• uint64 value = 1

  in drops

Used in: Offer

• bytes value = 1

  32 btes

Used in: Offer

• uint64 value = 1

Successor information for book directories. The book base is (usually) not an actual object, yet we need to be able to ask for the successor to the book base.

Used in: GetLedgerResponse

• bytes book_base = 1

  Base of the book in question

• bytes first_book = 2

  First book directory in the book. An empty value here means the entire book is deleted

Used in: AccountRoot

• uint32 value = 1

Used in: Escrow, EscrowCreate, PayChannel, PaymentChannelCreate

• uint32 value = 1

  time in seconds since Ripple epoch

Used in: PaymentChannelClaim, PaymentChannelFund

• bytes value = 1

  32 bytes

Next field: 14

Used in: LedgerObject

• optional Account account = 1

• optional Destination destination = 2

• optional Flags flags = 3

• optional OwnerNode owner_node = 4

• optional PreviousTransactionID previous_transaction_id = 5

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 6

• optional SendMax send_max = 7

• optional Sequence sequence = 8

• optional DestinationNode destination_node = 9

• optional DestinationTag destination_tag = 10

• optional Expiration expiration = 11

• optional InvoiceID invoice_id = 12

• optional SourceTag source_tag = 13

Next field: 2

Used in: Transaction

• optional CheckID check_id = 1

Next field: 4

Used in: Transaction

• optional CheckID check_id = 1

• oneof amount_oneof

  • Amount amount = 2

  • DeliverMin deliver_min = 3

Next field: 6

Used in: Transaction

• optional Destination destination = 1

• optional SendMax send_max = 2

• optional DestinationTag destination_tag = 3

• optional Expiration expiration = 4

• optional InvoiceID invoice_id = 5

Used in: CheckCancel, CheckCash

• bytes value = 1

  32 bytes

Used in: AccountSet

• uint32 value = 1

Used in: Amendments.Majority

• uint32 value = 1

  time in seconds since Ripple epoch

Used in: Escrow, EscrowCreate, EscrowFinish

• bytes value = 1

Next field: 2

Used in: AffectedNode

• optional LedgerObject new_fields = 1

Next field: 3

Used in: IssuedCurrencyAmount, Payment.PathElement, TakerGetsCurreny, TakerPaysCurrency

• string name = 1

  3 character ASCII code

• bytes code = 2

  160 bit currency code. 20 bytes

Next field: 3

Used in: Amount, Balance, DeliverMin, DeliveredAmount, HighLimit, LimitAmount, LowLimit, NFTokenBrokerFee, SendMax, TakerGets, TakerPays

• oneof amount

  • XRPDropsAmount xrp_amount = 1

  • IssuedCurrencyAmount issued_currency_amount = 2

Used in: GetTransactionResponse

• uint32 value = 1

  time in seconds since Ripple epoch

Next field: 2

Used in: AffectedNode

• optional LedgerObject final_fields = 1

Used in: CheckCash, Payment

• optional CurrencyAmount value = 1

Used in: Meta

• optional CurrencyAmount value = 1

Next field: 3

Used in: Transaction

• oneof authorization_oneof

  • Authorize authorize = 1

  • Unauthorize unauthorize = 2

Next field: 7

Used in: LedgerObject

• optional Account account = 1

• optional Authorize authorize = 2

• optional Flags flags = 3

• optional OwnerNode owner_node = 4

• optional PreviousTransactionID previous_transaction_id = 5

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 6

Used in: AccountDelete, Check, CheckCreate, Escrow, EscrowCreate, NFTokenCreateOffer, NFTokenOffer, PayChannel, Payment, PaymentChannelCreate

• optional AccountAddress value = 1

Used in: Check, Escrow, PayChannel

• uint64 value = 1

Used in: AccountDelete, Check, CheckCreate, Escrow, EscrowCreate, PayChannel, Payment, PaymentChannelCreate

• uint32 value = 1

Next field: 12

Used in: LedgerObject

• optional Flags flags = 1

• optional RootIndex root_index = 2

• repeated Index indexes = 3

• optional IndexNext index_next = 4

• optional IndexPrevious index_previous = 5

• optional Owner owner = 6

• optional TakerPaysCurrency taker_pays_currency = 7

• optional TakerPaysIssuer taker_pays_issuer = 8

• optional TakerGetsCurreny taker_gets_currency = 9

• optional TakerGetsIssuer taker_gets_issuer = 10

• optional NFTokenID nftoken_id = 11

Next field: 3

Used in: NegativeUNL

• optional PublicKey public_key = 1

• optional FirstLedgerSequence ledger_sequence = 2

Used in: AccountRoot, AccountSet

• string value = 1

Used in: AccountRoot, AccountSet

• bytes value = 1

Next field: 14

Used in: LedgerObject

• optional Account account = 1

• optional Destination destination = 2

• optional Amount amount = 3

• optional Condition condition = 4

• optional CancelAfter cancel_after = 5

• optional FinishAfter finish_after = 6

• optional Flags flags = 7

• optional SourceTag source_tag = 8

• optional DestinationTag destination_tag = 9

• optional OwnerNode owner_node = 10

• optional DestinationNode destination_node = 11

• optional PreviousTransactionID previous_transaction_id = 12

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 13

Next field: 3

Used in: Transaction

• optional Owner owner = 1

• optional OfferSequence offer_sequence = 2

Next field: 7

Used in: Transaction

• optional Amount amount = 1

• optional Destination destination = 2

• optional CancelAfter cancel_after = 3

• optional FinishAfter finish_after = 4

• optional Condition condition = 5

• optional DestinationTag destination_tag = 6

Next field: 5

Used in: Transaction

• optional Owner owner = 1

• optional OfferSequence offer_sequence = 2

• optional Condition condition = 3

• optional Fulfillment fulfillment = 4

Used in: Check, CheckCreate, NFTokenCreateOffer, NFTokenOffer, Offer, OfferCreate, PayChannel, PaymentChannelFund

• uint32 value = 1

  time in seconds since Ripple epoch

Next field: 5

Used in: GetFeeResponse

• optional XRPDropsAmount base_fee = 1

• optional XRPDropsAmount median_fee = 2

• optional XRPDropsAmount minimum_fee = 3

• optional XRPDropsAmount open_ledger_fee = 4

Next field: 5

Used in: GetFeeResponse

• uint64 median_level = 1

• uint64 minimum_level = 2

• uint64 open_ledger_level = 3

• uint64 reference_level = 4

Next field: 6

Used in: LedgerObject

• optional BaseFee base_fee = 1

• optional ReferenceFeeUnits reference_fee_units = 2

• optional ReserveBase reserve_base = 3

• optional ReserveIncrement reserve_increment = 4

• optional Flags flags = 5

Used in: Escrow, EscrowCreate

• uint32 value = 1

  time in seconds since Ripple epoch

Used in: DisabledValidator

• uint32 value = 1

Used in: AccountRoot, Amendments, Check, DepositPreauthObject, DirectoryNode, Escrow, FeeSettings, LedgerHashes, NFTokenOffer, NFTokenPage, NegativeUNL, Offer, PayChannel, RippleState, SignerList, TicketObject, Transaction

• uint32 value = 1

Used in: EscrowFinish

• bytes value = 1

Next field: 9

Used as response type in: XRPLedgerAPIService.GetTransaction

Used as field type in: GetAccountTransactionHistoryResponse

• oneof serialized_transaction

  • Transaction transaction = 1

  • bytes transaction_binary = 2

    Variable length

• uint32 ledger_index = 3

  Sequence number of ledger that contains this transaction

• bytes hash = 4

  32 bytes

• bool validated = 5

  whether the ledger has been validated

• oneof serialized_meta

  metadata about the transaction

  • Meta meta = 6

  • bytes meta_binary = 7

    Variable length

• optional Date date = 8

Used in: LedgerHashes

• bytes value = 1

  32 bytes

Used in: RippleState

• optional CurrencyAmount value = 1

Used in: RippleState

• uint64 value = 1

Used in: RippleState

• uint32 value = 1

Used in: RippleState

• uint32 value = 1

Used in: DirectoryNode, NFTokenCancelOffer

• bytes value = 1

  32 bytes

Used in: DirectoryNode

• uint64 value = 1

Used in: DirectoryNode

• uint64 value = 1

Used in: Check, CheckCreate, Payment

• bytes value = 1

  32 bytes

A representation of an amount of issued currency. Next field: 4

Used in: CurrencyAmount

• optional Currency currency = 1

  The currency used to value the amount.

• string value = 2

  The value of the amount. 8 bytes

• optional AccountAddress issuer = 3

  Unique account address of the entity issuing the currency.

Used in: NFTokenMint

• optional AccountAddress value = 1

Used in: LedgerHashes, QueuedTransaction, Transaction

• uint32 value = 1

Next field: 15

Used in: AffectedNode

• LEDGER_ENTRY_TYPE_UNSPECIFIED = 0

• LEDGER_ENTRY_TYPE_ACCOUNT_ROOT = 1

• LEDGER_ENTRY_TYPE_AMENDMENTS = 2

• LEDGER_ENTRY_TYPE_CHECK = 3

• LEDGER_ENTRY_TYPE_DEPOSIT_PREAUTH = 4

• LEDGER_ENTRY_TYPE_DIRECTORY_NODE = 5

• LEDGER_ENTRY_TYPE_ESCROW = 6

• LEDGER_ENTRY_TYPE_FEE_SETTINGS = 7

• LEDGER_ENTRY_TYPE_LEDGER_HASHES = 8

• LEDGER_ENTRY_TYPE_OFFER = 9

• LEDGER_ENTRY_TYPE_PAY_CHANNEL = 10

• LEDGER_ENTRY_TYPE_RIPPLE_STATE = 11

• LEDGER_ENTRY_TYPE_SIGNER_LIST = 12

• LEDGER_ENTRY_TYPE_NEGATIVE_UNL = 13

• LEDGER_ENTRY_TYPE_TICKET = 14

• LEDGER_ENTRY_TYPE_NFTOKEN_OFFER = 15

• LEDGER_ENTRY_TYPE_NFTOKEN_PAGE = 16

Next field: 4

Used in: LedgerObject

• optional LastLedgerSequence last_ledger_sequence = 1

• repeated Hash hashes = 2

• optional Flags flags = 3

Next field: 17

Used in: CreatedNode, DeletedNode, ModifiedNode

• oneof object

  • AccountRoot account_root = 1

  • Amendments amendments = 2

  • Check check = 3

  • DepositPreauthObject deposit_preauth = 4

  • DirectoryNode directory_node = 5

  • Escrow escrow = 6

  • FeeSettings fee_settings = 7

  • LedgerHashes ledger_hashes = 8

  • NFTokenOffer nftoken_offer = 15

  • NFTokenPage nftoken_page = 16

  • Offer offer = 9

  • PayChannel pay_channel = 10

  • RippleState ripple_state = 11

  • SignerList signer_list = 12

  • NegativeUNL negative_unl = 13

  • TicketObject ticket = 14

Next field: 3

Used in: GetAccountTransactionHistoryRequest, GetTransactionRequest

• uint32 ledger_index_min = 1

• uint32 ledger_index_max = 2

  Note, if ledger_index_min is non-zero and ledger_index_max is 0, the software will use the max validated ledger in place of ledger_index_max

Next field: 4

Used in: GetAccountInfoRequest, GetAccountTransactionHistoryRequest, GetLedgerDataRequest, GetLedgerDiffRequest, GetLedgerEntryRequest, GetLedgerEntryResponse, GetLedgerRequest

• oneof ledger

  • LedgerSpecifier.Shortcut shortcut = 1

  • uint32 sequence = 2

  • bytes hash = 3

    32 bytes

Next field: 4

Used in: LedgerSpecifier

• SHORTCUT_UNSPECIFIED = 0

• SHORTCUT_VALIDATED = 1

• SHORTCUT_CLOSED = 2

• SHORTCUT_CURRENT = 3

Used in: TrustSet

• optional CurrencyAmount value = 1

Used in: RippleState

• optional CurrencyAmount value = 1

Used in: RippleState

• uint64 value = 1

Used in: RippleState

• uint32 value = 1

Used in: RippleState

• uint32 value = 1

Next field: 3

Used in: GetAccountTransactionHistoryRequest, GetAccountTransactionHistoryResponse

• uint32 ledger_index = 1

• uint32 account_sequence = 2

Next field: 4

Used in: Transaction

• optional MemoData memo_data = 1

• optional MemoFormat memo_format = 2

• optional MemoType memo_type = 3

Used in: Memo

• bytes value = 1

Used in: Memo

• bytes value = 1

Used in: Memo

• bytes value = 1

Used in: AccountRoot, AccountSet

• bytes value = 1

Next field: 5

Used in: GetTransactionResponse

• uint64 transaction_index = 1

  index in ledger

• optional TransactionResult transaction_result = 2

  result code indicating whether the transaction succeeded or failed

• repeated AffectedNode affected_nodes = 3

• optional DeliveredAmount delivered_amount = 4

Used in: AccountRoot

• uint32 value = 1

Next field: 5

Used in: AffectedNode

• optional LedgerObject final_fields = 1

• optional LedgerObject previous_fields = 2

• optional PreviousTransactionID previous_transaction_id = 3

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 4

Next field: 3

Used in: NFTokenPage

• optional NFTokenID nftoken_id = 1

• optional URI uri = 2

Next field: 4

Used in: Transaction

• optional NFTokenBrokerFee nftoken_broker_fee = 1

• optional NFTokenBuyOffer nftoken_buy_offer = 2

• optional NFTokenSellOffer nftoken_sell_offer = 3

Used in: NFTokenAcceptOffer

• optional CurrencyAmount value = 1

Next field: 3

Used in: Transaction

• optional Owner owner = 1

• optional NFTokenID nftoken_id = 2

Used in: NFTokenAcceptOffer

• bytes value = 1

  32 bytes

Next field: 2

Used in: Transaction

• repeated Index nftoken_offers = 1

Next field: 6

Used in: Transaction

• optional Amount amount = 1

• optional Destination destination = 2

• optional Expiration expiration = 3

• optional Owner owner = 4

• optional NFTokenID nftoken_id = 5

Used in: DirectoryNode, NFToken, NFTokenBurn, NFTokenCreateOffer, NFTokenOffer

• bytes value = 1

Next field: 5

Used in: Transaction

• optional Issuer issuer = 1

• optional NFTokenTaxon nftoken_taxon = 2

• optional TransferFee transfer_fee = 3

• optional URI uri = 4

Used in: AccountRoot, AccountSet

• optional AccountAddress value = 1

Next field: 11

Used in: LedgerObject

• optional Flags flags = 1

• optional Owner owner = 2

• optional NFTokenID nftoken_id = 3

• optional Amount amount = 4

• optional OwnerNode owner_node = 5

• optional NFTokenOfferNode nftoken_offer_node = 6

• optional Destination destination = 7

• optional Expiration expiration = 8

• optional PreviousTransactionID previous_transaction_id = 9

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 10

Used in: NFTokenOffer

• uint64 value = 1

Next field: 7

Used in: LedgerObject

• optional Flags flags = 1

• optional PreviousPageMin previous_page_min = 2

• optional NextPageMin next_page_min = 3

• repeated NFToken nftokens = 4

• optional PreviousTransactionID previous_transaction_id = 5

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 6

Used in: NFTokenAcceptOffer

• bytes value = 1

  32 bytes

Used in: NFTokenMint

• uint32 value = 1

Next field: 5

Used in: LedgerObject

• repeated DisabledValidator disabled_validators = 1

• optional ValidatorToDisable validator_to_disable = 2

• optional ValidatorToReEnable validator_to_re_enable = 3

• optional Flags flags = 4

Used in: NFTokenPage

• bytes value = 1

  32 bytes

Next field: 12

Used in: LedgerObject

• optional Account account = 1

• optional Sequence sequence = 2

• optional Flags flags = 3

• optional TakerPays taker_pays = 4

• optional TakerGets taker_gets = 5

• optional BookDirectory book_directory = 6

• optional BookNode book_node = 7

• optional OwnerNode owner_node = 8

• optional Expiration expiration = 9

• optional PreviousTransactionID previous_transaction_id = 10

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 11

Next field: 2

Used in: Transaction

• optional OfferSequence offer_sequence = 1

Next field: 5

Used in: Transaction

• optional Expiration expiration = 1

• optional OfferSequence offer_sequence = 2

• optional TakerGets taker_gets = 3

• optional TakerPays taker_pays = 4

Used in: EscrowCancel, EscrowFinish, OfferCancel, OfferCreate

• uint32 value = 1

Used in: DirectoryNode, EscrowCancel, EscrowFinish, NFTokenBurn, NFTokenCreateOffer, NFTokenOffer

• optional AccountAddress value = 1

Used in: AccountRoot

• uint32 value = 1

Used in: Check, DepositPreauthObject, Escrow, NFTokenOffer, Offer, PayChannel, SignerList, TicketObject

• uint64 value = 1

Next field: 13

Used in: LedgerObject

• optional Account account = 1

• optional Destination destination = 2

• optional Amount amount = 3

• optional Balance balance = 4

• optional PublicKey public_key = 5

• optional SettleDelay settle_delay = 6

• optional OwnerNode owner_node = 7

• optional PreviousTransactionID previous_transaction_id = 8

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 9

• optional Flags flags = 10

• optional Expiration expiration = 11

• optional CancelAfter cancel_after = 12

• optional SourceTag source_tag = 13

• optional DestinationTag destination_tag = 14

• optional DestinationNode destination_node = 15

Next field: 8

Used in: Transaction

• optional Amount amount = 1

• optional Destination destination = 2

• optional DestinationTag destination_tag = 3

• optional InvoiceID invoice_id = 4

• repeated Payment.Path paths = 5

• optional SendMax send_max = 6

• optional DeliverMin deliver_min = 7

Next field: 2

Used in: Payment

• repeated PathElement elements = 1

Next field: 4

Used in: Path

• optional AccountAddress account = 1

• optional Currency currency = 2

• optional AccountAddress issuer = 3

Next field: 6

Used in: Transaction

• optional Channel channel = 1

• optional Balance balance = 2

• optional Amount amount = 3

• optional PaymentChannelSignature payment_channel_signature = 4

• optional PublicKey public_key = 5

Next field: 7

Used in: Transaction

• optional Amount amount = 1

• optional Destination destination = 2

• optional SettleDelay settle_delay = 3

• optional PublicKey public_key = 4

• optional CancelAfter cancel_after = 5

• optional DestinationTag destination_tag = 6

Next field: 4

Used in: Transaction

• optional Channel channel = 1

• optional Amount amount = 2

• optional Expiration expiration = 3

Used in: PaymentChannelClaim

• bytes value = 1

• uint32 ledger_index = 1

• bool success = 1

• string msg = 2

Used in: NFTokenPage

• bytes value = 1

  32 bytes

Used in: AccountRoot, Check, DepositPreauthObject, Escrow, ModifiedNode, NFTokenOffer, NFTokenPage, Offer, PayChannel, RippleState, SignerList, TicketObject

• bytes value = 1

  32 bytes

Used in: AccountRoot, Check, DepositPreauthObject, Escrow, ModifiedNode, NFTokenOffer, NFTokenPage, Offer, PayChannel, RippleState, SignerList, TicketObject

• uint32 value = 1

Used in: DisabledValidator, PayChannel, PaymentChannelClaim, PaymentChannelCreate

• bytes value = 1

Used in: TrustSet

• uint32 value = 1

Used in: TrustSet

• uint32 value = 1

Aggregate data about queued transactions Next field: 11

Used in: GetAccountInfoResponse

• uint32 txn_count = 1

• bool auth_change_queued = 2

• uint32 lowest_sequence = 3

• uint32 highest_sequence = 4

• optional XRPDropsAmount max_spend_drops_total = 5

• repeated QueuedTransaction transactions = 6

• uint32 lowest_ticket = 7

• uint32 highest_ticket = 8

• uint32 sequence_count = 9

• uint32 ticket_count = 10

Data about a single queued transaction Next field: 8

Used in: QueueData

• bool auth_change = 1

• optional XRPDropsAmount fee = 2

• uint64 fee_level = 3

• optional XRPDropsAmount max_spend_drops = 4

• optional Sequence sequence = 5

• optional LastLedgerSequence last_ledger_sequence = 6

• optional Ticket ticket = 7

Next field: 3

Used in: GetLedgerEntryResponse, RawLedgerObjects

• bytes data = 1

  Raw data of the ledger object. In GetLedgerResponse and GetLedgerDiffResponse, data will be empty if the object was deleted.

• bytes key = 2

  Key of the ledger object

• RawLedgerObject.ModificationType mod_type = 3

  Whether the object was created, modified or deleted

• bytes predecessor = 4

  Key of the object preceding this object in the desired ledger

• bytes successor = 5

  Key of the object succeeding this object in the desired ledger

Used in: RawLedgerObject

• UNSPECIFIED = 0

• CREATED = 1

• MODIFIED = 2

• DELETED = 3

Used in: GetLedgerDataResponse, GetLedgerDiffResponse, GetLedgerResponse

• repeated RawLedgerObject objects = 1

Used in: FeeSettings

• uint32 value = 1

Used in: AccountRoot, SetRegularKey

• optional AccountAddress value = 1

Used in: FeeSettings

• uint32 value = 1

  in drops

Used in: FeeSettings

• uint32 value = 1

  in drops

Next field: 13

Used in: LedgerObject

• optional Balance balance = 1

• optional Flags flags = 2

• optional LowLimit low_limit = 3

• optional HighLimit high_limit = 4

• optional LowNode low_node = 5

• optional HighNode high_node = 6

• optional LowQualityIn low_quality_in = 7

• optional LowQualityOut low_quality_out = 8

• optional HighQualityIn high_quality_in = 9

• optional HighQualityOut high_quality_out = 10

• optional PreviousTransactionID previous_transaction_id = 11

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 12

Used in: DirectoryNode

• bytes value = 1

  32 bytes

Used in: Check, CheckCreate, Payment

• optional CurrencyAmount value = 1

Used in: AccountRoot, Check, Offer, QueuedTransaction, Transaction

• uint32 value = 1

Used in: AccountSet

• uint32 value = 1

Next field: 2

Used in: Transaction

• optional RegularKey regular_key = 1

Used in: PayChannel, PaymentChannelCreate

• uint32 value = 1

Next field: 4

Used in: Transaction

• optional Account account = 1

• optional TransactionSignature transaction_signature = 2

• optional SigningPublicKey signing_public_key = 3

Next field: 3

Used in: SignerList, SignerListSet

• optional Account account = 1

• optional SignerWeight signer_weight = 2

• optional WalletLocator wallet_locator = 3

Next field: 8

Used in: GetAccountInfoResponse, LedgerObject

• optional Flags flags = 1

• optional PreviousTransactionID previous_transaction_id = 2

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 3

• optional OwnerNode owner_node = 4

• repeated SignerEntry signer_entries = 5

• optional SignerListID signer_list_id = 6

• optional SignerQuorum signer_quorum = 7

Used in: SignerList

• uint32 value = 1

Next field: 3

Used in: Transaction

• optional SignerQuorum signer_quorum = 1

• repeated SignerEntry signer_entries = 2

Used in: SignerList, SignerListSet

• uint32 value = 1

Used in: SignerEntry

• uint32 value = 1

  is actually uint16

Used in: Signer, Transaction

• bytes value = 1

Used in: Check, Escrow, PayChannel, Transaction

• uint32 value = 1

• repeated AffectedNode affected_nodes = 1

• uint32 ledger_sequence = 2

• bool success = 1

• string msg = 2

Used in: Offer, OfferCreate

• optional CurrencyAmount value = 1

*** Messages wrapping a Currency value *** TODO: if there's a V2 of the API, fix this misspelling.

Used in: DirectoryNode

• optional Currency value = 1

Used in: DirectoryNode

• bytes value = 1

  20 bytes

Used in: Offer, OfferCreate

• optional CurrencyAmount value = 1

Used in: DirectoryNode

• optional Currency value = 1

Used in: DirectoryNode

• bytes value = 1

  20 bytes

Used in: AccountRoot, AccountSet

• uint32 value = 1

  is actually uint8

Used in: QueuedTransaction

• uint32 value = 1

Used in: AccountRoot, TicketCreate

• uint32 value = 1

Next field: 2

Used in: Transaction

• optional TicketCount count = 1

Next field: 7

Used in: LedgerObject

• optional Flags flags = 1

• optional Account account = 2

• optional OwnerNode owner_node = 3

• optional PreviousTransactionID previous_transaction_id = 4

• optional PreviousTransactionLedgerSequence previous_transaction_ledger_sequence = 5

• optional TicketSequence ticket_sequence = 6

Used in: TicketObject, Transaction

• uint32 value = 1

A message encompassing all transaction types Next field: 37

Used in: GetTransactionResponse

• optional Account account = 1

• optional XRPDropsAmount fee = 2

• optional Sequence sequence = 3

• oneof transaction_data

  Data specific to the type of transaction

  • Payment payment = 4

  • AccountSet account_set = 13

  • AccountDelete account_delete = 14

  • CheckCancel check_cancel = 15

  • CheckCash check_cash = 16

  • CheckCreate check_create = 17

  • DepositPreauth deposit_preauth = 18

  • EscrowCancel escrow_cancel = 19

  • EscrowCreate escrow_create = 20

  • EscrowFinish escrow_finish = 21

  • NFTokenAcceptOffer nftoken_accept_offer = 32

  • NFTokenBurn nftoken_burn = 33

  • NFTokenCancelOffer nftoken_cancel_offer = 34

  • NFTokenCreateOffer nftoken_create_offer = 35

  • NFTokenMint nftoken_mint = 36

  • OfferCancel offer_cancel = 22

  • OfferCreate offer_create = 23

  • PaymentChannelClaim payment_channel_claim = 24

  • PaymentChannelCreate payment_channel_create = 25

  • PaymentChannelFund payment_channel_fund = 26

  • SetRegularKey set_regular_key = 27

  • SignerListSet signer_list_set = 28

  • TicketCreate ticket_create = 30

  • TrustSet trust_set = 29

• optional SigningPublicKey signing_public_key = 5

• optional TransactionSignature transaction_signature = 6

• optional Flags flags = 7

• optional LastLedgerSequence last_ledger_sequence = 8

• optional SourceTag source_tag = 9

• repeated Memo memos = 10

• repeated Signer signers = 11

• optional AccountTransactionID account_transaction_id = 12

• optional TicketSequence ticket_sequence = 31

Used in: TransactionAndMetadataList

• bytes transaction_blob = 1

• bytes metadata_blob = 2

Used in: GetLedgerResponse

• repeated TransactionAndMetadata transactions = 1

Used in: GetLedgerResponse

• repeated bytes hashes = 1

Next field: 3

Used in: Meta, SubmitTransactionResponse

• TransactionResult.ResultType result_type = 1

  category of the transaction result

• string result = 2

  full result string, i.e. tesSUCCESS

Next field: 7

Used in: TransactionResult

• RESULT_TYPE_UNSPECIFIED = 0

• RESULT_TYPE_TEC = 1

  Claimed cost only

• RESULT_TYPE_TEF = 2

  Failure

• RESULT_TYPE_TEL = 3

  Local error

• RESULT_TYPE_TEM = 4

  Malformed transaction

• RESULT_TYPE_TER = 5

  Retry

• RESULT_TYPE_TES = 6

  Success

Used in: Signer, Transaction

• bytes value = 1

Used in: NFTokenMint

• uint32 value = 1

  is actually uint16

Used in: AccountRoot, AccountSet

• uint32 value = 1

Next field: 4

Used in: Transaction

• optional LimitAmount limit_amount = 1

• optional QualityIn quality_in = 2

• optional QualityOut quality_out = 3

Used in: NFToken, NFTokenMint

• string value = 1

Used in: DepositPreauth

• optional AccountAddress value = 1

Used in: NegativeUNL

• bytes value = 1

Used in: NegativeUNL

• bytes value = 1

Used in: SignerEntry

• bytes value = 1

  32 bytes

A representation of an amount of XRP. Next field: 2

Used in: CurrencyAmount, Fee, QueueData, QueuedTransaction, Transaction

• uint64 drops = 1