# PathFindStream | xrpl
Documentation for xrpl

# Interface PathFindStream

The path_find method searches for a path along which a transaction can possibly be made, and periodically sends updates when the path changes over time.

#### Hierarchy

- BaseStream
  - PathFindStream

- Defined in packages/xrpl/src/models/methods/subscribe.ts:393

#####
Index

### Properties

alternatives
destination_account
destination_amount
full_reply
id
send_max?
source_account
type

## Properties

### alternatives

alternatives: [] | {
paths_computed: Path[];
source_amount: Amount;
}

Array of objects with suggested paths to take. If empty, then no paths were found connecting the source and destination accounts.

- Defined in packages/xrpl/src/models/methods/subscribe.ts:417

### destination_account

destination_account: string

Unique address of the account that would receive a transaction.

- Defined in packages/xrpl/src/models/methods/subscribe.ts:398

### destination_amount

destination_amount: Amount

Currency Amount that the destination would receive in a transaction.

- Defined in packages/xrpl/src/models/methods/subscribe.ts:400

### full_reply

full_reply: boolean

If false, this is the result of an incomplete search. A later reply may have a better path. If true, then this is the best path found. (It is still theoretically possible that a better path could exist, but rippled won't find it.) Until you close the pathfinding request, rippled continues to send updates each time a new ledger closes.

- Defined in packages/xrpl/src/models/methods/subscribe.ts:408

### id

id: string | number

The ID provided in the WebSocket request is included again at this level.

- Defined in packages/xrpl/src/models/methods/subscribe.ts:410

### `Optional` send_max

send_max?: Amount

Currency Amount that would be spent in the transaction.

- Defined in packages/xrpl/src/models/methods/subscribe.ts:412

### source_account

source_account: string

Unique address that would send a transaction.

- Defined in packages/xrpl/src/models/methods/subscribe.ts:396

### type

type: "path_find"

Overrides BaseStream.type

- Defined in packages/xrpl/src/models/methods/subscribe.ts:394

Generated using TypeDoc