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

This method does not accept any parameters

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

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

destination_amount

string

The destination amount received

destination_account

string

Unique address of the account that would receive a transaction

destination_amount

string

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
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "path_find",
6
  "params": [],
7
  "id": 1
8
}'

1
curl -X POST "https://docs-demo.xrp-mainnet.quiknode.pro/" \
2
  -H "Content-Type: application/json" \
3
  -d '{
4
  "jsonrpc": "2.0",
5
  "method": "path_find",
6
  "params": [],
7
  "id": 1
8
}'

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'path_find',
4
    params: [],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
const body = {
2
    jsonrpc: '2.0',
3
    method: 'path_find',
4
    params: [],
5
    id: 1
6
}
7

8
async function main() {
9
    const response = await fetch('https://docs-demo.xrp-mainnet.quiknode.pro/', {
10
        method: 'POST',
11
        headers: {'Content-Type': 'application/json'},
12
        body: JSON.stringify(body)
13
    })
14
    const data = await response.json()
15
    console.log(data)
16
}
17

18
main()

1
import requests
2
import json
3

4
url = "https://docs-demo.xrp-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "path_find",
9
  "params": [],
10
  "id": 1
11
})
12
headers = {
13
  'Content-Type': 'application/json'
14
}
15

16
response = requests.request("POST", url, headers=headers, data=payload)
17

18
print(response.text)

1
import requests
2
import json
3

4
url = "https://docs-demo.xrp-mainnet.quiknode.pro/"
5

6
payload = json.dumps({
7
  "jsonrpc": "2.0",
8
  "method": "path_find",
9
  "params": [],
10
  "id": 1
11
})
12
headers = {
13
  'Content-Type': 'application/json'
14
}
15

16
response = requests.request("POST", url, headers=headers, data=payload)
17

18
print(response.text)

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "path_find",
11
  params: []
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

1
require "uri"
2
require "json"
3
require "net/http"
4

5
uri = URI("https://docs-demo.xrp-mainnet.quiknode.pro/")
6

7
payload = {
8
  jsonrpc: "2.0",
9
  id: 1,
10
  method: "path_find",
11
  params: []
12
}
13

14
request = Net::HTTP::Post.new(uri)
15
request["Content-Type"] = "application/json"
16
request.body = JSON.generate(payload)
17

18
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) do |http|
19
  http.request(request)
20
end
21

22
puts response.body

Response

1
{
2
  "jsonrpc": "2.0",
3
  "id": 1,
4
  "result": {
5
    "result": {
6
      "alternatives": [
7
        {
8
          "paths_computed": [],
9
          "source_amount": "example_value",
10
          "destination_amount": "example_value"
11
        }
12
      ],
13
      "destination_account": "example_value",
14
      "destination_amount": "example_value",
15
      "source_account": "example_value",
16
      "full_reply": false
17
    },
18
    "warnings": [
19
      {
20
        "id": 1,
21
        "message": "example_value"
22
      }
23
    ]
24
  }
25
}

1
{
2
  "jsonrpc": "2.0",
3
  "id": 1,
4
  "result": {
5
    "result": {
6
      "alternatives": [
7
        {
8
          "paths_computed": [],
9
          "source_amount": "example_value",
10
          "destination_amount": "example_value"
11
        }
12
      ],
13
      "destination_account": "example_value",
14
      "destination_amount": "example_value",
15
      "source_account": "example_value",
16
      "full_reply": false
17
    },
18
    "warnings": [
19
      {
20
        "id": 1,
21
        "message": "example_value"
22
      }
23
    ]
24
  }
25
}

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free