Koios API is Elastic Cardano Query Layer!
A consistent query layer for developers to build upon Cardano, with
multiple, redundant endpoints that allow $$for easy scalability.
Development Status
see koios-cli -h for available commands
koios-cli api --help
KOIOS CLI - v2.0.0
Copyright © 2022 - 2024 The Cardano Community
License: Apache-2.0
Interact with Koios API REST endpoints
koios api [flags] [subcommand]
COMMANDS:
ADDRESS - Query information about specific address(es)
address_assets Address Assets
address_info Address Information
address_txs Address Transactions
address_utxos Address UTxOs
credential_txs Transactions from payment credentials
credential_utxos UTxOs from payment credentials
ASSET - Query Asset related informations
asset_addresses Asset Addresses
asset_history Asset History
asset_info Asset Information (Bulk)
asset_list Asset List
asset_nft_address Asset NFT Address
asset_summary Asset Summary
asset_token_registry Asset Token Registry
asset_txs Asset Transactions
asset_utxos Asset UTXOs
policy_asset_addresses Policy Asset Address List
policy_asset_info Policy Asset Information
policy_asset_list Policy Asset List
policy_asset_mints Policy Asset Mints
BLOCK - Query information about particular block on chain
block-info Block Info
block-txs Block Txs
blocks Block List
EPOCH - Query epoch-specific details
epoch_block_protocols Epoch Block Protocols
epoch_info Epoch Information
epoch_params Epoch Parameters
NETWORK - Query information about the network
genesis Get Genesis info
param_updates Param Update Proposals
reserve_withdrawals Reserve Withdrawals
tip Query Chain Tip
totals Get historical tokenomic stats
treasury_withdrawals Treasury Withdrawals
OGMIOS - Various stateless queries against Ogmios v6 instance
ogmios NOT IMPLEMENTED
POOL - Query information about specific pools
pool_blocks Pool Blocks
pool_delegators Pool Delegators
pool_delegators_history Pool Delegators History
pool_history Pool History
pool_info Pool Information
pool_list Pool List
pool_metadata Pool Metadata
pool_registrations Pool Registrations
pool_relays Pool Relays
pool_retirements Pool Retirements
pool_stake_snapshot Pool Stake Snapshot
pool_updates Pool Updates (History)
SCRIPT - Query information about specific scripts (Smart Contracts)
datum_info Datum Information
native_script_list Native Script List
plutus_script_list Plutus Script List
script_info Script Information
script_redeemers Script Redeemers
script_utxos Script Utxos
STAKE ACCOUNT - Query details about specific stake account addresses
account_addresses Account Addresses
account_assets Account Assets
account_history Account History
account_info Account Information
account_info_cached Account Information Cached
account_list Account List
account_rewards Account Rewards
account_txs Account Transactions
account_updates Account Updates
account_utxos Account Utxos
TRANSACTIONS - Query blockchain transaction details
submittx NOT IMPLEMENTED
tx_info Transaction Information
tx_metadata Transaction Metadata
tx_metalabels Transaction Metadata Labels
tx_status Transaction Status
utxo_info UTxO Info
FLAGS:
--api-version Set API version - default: "v1"
--auth JWT Bearer Auth token generated via https://koios.rest Profile page.
--host Set host for the API server - default: "api.koios.rest"
--host-eu Use eu mainet network host - default: "false"
--host-guildnet Use guildnet network host - default: "false"
--host-preprod Use preprod network host - default: "false"
--host-preview Use preview network host - default: "false"
--no-format prints response as machine readable json string - default: "false"
--origin Set origin for the API server - default:
"https://github.com/cardano-community/koios-cli/v2"
--port Set port number for the API server - default: "443"
--rate-limit Set rate limit for the API server - default: "10"
--scheme Set scheme for the API server - default: "https"
--stats Enable request stats - default: "false"
--timeout Set timeout for the API server - default: "1m0s"
GLOBAL FLAGS:
--debug enable debug log level. when debug flag is after the command then debug level
will be enabled only for that command - default: "false"
--help -h display help or help for the command. [...command --help] - default: "false"
--profile session profile to be used - default: "public"
--system-debug enable system debug log level (very verbose) - default: "false"
--verbose -v enable verbose log level - default: "false"
--version print application version - default: "false"
-x the -x flag prints all the cli commands as they are executed. - default: "false"
koios-cli api --stats tipresponse
{
"request_url": "https://api.koios.rest/api/v1/tip",
"request_method": "GET",
"status_code": 200,
"status": "200 OK",
"date": "Fri, 31 May 2024 08:06:48 GMT",
"content_range": "0-0/*",
"stats": {
"req_started_at": "2024-05-31T08:06:48.846603938Z",
"req_dns_lookup_dur": 78489018,
"tls_hs_dur": 109035482,
"est_cxn_dur": 62920181,
"ttfb": 636448677,
"req_dur": 636774353,
"req_dur_str": "636.774353ms",
"auth": {
"tier": "public",
"expires": "No expiration date",
"max_requests": 5000,
"max_rps": 10,
"query_timeout": "30s",
"cors_restricted": true
}
},
"data": {
"abs_slot": 125576504,
"block_no": 10385051,
"block_time": 1717142795,
"epoch_no": 488,
"epoch_slot": 123704,
"hash": "1dd29324ce46038be9afb9011348530e6ff2e57ad0f818dcbe12bbf498abd157"
}
}koios-cli api --stats --host-preprod tip
# OR
koios-cli api --stats --host preprod.koios.rest tipresponse
{
"request_url": "https://preprod.koios.rest/api/v1/tip",
"request_method": "GET",
"status_code": 200,
"status": "200 OK",
"date": "Fri, 31 May 2024 08:09:31 GMT",
"content_range": "0-0/*",
"stats": {
"req_started_at": "2024-05-31T08:09:30.905348607Z",
"req_dns_lookup_dur": 1873265,
"tls_hs_dur": 63867504,
"est_cxn_dur": 28092739,
"ttfb": 159446743,
"req_dur": 159811589,
"req_dur_str": "159.811589ms",
"auth": {
"tier": "public",
"expires": "No expiration date",
"max_requests": 5000,
"max_rps": 10,
"query_timeout": "30s",
"cors_restricted": true
}
},
"data": {
"abs_slot": 61459716,
"block_no": 2304547,
"block_time": 1717142916,
"epoch_no": 146,
"epoch_slot": 29316,
"hash": "1f5df7af623cfc29539ee48a3cfd5ac9c93a5b85fd84066566c762a968d0f04c"
}
}It's highly recommended installing a latest version of koios-cli available on the releases page.
go install github.com/cardano-community/koios-cli/v2@latestverify installation
koios-cli --version
We would love for you to contribute to Koios API Client Library for Go and help make it even better than it is today! As a contributor, here are the guidelines we would like you to follow:
- Code of Conduct
- Question or Problem?
- Found a Bug?
- Missing a Feature?
- Submission Guidelines
- Coding Rules
- Commit Message Guidelines
- Development Documentation
Help us keep Koios API Client Library for Go open and inclusive. Please read and follow our Code of Conduct
Do not open issues for general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on Koios Telegram Group
If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better, you can submit a Pull Request with a fix.
You can request a new feature by submitting an issue to our GitHub Repository. If you would like to implement a new feature, please submit an issue with a proposal for your work first, to be sure that we can use it. Please consider what kind of change it is:
- For a Major Feature, first open an issue and outline your proposal so that it can be discussed. This will also allow us to better coordinate our efforts, prevent duplication of work, and help you to craft the change so that it is successfully accepted into the project.
- Small Features can be crafted and directly submitted as a Pull Request.
Before you submit an issue, please search the issue tracker, maybe an issue for your problem already exists and the discussion might inform you of workarounds readily available.
You can file new issues by filling out our new issue form.
Before you submit your Pull Request (PR) consider the following guidelines:
-
Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.
-
Fork the cardano-community/koios-cli repo.
-
Setup you local repository
git@github.com:<your-github-username>/koios-cli.git cd koios-cli git remote add upstream git@github.com:cardano-community/koios-cli.git
-
Make your changes in a new git branch and ensure that you always start from up to date main branch. Repeat this step every time you are about to start woking on new PR.
e.g. Start new change work to update readme:
# if you are not in main branch e.g. still on previous work branch git checkout main git pull --ff upstream main git checkout -b update-readme main -
Create your patch, including appropriate test cases.
-
Follow our Coding Rules.
-
If changes are in source code except documentations then run the full test suite, as described in the developer documentation, and ensure that all tests pass.
-
Commit your changes using a descriptive commit message that follows our commit message conventions. Adherence to these conventions is necessary because release notes are automatically generated from these messages.
git add -A git commit --signoff # or in short git commit -sm"docs(markdown): update readme examples"
-
Push your branch to GitHub:
git push -u origin update-readme
-
In GitHub, send a pull request to
mainbranch.
- If we suggest changes then:
-
Make the required updates.
-
Re-run the test suites to ensure tests are still passing.
-
Rebase your branch and force push to your GitHub repository (this will update your Pull Request):
git fetch --all git rebase upstream main git push -uf origin update-readme
-
That's it! Thank you for your contribution!
After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:
-
Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:
git push origin --delete update-readme
-
Check out the main branch:
git checkout main -f
-
Delete the local branch:
git branch -D update-readme
-
Update your master with the latest upstream version:
git pull --ff upstream main
To ensure consistency throughout the source code, keep these rules in mind as you are working:
- All features or bug fixes must be tested by one or more specs (unit-tests).
- All public API methods must be documented.
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits. Our release workflow uses these rules to generate changelogs.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
When maintainers are merging PR merge commit should be edited:
<type>(<scope>): <subject> (#pr)
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
The footer should contain a closing reference to an issue if any.
Samples:
docs(markdown): update readme examples
fix(endpoint): update Tip endpoint to latest specs.
description of your change.
refactor(client): change Client GET function signature
change order of client GET method arguments.
BREAKING CHANGE: Clien.Get signature has changed
If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
Must be one of the following:
- build: Changes that affect the build system or external dependencies (example scopes: goreleaser, taskfile)
- chore: Other changes that don't modify src or test files.
- ci: Changes to our CI configuration files and scripts.
- dep: Changes related to dependecies e.g.
go.mod - docs: Documentation only changes (example scopes: markdown, godoc)
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- revert: Reverts a previous commit
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
The following is the list of supported scopes:
| scope | description |
|---|---|
| client | API client related changes |
| endpoint | Changes related to api endpoints |
| godoc | Go documentation |
| markdown | Markdown files |
The subject contains a succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize the first letter
- no dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines. The rest of the commit message is then used for this.
A detailed explanation can be found in this [document][commit-message-format].
Prerequisites:
-
Working Go environment. See the install instructions for Go.
-
golangci-lint - Go linters aggregator should be installed
-
taskfile - task runner / build tool should be installed
-
svu - Semantic Version Util tool should be installed
-
Fork the cardano-community/koios-cli repo.
-
Setup you local repository
git@github.com:<your-github-username>/koios-cli.git cd koios-cli git remote add upstream git@github.com:cardano-community/koios-cli.git
Setup local env
task setupLint your code
task lintTest your change
task testView code coverage report from in browser (results from task test)
task cover
Original author.
koios-cli was moved under Cardano Community from howijd/koios-rest-go-client