Skip to content
[ ARKIV ] Docs

RpcQueryOptions

RpcQueryOptions = object

Defined in: src/types/rpcSchema.ts:73

The second parameter of arkiv_query — what to return, and where in the results to start.

Properties

Section titled “Properties”

atBlock?

Section titled “atBlock?”

optional atBlock: Hex

Defined in: src/types/rpcSchema.ts:75

Block height to read at, as a hex quantity. Defaults to the head, and must be within the node’s retained range.

cursor?

Section titled “cursor?”

optional cursor: string

Defined in: src/types/rpcSchema.ts:81

Opaque cursor from a previous response; bound to that query, block and selection.

limit?

Section titled “limit?”

optional limit: Hex

Defined in: src/types/rpcSchema.ts:79

Page size, as a hex quantity. Node maximum is 200.

select?

Section titled “select?”

optional select: RpcSelect

Defined in: src/types/rpcSchema.ts:77

What to return. Defaults to { key: true }.