adamant-api / api / KVSOptions
Interface: KVSOptions
Defined in: src/api/index.ts:332
Options for /api/states/get (getKVS).
Verified against the node query builder, this endpoint applies type, key, keyIds, senderId, senderIds, and fromHeight, plus pagination. It does not support amount filters (excluded at the type level) and ignores recipientId.
Extends
Properties
blockId?
optional blockId?: string;Defined in: src/api/index.ts:264
Inherited from
TransactionQueryParameters.blockId
fromHeight?
optional fromHeight?: number;Defined in: src/api/index.ts:265
Inherited from
TransactionQueryParameters.fromHeight
fromTimestamp?
optional fromTimestamp?: number;Defined in: src/api/index.ts:267
Inherited from
TransactionQueryParameters.fromTimestamp
inId?
optional inId?: string;Defined in: src/api/index.ts:274
Inherited from
TransactionQueryParameters.inId
isIn?
optional isIn?: string;Defined in: src/api/index.ts:275
Inherited from
TransactionQueryParameters.isIn
key?
optional key?: string;Defined in: src/api/index.ts:334
keyIds?
optional keyIds?: string[];Defined in: src/api/index.ts:335
limit?
optional limit?: number;Defined in: src/api/index.ts:276
Inherited from
TransactionQueryParameters.limit
maxFee?
optional maxFee?: number;Defined in: src/api/index.ts:270
Inherited from
TransactionQueryParameters.maxFee
minConfirmations?
optional minConfirmations?: number;Defined in: src/api/index.ts:271
Inherited from
TransactionQueryParameters.minConfirmations
minFee?
optional minFee?: number;Defined in: src/api/index.ts:269
Inherited from
TransactionQueryParameters.minFee
offset?
optional offset?: number;Defined in: src/api/index.ts:277
Inherited from
TransactionQueryParameters.offset
orderBy?
optional orderBy?: string;Defined in: src/api/index.ts:278
Inherited from
TransactionQueryParameters.orderBy
recipientId?
optional recipientId?: string;Defined in: src/api/index.ts:273
Inherited from
TransactionQueryParameters.recipientId
returnUnconfirmed?
optional returnUnconfirmed?: 0 | 1;Defined in: src/api/index.ts:263
Inherited from
TransactionQueryParameters.returnUnconfirmed
senderId?
optional senderId?: string;Defined in: src/api/index.ts:272
Inherited from
TransactionQueryParameters.senderId
senderIds?
optional senderIds?: string[];Defined in: src/api/index.ts:333
toHeight?
optional toHeight?: number;Defined in: src/api/index.ts:266
Inherited from
TransactionQueryParameters.toHeight
toTimestamp?
optional toTimestamp?: number;Defined in: src/api/index.ts:268
Inherited from
TransactionQueryParameters.toTimestamp
type?
optional type?: number;Defined in: src/api/index.ts:336