Parameters
- objectobjectREQUIRED
The ripple_path_find request object.
- destination_accountstringREQUIRED
The unique address of the account that would receive funds in a transaction
- destination_amountobjectREQUIRED
The amount that the destination account will recieve. It contains the following fields:
- currencystring
The currency of the destination amount
- issuerstring
The issuer of the currency
- valuestring
The value of the destination amount
- source_accountstringREQUIRED
The unique address of the account that would send funds in a transaction
- source_currenciesarray
An array of currencies that the source account might want to spend
- currencystring
The currency of the source amount
Returns
- resultobject
An object which contains the following fields:
- alternativesarray
An array of objects with possible paths to take
- destination_accountstring
The unique address of the account that would receive a payment transaction
- destination_amountobject
The currency Amount that the destination account would receive in a transaction
- currencystring
The currency of the destination amount
- issuerstring
The issuer of the currency
- valuestring
The value of the destination amount
- destination_currenciesstring
An array of strings representing the currencies that the destination accepts, as 3-letter codes like USD or as 40-character hex like 015841551A748AD2C1F76FF6ECB0CCCD00000000
- full_replyboolean
If true, then this is the best path that network can find as of the current ledger
- source_accountstring
The source account
- statusstring
The status of the request
- warningsarray
An array of warning objects, each containing the following fields:
- idinteger
The ID of the warning
- messagestring
The warning message
1{2"result": {3"alternatives": [4{5"paths_canonical": [],6"paths_computed": [7[8{9"currency": "USD",10"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",11"type": 4812}13],14[15{16"currency": "USD",17"issuer": "rsbgrRPMTykHoStSYst8jbqkscAnHCPWY8",18"type": 4819},20{21"account": "rsbgrRPMTykHoStSYst8jbqkscAnHCPWY8",22"type": 123}24]25],26"source_amount": "722"27},28{29"paths_canonical": [],30"paths_computed": [],31"source_amount": {32"currency": "USD",33"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",34"value": "0.0010015"35}36}37],38"destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",39"destination_amount": {40"currency": "USD",41"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",42"value": "0.001"43},44"destination_currencies": [45"JOE",46"MXN",47"USD",48"DYM",49"CNY",50"015841551A748AD2C1F76FF6ECB0CCCD00000000",51"EUR",52"BTC",53"XRP"54],55"full_reply": true,56"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",57"status": "success"58},59"status": "success",60"type": "response",61"forwarded": true,62"warnings": [63{64"id": 2001,65"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"66}67]68}
1{2"result": {3"alternatives": [4{5"paths_canonical": [],6"paths_computed": [7[8{9"currency": "USD",10"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",11"type": 4812}13],14[15{16"currency": "USD",17"issuer": "rsbgrRPMTykHoStSYst8jbqkscAnHCPWY8",18"type": 4819},20{21"account": "rsbgrRPMTykHoStSYst8jbqkscAnHCPWY8",22"type": 123}24]25],26"source_amount": "722"27},28{29"paths_canonical": [],30"paths_computed": [],31"source_amount": {32"currency": "USD",33"issuer": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",34"value": "0.0010015"35}36}37],38"destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",39"destination_amount": {40"currency": "USD",41"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",42"value": "0.001"43},44"destination_currencies": [45"JOE",46"MXN",47"USD",48"DYM",49"CNY",50"015841551A748AD2C1F76FF6ECB0CCCD00000000",51"EUR",52"BTC",53"XRP"54],55"full_reply": true,56"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",57"status": "success"58},59"status": "success",60"type": "response",61"forwarded": true,62"warnings": [63{64"id": 2001,65"message": "This is a clio server. clio only serves validated data. If you want to talk to rippled, include 'ledger_index':'current' in your request"66}67]68}