Tokens

Get ERC20-Token TotalSupply by ContractAddress

Returns the current amount of an ERC-20 token in circulation.

https://api-optimistic.etherscan.io/api
   ?module=stats
   &action=tokensupply
   &contractaddress=0xda10009cbd5d07dd0cecc66161fc93d7c9000da1
   &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Query Parameters

Parameter

Description

contractaddress

the contract address of the ERC-20 token

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":"118259239202407577727777940"
}

📈 Tip : The result is returned in the token's smallest decimal representation.

Eg. a token with a balance of 215.241526476136819398 and 18 decimal places will be returned as 215241526476136819398

Get ERC20-Token Account Balance for TokenContractAddress

Returns the current balance of an ERC-20 token of an address.

https://api-optimistic.etherscan.io/api
   ?module=account
   &action=tokenbalance
   &contractaddress=0xda10009cbd5d07dd0cecc66161fc93d7c9000da1
   &address=0xbf16ef186e715668aa29cef57e2fd7f9d48adfe6
   &tag=latest&apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Query Parameters

Parameter

Description

contractaddress

the contract address of the ERC-20 token

address

the string representing the address to check for token balance

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":"2691775037816083725131450"
}

📈 Tip : The result is returned in the token's smallest decimal representation.

Eg. a token with a balance of 215.241526476136819398 and 18 decimal places will be returned as 215241526476136819398

Get Historical ERC-20 Token TotalSupply by ContractAddress & BlockNo

Returns the historical amount of a ERC-20 token in circulation at a certain block height.

📝 Note : This endpoint is throttled to 2 calls/second regardless of API Pro tier.

https://api-optimistic.etherscan.io/api
   ?module=stats
   &action=tokensupplyhistory
   &contractaddress=0x831753dd7087cac61ab5644b308642cc1c33dc13
   &blockno=20071631
   &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Query Parameters

Parameter

Description

contractaddress

the contract address of the ERC-20 token

blockno

the integer block number to check total supply for eg. 4000000

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":"951911913447326414573422"
}

📈 Tip : The result is returned in the token's smallest decimal representation.

Eg. a token with a balance of 215.241526476136819398 and 18 decimal places will be returned as 215241526476136819398

Get Historical ERC-20 Token Account Balance by ContractAddress & BlockNo

Returns the balance of a ERC-20 token of an address at a certain block height.

📝 Note : This endpoint is throttled to 2 calls/second regardless of API Pro tier.

https://api-optimistic.etherscan.io/api
   ?module=account
   &action=tokenbalancehistory
   &contractaddress=0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1
   &address=0x32faa972024eff1c227ecf33554b328eb8494806
   &blockno=112921824
   &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Query Parameters

Parameter

Description

contractaddress

the contract address of the ERC-20 token

address

the string representing the address to check for balance

blockno

the integer block number to check total supply for eg. 400000

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":"96374843780214043395177"
}

📈 Tip : The result is returned in the token's smallest decimal representation.

Eg. a token with a balance of 215.241526476136819398 and 18 decimal places will be returned as 215241526476136819398

Get Address ERC-20 Token Holdings

Return the current ERC20 token holders and number of tokens held.

https://api-optimistic.etherscan.io/api
    ?module=account
    &action=addresstokenbalance
    &address=0x5a52E96BAcdaBb82fd05763E25335261B270Efcb
    &page=1
    &offset=2
    &apikey=YourApikeyToken

Try this endpoint in your browser 🔗

Query Parameters

Parameter

Description

address

the string representing the address to check for Token Holdings

page

the integer page number, if pagination is enabled

offset

the number of transactions displayed per page

Sample Response

{
  "status": "1",
  "message": "OK",
  "result": [
    {
      "TokenAddress": "0x4200000000000000000000000000000000000042",
      "TokenName": "Optimism",
      "TokenSymbol": "OP",
      "TokenQuantity": "37999000000000000000000000",
      "TokenDivisor": "18"
    },
    {
      "TokenAddress": "0xdc6ff44d5d932cbd77b52e5612ba0529dc6226f1",
      "TokenName": "Worldcoin",
      "TokenSymbol": "WLD",
      "TokenQuantity": "1000000000000000",
      "TokenDivisor": "18"
    }
  ]
}

Get Address ERC-721 Token Holding

Return the current ERC20 token holders and number of tokens held.

https://api-optimistic.etherscan.io/api
    ?module=account
    &action=addresstokennftbalance
    &address=0x5a52E96BAcdaBb82fd05763E25335261B270Efcb
    &page=1
    &offset=2
    &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Query Parameters

Parameter

Description

address

the string representing the address to check for Token Holdings

page

the integer page number, if pagination is enabled

offset

the number of transactions displayed per page

Sample Response

{
  "status": "1",
  "message": "OK",
  "result": [
    {
      "TokenAddress": "0x42adf84b545a3a8f0aa73c746b48f11a323720f2",
      "TokenName": "Optimism X TAKASHI MURAKAMI",
      "TokenSymbol": "TakashiX",
      "TokenQuantity": "2"
    }
  ]
}

Get Address ERC721 Token Inventory By Contract Address

https://api-optimistic.etherscan.io/api
    ?module=account
    &action=addresstokennftinventory
    &address=0x5a52e96bacdabb82fd05763e25335261b270efcb
    &contractaddress=0x42Adf84B545A3a8f0aa73c746b48F11a323720f2
    &page=1
    &offset=20
    &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Query Parameters

Parameter

Description

address

the string representing the address to check for inventory

contractaddress

the contract address of the ERC-721 token

page

the integer page number, if pagination is enabled

offset

the number of transactions displayed per page

Sample Response

{
  "status": "1",
  "message": "OK",
  "result": [
    {
      "TokenAddress": "0x42adf84b545a3a8f0aa73c746b48f11a323720f2",
      "TokenId": "9302"
    },
    {
      "TokenAddress": "0x42adf84b545a3a8f0aa73c746b48f11a323720f2",
      "TokenId": "9303"
    }
  ]
}

Get Token Holder List by Contract Address

Return the current ERC20 token holders and number of tokens held.

https://api-optimistic.etherscan.io/api
   ?module=token
   &action=tokenholderlist
   &contractaddress=0xDA10009cBd5D07dd0CeCc66161FC93D7c9000da1&
   &page=1
   &offset=10
   &apikey=YourApiKeyToken 

Try this endpoint in your browser 🔗

Query Parameters

Parameter

Description

contractaddress

the contract address of the ERC-20 token

page

the integer page number, if pagination is enabled

offset

the number of transactions displayed per page

Sample Response

{
  "status": "1",
  "message": "OK",
  "result": [
    {
      "TokenHolderAddress": "0x000000000000000000000000000000000000dead",
      "TokenHolderQuantity": "6549992555825959503"
    },
    {
      "TokenHolderAddress": "0x0000000000003e152231c1f63662abd7b1a56234",
      "TokenHolderQuantity": "2000000000000037"
    }
  ]
}

Get Token Info by ContractAddress

Returns project information and social media links of an ERC-20/ERC-721 token.

📝 Note : This endpoint is throttled to 2 calls/second regardless of API Pro tier.

https://api-optimistic.etherscan.io/api
   ?module=token
   &action=tokeninfo
   &contractaddress=0x53e0bca35ec356bd5dddfebbd1fc0fd03fabad39
   &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Query Parameters

Parameter

Description

contractaddress

the contract address of the ERC-20/ERC-721 token to retrieve token info

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "contractAddress":"0x53e0bca35ec356bd5dddfebbd1fc0fd03fabad39",
         "tokenName":"ChainLink Token",
         "symbol":"LINK",
         "divisor":"18",
         "tokenType":"ERC20",
         "totalSupply":"1573879.616930000000000000",
         "blueCheckmark":"true",
         "description":"A blockchain-based middleware, acting as a bridge between cryptocurrency smart contracts, data feeds, APIs and traditional bank account payments.",
         "website":"https://chain.link/",
         "email":"[email protected]",
         "blog":"",
         "reddit":"",
         "slack":"",
         "facebook":"",
         "twitter":"https://twitter.com/chainlink",
         "bitcointalk":"",
         "github":"",
         "telegram":"",
         "wechat":"",
         "linkedin":"",
         "discord":"",
         "whitepaper":"https://link.smartcontract.com/whitepaper",
         "tokenPriceUSD":"24.5400000000"
      }
   ]
}