Interface AccountObjectsRequest

The account_objects command returns the raw ledger format for all objects owned by an account. For a higher-level view of an account's trust lines and balances, see the account_lines method instead. Expects a response in the form of an AccountObjectsResponse.

Hierarchy

  • BaseRequest
  • LookupByLedgerRequest
    • AccountObjectsRequest

Properties

account api_version? command deletion_blockers_only? id? ledger_hash? ledger_index? limit? marker? type?

Properties

account

account: string

A unique identifier for the account, most commonly the account's address.

Optional api_version

api_version?: number

The API version to use. If omitted, use version 1.

command

command: "account_objects"

The name of the API method.

Optional deletion_blockers_only

deletion_blockers_only?: boolean

If true, the response only includes objects that would block this account from being deleted. The default is false.

Optional id

id?: string | number

A unique value to identify this request. The response to this request uses the same id field. This way, even if responses arrive out of order, you know which request prompted which response.

Optional ledger_hash

ledger_hash?: string

A 20-byte hex string for the ledger version to use.

Optional ledger_index

ledger_index?: LedgerIndex

The ledger index of the ledger to use, or a shortcut string.

Optional limit

limit?: number

The maximum number of objects to include in the results. Must be within the inclusive range 10 to 400 on non-admin connections. The default is 200.

Optional marker

marker?: unknown

Value from a previous paginated response. Resume retrieving data where that response left off.

Optional type

type?: AccountObjectType

If included, filter results to include only this type of ledger object.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc