Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AccountObjectsResponse

Response expected from an AccountObjectsRequest.

Hierarchy

  • BaseResponse
    • AccountObjectsResponse

Index

Properties

api_version?: number
forwarded?: boolean
id: string | number
result: { account: string; account_objects: AccountObject[]; ledger_current_index?: number; ledger_hash?: string; ledger_index?: number; limit?: number; marker?: string; validated?: boolean }

Type declaration

  • account: string

    Unique Address of the account this request corresponds to.

  • account_objects: AccountObject[]

    Array of objects owned by this account. Each object is in its raw ledger format.

  • Optional ledger_current_index?: number

    The ledger index of the current in-progress ledger version, which was used to generate this response.

  • Optional ledger_hash?: string

    The identifying hash of the ledger that was used to generate this response.

  • Optional ledger_index?: number

    The ledger index of the ledger version that was used to generate this response.

  • Optional limit?: number

    The limit that was used in this request, if any.

  • Optional marker?: string

    Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no additional pages after this one.

  • Optional validated?: boolean

    If included and set to true, the information in this response comes from a validated ledger version. Otherwise, the information is subject to change.

status?: string
type: string
warning?: "load"
warnings?: Warning[]

Generated using TypeDoc