Interface EtherscanApi

The namespaced Etherscan API returned by init.

interface EtherscanApi {
    account: {
        balance(
            address: string | string[],
        ): Promise<EtherscanResponse<string | MultiBalanceItem[]>>;
        fundedby(address: string): Promise<EtherscanResponse<unknown>>;
        getdeposittxs(
            address: string,
            startblock?: string | number,
            endblock?: string | number,
            page?: number,
            offset?: number,
            sort?: string,
        ): Promise<EtherscanResponse<unknown>>;
        getminedblocks(address: string): Promise<EtherscanResponse<MinedBlock[]>>;
        getwithdrawaltxs(
            address: string,
            startblock?: string | number,
            endblock?: string | number,
            page?: number,
            offset?: number,
            sort?: string,
        ): Promise<EtherscanResponse<unknown>>;
        token1155tx(
            address: string,
            contractaddress?: string,
            startblock?: string | number,
            endblock?: string | number,
            page?: number,
            offset?: number,
            sort?: string,
        ): Promise<EtherscanResponse<Erc1155Transfer[]>>;
        tokenbalance(
            address?: string,
            tokenname?: string,
            contractaddress?: string,
        ): Promise<EtherscanResponse<string>>;
        tokennfttx(
            address: string,
            contractaddress?: string,
            startblock?: string | number,
            endblock?: string | number,
            page?: number,
            offset?: number,
            sort?: string,
        ): Promise<EtherscanResponse<Erc721Transfer[]>>;
        tokentx(
            address: string,
            contractaddress?: string,
            startblock?: string | number,
            endblock?: string | number,
            page?: number,
            offset?: number,
            sort?: string,
        ): Promise<EtherscanResponse<Erc20Transfer[]>>;
        txlist(
            address: string,
            startblock?: string | number,
            endblock?: string | number,
            page?: number,
            offset?: number,
            sort?: string,
        ): Promise<EtherscanResponse<NormalTransaction[]>>;
        txlistinternal(
            txhash?: string,
            address?: string,
            startblock?: string | number,
            endblock?: string | number,
            sort?: string,
        ): Promise<EtherscanResponse<InternalTransaction[]>>;
        txsBeaconWithdrawal(
            address: string,
            startblock?: string | number,
            endblock?: string | number,
            page?: number,
            offset?: number,
            sort?: string,
        ): Promise<EtherscanResponse<unknown>>;
    };
    block: {
        getblockcountdown(
            blockno: string | number,
        ): Promise<EtherscanResponse<BlockCountdown>>;
        getblocknobytime(
            timestamp: string | number,
            closest?: "before" | "after",
        ): Promise<EtherscanResponse<string>>;
        getblockreward(
            address: string,
            blockno?: string | number,
        ): Promise<EtherscanResponse<BlockReward>>;
    };
    contract: {
        checkproxyverification(
            guid: string,
        ): Promise<EtherscanResponse<string>>;
        checkverifystatus(guid: string): Promise<EtherscanResponse<string>>;
        getabi(address: string): Promise<EtherscanResponse<string>>;
        getcontractcreation(
            contractaddresses: string | string[],
        ): Promise<EtherscanResponse<ContractCreation[]>>;
        getsourcecode(
            address: string,
        ): Promise<EtherscanResponse<ContractSource[]>>;
        verifyproxycontract(
            address: string,
            expectedimplementation?: string,
        ): Promise<EtherscanResponse<string>>;
        verifysourcecode(
            params: VerifySourceCodeParams,
        ): Promise<EtherscanResponse<string>>;
        verifystylus(params: VerifyParams): Promise<EtherscanResponse<string>>;
        verifyvyper(params: VerifyParams): Promise<EtherscanResponse<string>>;
        verifyzksyncsourcecode(
            params: VerifyParams,
        ): Promise<EtherscanResponse<string>>;
    };
    gastracker: {
        gasestimate(
            gasprice: string | number,
        ): Promise<EtherscanResponse<string>>;
        gasoracle(): Promise<EtherscanResponse<GasOracle>>;
    };
    log: {
        getLogs(
            address?: string,
            fromBlock?: string | number,
            toBlock?: string | number,
            topic0?: string,
            topic0_1_opr?: string,
            topic1?: string,
            topic1_2_opr?: string,
            topic2?: string,
            topic2_3_opr?: string,
            topic3?: string,
            topic0_2_opr?: string,
            page?: number,
            offset?: number,
        ): Promise<EtherscanResponse<EventLog[]>>;
    };
    proxy: {
        eth_blockNumber(): Promise<EtherscanResponse<string>>;
        eth_call(
            to: string,
            data: string,
            tag: string,
        ): Promise<EtherscanResponse<string>>;
        eth_estimateGas(
            to: string,
            value: string,
            gasPrice: string,
            gas: string,
        ): Promise<EtherscanResponse<string>>;
        eth_gasPrice(): Promise<EtherscanResponse<string>>;
        eth_getBlockByNumber(
            tag: string,
            fullTransactions?: boolean,
        ): Promise<EtherscanResponse<unknown>>;
        eth_getBlockTransactionCountByNumber(
            tag: string,
        ): Promise<EtherscanResponse<string>>;
        eth_getCode(
            address: string,
            tag: string,
        ): Promise<EtherscanResponse<string>>;
        eth_getStorageAt(
            address: string,
            position: string,
            tag: string,
        ): Promise<EtherscanResponse<string>>;
        eth_getTransactionByBlockNumberAndIndex(
            tag: string,
            index: string,
        ): Promise<EtherscanResponse<unknown>>;
        eth_getTransactionByHash(
            txhash: string,
        ): Promise<EtherscanResponse<unknown>>;
        eth_getTransactionCount(
            address: string,
        ): Promise<EtherscanResponse<string>>;
        eth_getTransactionReceipt(
            txhash: string,
        ): Promise<EtherscanResponse<unknown>>;
        eth_getUncleByBlockNumberAndIndex(
            tag: string,
            index: string,
        ): Promise<EtherscanResponse<unknown>>;
        eth_sendRawTransaction(hex: string): Promise<EtherscanResponse<string>>;
    };
    stats: {
        ethprice(): Promise<EtherscanResponse<EthPrice>>;
        ethsupply(): Promise<EtherscanResponse<string>>;
        ethsupply2(): Promise<EtherscanResponse<string>>;
        nodecount(): Promise<EtherscanResponse<string>>;
        tokensupply(
            tokenname?: string | null,
            contractaddress?: string,
        ): Promise<EtherscanResponse<string>>;
    };
    transaction: {
        getstatus(txhash: string): Promise<EtherscanResponse<ExecutionStatus>>;
        gettxreceiptstatus(
            txhash: string,
        ): Promise<EtherscanResponse<ReceiptStatus>>;
    };
    usage: {
        chainlist(): Promise<EtherscanResponse<ChainListItem[]>>;
        getapilimit(): Promise<EtherscanResponse<unknown>>;
    };
}

Index

Properties

account block contract gastracker log proxy stats transaction usage

Properties

account

account: {
    balance(
        address: string | string[],
    ): Promise<EtherscanResponse<string | MultiBalanceItem[]>>;
    fundedby(address: string): Promise<EtherscanResponse<unknown>>;
    getdeposittxs(
        address: string,
        startblock?: string | number,
        endblock?: string | number,
        page?: number,
        offset?: number,
        sort?: string,
    ): Promise<EtherscanResponse<unknown>>;
    getminedblocks(address: string): Promise<EtherscanResponse<MinedBlock[]>>;
    getwithdrawaltxs(
        address: string,
        startblock?: string | number,
        endblock?: string | number,
        page?: number,
        offset?: number,
        sort?: string,
    ): Promise<EtherscanResponse<unknown>>;
    token1155tx(
        address: string,
        contractaddress?: string,
        startblock?: string | number,
        endblock?: string | number,
        page?: number,
        offset?: number,
        sort?: string,
    ): Promise<EtherscanResponse<Erc1155Transfer[]>>;
    tokenbalance(
        address?: string,
        tokenname?: string,
        contractaddress?: string,
    ): Promise<EtherscanResponse<string>>;
    tokennfttx(
        address: string,
        contractaddress?: string,
        startblock?: string | number,
        endblock?: string | number,
        page?: number,
        offset?: number,
        sort?: string,
    ): Promise<EtherscanResponse<Erc721Transfer[]>>;
    tokentx(
        address: string,
        contractaddress?: string,
        startblock?: string | number,
        endblock?: string | number,
        page?: number,
        offset?: number,
        sort?: string,
    ): Promise<EtherscanResponse<Erc20Transfer[]>>;
    txlist(
        address: string,
        startblock?: string | number,
        endblock?: string | number,
        page?: number,
        offset?: number,
        sort?: string,
    ): Promise<EtherscanResponse<NormalTransaction[]>>;
    txlistinternal(
        txhash?: string,
        address?: string,
        startblock?: string | number,
        endblock?: string | number,
        sort?: string,
    ): Promise<EtherscanResponse<InternalTransaction[]>>;
    txsBeaconWithdrawal(
        address: string,
        startblock?: string | number,
        endblock?: string | number,
        page?: number,
        offset?: number,
        sort?: string,
    ): Promise<EtherscanResponse<unknown>>;
}

Type Declaration

balance: function
- balance(
  address: string | string[],
  ): Promise<EtherscanResponse<string | MultiBalanceItem[]>>
  Returns the balance of a specific account, or several accounts when given an array (uses the balancemulti action).
  Parameters
  - address: string | string[]
    A single address, or an array of addresses
  Returns Promise<EtherscanResponse<string | MultiBalanceItem[]>>
  Example
  api.account.balance('0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae');
  - Defined in src/account.ts:48
fundedby: function
- fundedby(address: string): Promise<EtherscanResponse<unknown>>
  Returns the address that first funded a given address.
  Parameters
  - address: string
    Account address
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/account.ts:327
getdeposittxs: function
- getdeposittxs(
      address: string,
      startblock?: string | number,
      endblock?: string | number,
      page?: number,
      offset?: number,
      sort?: string,
  ): Promise<EtherscanResponse<unknown>>
  Get the list of L2 deposit transactions for an address.
  Parameters
  - address: string
    Account address
  - Optionalstartblock: string | number
    Start block
  - Optionalendblock: string | number
    End block
  - Optionalpage: number
    Page number
  - Optionaloffset: number
    Max records to return
  - Optionalsort: string
    Sort asc/desc
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/account.ts:274
getminedblocks: function
- getminedblocks(address: string): Promise<EtherscanResponse<MinedBlock[]>>
  Get a list of blocks that a specific account has mined.
  Parameters
  - address: string
    Account address
  Returns Promise<EtherscanResponse<MinedBlock[]>>
  Example
  api.account.getminedblocks('0x9dd134d14d1e65f84b706d6f205cd5b1cd03a46b');
  - Defined in src/account.ts:127
getwithdrawaltxs: function
- getwithdrawaltxs(
      address: string,
      startblock?: string | number,
      endblock?: string | number,
      page?: number,
      offset?: number,
      sort?: string,
  ): Promise<EtherscanResponse<unknown>>
  Get the list of L2 withdrawal transactions for an address.
  Parameters
  - address: string
    Account address
  - Optionalstartblock: string | number
    Start block
  - Optionalendblock: string | number
    End block
  - Optionalpage: number
    Page number
  - Optionaloffset: number
    Max records to return
  - Optionalsort: string
    Sort asc/desc
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/account.ts:303
token1155tx: function
- token1155tx(
      address: string,
      contractaddress?: string,
      startblock?: string | number,
      endblock?: string | number,
      page?: number,
      offset?: number,
      sort?: string,
  ): Promise<EtherscanResponse<Erc1155Transfer[]>>
  Get a list of "ERC1155 - Token Transfer Events" by address.
  Parameters
  - address: string
    Account address
  - Optionalcontractaddress: string
    ERC1155 token contract address (omit for all tokens)
  - Optionalstartblock: string | number
    Start block
  - Optionalendblock: string | number
    End block
  - Optionalpage: number
    Page number
  - Optionaloffset: number
    Max records to return
  - Optionalsort: string
    Sort asc/desc
  Returns Promise<EtherscanResponse<Erc1155Transfer[]>>
  - Defined in src/account.ts:211
tokenbalance: function
- tokenbalance(
      address?: string,
      tokenname?: string,
      contractaddress?: string,
  ): Promise<EtherscanResponse<string>>
  Returns the amount of Tokens a specific account owns.
  Parameters
  - Optionaladdress: string
    Account address
  - Optionaltokenname: string
    Name of the token
  - Optionalcontractaddress: string
    Token contract address
  Returns Promise<EtherscanResponse<string>>
  Example
  api.account.tokenbalance( '0x4366ddc115d8cf213c564da36e64c8ebaa30cdbd', '', '0xe0b7927c4af23765cb51314a0e0521a9645f0e2a' );
  - Defined in src/account.ts:27
tokennfttx: function
- tokennfttx(
      address: string,
      contractaddress?: string,
      startblock?: string | number,
      endblock?: string | number,
      page?: number,
      offset?: number,
      sort?: string,
  ): Promise<EtherscanResponse<Erc721Transfer[]>>
  Get a list of "ERC721 - Token Transfer Events" by address.
  Parameters
  - address: string
    Account address
  - Optionalcontractaddress: string
    ERC721 token contract address (omit for all tokens)
  - Optionalstartblock: string | number
    Start block
  - Optionalendblock: string | number
    End block
  - Optionalpage: number
    Page number
  - Optionaloffset: number
    Max records to return
  - Optionalsort: string
    Sort asc/desc
  Returns Promise<EtherscanResponse<Erc721Transfer[]>>
  - Defined in src/account.ts:176
tokentx: function
- tokentx(
      address: string,
      contractaddress?: string,
      startblock?: string | number,
      endblock?: string | number,
      page?: number,
      offset?: number,
      sort?: string,
  ): Promise<EtherscanResponse<Erc20Transfer[]>>
  Get a list of "ERC20 - Token Transfer Events" by address.
  Parameters
  - address: string
    Account address
  - Optionalcontractaddress: string
    ERC20 token contract address (omit for all tokens)
  - Optionalstartblock: string | number
    Start block
  - Optionalendblock: string | number
    End block
  - Optionalpage: number
    Page number
  - Optionaloffset: number
    Max records to return
  - Optionalsort: string
    Sort asc/desc
  Returns Promise<EtherscanResponse<Erc20Transfer[]>>
  - Defined in src/account.ts:141
txlist: function
- txlist(
      address: string,
      startblock?: string | number,
      endblock?: string | number,
      page?: number,
      offset?: number,
      sort?: string,
  ): Promise<EtherscanResponse<NormalTransaction[]>>
  Get a list of transactions for a specific address.
  Parameters
  - address: string
    Account address
  - Optionalstartblock: string | number
    Start block
  - Optionalendblock: string | number
    End block
  - Optionalpage: number
    Page number
  - Optionaloffset: number
    Max records to return
  - Optionalsort: string
    Sort asc/desc
  Returns Promise<EtherscanResponse<NormalTransaction[]>>
  Example
  api.account.txlist('0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae', 1, 'latest', 1, 100, 'asc');
  - Defined in src/account.ts:101
txlistinternal: function
- txlistinternal(
      txhash?: string,
      address?: string,
      startblock?: string | number,
      endblock?: string | number,
      sort?: string,
  ): Promise<EtherscanResponse<InternalTransaction[]>>
  Get a list of internal transactions.
  Parameters
  - Optionaltxhash: string
    Transaction hash. If specified then address is ignored
  - Optionaladdress: string
    Account address
  - Optionalstartblock: string | number
    Start block
  - Optionalendblock: string | number
    End block
  - Optionalsort: string
    Sort asc/desc
  Returns Promise<EtherscanResponse<InternalTransaction[]>>
  Example
  api.account.txlistinternal('0x40eb908387324f2b575b4879cd9d7188f69c8fc9d87c901b9e2daaea4b442170');
  - Defined in src/account.ts:70
txsBeaconWithdrawal: function
- txsBeaconWithdrawal(
      address: string,
      startblock?: string | number,
      endblock?: string | number,
      page?: number,
      offset?: number,
      sort?: string,
  ): Promise<EtherscanResponse<unknown>>
  Get the beacon chain withdrawals made to an address.
  Parameters
  - address: string
    Account address
  - Optionalstartblock: string | number
    Start block
  - Optionalendblock: string | number
    End block
  - Optionalpage: number
    Page number
  - Optionaloffset: number
    Max records to return
  - Optionalsort: string
    Sort asc/desc
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/account.ts:245

block

block: {
    getblockcountdown(
        blockno: string | number,
    ): Promise<EtherscanResponse<BlockCountdown>>;
    getblocknobytime(
        timestamp: string | number,
        closest?: "before" | "after",
    ): Promise<EtherscanResponse<string>>;
    getblockreward(
        address: string,
        blockno?: string | number,
    ): Promise<EtherscanResponse<BlockReward>>;
}

Type Declaration

getblockcountdown: function
- getblockcountdown(
  blockno: string | number,
  ): Promise<EtherscanResponse<BlockCountdown>>
  Returns the estimated time remaining, in seconds, until a certain block is mined.
  Parameters
  - blockno: string | number
    Target block number
  Returns Promise<EtherscanResponse<BlockCountdown>>
  - Defined in src/block.ts:20
getblocknobytime: function
- getblocknobytime(
  timestamp: string | number,
  closest?: "before" | "after",
  ): Promise<EtherscanResponse<string>>
  Returns the block number that was mined at a certain timestamp.
  Parameters
  - timestamp: string | number
    Unix timestamp in seconds
  - closest: "before" | "after" = 'before'
    Return the closest block 'before' (default) or 'after' the timestamp
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/block.ts:29
getblockreward: function
- getblockreward(
  address: string,
  blockno?: string | number,
  ): Promise<EtherscanResponse<BlockReward>>
  Find the block reward for a given address and block.
  Parameters
  - address: string
    Miner address
  - Optionalblockno: string | number
    Block number (defaults to 0)
  Returns Promise<EtherscanResponse<BlockReward>>
  - Defined in src/block.ts:12

contract

contract: {
    checkproxyverification(guid: string): Promise<EtherscanResponse<string>>;
    checkverifystatus(guid: string): Promise<EtherscanResponse<string>>;
    getabi(address: string): Promise<EtherscanResponse<string>>;
    getcontractcreation(
        contractaddresses: string | string[],
    ): Promise<EtherscanResponse<ContractCreation[]>>;
    getsourcecode(
        address: string,
    ): Promise<EtherscanResponse<ContractSource[]>>;
    verifyproxycontract(
        address: string,
        expectedimplementation?: string,
    ): Promise<EtherscanResponse<string>>;
    verifysourcecode(
        params: VerifySourceCodeParams,
    ): Promise<EtherscanResponse<string>>;
    verifystylus(params: VerifyParams): Promise<EtherscanResponse<string>>;
    verifyvyper(params: VerifyParams): Promise<EtherscanResponse<string>>;
    verifyzksyncsourcecode(
        params: VerifyParams,
    ): Promise<EtherscanResponse<string>>;
}

Type Declaration

checkproxyverification: function
- checkproxyverification(guid: string): Promise<EtherscanResponse<string>>
  Checks the status of a proxy-contract verification request.
  Parameters
  - guid: string
    The GUID returned by verifyproxycontract
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/contract.ts:129
checkverifystatus: function
- checkverifystatus(guid: string): Promise<EtherscanResponse<string>>
  Checks the status of a source-code verification request.
  Parameters
  - guid: string
    The GUID returned by verifysourcecode
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/contract.ts:107
getabi: function
- getabi(address: string): Promise<EtherscanResponse<string>>
  Returns the ABI of a verified contract (JSON encoded as a string).
  Parameters
  - address: string
    Contract address
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/contract.ts:58
getcontractcreation: function
- getcontractcreation(
  contractaddresses: string | string[],
  ): Promise<EtherscanResponse<ContractCreation[]>>
  Returns the creator address and creation transaction hash for one or more contracts (up to 5).
  Parameters
  - contractaddresses: string | string[]
    A single contract address or an array of up to 5
  Returns Promise<EtherscanResponse<ContractCreation[]>>
  - Defined in src/contract.ts:49
getsourcecode: function
- getsourcecode(address: string): Promise<EtherscanResponse<ContractSource[]>>
  Returns the source code of a verified contract.
  Parameters
  - address: string
    Contract address
  Returns Promise<EtherscanResponse<ContractSource[]>>
  - Defined in src/contract.ts:66
verifyproxycontract: function
- verifyproxycontract(
  address: string,
  expectedimplementation?: string,
  ): Promise<EtherscanResponse<string>>
  Submits a proxy contract for verification (POST). Resolves with a GUID (string) you can poll with checkproxyverification.
  Parameters
  - address: string
    Proxy contract address
  - Optionalexpectedimplementation: string
    (optional) expected implementation address
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/contract.ts:117
verifysourcecode: function
- verifysourcecode(
  params: VerifySourceCodeParams,
  ): Promise<EtherscanResponse<string>>
  Submits a contract's source code for verification (POST). Resolves with a GUID (string) you can poll with checkverifystatus.
  Parameters
  - params: VerifySourceCodeParams
    Verification fields (VerifySourceCodeParams)
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/contract.ts:75
verifystylus: function
- verifystylus(params: VerifyParams): Promise<EtherscanResponse<string>>
  Submits Stylus (Rust/WASM) source code for verification (POST). Resolves with a GUID.
  Parameters
  - params: VerifyParams
    Verification fields (VerifyParams)
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/contract.ts:91
verifyvyper: function
- verifyvyper(params: VerifyParams): Promise<EtherscanResponse<string>>
  Submits Vyper source code for verification (POST). Resolves with a GUID.
  Parameters
  - params: VerifyParams
    Verification fields (VerifyParams)
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/contract.ts:83
verifyzksyncsourcecode: function
- verifyzksyncsourcecode(params: VerifyParams): Promise<EtherscanResponse<string>>
  Submits zkSync-compiled source code for verification (POST). Resolves with a GUID.
  Parameters
  - params: VerifyParams
    Verification fields (VerifyParams); include compilerversion
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/contract.ts:99

gastracker

gastracker: {
    gasestimate(
        gasprice: string | number,
    ): Promise<EtherscanResponse<string>>;
    gasoracle(): Promise<EtherscanResponse<GasOracle>>;
}

Type Declaration

gasestimate: function
- gasestimate(gasprice: string | number): Promise<EtherscanResponse<string>>
  Returns the estimated confirmation time, in seconds, for a transaction at the given gas price.
  Parameters
  - gasprice: string | number
    Gas price in wei
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/gastracker.ts:20
gasoracle: function
- gasoracle(): Promise<EtherscanResponse<GasOracle>>
  Returns the current Safe / Propose / Fast gas prices (in Gwei) along with the suggested base fee and recent gas-used ratio.
  
  Returns Promise<EtherscanResponse<GasOracle>>
  - Defined in src/gastracker.ts:11

log

log: {
    getLogs(
        address?: string,
        fromBlock?: string | number,
        toBlock?: string | number,
        topic0?: string,
        topic0_1_opr?: string,
        topic1?: string,
        topic1_2_opr?: string,
        topic2?: string,
        topic2_3_opr?: string,
        topic3?: string,
        topic0_2_opr?: string,
        page?: number,
        offset?: number,
    ): Promise<EtherscanResponse<EventLog[]>>;
}

Type Declaration

getLogs: function
- getLogs(
      address?: string,
      fromBlock?: string | number,
      toBlock?: string | number,
      topic0?: string,
      topic0_1_opr?: string,
      topic1?: string,
      topic1_2_opr?: string,
      topic2?: string,
      topic2_3_opr?: string,
      topic3?: string,
      topic0_2_opr?: string,
      page?: number,
      offset?: number,
  ): Promise<EtherscanResponse<EventLog[]>>
  The Event Log API — an alternative to the native eth_getLogs. Only the arguments you provide are sent.
  Parameters
  - Optionaladdress: string
    Address to filter logs by
  - OptionalfromBlock: string | number
    From block
  - OptionaltoBlock: string | number
    To block
  - Optionaltopic0: string
    Topic 0 (32 bytes)
  - Optionaltopic0_1_opr: string
    and|or operator between topic0 & topic1
  - Optionaltopic1: string
    Topic 1 (32 bytes)
  - Optionaltopic1_2_opr: string
    and|or operator between topic1 & topic2
  - Optionaltopic2: string
    Topic 2 (32 bytes)
  - Optionaltopic2_3_opr: string
    and|or operator between topic2 & topic3
  - Optionaltopic3: string
    Topic 3 (32 bytes)
  - Optionaltopic0_2_opr: string
    and|or operator between topic0 & topic2
  - Optionalpage: number
    Page number
  - Optionaloffset: number
    Max records to return
  Returns Promise<EtherscanResponse<EventLog[]>>
  See
  https://docs.etherscan.io/api-endpoints/logs
  - Defined in src/log.ts:25

proxy

proxy: {
    eth_blockNumber(): Promise<EtherscanResponse<string>>;
    eth_call(
        to: string,
        data: string,
        tag: string,
    ): Promise<EtherscanResponse<string>>;
    eth_estimateGas(
        to: string,
        value: string,
        gasPrice: string,
        gas: string,
    ): Promise<EtherscanResponse<string>>;
    eth_gasPrice(): Promise<EtherscanResponse<string>>;
    eth_getBlockByNumber(
        tag: string,
        fullTransactions?: boolean,
    ): Promise<EtherscanResponse<unknown>>;
    eth_getBlockTransactionCountByNumber(
        tag: string,
    ): Promise<EtherscanResponse<string>>;
    eth_getCode(
        address: string,
        tag: string,
    ): Promise<EtherscanResponse<string>>;
    eth_getStorageAt(
        address: string,
        position: string,
        tag: string,
    ): Promise<EtherscanResponse<string>>;
    eth_getTransactionByBlockNumberAndIndex(
        tag: string,
        index: string,
    ): Promise<EtherscanResponse<unknown>>;
    eth_getTransactionByHash(
        txhash: string,
    ): Promise<EtherscanResponse<unknown>>;
    eth_getTransactionCount(
        address: string,
    ): Promise<EtherscanResponse<string>>;
    eth_getTransactionReceipt(
        txhash: string,
    ): Promise<EtherscanResponse<unknown>>;
    eth_getUncleByBlockNumberAndIndex(
        tag: string,
        index: string,
    ): Promise<EtherscanResponse<unknown>>;
    eth_sendRawTransaction(hex: string): Promise<EtherscanResponse<string>>;
}

Type Declaration

eth_blockNumber: function
- eth_blockNumber(): Promise<EtherscanResponse<string>>
  Returns the number of the most recent block (hex).
  
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/proxy.ts:7
eth_call: function
- eth_call(
      to: string,
      data: string,
      tag: string,
  ): Promise<EtherscanResponse<string>>
  Executes a new message call immediately without creating a transaction (hex).
  Parameters
  - to: string
    Address to execute against
  - data: string
    Hash of the method signature and encoded parameters
  - tag: string
    Block number tag
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/proxy.ts:84
eth_estimateGas: function
- eth_estimateGas(
      to: string,
      value: string,
      gasPrice: string,
      gas: string,
  ): Promise<EtherscanResponse<string>>
  Estimates the gas needed for a transaction without adding it to the chain (hex).
  Parameters
  - to: string
    Address to interact with
  - value: string
    Value sent in the transaction
  - gasPrice: string
    Gas price in wei
  - gas: string
    Gas provided
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/proxy.ts:119
eth_gasPrice: function
- eth_gasPrice(): Promise<EtherscanResponse<string>>
  Returns the current price per gas in wei (hex).
  
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/proxy.ts:108
eth_getBlockByNumber: function
- eth_getBlockByNumber(
  tag: string,
  fullTransactions?: boolean,
  ): Promise<EtherscanResponse<unknown>>
  Returns information about a block by block number.
  Parameters
  - tag: string
    Block number tag, e.g. '0x10d4f'
  - fullTransactions: boolean = true
    When true (default) returns full transaction objects, otherwise only hashes
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/proxy.ts:16
eth_getBlockTransactionCountByNumber: function
- eth_getBlockTransactionCountByNumber(
  tag: string,
  ): Promise<EtherscanResponse<string>>
  Returns the number of transactions in a block matching the given block number (hex).
  Parameters
  - tag: string
    Block number tag
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/proxy.ts:33
eth_getCode: function
- eth_getCode(address: string, tag: string): Promise<EtherscanResponse<string>>
  Returns code at a given address (hex).
  Parameters
  - address: string
    Address to get code from
  - tag: string
    Block number tag
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/proxy.ts:93
eth_getStorageAt: function
- eth_getStorageAt(
      address: string,
      position: string,
      tag: string,
  ): Promise<EtherscanResponse<string>>
  Returns the value from a storage position at a given address (hex).
  Parameters
  - address: string
    Address to get storage from
  - position: string
    Storage position
  - tag: string
    Block number tag
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/proxy.ts:103
eth_getTransactionByBlockNumberAndIndex: function
- eth_getTransactionByBlockNumberAndIndex(
  tag: string,
  index: string,
  ): Promise<EtherscanResponse<unknown>>
  Returns information about a transaction by block number and index.
  Parameters
  - tag: string
    Block number tag
  - index: string
    Transaction index position
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/proxy.ts:50
eth_getTransactionByHash: function
- eth_getTransactionByHash(txhash: string): Promise<EtherscanResponse<unknown>>
  Returns information about a transaction by hash.
  Parameters
  - txhash: string
    Transaction hash
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/proxy.ts:41
eth_getTransactionCount: function
- eth_getTransactionCount(address: string): Promise<EtherscanResponse<string>>
  Returns the number of transactions sent from an address (hex).
  Parameters
  - address: string
    Account address
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/proxy.ts:58
eth_getTransactionReceipt: function
- eth_getTransactionReceipt(txhash: string): Promise<EtherscanResponse<unknown>>
  Returns the receipt of a transaction by hash.
  Parameters
  - txhash: string
    Transaction hash
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/proxy.ts:74
eth_getUncleByBlockNumberAndIndex: function
- eth_getUncleByBlockNumberAndIndex(
  tag: string,
  index: string,
  ): Promise<EtherscanResponse<unknown>>
  Returns information about an uncle by block number and index.
  Parameters
  - tag: string
    Block number tag
  - index: string
    Uncle index position
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/proxy.ts:25
eth_sendRawTransaction: function
- eth_sendRawTransaction(hex: string): Promise<EtherscanResponse<string>>
  Submits a pre-signed transaction for broadcast. Resolves with the tx hash.
  Parameters
  - hex: string
    Serialized signed message
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/proxy.ts:66

stats

stats: {
    ethprice(): Promise<EtherscanResponse<EthPrice>>;
    ethsupply(): Promise<EtherscanResponse<string>>;
    ethsupply2(): Promise<EtherscanResponse<string>>;
    nodecount(): Promise<EtherscanResponse<string>>;
    tokensupply(
        tokenname?: string | null,
        contractaddress?: string,
    ): Promise<EtherscanResponse<string>>;
}

Type Declaration

ethprice: function
- ethprice(): Promise<EtherscanResponse<EthPrice>>
  Returns the current ether price.
  
  Returns Promise<EtherscanResponse<EthPrice>>
  - Defined in src/stats.ts:41
ethsupply: function
- ethsupply(): Promise<EtherscanResponse<string>>
  Returns the total supply of ether.
  
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/stats.ts:26
ethsupply2: function
- ethsupply2(): Promise<EtherscanResponse<string>>
  Returns the total supply of ether including Eth2 staking and burnt fees.
  
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/stats.ts:31
nodecount: function
- nodecount(): Promise<EtherscanResponse<string>>
  Returns the total number of discoverable nodes on the network.
  
  Returns Promise<EtherscanResponse<string>>
  - Defined in src/stats.ts:36
tokensupply: function
- tokensupply(
  tokenname?: string | null,
  contractaddress?: string,
  ): Promise<EtherscanResponse<string>>
  Returns the supply of a token.
  Parameters
  - Optionaltokenname: string | null
    Name of the token
  - Optionalcontractaddress: string
    Token contract address
  Returns Promise<EtherscanResponse<string>>
  Example
  api.stats.tokensupply(null, '0x57d90b64a1a57749b0f932f1a3395792e12e7055');
  - Defined in src/stats.ts:14

transaction

transaction: {
    getstatus(txhash: string): Promise<EtherscanResponse<ExecutionStatus>>;
    gettxreceiptstatus(
        txhash: string,
    ): Promise<EtherscanResponse<ReceiptStatus>>;
}

Type Declaration

getstatus: function
- getstatus(txhash: string): Promise<EtherscanResponse<ExecutionStatus>>
  Returns the contract-execution status of a transaction (was the tx itself an error).
  Parameters
  - txhash: string
    Transaction hash
  Returns Promise<EtherscanResponse<ExecutionStatus>>
  - Defined in src/transaction.ts:12
gettxreceiptstatus: function
- gettxreceiptstatus(txhash: string): Promise<EtherscanResponse<ReceiptStatus>>
  Returns the receipt status of a transaction (only for post-Byzantium blocks).
  Parameters
  - txhash: string
    Transaction hash
  Returns Promise<EtherscanResponse<ReceiptStatus>>
  - Defined in src/transaction.ts:20

usage

usage: {
chainlist(): Promise<EtherscanResponse<ChainListItem[]>>;
getapilimit(): Promise<EtherscanResponse<unknown>>;
}

Type Declaration

chainlist: function
- chainlist(): Promise<EtherscanResponse<ChainListItem[]>>
  Returns the list of chains supported by the Etherscan V2 API and their chain ids. Hits the dedicated /v2/chainlist endpoint (no API key needed).
  
  Returns Promise<EtherscanResponse<ChainListItem[]>>
  - Defined in src/usage.ts:19
getapilimit: function
- getapilimit(): Promise<EtherscanResponse<unknown>>
  Returns the amount of API calls used and the daily limit for your API key. (module getapilimit)
  
  Returns Promise<EtherscanResponse<unknown>>
  - Defined in src/usage.ts:11

Interface EtherscanApi

Index

Properties

Properties

account

Type Declaration

balance: function

Parameters

Returns Promise<EtherscanResponse<string | MultiBalanceItem[]>>

Example

fundedby: function

Parameters

Returns Promise<EtherscanResponse<unknown>>

getdeposittxs: function

Parameters

Returns Promise<EtherscanResponse<unknown>>

getminedblocks: function

Parameters

Returns Promise<EtherscanResponse<MinedBlock[]>>

Example

getwithdrawaltxs: function

Parameters

Returns Promise<EtherscanResponse<unknown>>

token1155tx: function

Parameters

Returns Promise<EtherscanResponse<Erc1155Transfer[]>>

tokenbalance: function

Parameters

Returns Promise<EtherscanResponse<string>>

Example

tokennfttx: function

Parameters

Returns Promise<EtherscanResponse<Erc721Transfer[]>>

tokentx: function

Parameters

Returns Promise<EtherscanResponse<Erc20Transfer[]>>

txlist: function

Parameters

Returns Promise<EtherscanResponse<NormalTransaction[]>>

Example

txlistinternal: function

Parameters

Returns Promise<EtherscanResponse<InternalTransaction[]>>

Example

txsBeaconWithdrawal: function

Parameters

Returns Promise<EtherscanResponse<unknown>>

block

Type Declaration

getblockcountdown: function

Parameters

Returns Promise<EtherscanResponse<BlockCountdown>>

getblocknobytime: function

Parameters

Returns Promise<EtherscanResponse<string>>

getblockreward: function

Parameters

Returns Promise<EtherscanResponse<BlockReward>>

contract

Type Declaration

checkproxyverification: function

Parameters

Returns Promise<EtherscanResponse<string>>

checkverifystatus: function

Parameters

Returns Promise<EtherscanResponse<string>>

getabi: function

Parameters

Returns Promise<EtherscanResponse<string>>

getcontractcreation: function

Parameters

Returns Promise<EtherscanResponse<ContractCreation[]>>

getsourcecode: function

Parameters

Returns Promise<EtherscanResponse<ContractSource[]>>

verifyproxycontract: function

Parameters

Returns Promise<EtherscanResponse<string>>

verifysourcecode: function

Parameters