Skip to main content

GetOwnedObjectsParams

@iota/iota-sdk

@iota/iota-sdk / client / GetOwnedObjectsParams

Type Alias: GetOwnedObjectsParams

GetOwnedObjectsParams = object & IotaObjectResponseQuery

Defined in: sdk/typescript/src/client/types/params.ts:377

Return the list of objects owned by an address. Note that if the address owns more than QUERY_MAX_RESULT_LIMIT objects, the pagination is not accurate, because previous page may have been updated when the next page is fetched. Please use iotax_queryObjects if this is a concern.

Type Declaration​

cursor?​

optional cursor?: string | null

An optional paging cursor. If provided, the query will start from the next item after the specified cursor. Default to start from the first item if not specified.

limit?​

optional limit?: number | null

Max number of items returned per page, default to [QUERY_MAX_RESULT_LIMIT] if not specified.

owner​

owner: string

the owner's IOTA address

signal?​

optional signal?: AbortSignal