iou.retrieve()
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

Read a single IOU trust line (point-in-time).

Signature

iou.retrieve(
  params: IOURetrieveParams
): Promise<IOURetrieveResult>

Parameter	Type	Required	Description
`ticker`	`string`	Yes	The currency code (3-character ISO-4217-style or 40-character hex; other codes are auto-encoded to hex).
`issuer`	`string`	Yes	The IOU issuer's r-address.
`account`	`string`	No	The holder account to read from. Defaults to the primary signer's account.

Resolves to an IOURetrieveResult:

Field	Type	Description
`iouID`	`string`	Currency code and issuer, e.g. `USD.rIssuer...` — pass to the write operations.
`data`	`IOUTrustLine \| undefined`	The point-in-time trust line snapshot, or `undefined` if no line exists.

Field	Type	Description
`currency`	`string`	The currency ticker (hex codes decoded to ASCII where printable).
`peer`	`string`	The counterparty r-address (the issuer, when querying as `holder`).
`balance`	`string`	The trust line balance, from the queried account's perspective.
`limit`	`string`	The queried account's trust limit.
`limitPeer`	`string`	The counterparty's trust limit.
`noRipple`	`boolean`	Whether rippling is disabled on this line.
`frozen`	`boolean`	Whether the queried account has frozen this line.
`authorized`	`boolean`	Whether the line is authorized (issuer authorized the holder).

Read-only — no signer is required and nothing is submitted. Queries the ledger with account_lines.

const { data } = await client.iou.retrieve({
  ticker: 'USD',
  issuer: 'rIssuer...',
})

console.log(data?.balance)