{"swagger":"2.0","info":{"title":"hilltop-api","version":"0.0.1-SNAPSHOT"},"host":"hilltop-api.mainnet.dandelion.link","basePath":"/","schemes":["https"],"consumes":["application/json"],"produces":["application/json"],"paths":{"/active_stake_amounts":{"get":{"parameters":[{"name":"epoch_number","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/active_stake_amount"}}}}},"/active_stake_amounts/{pool_bech32_id}":{"get":{"parameters":[{"name":"pool_bech32_id","in":"path","required":true,"type":"string"},{"name":"epoch_number","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/active_stake_amount"}}}}},"/active_stake_amounts/{pool_bech32_id}/addresses":{"get":{"parameters":[{"name":"pool_bech32_id","in":"path","required":true,"type":"string"},{"name":"epoch_number","in":"query","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/address_stake_amount"}}}}}},"/blocks/blocks_in_day":{"get":{"parameters":[{"name":"date","in":"query","required":true,"type":"string","format":"date"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/day_block"}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/blocks/{block_number}":{"get":{"parameters":[{"name":"block_number","in":"path","description":"the block number","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/block"}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/delegations/{staking_address}/safe_payment":{"get":{"parameters":[{"name":"staking_address","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/string"}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/delegations/{staking_address}/stakepool":{"get":{"parameters":[{"name":"staking_address","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/delegation"}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/delegators_counts/{pool_bech32_id}":{"get":{"parameters":[{"name":"pool_bech32_id","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/delegators_count"}}}}},"/epochs/current":{"get":{"parameters":[],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/epoch"}}}}},"/epochs/{epoch_number}":{"get":{"parameters":[{"name":"epoch_number","in":"path","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/epoch"}}}}},"/healthchecks":{"get":{"parameters":[],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/healthcheck"}}}}},"/native_assets/ids":{"get":{"parameters":[{"name":"block_number_from","in":"query","description":"the block number from when fetching updates, it's the pagination index","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"the number of updates to fetch","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/native_asset_id"}}}}}},"/native_assets/{policy_id}/asset_names":{"get":{"parameters":[{"name":"policy_id","in":"path","description":"the policy id to get the asset name","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/string"}}}}}},"/native_assets/nfts":{"get":{"parameters":[{"name":"block_number_from","in":"query","required":true,"type":"integer","format":"int64"},{"name":"block_number_to","in":"query","required":true,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/nft_details"}}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/native_assets/native_assets_details":{"post":{"parameters":[{"name":"native_asset_details_request","in":"body","schema":{"$ref":"#/definitions/native_asset_details_request"}}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/native_asset_details"}}}}}},"/native_assets/{stake_address}":{"get":{"parameters":[{"name":"stake_address","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/native_asset"}}}}}},"/pool_updates/retiring":{"get":{"parameters":[{"name":"block_number_from","in":"query","description":"the block number from when fetching updates, it's the pagination index","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"the number of updates to fetch","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/pool_retiring"}}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/pool_updates/{pool_id}":{"get":{"parameters":[{"name":"pool_id","in":"path","required":true,"type":"string"},{"name":"block_number_from","in":"query","description":"the block number from when fetching updates, it's the pagination index","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"the number of updates to fetch","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/pool_update"}}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/pool_updates":{"get":{"parameters":[{"name":"block_number_from","in":"query","description":"the block number from when fetching updates, it's the pagination index","required":false,"type":"integer","format":"int64"},{"name":"limit","in":"query","description":"the number of updates to fetch","required":false,"type":"integer","format":"int64"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/pool_update"}}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/rewards/{staking_address}":{"get":{"parameters":[{"name":"staking_address","in":"path","required":true,"type":"string"},{"name":"epoch_from","in":"query","required":false,"type":"integer","format":"int32"},{"name":"epoch_to","in":"query","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/reward"}}}}}},"/sigmas/{pool_id}":{"get":{"description":"can be either the pool_id (e.g. pool1wcwe923r...) or the pool_hash","parameters":[{"name":"pool_id","in":"path","required":true,"type":"string"},{"name":"epoch_number","in":"query","required":true,"type":"integer","format":"int32"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/sigma"}}}}},"/stakepools/vrf_vkey/{vrf_vkey_hash}":{"get":{"description":"find pool details by vrf_vkey","parameters":[{"name":"vrf_vkey_hash","in":"path","description":"the hash of the vrf_vkey","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/stakepool"}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/stakepools/{pool_id}/established_epoch":{"get":{"description":"Epoch at which stake pool was originally registered","parameters":[{"name":"pool_id","in":"path","description":"id of the pool to query. Both id and bech32 formats are supported","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/integer"}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/stakepools/{pool_id}/live_stake":{"get":{"description":"live stake in lovelaces","parameters":[{"name":"pool_id","in":"path","description":"id of the pool to query. Both id and bech32 formats are supported","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/long"}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/stakepools/{pool_id}/blocks":{"get":{"description":"number minted blocks in epoch","parameters":[{"name":"pool_id","in":"path","description":"id of the pool to query. Both id and bech32 formats are supported","required":true,"type":"string"},{"name":"epoch","in":"query","description":"epoch in which to query number of produced blocks or current epoch if not specified","required":false,"type":"integer","format":"int32"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/integer"}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/stakepools":{"get":{"parameters":[],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/stakepool"}}}}}},"/stakepool_metadata/{pool_id_bech32}":{"get":{"parameters":[{"name":"pool_id_bech32","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/stakepool_metadata"}},"404":{"description":"404 response","schema":{"$ref":"#/definitions/generic_error"}}}}},"/transactions/history":{"post":{"parameters":[{"name":"transaction_history_request","in":"body","schema":{"$ref":"#/definitions/transaction_history_request"}}],"responses":{"200":{"description":"200 response","schema":{"type":"array","items":{"$ref":"#/definitions/transaction"}}}}}},"/wallet_balances/{staking_address}":{"get":{"parameters":[{"name":"staking_address","in":"path","required":true,"type":"string"}],"responses":{"200":{"description":"200 response","schema":{"$ref":"#/definitions/wallet_balance"}}}}}},"definitions":{"active_stake_amount":{"type":"object","title":"active_stake_amount","required":["amount_in_lovelaces"],"properties":{"amount_in_lovelaces":{"type":"integer","format":"int64"}}},"address_stake_amount":{"type":"object","title":"address_stake_amount","required":["stake_address","amount_in_lovelaces"],"properties":{"stake_address":{"description":"stake1...","type":"string"},"amount_in_lovelaces":{"type":"integer","format":"int64"}}},"block":{"type":"object","title":"block","required":["number","epoch_number","slot_number","epoch_slot_number","size","transaction_count","time"],"properties":{"number":{"type":"integer","format":"int64"},"epoch_number":{"type":"integer","format":"int64"},"slot_number":{"type":"integer","format":"int64"},"epoch_slot_number":{"type":"integer","format":"int64"},"size":{"type":"integer","format":"int64"},"transaction_count":{"type":"integer","format":"int64"},"time":{"type":"string","format":"date-time"}}},"cnft_metadata_v001":{"type":"object","title":"cnft_metadata_v001","required":["policyId","tokens","asset"],"properties":{"policyId":{"type":"string"},"tokens":{"$ref":"#/definitions/map[string]"},"asset":{"$ref":"#/definitions/cnft_metadata_v001_asset"}}},"cnft_metadata_v001_asset":{"type":"object","title":"cnft_metadata_v001_asset","required":["ipfs"],"properties":{"assetName":{"type":"string"},"attributes":{"$ref":"#/definitions/json"},"ipfs":{"type":"string"},"mimeType":{"type":"string"}}},"day_block":{"type":"object","title":"day_block","required":["first","last"],"properties":{"first":{"$ref":"#/definitions/block"},"last":{"$ref":"#/definitions/block"}}},"delegation":{"type":"object","title":"delegation","required":["staking_address","delegations"],"properties":{"staking_address":{"type":"string"},"delegations":{"type":"array","items":{"$ref":"#/definitions/stakepool_delegation"}}}},"delegators_count":{"type":"object","title":"delegators_count","required":["delegators_count_total"],"properties":{"delegators_count_total":{"type":"integer","format":"int32"}}},"epoch":{"type":"object","title":"epoch","required":["out_sum","fees","tx_count","blk_count","number","start_time","end_time"],"properties":{"out_sum":{"type":"integer","format":"int64"},"fees":{"type":"integer","format":"int64"},"tx_count":{"type":"integer","format":"int32"},"blk_count":{"type":"integer","format":"int32"},"number":{"type":"integer","format":"int32"},"start_time":{"type":"string","format":"date-time"},"end_time":{"type":"string","format":"date-time"}}},"generic_error":{"type":"object","title":"generic_error","required":["description"],"properties":{"description":{"type":"string"}}},"healthcheck":{"type":"object","description":"Response for the healthcheck's endpoint of the service","title":"healthcheck","required":["status"],"properties":{"status":{"type":"string"}}},"native_asset":{"type":"object","title":"native_asset","required":["transaction_id","policy_id","token_name","metadata","block_number","epoch_slot_number","epoch_number","quantity"],"properties":{"transaction_id":{"type":"string"},"policy_id":{"type":"string"},"token_name":{"type":"string"},"metadata":{"$ref":"#/definitions/json"},"block_number":{"type":"integer","format":"int64"},"epoch_slot_number":{"type":"integer","format":"int64"},"epoch_number":{"type":"integer","format":"int64"},"invalid_before":{"type":"integer","format":"int64"},"invalid_hereafter":{"type":"integer","format":"int64"},"quantity":{"type":"integer","format":"int64"}}},"native_asset_details":{"type":"object","title":"native_asset_details","required":["policy_id","asset_name","metadata","minted_at","last_minted_at","first_minting_tx_block","last_minting_tx_block","minting_tx_hash","circulating_supply","fingerprint"],"properties":{"policy_id":{"type":"string"},"asset_name":{"type":"string"},"metadata":{"$ref":"#/definitions/json"},"minted_at":{"type":"string","format":"date-time"},"last_minted_at":{"type":"string","format":"date-time"},"first_minting_tx_block":{"type":"integer","format":"int64"},"last_minting_tx_block":{"type":"integer","format":"int64"},"minting_tx_hash":{"type":"string"},"circulating_supply":{"type":"integer","format":"int64"},"fingerprint":{"type":"string"}}},"native_asset_details_request":{"type":"object","title":"native_asset_details_request","required":["policy_id"],"properties":{"policy_id":{"type":"string"},"asset_names":{"type":"array","items":{"type":"string"}}}},"native_asset_id":{"type":"object","title":"native_asset_id","required":["policy_id","asset_name","block_number","block_time","fingerprint"],"properties":{"policy_id":{"type":"string"},"asset_name":{"type":"string"},"block_number":{"type":"integer","format":"int64"},"block_time":{"type":"string","format":"date-time"},"fingerprint":{"type":"string"}}},"nft_details":{"type":"object","title":"nft_details","required":["policy_id","asset_name_raw","metadata","minted_at","minted_at_block","minting_tx_hash","amount","fingerprint"],"properties":{"policy_id":{"type":"string"},"asset_name_raw":{"type":"string"},"asset_name":{"type":"string"},"metadata":{"$ref":"#/definitions/json"},"minted_at":{"type":"string","format":"date-time"},"minted_at_block":{"type":"integer","format":"int64"},"minting_tx_hash":{"type":"string"},"amount":{"type":"integer","format":"int64"},"fingerprint":{"type":"string"}}},"nft_metadata":{"type":"object","title":"nft_metadata","properties":{"name":{"type":"string"},"image":{"type":"string"},"mediaType":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/definitions/nft_metadata_file"}}}},"nft_metadata_file":{"type":"object","title":"nft_metadata_file","properties":{"name":{"type":"string"},"src":{"type":"string"},"mediaType":{"type":"string"}}},"nft_metadata_files_as_object":{"type":"object","title":"nft_metadata_files_as_object","properties":{"name":{"type":"string"},"image":{"type":"string"},"mediaType":{"type":"string"},"files":{"$ref":"#/definitions/nft_metadata_file"}}},"nft_metadata_img_array":{"type":"object","title":"nft_metadata_img_array","properties":{"name":{"type":"string"},"image":{"type":"array","items":{"type":"string"}},"mediaType":{"type":"string"},"files":{"type":"array","items":{"$ref":"#/definitions/nft_metadata_file"}}}},"nft_metadata_no_files":{"type":"object","title":"nft_metadata_no_files","properties":{"name":{"type":"string"},"image":{"type":"string"},"mediaType":{"type":"string"}}},"pool_retiring":{"type":"object","title":"pool_retiring","required":["pool_id","certificate_index","epoch_number","block_number","retiring_at_epoch","tx_hash"],"properties":{"ticker_name":{"type":"string"},"pool_id":{"type":"string"},"certificate_index":{"type":"integer","format":"int32"},"epoch_number":{"type":"integer","format":"int64"},"block_number":{"type":"integer","format":"int64"},"retiring_at_epoch":{"type":"integer","format":"int64"},"tx_hash":{"type":"string"}}},"pool_update":{"type":"object","title":"pool_update","required":["epoch_number","block_number","tx_hash","pool_bech32_id","certificate_index","vrf_key_hash","pledge","reward_address","active_epoch_number","margin","fixed_cost"],"properties":{"epoch_number":{"type":"integer","format":"int32"},"block_number":{"type":"integer","format":"int64"},"tx_hash":{"type":"string"},"pool_ticker_name":{"type":"string"},"pool_bech32_id":{"type":"string"},"certificate_index":{"type":"integer","format":"int32"},"vrf_key_hash":{"type":"string"},"pledge":{"type":"integer","format":"int64"},"reward_address":{"type":"string"},"active_epoch_number":{"type":"integer","format":"int64"},"margin":{"type":"number","format":"double"},"fixed_cost":{"type":"integer","format":"int64"}}},"reward":{"type":"object","title":"reward","required":["staking_address","epoch","amount","pool_id"],"properties":{"staking_address":{"type":"string"},"epoch":{"type":"integer","format":"int32"},"amount":{"type":"integer","format":"int64"},"pool_id":{"type":"string"}}},"sigma":{"type":"object","title":"sigma","required":["sigma","epoch","total_staked","active_stake","nonce","d"],"properties":{"sigma":{"type":"number","format":"double"},"epoch":{"type":"integer","format":"int32"},"total_staked":{"type":"integer","format":"int64"},"active_stake":{"type":"integer","format":"int64"},"nonce":{"type":"string"},"d":{"type":"number","format":"double"}}},"stakepool":{"type":"object","title":"stakepool","required":["id","pool_id_bech32","cost","margin","pledge","active_stake","saturation"],"properties":{"id":{"description":"the id of the pool","example":"pool1yr0cv3dtmhcfgqa6yetvmf769ngk89e6tepecmjrmjl2jzcw2lm","type":"string"},"pool_id_bech32":{"description":"the id in bech32 format of the pool","example":"20df8645abddf09403ba2656cda7da2cd163973a5e439c6e43dcbea9","type":"string"},"metadata":{"$ref":"#/definitions/stakepool_metadata"},"cost":{"description":"operational costs per epoch in lovelaces","type":"integer","format":"int64"},"margin":{"description":"operator margin, percentage (from 0 to 1)","type":"number","format":"double"},"pledge":{"description":"pledge amount, in lovelaces","type":"integer","format":"int64"},"active_stake":{"description":"active stake for current epoch in lovelaces","type":"integer","format":"int64"},"saturation":{"description":"pool saturation as percentage (0 to 1)","type":"number","format":"double"},"retiring_at_epoch":{"description":"if defined, is the epoch at which the pool will retire","type":"integer","format":"int64"}}},"stakepool_delegation":{"type":"object","title":"stakepool_delegation","required":["stakepool","epoch"],"properties":{"stakepool":{"$ref":"#/definitions/stakepool"},"epoch":{"type":"integer","format":"int32"}}},"stakepool_metadata":{"type":"object","description":"Stake Pool Offline Metadata","title":"stakepool_metadata","required":["name","ticker","homepage","description"],"properties":{"name":{"type":"string"},"ticker":{"type":"string"},"homepage":{"type":"string"},"description":{"type":"string"},"extended":{"type":"string"}}},"transaction":{"type":"object","title":"transaction","required":["hash","block","timestamp"],"properties":{"hash":{"type":"string"},"block":{"type":"integer","format":"int64"},"timestamp":{"type":"string","format":"date-time"}}},"transaction_history_request":{"type":"object","title":"transaction_history_request","required":["addresses"],"properties":{"addresses":{"type":"array","items":{"type":"string"}}}},"wallet_balance":{"type":"object","title":"wallet_balance","required":["balance"],"properties":{"balance":{"type":"integer","format":"int64"}}}}}