adamant-api / api / TransactionQueryParameters

Interface: TransactionQueryParameters

Defined in: src/api/index.ts:262

Query parameters shared by the transaction-style endpoints: /api/transactions, /api/chats/get, /api/chatrooms, and /api/states/get.

Two things to keep in mind:

1. Filter combination. Top-level filter conditions are combined with and by default — see TransactionQuery to opt into or. Control and pagination fields (limit, offset, orderBy, returnUnconfirmed) are never treated as filters.
2. Endpoint support varies. The node does not reject unknown query fields, but each endpoint only applies a subset of these in its SQL, so passing a field an endpoint ignores simply has no effect. The applicable filters were verified against the node's per-module query builders, not just the docs. Amount filters (minAmount / maxAmount) are honored only by /api/transactions and are therefore declared on TransactionsOptions rather than here.

See

• https://docs.adamant.im/api/transactions-query-language.html
• https://github.com/Adamant-im/adamant/blob/dev/modules/transactions.js

Extended by

• ChatroomsOptions
• TransactionsOptions
• KVSOptions

Properties

blockId?

optional blockId?: string;

Defined in: src/api/index.ts:264

---

fromHeight?

optional fromHeight?: number;

Defined in: src/api/index.ts:265

---

fromTimestamp?

optional fromTimestamp?: number;

Defined in: src/api/index.ts:267

---

inId?

optional inId?: string;

Defined in: src/api/index.ts:274

---

isIn?

optional isIn?: string;

Defined in: src/api/index.ts:275

---

limit?

optional limit?: number;

Defined in: src/api/index.ts:276

---

maxFee?

optional maxFee?: number;

Defined in: src/api/index.ts:270

---

minConfirmations?

optional minConfirmations?: number;

Defined in: src/api/index.ts:271

---

minFee?

optional minFee?: number;

Defined in: src/api/index.ts:269

---

offset?

optional offset?: number;

Defined in: src/api/index.ts:277

---

orderBy?

optional orderBy?: string;

Defined in: src/api/index.ts:278

---

recipientId?

optional recipientId?: string;

Defined in: src/api/index.ts:273

---

returnUnconfirmed?

optional returnUnconfirmed?: 0 | 1;

Defined in: src/api/index.ts:263

---

senderId?

optional senderId?: string;

Defined in: src/api/index.ts:272

---

toHeight?

optional toHeight?: number;

Defined in: src/api/index.ts:266

---

toTimestamp?

optional toTimestamp?: number;

Defined in: src/api/index.ts:268