Class CardanoscanAPI

constructor

• new CardanoscanAPI(apiKey): CardanoscanAPI

• Parameters

  • apiKey: string

  Returns CardanoscanAPI

instance

getAddressBalance

• getAddressBalance(params): Promise<Address>

• Parameters

  • params: GetAddressBalanceParams

  Returns Promise<Address>

getAddressesByStakeKey

• getAddressesByStakeKey(params): Promise<AddressesByStakeKey>

• Parameters

  • params: GetAddressesByStakeKey

  Returns Promise<AddressesByStakeKey>

getAssetDetails

• getAssetDetails(params): Promise<undefined | Token>

• Parameters

  • params: GetAssetDetailsParams

  Returns Promise<undefined | Token>

getAssetHoldersByAssetId

• getAssetHoldersByAssetId(params): Promise<PaginatedAssetHoldersByAssetId>

• Only available in PRO plan

  Parameters

  • params: GetAssetHoldersByAssetIdParams

  Returns Promise<PaginatedAssetHoldersByAssetId>

getAssetHoldersByPolicyId

• getAssetHoldersByPolicyId(params): Promise<PaginatedAssetHoldersByPolicy>

• Only available in PRO plan

  Parameters

  • params: GetAssetHoldersByPolicyIdParams

  Returns Promise<PaginatedAssetHoldersByPolicy>

getAssetsByAddress

• getAssetsByAddress(params): Promise<PaginatedAddressTokens>

• Parameters

  • params: GetAssetByAddressParams

  Returns Promise<PaginatedAddressTokens>

getAssetsByPolicyId

• getAssetsByPolicyId(params): Promise<PaginatedTokens>

• Parameters

  • params: GetAssetsByPolicyIdParams

  Returns Promise<PaginatedTokens>

getAssetsMetadata

• getAssetsMetadata(params): Promise<PaginatedAssetsMetadata>

• Only available in PRO plan

  Parameters

  • params: GetAssetsMetadataParams

  Returns Promise<PaginatedAssetsMetadata>

getBlockDetails

• getBlockDetails(params): Promise<Block>

• Parameters

  • params: GetBlockDetailsParams

  Returns Promise<Block>

getCCHotDetails

• getCCHotDetails(params): Promise<undefined | ccHot>

• Parameters

  • params: GetCCHotDetailsParams

  Returns Promise<undefined | ccHot>

getCCMemberDetails

• getCCMemberDetails(params): Promise<undefined | ccMember>

• Parameters

  • params: GetCCMemberDetailsParams

  Returns Promise<undefined | ccMember>

getCommitteeInformation

• getCommitteeInformation(): Promise<undefined | Committee>

• Returns Promise<undefined | Committee>

getCommitteeMembers

• getCommitteeMembers(params): Promise<PaginatedCommitteeMembers>

• Parameters

  • params: GetCommitteeMembersParams

  Returns Promise<PaginatedCommitteeMembers>

getDRepInformation

• getDRepInformation(params): Promise<undefined | DRep>

• Parameters

  • params: GetDRepInformationParams

  Returns Promise<undefined | DRep>

getDReps

• getDReps(params): Promise<PaginatedDReps>

• Parameters

  • params: GetDRepListParams

  Returns Promise<PaginatedDReps>

getExpiredPools

• getExpiredPools(params): Promise<PaginatedExpiredPools>

• Parameters

  • params: GetExpiredPoolsParams

  Returns Promise<PaginatedExpiredPools>

getExpiringPools

• getExpiringPools(params): Promise<PaginatedExpiringPools>

• Parameters

  • params: GetPoolListExpireParams

  Returns Promise<PaginatedExpiringPools>

getGovernanceAction

• getGovernanceAction(params): Promise<undefined | GovActionResponse>

• Parameters

  • params: GetGovActionParams

  Returns Promise<undefined | GovActionResponse>

getLatestBlockDetails

• getLatestBlockDetails(): Promise<Block>

• Returns Promise<Block>

getNetworkDetails

• getNetworkDetails(): Promise<NetworkState>

• Returns Promise<NetworkState>

getNetworkProtocolDetails

• getNetworkProtocolDetails(): Promise<null | NetworkProtocol>

• Returns Promise<null | NetworkProtocol>

getPoolDetails

• getPoolDetails(params): Promise<undefined | Pool>

• Parameters

  • params: GetPoolDetails

  Returns Promise<undefined | Pool>

getPoolStats

• getPoolStats(params): Promise<undefined | PoolStats>

• Parameters

  • params: GetPoolStatsParams

  Returns Promise<undefined | PoolStats>

getPools

• getPools(params): Promise<PaginatedPools>

• Parameters

  • params: GetPoolListParams

  Returns Promise<PaginatedPools>

getStakeKeyDetails

• getStakeKeyDetails(params): Promise<undefined | StakeKeyDetails>

• Parameters

  • params: GetStakeKeyDetailsParams

  Returns Promise<undefined | StakeKeyDetails>

getTransactionDetails

• getTransactionDetails(params): Promise<undefined | Transaction>

• Parameters

  • params: GetTransactionDetailsParams

  Returns Promise<undefined | Transaction>

getTransactionListByAddress

• getTransactionListByAddress(params): Promise<PaginatedTransactions>

• Parameters

  • params: GetTransactionListByAddressParams

  Returns Promise<PaginatedTransactions>

getTransactionSummary

• getTransactionSummary(params): Promise<TransactionSummary>

• Only available in PRO plan

  Parameters

  • params: GetTransactionSummaryParams

  Returns Promise<TransactionSummary>

getUTXOList

• getUTXOList(params): Promise<PaginatedUtxos>

• Only available in PRO plan

  Parameters

  • params: GetUtxoListParams

  Returns Promise<PaginatedUtxos>

getVotesByAction

• getVotesByAction(params): Promise<PaginatedVotes>

• Only available in PRO plan

  Parameters

  • params: GetVotesByActionParams

  Returns Promise<PaginatedVotes>

getVotesByVoter

• getVotesByVoter(params): Promise<PaginatedVotes>

• Only available in PRO plan

  Parameters

  • params: GetVotesByVoterParams

  Returns Promise<PaginatedVotes>

postSubmitTransaction

• postSubmitTransaction(params): Promise<void>

• Only available in PRO plan

  Parameters

  • params: postSubmitTransactionParams

  Returns Promise<void>