Koios Java Client Library is based on Koios Elastic Query Layer for Cardano Node by Cardano Community Guild Operators.
Koios is best described as a Decentralized and Elastic RESTful query layer for exploring data on Cardano blockchain to consume within applications/wallets/explorers/etc.
Resource and maintenance requirements for Cardano blockchain components (e.g. cardano-node, cardano-db-sync) are ever-growing. Along with that, every builder needs to identify how to query complex information from the chain.
Koios Java Client is a Java REST Client library which allows interacting with Koios Server Instances using Java Objects.
- Synchronous REST messaging using java objects
- Structured Java Objects logging
- Pagination (Limit and Offset) Supported
- Horizontal Filtering Supported
- Sorting Supported
- Rate Control
- Inner Retry Mechanism upon Timeouts (Default: 3 Retries)
- Supported REST Services:
- Network
- Chain Tip
- Genesis Info
- Historical Tokenomic Statistics
- Epoch
- Epoch Information
- Epoch's Protocol Parameters
- Block
- Block List
- Block Information
- Block Transactions
- Transactions
- Transaction Information
- Transaction UTxOs
- Transaction Metadata
- Transaction Metadata Labels
- Transaction Submission
- Transaction Status (Block Confirmations)
- Address
- Address Information
- Address Transactions
- Transactions from Payment Credentials
- Address Assets
- Account
- Account List
- Account Information
- Account Rewards
- Account Updates (History)
- Account Addresses
- Account Assets
- Account History
- Asset
- Asset List
- Asset Address List
- Asset Information
- Asset History
- Asset Policy Information
- Asset Summary
- Asset Transaction History
- Pool
- Pool List
- Pool Information
- Pool Delegators List
- Pool Blocks
- Pool Stake, Block and Reward History
- Pool Updates (History)
- Pool Relays
- Pool Metadata
- Script
- Native Script List
- Plutus Script List
- Script Redeemers
- Network
- For Maven, add the following dependency to project's pom.xml
<dependency>
<groupId>io.github.cardano-community</groupId>
<artifactId>koios-java-client</artifactId>
<version>1.11</version>
</dependency>
- For Gradle, add the following dependency to build.gradle
compile group: 'io.github.cardano-community', name: 'koios-java-client', version: '1.11'
- Mainnet
BackendService backendService = BackendFactory.getKoiosMainnetService();
- Testnet
BackendService backendService = BackendFactory.getKoiosTestnetService();
- Guildnet
BackendService backendService = BackendFactory.getKoiosGuildService();
NetworkService networkService = backendService.getNetworkService();
EpochService epochService = backendService.getEpochService();
BlockService blockService = backendService.getBlockService();
TransactionsService transactionsService = backendService.getTransactionsService();
AddressService addressService = backendService.getAddressService();
AccountService accountService = backendService.getAccountService();
AssetService assetService = backendService.getAssetService();
PoolService poolService = backendService.getPoolService();
ScriptService scriptService = backendService.getScriptService();
Querying a Descending Order of All Address Transactions since Block No. #3168087 to Block No. #3168097 (inclusive), Limited to Maximum of 10 Results.
String address = "addr_test1qzx9hu8j4ah3auytk0mwcupd69hpc52t0cw39a65ndrah86djs784u92a3m5w475w3w35tyd6v3qumkze80j8a6h5tuqq5xe8y";
Options options = Options.builder()
.option(Limit.of(10))
.option(Offset.of(0))
.option(Order.by("block_height", SortType.DESC))
.option(Filter.of("block_height", FilterType.GTE, "3168087"))
.option(Filter.of("block_height", FilterType.LTE, "3168097")).build();
Result<List<TxHash>> transactionsResult = addressService.getAddressTransactions(List.of(address), options);
KOIOS_JAVA_LIB_LOGGING=true
git clone https://github.com/cardano-community/koios-java-client.git
cd koios-java-client
mvn clean install