Home

simulate

POST
https://xrp.nownodes.io/

Authorizations

ApiKeyAuthApiKeyAuth

api-key string

NOWNodes API key passed in the api-key header.

Simulates a transaction without actually submitting it to the network. This method allows you to test transaction outcomes, check for errors, and see the exact ledger changes that would occur if the transaction were executed. The simulation runs against the current working ledger state.

Body

application/json

Simulates a transaction without actually submitting it to the network. This method allows you to test transaction outcomes, check for errors, and see the exact ledger changes that would occur if the transaction were executed. The simulation runs against the current working ledger state.

JSON-RPC request payload.

methodstringsimulaterequired

JSON-RPC method name. Must be "simulate" for transaction simulation.

paramsArray<object>required

Array containing transaction simulation parameters. Must contain exactly one object.

Show child attributes
tx_jsonobjectrequired

Transaction object to simulate. Contains all transaction fields except signatures.

Show child attributes
TransactionTypestringPaymentTrustSetOfferCreateOfferCancelPaymentChannelCreatePaymentChannelClaimPaymentChannelFundCheckCreateCheckCashCheckCancelEscrowCreateEscrowFinishEscrowCancelAccountSetSetRegularKeySignerListSetTicketCreateDepositPreauthrequired

Type of transaction to execute. For payment simulation, must be "Payment".

Accountstringrequired

XRP Ledger address of the transaction sender (source account). Must be a valid XRP address starting with 'r'.

Destinationstringrequired

XRP Ledger address of the transaction recipient. Must be a valid XRP address starting with 'r'.

Amountobjectrequired

Amount of issued currency (IOU) to send. Required for non-XRP payments.

Show child attributes
currencystringrequired

Three-letter ISO 4217 currency code or 160-bit hex string for custom currencies. For USD, use "USD".

valuestringrequired

Amount of currency to send as a decimal string. Can include decimal point.

issuerstringrequired

XRP Ledger address of the currency issuer. Must be a valid XRP address.

Feestring

Transaction fee in drops. Automatically calculated if omitted. For simulation, can be omitted or estimated.

Sequenceinteger>= 1

Transaction sequence number. Must be one greater than the sender's current sequence number. If omitted, uses next available sequence.

LastLedgerSequenceinteger>= 1

Highest ledger index in which the transaction can be validated. Provides transaction expiration. Recommended for reliable simulation.

Flagsinteger

Bitwise flags for transaction options. 2147483648 (0x80000000) indicates fully canonical signature.

SigningPubKeystring

Public key used to verify the transaction signature. Can be empty string for simulation.

TxnSignaturestring

Transaction signature. Can be empty string for simulation.

Response

200OK

HTTP 200 response for simulate. The body contains either a successful result or a method-level JSON-RPC error.

400Bad Request

Bad Request. The request body is malformed or contains invalid JSON-RPC parameters.

401Unauthorized

Unauthorized: API key is present but rejected by the NOWNodes gateway.

405Method Not Allowed

Method Not Allowed. Returned by the NOWNodes gateway for malformed or unsupported gateway-level requests.

422Unprocessable Entity

Missing API key. The NOWNodes gateway returns plain text for this error.

500Internal Server Error

Internal Server Error. The gateway or node failed while processing the request.