Resources Enums Models Clients

hilltop-api 0.0.1-SNAPSHOT

History | Watch
  • Contact: N/A
  • License: N/A

Resources

active_stake_amount

active_stake_amount resource

Operations

Method and Path Description
GET /active_stake_amounts
GET /active_stake_amounts/:pool_bech32_id
GET /active_stake_amounts/:pool_bech32_id/addresses

block

Operations

Method and Path Description
GET /blocks/blocks_in_day
GET /blocks/:block_number

delegation

Operations

Method and Path Description
GET /delegations/:staking_address/safe_payment
GET /delegations/:staking_address/stakepool

delegators_count

active_stake_amount resource

Operations

Method and Path Description
GET /delegators_counts/:pool_bech32_id

epoch

epoch resource

Operations

Method and Path Description
GET /epochs/current
GET /epochs/:epoch_number

healthcheck

healthcheck endpoint

Operations

Method and Path Description
GET /healthchecks

native_asset

find native assets

Operations

Method and Path Description
GET /native_assets/ids
GET /native_assets/:policy_id/asset_names
GET /native_assets/nfts
POST /native_assets/native_assets_details
GET /native_assets/:stake_address

pool_update

Operations

Method and Path Description
GET /pool_updates/retiring
GET /pool_updates/:pool_id
GET /pool_updates

reward

Operations

Method and Path Description
GET /rewards/:staking_address

sigma

calculates sigma

Operations

Method and Path Description
GET /sigmas/:pool_id

can be either the pool_id (e.g. pool1wcwe923r...) or the pool_hash

stakepool

retrieve stake pool information

Operations

Method and Path Description
GET /stakepools/vrf_vkey/:vrf_vkey_hash

find pool details by vrf_vkey
GET /stakepools/:pool_id/established_epoch

Epoch at which stake pool was originally registered
GET /stakepools/:pool_id/live_stake

live stake in lovelaces
GET /stakepools/:pool_id/blocks

number minted blocks in epoch
GET /stakepools

stakepool_metadata

retrieve stake pool information

Operations

Method and Path Description
GET /stakepool_metadata/:pool_id_bech32

transaction

Operations

Method and Path Description
POST /transactions/history

wallet_balance

Operations

Method and Path Description
GET /wallet_balances/:staking_address

Headers

No headers

Imports

No imports

Enums

country

Name Value Description
IE IE
UK UK

Interfaces

No interfaces

Models

active_stake_amount

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
amount_in_lovelaces long Yes -

address_stake_amount

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
stake_address string Yes -

stake1...
amount_in_lovelaces long Yes -

block

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
number long Yes -

epoch_number long Yes -

slot_number long Yes -

epoch_slot_number long Yes -

size long Yes -

transaction_count long Yes -

time date-time-iso8601 Yes -

cnft_metadata_v001

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
policyId string Yes -

tokens map[string] Yes -

asset cnft_metadata_v001_asset Yes -

cnft_metadata_v001_asset

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
assetName string No -

attributes json No -

ipfs string Yes -

mimeType string No -

day_block

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
first block Yes -

last block Yes -

delegation

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
staking_address string Yes -

delegations [stakepool_delegation] Yes -

delegators_count

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
delegators_count_total integer Yes -

epoch

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
out_sum long Yes -

fees long Yes -

tx_count integer Yes -

blk_count integer Yes -

number integer Yes -

start_time date-time-iso8601 Yes -

end_time date-time-iso8601 Yes -

generic_error

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
description string Yes -

healthcheck

Example Json: Minimal | Full

Interfaces: None

Response for the healthcheck's endpoint of the service

Field Type Required? Default Description
status string Yes -

native_asset

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
transaction_id string Yes -

policy_id string Yes -

token_name string Yes -

metadata json Yes -

block_number long Yes -

epoch_slot_number long Yes -

epoch_number long Yes -

invalid_before long No -

invalid_hereafter long No -

quantity long Yes -

native_asset_details

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
policy_id string Yes -

asset_name string Yes -

metadata json Yes -

minted_at date-time-iso8601 Yes -

last_minted_at date-time-iso8601 Yes -

first_minting_tx_block long Yes -

last_minting_tx_block long Yes -

minting_tx_hash string Yes -

circulating_supply long Yes -

fingerprint string Yes -

native_asset_details_request

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
policy_id string Yes -

asset_names [string] No -

native_asset_id

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
policy_id string Yes -

asset_name string Yes -

block_number long Yes -

block_time date-time-iso8601 Yes -

fingerprint string Yes -

nft_details

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
policy_id string Yes -

asset_name_raw string Yes -

asset_name string No -

metadata json Yes -

minted_at date-time-iso8601 Yes -

minted_at_block long Yes -

minting_tx_hash string Yes -

amount long Yes -

fingerprint string Yes -

nft_metadata

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string No -

image string No -

mediaType string No -

files [nft_metadata_file] No -

nft_metadata_file

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string No -

src string No -

mediaType string No -

nft_metadata_files_as_object

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string No -

image string No -

mediaType string No -

files nft_metadata_file No -

nft_metadata_img_array

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string No -

image [string] No -

mediaType string No -

files [nft_metadata_file] No -

nft_metadata_no_files

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
name string No -

image string No -

mediaType string No -

pool_retiring

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
ticker_name string No -

pool_id string Yes -

certificate_index integer Yes -

epoch_number long Yes -

block_number long Yes -

retiring_at_epoch long Yes -

tx_hash string Yes -

pool_update

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
epoch_number integer Yes -

block_number long Yes -

tx_hash string Yes -

pool_ticker_name string No -

pool_bech32_id string Yes -

certificate_index integer Yes -

vrf_key_hash string Yes -

pledge long Yes -

reward_address string Yes -

active_epoch_number long Yes -

margin double Yes -

fixed_cost long Yes -

reward

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
staking_address string Yes -

epoch integer Yes -

amount long Yes -

pool_id string Yes -

sigma

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
sigma double Yes -

epoch integer Yes -

total_staked long Yes -

active_stake long Yes -

nonce string Yes -

d double Yes -

stakepool

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
id string Yes -

the id of the pool

Example: pool1yr0cv3dtmhcfgqa6yetvmf769ngk89e6tepecmjrmjl2jzcw2lm
pool_id_bech32 string Yes -

the id in bech32 format of the pool

Example: 20df8645abddf09403ba2656cda7da2cd163973a5e439c6e43dcbea9
metadata stakepool_metadata No -

cost long Yes -

operational costs per epoch in lovelaces
margin double Yes -

operator margin, percentage (from 0 to 1)
pledge long Yes -

pledge amount, in lovelaces
active_stake long Yes -

active stake for current epoch in lovelaces
saturation double Yes -

pool saturation as percentage (0 to 1)
retiring_at_epoch long No -

if defined, is the epoch at which the pool will retire

stakepool_delegation

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
stakepool stakepool Yes -

epoch integer Yes -

stakepool_metadata

Example Json: Minimal | Full

Interfaces: None

Stake Pool Offline Metadata

Field Type Required? Default Description
name string Yes -

ticker string Yes -

homepage string Yes -

description string Yes -

extended string No -

transaction

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
hash string Yes -

block long Yes -

timestamp date-time-iso8601 Yes -

transaction_history_request

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
addresses [string] Yes -

wallet_balance

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description
balance long Yes -

Unions

No unions

Annotations

No annotations