stakelovelace
commit from tesla
3d604a5
raw
history blame
14.6 kB
endpoint;tags;summary;description;ordering_filters;parameters;parameters_description;parameter_types;parameter_examples;returning_fields;curl_example
/tip;Network;Query Chain Tip;Get the tip info about the latest block seen by chain;;;;;;"hash: string; epoch_no: number; abs_slot: number; epoch_slot: number; block_no: number or null; block_time: number;";"curl -X GET ""https://api.koios.rest/api/v1/tip"" -H ""accept: application/json"""
/genesis;Network;Get Genesis info;Get the Genesis parameters used to start specific era on chain;;;;;;;"curl -X GET ""https://api.koios.rest/api/v1/genesis"" -H ""accept: application/json"""
/totals;Network;Get historical tokenomic stats;Get the circulating utxo, treasury, rewards, supply, and reserves in lovelace for the specified epoch. Returns data for all epochs if the epoch number is not provided.;;_epoch_no;Epoch number (required to get specific epoch data).;_epoch_no: number;_epoch_no: 480;;"curl -X GET ""https://api.koios.rest/api/v1/totals?_epoch_no=320"" -H ""accept: application/json"""
/param_updates;Network;Param Update Proposals;Get all parameter update proposals submitted to the chain starting Shelley era;;;;;;;"curl -X GET ""https://api.koios.rest/api/v1/param_updates"" -H ""accept: application/json"""
/reserve_withdrawals;Network;Reserve Withdrawals;List of all withdrawals from reserves against stake accounts;;epoch_no, limit;"Filter blocks by epoch. Use ""epoch_no=eq.{value}"" to filter by an exact match.If not specified, the API defaults to ""eq.{epoch_no}"" where {epoch_no} is the latest epoch fetched from the /tip endpoint.; ";"epoch_no: string; limit: number";"_epoch_no: 480; limit: 5";;"curl -X GET ""https://api.koios.rest/api/v1/reserve_withdrawals"" -H ""accept: application/json"""
/treasury_withdrawals;Network;Treasury Withdrawals;List of all withdrawals from treasury against stake accounts;;epoch_no, limit;"Filter blocks by epoch. Use ""epoch_no=eq.{value}"" to filter by an exact match. If not specified, the API defaults to ""eq.{epoch_no}"" where {epoch_no} is the latest epoch fetched from the /tip endpoint.;";"epoch_no: string; limit: number";"_epoch_no: 480; limit: 5";;"curl -X GET ""https://api.koios.rest/api/v1/treasury_withdrawals"" -H ""accept: application/json"""
/epoch_info;Epoch;Epoch Information;Get the epoch information, all epochs if no epoch specified;;_epoch_no, include_next_epoch;"Epoch number (required to get specific epoch data).; Include details of the next epoch if available.";"_epoch_no: string; include_next_epoch: boolean";"_epoch_no: 480; include_next_epoch: false";;"curl -X GET ""https://api.koios.rest/api/v1/epoch_info?_epoch_no=320&_include_next_epoch=false"" -H ""accept: application/json"""
/epoch_params;Epoch;Epoch's Protocol Parameters;Get the protocol parameters for specific epoch, returns information about all epochs if no epoch specified;;_epoch_no;Epoch number (required to get specific epoch data).;_epoch_no: string;_epoch_no: 480;;"curl -X GET ""https://api.koios.rest/api/v1/epoch_params?_epoch_no=320"" -H ""accept: application/json"""
/epoch_block_protocols;Epoch;Epoch's Block Protocols;Get the information about block protocol distribution in epoch;;_epoch_no;Epoch number (required to get specific epoch data).;_epoch_no: string;_epoch_no: 480;;"curl -X GET ""https://api.koios.rest/api/v1/epoch_block_protocols?_epoch_no=320"" -H ""accept: application/json"""
/blocks;Block;Block List;Get summarised details about all blocks (paginated - latest first);;epoch_no, limit;"Filter blocks by epoch. Use ""epoch_no=eq.{value}"" to filter by an exact match. When epoch_no is not specified, the API defaults to ""eq.{epoch_no}"" where {epoch_no} is the latest epoch fetched from the /tip endpoint.; ";"epoch_no: string; limit: number";"_epoch_no: 480; limit: 5";;"curl -X GET ""https://api.koios.rest/api/v1/blocks"" -H ""accept: application/json"""
/block_info;Block;Block Information;Get detailed information about a specific block;;_block_hashes;Hash of the block;_block_hashes: string;"_block_hashes: [""fb9087c9f1408a7bbd7b022fd294ab565fec8dd3a8ef091567482722a1fa4e30"",""60188a8dcb6db0d80628815be2cf626c4d17cb3e826cebfca84adaff93ad492a"",""c6646214a1f377aa461a0163c213fc6b86a559a2d6ebd647d54c4eb00aaab015""]";;"curl -X POST ""https://api.koios.rest/api/v1/block_info"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_block_hashes"":[""fb9087c9f1408a7bbd7b022fd294ab565fec8dd3a8ef091567482722a1fa4e30"",""60188a8dcb6db0d80628815be2cf626c4d17cb3e826cebfca84adaff93ad492a"",""c6646214a1f377aa461a0163c213fc6b86a559a2d6ebd647d54c4eb00aaab015""]}'"
/block_txs;Block;Block Transactions;Get a list of all transactions included in provided blocks;;_block_hashes;Hash of the block;_block_hashes: string;"_block_hashes: [""fb9087c9f1408a7bbd7b022fd294ab565fec8dd3a8ef091567482722a1fa4e30"",""60188a8dcb6db0d80628815be2cf626c4d17cb3e826cebfca84adaff93ad492a"",""c6646214a1f377aa461a0163c213fc6b86a559a2d6ebd647d54c4eb00aaab015""]";;"curl -X POST ""https://api.koios.rest/api/v1/block_txs"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_block_hashes"":[""fb9087c9f1408a7bbd7b022fd294ab565fec8dd3a8ef091567482722a1fa4e30"",""60188a8dcb6db0d80628815be2cf626c4d17cb3e826cebfca84adaff93ad492a"",""c6646214a1f377aa461a0163c213fc6b86a559a2d6ebd647d54c4eb00aaab015""]}'"
/utxo_info;Transactions;UTxO Info;Get UTxO set for requested UTxO references;;_utxo_refs, _extended;"_utxo_refs: Array of Cardano utxo references in the form “hash#index”; _extended: Controls whether or not certain optional fields supported by a given endpoint are populated as a part of the call";_tx_hashes: string;"_tx_hashes”:[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94""]";;"curl -X POST ""https://api.koios.rest/api/v1/utxo_info"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_utxo_refs"":[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e#0"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94#0""],""_extended"":false}'"
/tx_info;Transactions;Transaction Information;Get detailed information about transaction(s);;_tx_hashes;Array of Cardano Transaction hashes;_tx_hashes: string;"_tx_hashes”:[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94""]";;"curl -X POST ""https://api.koios.rest/api/v1/tx_info"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_tx_hashes"":[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94""]}'"
/tx_metadata;Transactions;Transaction Metadata;Get metadata information (if any) for given transaction(s);;_tx_hashes;Array of Cardano Transaction hashes;_tx_hashes: string;"_tx_hashes”:[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94""]";;"curl -X POST ""https://api.koios.rest/api/v1/tx_metadata"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_tx_hashes"":[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94""]}'"
/tx_metalabels;Transactions;Transaction Metadata Labels;Get a list of all transaction metalabels;;;;;;;"curl -X GET ""https://api.koios.rest/api/v1/tx_metalabels"" -H ""accept: application/json"""
/tx_submit;Transactions;Submit Transaction;Submit an already serialized transaction to the network.;;cbor_data;Assuming ${data} is a raw binary serialized transaction on the file-system.;cbor: binary;;;"curl -X POST --header ""Content-Type: application/cbor"" --data-binary @${data} https://api.koios.rest/api/v1/submittx"
/tx_status;Transactions;Transaction Status;Get the number of block confirmations for a given transaction hash list;;_tx_hashes;Array of Cardano Transaction hashes;_tx_hashes: string;"_tx_hashes”:[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94""]";;"curl -X POST ""https://api.koios.rest/api/v1/tx_status"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_tx_hashes"":[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94""]}'"
/tx_utxos;Transactions;Transaction UTxOs;Get UTxO set (inputs/outputs) of transactions [DEPRECATED - Use /utxo_info instead].;;_tx_hashes;Array of Cardano Transaction hashes;_tx_hashes: string;"_tx_hashes”:[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94""]";;"curl -X POST ""https://api.koios.rest/api/v1/utxo_info"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_utxo_refs"":[""f144a8264acf4bdfe2e1241170969c930d64ab6b0996a4a45237b623f1dd670e#0"",""0b8ba3bed976fa4913f19adc9f6dd9063138db5b4dd29cecde369456b5155e94#0""],""_extended"":false}'"
/address_info;Address;Address Information;Get address info - balance, associated stake address (if any) and UTxO set for given addresses;;_addresses;A Cardano payment/base address (bech32 encoded);_addresses: string;"_addresses"":[""addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv"",""addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y""]";;"curl -X POST ""https://api.koios.rest/api/v1/address_info"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_addresses"":[""addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv"",""addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y""]}'"
/address_assets;Address;Address Assets;Get the list of all the assets (policy, name and quantity) for given addresses;;_addresses;A Cardano payment/base address (bech32 encoded);_addresses: string;"_addresses"":[""addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv"",""addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y""]";;"curl -X POST ""https://api.koios.rest/api/v1/address_assets"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_addresses"":[""addr1qy2jt0qpqz2z2z9zx5w4xemekkce7yderz53kjue53lpqv90lkfa9sgrfjuz6uvt4uqtrqhl2kj0a9lnr9ndzutx32gqleeckv"",""addr1q9xvgr4ehvu5k5tmaly7ugpnvekpqvnxj8xy50pa7kyetlnhel389pa4rnq6fmkzwsaynmw0mnldhlmchn2sfd589fgsz9dd0y""]}'"
/account_list;Stake Account;Account List;Get a list of all stake addresses that have atleast 1 transaction;;;;;;;"curl -X GET ""https://api.koios.rest/api/v1/account_list"" -H ""accept: application/json"""
/account_info;Stake Account;Account Information;Get the account information for given stake addresses;;_stake_address;Cardano staking address (reward account) in bech32 format for which the transactions are requested.;_stake_address: string;"_stake_addresses"":[""stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250"",""stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy""]";;"curl -X POST ""https://api.koios.rest/api/v1/account_info"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_stake_addresses"":[""stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250"",""stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy""]}'"
/account_txs;Stake Account;Account Txs;Get a list of all Txs for a given stake address (account);;_stake_address, _after_block_height;"Cardano staking address (reward account) in bech32 format for which the transactions are requested.; Block height for specifying time delta";"_stake_address: string; _after_block_height: number";"_stake_address: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz; _after_block_height: 100000";;"curl -X GET ""https://api.koios.rest/api/v1/account_txs?_stake_address=stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz&_after_block_height=50000"" -H ""accept: application/json"""
/account_rewards;Stake Account;Account Rewards;Get the full rewards history (including MIR) for given stake addresses;;_stake_addresses, _epoch_no;"_stake_addresses: Array of Cardano stake address(es) in bech32 format; _epoch_no: Epoch number (required to get specific epoch data).";"_stake_address: string; _epoch_no: number";"_stake_address: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz; _epoch_no: 320";;"curl -X POST ""https://api.koios.rest/api/v1/account_rewards"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_stake_addresses"":[""stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250"",""stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy""],""_epoch_no"":409}'"
/account_updates;Stake Account;Account Updates;Get the account updates (registration, deregistration, delegation and withdrawals) for given stake addresses;;_stake_address;Cardano staking address (reward account) in bech32 format for which the transactions are requested.;_stake_address: string;_stake_address: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz;;"curl -X POST ""https://api.koios.rest/api/v1/account_updates"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_stake_addresses"":[""stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250"",""stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy""]}'"
/account_assets;Stake Account;Account Assets;Get the native asset balance for a given stake address;;_stake_address;Cardano staking address (reward account) in bech32 format for which the transactions are requested.;_stake_address: string;_stake_address: stake1u8yxtugdv63wxafy9d00nuz6hjyyp4qnggvc9a3vxh8yl0ckml2uz;;"curl -X POST ""https://api.koios.rest/api/v1/account_assets"" -H ""accept: application/json"" -H ""content-type: application/json"" -d '{""_stake_addresses"":[""stake1uyrx65wjqjgeeksd8hptmcgl5jfyrqkfq0xe8xlp367kphsckq250"",""stake1uxpdrerp9wrxunfh6ukyv5267j70fzxgw0fr3z8zeac5vyqhf9jhy""]}'"
/asset_list;Asset;Asset List;Get the list of all native assets (paginated);;;;;;;"curl -X GET ""https://api.koios.rest/api/v1/asset_list"" -H ""accept: application/json"""