adamant-api / api
api
ADM HTTP client (AdamantApi): resilient node access with health checks, retries, and failover; typed request options; and the generated ADAMANT API DTO types.
Classes
| Class | Description |
|---|---|
| AdamantApi | Resilient client for the public ADAMANT Node HTTP API. |
Interfaces
| Interface | Description |
|---|---|
| AdamantApiOptions | - |
| AddressObject | - |
| ChatroomsOptions | Options for the chat endpoints: /api/chatrooms (getChats, getChatMessages) and the legacy /api/chats/get (getChatTransactions). |
| GetBlocksOptions | - |
| GetDelegatesOptions | - |
| GetDelegateStatsOptions | - |
| GetPeersOptions | - |
| GetTopAccountsOptions | - |
| KVSOptions | Options for /api/states/get (getKVS). |
| PooledTransactionsOptions | - |
| PublicKeyObject | - |
| SearchDelegatesOptions | - |
| TransactionQueryParameters | Query parameters shared by the transaction-style endpoints: /api/transactions, /api/chats/get, /api/chatrooms, and /api/states/get. |
| TransactionsOptions | Options for /api/transactions (getTransactions, getTransaction). This is the most permissive endpoint: it applies the full filter set, including the amount filters (minAmount / maxAmount) that the chat and KVS endpoints do not support. |
| UsernameObject | - |
Type Aliases
| Type Alias | Description |
|---|---|
| AdamantAddress | - |
| AddressOrPublicKeyObject | Object that contains either address or publicKey field |
| DelegateLookupOptions | Object that identifies a delegate by username, public key, or address. |
| TransactionQuery | A transaction query. |
| UsernameOrPublicKeyObject | Object that contains either username or publicKey field |
References
getUnsupportedTransactionQueryControls
Re-exports getUnsupportedTransactionQueryControls
hasMixedTransactionQueryGroups
Re-exports hasMixedTransactionQueryGroups
isVoteDirection
Re-exports isVoteDirection
parseVote
Re-exports parseVote
TransactionQueryEndpoint
Re-exports TransactionQueryEndpoint
transformTransactionQuery
Re-exports transformTransactionQuery
VoteDirection
Re-exports VoteDirection