Honeycluster Docs – Create a pathfinding request

Path Finding Methods

Create a pathfinding request

wss://honeycluster.io

rpc method: path_find_create

Starts a new pathfinding request to find payment paths between two accounts. The server will send periodic updates until closed.

Try it now

Response · path_find_create WS Response

{
  "result": {
    "alternatives": [
      {
        "paths_computed": [
          [
            {
              "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
              "type": 1,
              "type_hex": "0000000000000001"
            }
          ]
        ],
        "source_amount": "207414"
      }
    ],
    "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "destination_amount": {
      "currency": "USD",
      "issuer": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
      "value": "100"
    },
    "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

path_find_create WS Request

application/json

Create a pathfinding request

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`source_account`	string	The account that would send the payment.
`destination_account`	string	The account that would receive the payment.
`destination_amount`	object	The amount the destination would receive. Can be a string (XRP drops) or currency object.
`send_max`	object	Maximum amount the source is willing to send.
`source_currencies`	object[]	Array of currencies the source can use. Defaults to all available.
`source_currencies[].currency` required	string	Three-letter ISO 4217 currency code, or 160-bit hex currency code.
`source_currencies[].issuer`	string	Account address of the token issuer. Omit for XRP.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "path_find_create",
  "id": 1,
  "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
  "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
  "destination_amount": {
    "currency": "USD",
    "issuer": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "value": "100"
  }
}

Response Message

path_find_create WS Response

application/json

WebSocket response for path_find_create

Field	Type	Description
`result`	object
`status`	enum<string>	Available `successerror`
`type`	string
`id`	stringnumber	Echo of the client-provided correlation ID

Example

Json

{
  "result": {
    "alternatives": [
      {
        "paths_computed": [
          [
            {
              "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
              "type": 1,
              "type_hex": "0000000000000001"
            }
          ]
        ],
        "source_amount": "207414"
      }
    ],
    "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "destination_amount": {
      "currency": "USD",
      "issuer": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
      "value": "100"
    },
    "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request

Payload · JSON

const ws = new WebSocket('wss://honeycluster.io');

ws.addEventListener('open', () => {
  const request = {
    "command": "path_find_create",
    "id": 1,
    "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn",
    "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "destination_amount": {
      "currency": "USD",
      "issuer": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
      "value": "100"
    }
  };
  ws.send(JSON.stringify(request));
});

ws.addEventListener('message', (event: MessageEvent<string>) => {
  const response: unknown = JSON.parse(event.data);
  console.log(response);
  ws.close();
});

Response · path_find_create WS Response

{
  "result": {
    "alternatives": [
      {
        "paths_computed": [
          [
            {
              "account": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
              "type": 1,
              "type_hex": "0000000000000001"
            }
          ]
        ],
        "source_amount": "207414"
      }
    ],
    "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "destination_amount": {
      "currency": "USD",
      "issuer": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
      "value": "100"
    },
    "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
  },
  "status": "success",
  "type": "response",
  "id": 1
}