path_find RPC Method

A client can only have one pathfinding request open at a time. If another pathfinding request is already open on the same connection, the old request is automatically closed and replaced with the new request.

Parameters

subcommand

string

REQUIRED

Use 'create' to send the create sub-command

source_account

string

REQUIRED

Unique address of the account to find a path from

destination_account

string

REQUIRED

Unique address of the account to find a path to

destination_amount

string

REQUIRED

The currency amount that the destination account would receive in a transaction

send_max

string

The currency amount that would be spent in the transaction

paths

string

Representing the payment paths

Returns

result

object

An object with the following fields:

alternatives

array

An array of objects with suggested paths to take

paths_computed

array

The defined payment paths

source_amount

string/object

The currency amount that the source would have to send along this path for the destination to receive the desired amount

destination_amount

string/object

The destination amount received

destination_account

string

Unique address of the account that would receive a transaction

destination_amount

string/object

The currency amount that the destination would receive in a transaction

source_account

string

The unique address that would send a transaction

full_reply

boolean

If false, incomplete search; later reply may have a better path. If true, best path found; updates sent on new ledger closures until pathfinding request is closed

warnings

array

A list of warnings

id

integer

The ID of the warning

message

string

The warning message

Request

1
wscat -c  \
2
# wait for connection
3
{"id":1,"command":"path_find","ledger_index": "current", "subcommand": "create","source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59","destination_amount": {"value": "0.001","currency": "USD","issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B"}}
4

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free