Honeycluster Docs – Get pathfinding status

Path Finding Methods

Get pathfinding status

wss://honeycluster.io

rpc method: path_find_status

Returns the current results of an open pathfinding request without waiting for an automatic update.

Try it now

Response · path_find_status WS Response

{
  "result": {
    "alternatives": [],
    "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
  },
  "status": "success",
  "type": "response",
  "id": 1
}

Request Message

path_find_status WS Request

application/json

Get pathfinding status

Field	Type	Description
`command` required	string	WebSocket command name
`id`	object	Client-supplied identifier to correlate requests with responses.
`api_version`	object	API version for the response format. Version 2 is the default for rippled 2.0+.

Example

Json

{
  "command": "path_find_status",
  "id": 1
}

Response Message

path_find_status WS Response

application/json

WebSocket response for path_find_status

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": [],
    "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "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_status",
    "id": 1
  };
  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_status WS Response

{
  "result": {
    "alternatives": [],
    "destination_account": "rPT1Sjq2YGrBMTttX4GZHjKu9dyfzbpAYe",
    "source_account": "rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn"
  },
  "status": "success",
  "type": "response",
  "id": 1
}