symbol_rest_client

Description:

symbol rest client

symbol_rest_client #
OpenAPI Specification of catapult-rest
This Dart package is automatically generated by the OpenAPI Generator project:

API version: 1.0.4
Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements #
Dart 2.12 or later
Installation & Usage #
Github #
If this Dart package is published to Github, add the following dependency to your pubspec.yaml
dependencies:
symbol_rest_client:
git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
copied to clipboard
Local #
To use the package in your local drive, add the following dependency to your pubspec.yaml
dependencies:
symbol_rest_client:
path: /path/to/symbol_rest_client
copied to clipboard
Tests #
TODO
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:symbol_rest_client/api.dart';


final api_instance = AccountRoutesApi();
final accountId = accountId_example; // String | Account public key or address encoded using a 32-character set.

try {
final result = api_instance.getAccountInfo(accountId);
print(result);
} catch (e) {
print('Exception when calling AccountRoutesApi->getAccountInfo: $e\n');
}

copied to clipboard
Documentation for API Endpoints #
All URIs are relative to http://localhost:3000



Class
Method
HTTP request
Description




AccountRoutesApi
getAccountInfo
GET /accounts/{accountId}
Get account information


AccountRoutesApi
getAccountInfoMerkle
GET /accounts/{accountId}/merkle
Get account merkle information


AccountRoutesApi
getAccountsInfo
POST /accounts
Get accounts information


AccountRoutesApi
searchAccounts
GET /accounts
Search accounts


BlockRoutesApi
getBlockByHeight
GET /blocks/{height}
Get block information


BlockRoutesApi
getMerkleReceipts
GET /blocks/{height}/statements/{hash}/merkle
Get the merkle path for a given a receipt statement hash and block


BlockRoutesApi
getMerkleTransaction
GET /blocks/{height}/transactions/{hash}/merkle
Get the merkle path for a given a transaction and block


BlockRoutesApi
searchBlocks
GET /blocks
Search blocks


ChainRoutesApi
getChainInfo
GET /chain/info
Get the current information of the chain


FinalizationRoutesApi
getFinalizationProofAtEpoch
GET /finalization/proof/epoch/{epoch}
Get finalization proof


FinalizationRoutesApi
getFinalizationProofAtHeight
GET /finalization/proof/height/{height}
Get finalization proof


HashLockRoutesApi
getHashLock
GET /lock/hash/{hash}
Get hash lock information


HashLockRoutesApi
getHashLockMerkle
GET /lock/hash/{hash}/merkle
Get hash lock merkle information


HashLockRoutesApi
searchHashLock
GET /lock/hash
Search hash lock entries


MetadataRoutesApi
getMetadata
GET /metadata/{compositeHash}
Get metadata information


MetadataRoutesApi
getMetadataMerkle
GET /metadata/{compositeHash}/merkle
Get metadata merkle information


MetadataRoutesApi
searchMetadataEntries
GET /metadata
Search metadata entries


MosaicRoutesApi
getMosaic
GET /mosaics/{mosaicId}
Get mosaic information


MosaicRoutesApi
getMosaicMerkle
GET /mosaics/{mosaicId}/merkle
Get mosaic merkle information


MosaicRoutesApi
getMosaics
POST /mosaics
Get mosaics information for an array of mosaics


MosaicRoutesApi
searchMosaics
GET /mosaics
Search mosaics


MultisigRoutesApi
getAccountMultisig
GET /account/{address}/multisig
Get multisig account information


MultisigRoutesApi
getAccountMultisigGraph
GET /account/{address}/multisig/graph
Get multisig account graph information


MultisigRoutesApi
getAccountMultisigMerkle
GET /account/{address}/multisig/merkle
Get multisig account merkle information


NamespaceRoutesApi
getAccountsNames
POST /namespaces/account/names
Get readable names for a set of accountIds


NamespaceRoutesApi
getMosaicsNames
POST /namespaces/mosaic/names
Get readable names for a set of mosaics


NamespaceRoutesApi
getNamespace
GET /namespaces/{namespaceId}
Get namespace information


NamespaceRoutesApi
getNamespaceMerkle
GET /namespaces/{namespaceId}/merkle
Get namespace merkle information


NamespaceRoutesApi
getNamespacesNames
POST /namespaces/names
Get readable names for a set of namespaces


NamespaceRoutesApi
searchNamespaces
GET /namespaces
Search namespaces


NetworkRoutesApi
getNetworkProperties
GET /network/properties
Get the network properties


NetworkRoutesApi
getNetworkType
GET /network
Get the current network type of the chain


NetworkRoutesApi
getRentalFees
GET /network/fees/rental
Get rental fees information


NetworkRoutesApi
getTransactionFees
GET /network/fees/transaction
Get transaction fees information


NodeRoutesApi
getNodeHealth
GET /node/health
Get the node health information


NodeRoutesApi
getNodeInfo
GET /node/info
Get the node information


NodeRoutesApi
getNodePeers
GET /node/peers
Get peers information


NodeRoutesApi
getNodeStorage
GET /node/storage
Get the storage information of the node


NodeRoutesApi
getNodeTime
GET /node/time
Get the node time


NodeRoutesApi
getServerInfo
GET /node/server
Get the version of the running REST component


NodeRoutesApi
getUnlockedAccount
GET /node/unlockedaccount
Get the unlocked harvesting account public keys.


ReceiptRoutesApi
searchAddressResolutionStatements
GET /statements/resolutions/address
Get receipts address resolution statements


ReceiptRoutesApi
searchMosaicResolutionStatements
GET /statements/resolutions/mosaic
Get receipts mosaic resolution statements


ReceiptRoutesApi
searchReceipts
GET /statements/transaction
Search transaction statements


RestrictionAccountRoutesApi
getAccountRestrictions
GET /restrictions/account/{address}
Get the account restrictions


RestrictionAccountRoutesApi
getAccountRestrictionsMerkle
GET /restrictions/account/{address}/merkle
Get the account restrictions merkle


RestrictionAccountRoutesApi
searchAccountRestrictions
GET /restrictions/account
Search account restrictions


RestrictionMosaicRoutesApi
getMosaicRestrictions
GET /restrictions/mosaic/{compositeHash}
Get the mosaic restrictions


RestrictionMosaicRoutesApi
getMosaicRestrictionsMerkle
GET /restrictions/mosaic/{compositeHash}/merkle
Get the mosaic restrictions merkle


RestrictionMosaicRoutesApi
searchMosaicRestrictions
GET /restrictions/mosaic
Search mosaic restrictions


SecretLockRoutesApi
getSecretLock
GET /lock/secret/{compositeHash}
Get secret lock information


SecretLockRoutesApi
getSecretLockMerkle
GET /lock/secret/{compositeHash}/merkle
Get secret lock merkle information


SecretLockRoutesApi
searchSecretLock
GET /lock/secret
Search secret lock entries


TransactionRoutesApi
announceCosignatureTransaction
PUT /transactions/cosignature
Announce a cosignature transaction


TransactionRoutesApi
announcePartialTransaction
PUT /transactions/partial
Announce an aggregate bonded transaction


TransactionRoutesApi
announceTransaction
PUT /transactions
Announce a new transaction


TransactionRoutesApi
getConfirmedTransaction
GET /transactions/confirmed/{transactionId}
Get confirmed transaction information


TransactionRoutesApi
getConfirmedTransactions
POST /transactions/confirmed
Get confirmed trasactions information


TransactionRoutesApi
getPartialTransaction
GET /transactions/partial/{transactionId}
Get partial transaction information


TransactionRoutesApi
getPartialTransactions
POST /transactions/partial
Get partial trasactions information


TransactionRoutesApi
getUnconfirmedTransaction
GET /transactions/unconfirmed/{transactionId}
Get unconfirmed transaction information


TransactionRoutesApi
getUnconfirmedTransactions
POST /transactions/unconfirmed
Get unconfirmed trasactions information


TransactionRoutesApi
searchConfirmedTransactions
GET /transactions/confirmed
Search confirmed transactions


TransactionRoutesApi
searchPartialTransactions
GET /transactions/partial
Search partial transactions


TransactionRoutesApi
searchUnconfirmedTransactions
GET /transactions/unconfirmed
Search unconfirmed transactions


TransactionStatusRoutesApi
getTransactionStatus
GET /transactionStatus/{hash}
Get transaction status


TransactionStatusRoutesApi
getTransactionStatuses
POST /transactionStatus
Get transaction statuses



Documentation For Models #

AccountAddressRestrictionTransactionBodyDTO
AccountAddressRestrictionTransactionDTO
AccountDTO
AccountIds
AccountInfoDTO
AccountKeyLinkNetworkPropertiesDTO
AccountKeyLinkTransactionBodyDTO
AccountKeyLinkTransactionDTO
AccountKeyTypeFlagsEnum
AccountLinkPublicKeyDTO
AccountLinkVotingKeyDTO
AccountLinkVotingKeysDTO
AccountMetadataTransactionBodyDTO
AccountMetadataTransactionDTO
AccountMosaicRestrictionTransactionBodyDTO
AccountMosaicRestrictionTransactionDTO
AccountNamesDTO
AccountOperationRestrictionTransactionBodyDTO
AccountOperationRestrictionTransactionDTO
AccountOrderByEnum
AccountPage
AccountRestrictionDTO
AccountRestrictionFlagsEnum
AccountRestrictionNetworkPropertiesDTO
AccountRestrictionsDTO
AccountRestrictionsInfoDTO
AccountRestrictionsPage
AccountTypeEnum
AccountsNamesDTO
ActivityBucketDTO
AddressAliasTransactionBodyDTO
AddressAliasTransactionDTO
Addresses
AggregateNetworkPropertiesDTO
AggregateTransactionBodyDTO
AggregateTransactionBodyExtendedDTO
AggregateTransactionDTO
AggregateTransactionExtendedDTO
AliasActionEnum
AliasDTO
AliasTypeEnum
AnnounceTransactionInfoDTO
BalanceChangeReceiptDTO
BalanceTransferReceiptDTO
BlockDTO
BlockInfoDTO
BlockInfoDTOBlock
BlockMetaDTO
BlockOrderByEnum
BlockPage
BmTreeSignature
ChainInfoDTO
ChainPropertiesDTO
CommunicationTimestampsDTO
Cosignature
CosignatureDTO
DeploymentDTO
EmbeddedAccountAddressRestrictionTransactionDTO
EmbeddedAccountKeyLinkTransactionDTO
EmbeddedAccountMetadataTransactionDTO
EmbeddedAccountMosaicRestrictionTransactionDTO
EmbeddedAccountOperationRestrictionTransactionDTO
EmbeddedAddressAliasTransactionDTO
EmbeddedHashLockTransactionDTO
EmbeddedMosaicAddressRestrictionTransactionDTO
EmbeddedMosaicAliasTransactionDTO
EmbeddedMosaicDefinitionTransactionDTO
EmbeddedMosaicGlobalRestrictionTransactionDTO
EmbeddedMosaicMetadataTransactionDTO
EmbeddedMosaicSupplyChangeTransactionDTO
EmbeddedMosaicSupplyRevocationTransactionDTO
EmbeddedMultisigAccountModificationTransactionDTO
EmbeddedNamespaceMetadataTransactionDTO
EmbeddedNamespaceRegistrationTransactionDTO
EmbeddedNodeKeyLinkTransactionDTO
EmbeddedSecretLockTransactionDTO
EmbeddedSecretProofTransactionDTO
EmbeddedTransactionBodyDTO
EmbeddedTransactionDTO
EmbeddedTransactionInfoDTO
EmbeddedTransactionInfoDTOTransaction
EmbeddedTransactionMetaDTO
EmbeddedTransferTransactionDTO
EmbeddedVotingKeyLinkTransactionDTO
EmbeddedVrfKeyLinkTransactionDTO
EntityDTO
FinalizationProofDTO
FinalizedBlockDTO
HashLockEntryDTO
HashLockInfoDTO
HashLockNetworkPropertiesDTO
HashLockPage
HashLockTransactionBodyDTO
HashLockTransactionDTO
ImportanceBlockDTO
InflationReceiptDTO
LinkActionEnum
LockHashAlgorithmEnum
LockStatus
MerklePathItemDTO
MerkleProofInfoDTO
MerkleStateInfoDTO
MerkleStateInfoDTOTreeInner
MerkleTreeBranchDTO
MerkleTreeBranchLinkDTO
MerkleTreeLeafDTO
MerkleTreeNodeTypeEnum
MessageGroup
MetadataEntryDTO
MetadataInfoDTO
MetadataNetworkPropertiesDTO
MetadataPage
MetadataTypeEnum
ModelError
Mosaic
MosaicAddressRestrictionDTO
MosaicAddressRestrictionEntryDTO
MosaicAddressRestrictionEntryWrapperDTO
MosaicAddressRestrictionTransactionBodyDTO
MosaicAddressRestrictionTransactionDTO
MosaicAliasTransactionBodyDTO
MosaicAliasTransactionDTO
MosaicDTO
MosaicDefinitionTransactionBodyDTO
MosaicDefinitionTransactionDTO
MosaicExpiryReceiptDTO
MosaicGlobalRestrictionDTO
MosaicGlobalRestrictionEntryDTO
MosaicGlobalRestrictionEntryRestrictionDTO
MosaicGlobalRestrictionEntryWrapperDTO
MosaicGlobalRestrictionTransactionBodyDTO
MosaicGlobalRestrictionTransactionDTO
MosaicIds
MosaicInfoDTO
MosaicMetadataTransactionBodyDTO
MosaicMetadataTransactionDTO
MosaicNamesDTO
MosaicNetworkPropertiesDTO
MosaicPage
MosaicRestrictionDTO
MosaicRestrictionEntryTypeEnum
MosaicRestrictionNetworkPropertiesDTO
MosaicRestrictionTypeEnum
MosaicRestrictionsPage
MosaicSupplyChangeActionEnum
MosaicSupplyChangeTransactionBodyDTO
MosaicSupplyChangeTransactionDTO
MosaicSupplyRevocationTransactionBodyDTO
MosaicSupplyRevocationTransactionDTO
MosaicsNamesDTO
MultisigAccountGraphInfoDTO
MultisigAccountInfoDTO
MultisigAccountModificationTransactionBodyDTO
MultisigAccountModificationTransactionDTO
MultisigDTO
MultisigNetworkPropertiesDTO
NamespaceDTO
NamespaceExpiryReceiptDTO
NamespaceIds
NamespaceInfoDTO
NamespaceMetaDTO
NamespaceMetadataTransactionBodyDTO
NamespaceMetadataTransactionDTO
NamespaceNameDTO
NamespaceNetworkPropertiesDTO
NamespacePage
NamespaceRegistrationTransactionBodyDTO
NamespaceRegistrationTransactionDTO
NamespaceRegistrationTypeEnum
NetworkConfigurationDTO
NetworkPropertiesDTO
NetworkTypeDTO
NetworkTypeEnum
NodeHealthDTO
NodeHealthInfoDTO
NodeIdentityEqualityStrategy
NodeInfoDTO
NodeKeyLinkNetworkPropertiesDTO
NodeKeyLinkTransactionBodyDTO
NodeKeyLinkTransactionDTO
NodeStatusEnum
NodeTimeDTO
Order
Pagination
ParentPublicKeySignaturePair
PluginsPropertiesDTO
PositionEnum
ReceiptDTO
ReceiptTypeEnum
RentalFeesDTO
ResolutionEntryDTO
ResolutionStatementDTO
ResolutionStatementInfoDTO
ResolutionStatementPage
SecretLockEntryDTO
SecretLockInfoDTO
SecretLockNetworkPropertiesDTO
SecretLockPage
SecretLockTransactionBodyDTO
SecretLockTransactionDTO
SecretProofTransactionBodyDTO
SecretProofTransactionDTO
ServerDTO
ServerInfoDTO
SizePrefixedEntityDTO
SourceDTO
StageEnum
StatementMetaDTO
StorageInfoDTO
SupplementalPublicKeysDTO
TransactionBodyDTO
TransactionDTO
TransactionFeesDTO
TransactionGroupEnum
TransactionHashes
TransactionIds
TransactionInfoDTO
TransactionInfoDTOMeta
TransactionInfoDTOTransaction
TransactionMetaDTO
TransactionPage
TransactionPayload
TransactionStatementDTO
TransactionStatementDTOReceiptsInner
TransactionStatementInfoDTO
TransactionStatementPage
TransactionStatusDTO
TransactionStatusEnum
TransactionTypeEnum
TransferNetworkPropertiesDTO
TransferTransactionBodyDTO
TransferTransactionDTO
UnlockedAccountDTO
UnresolvedMosaic
VerifiableEntityDTO
VotingKeyLinkNetworkPropertiesDTO
VotingKeyLinkTransactionBodyDTO
VotingKeyLinkTransactionDTO
VrfKeyLinkNetworkPropertiesDTO
VrfKeyLinkTransactionBodyDTO
VrfKeyLinkTransactionDTO

Documentation For Authorization #
Endpoints do not require authorization.
Author #