Tokens

Endpoints with are under the API Pro subscription. To upgrade your API plan, browse through the BscScan APIs page.

Get BEP-20 Token CirculatingSupply by ContractAddress

Returns the current circulating supply of a BEP-20 token.

https://api.bscscan.com/api
   ?module=stats
   &action=tokenCsupply
   &contractaddress=0xe9e7cea3dedca5984780bafc599bd69add087d56
   &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
contractaddress	the contract address of the BEP-20 token

Response

Sample Response

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

📈 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 BEP-20 Token TotalSupply by ContractAddress

Returns the total supply of a BEP-20 token.

https://api.bscscan.com/api
   ?module=stats
   &action=tokensupply
   &contractaddress=0xe9e7cea3dedca5984780bafc599bd69add087d56
   &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
contractaddress	the contract address of the BEP-20 token

Response

Sample Response

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

📈 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 BEP-20 Token Account Balance by ContractAddress

Returns the current balance of a BEP-20 token of an address.

https://api.bscscan.com/api
   ?module=account
   &action=tokenbalance
   &contractaddress=0xe9e7cea3dedca5984780bafc599bd69add087d56
   &address=0x89e73303049ee32919903c09e8de5629b84f59eb
   &tag=latest
   &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
contractaddress	the contract address of the BEP-20 token
address	the string representing the address to check for token balance

Response

Sample Response

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

📈 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 BEP-20 Token TotalSupply by ContractAddress & BlockNo

Returns the historical amount of a BEP-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.bscscan.com/api
   ?module=stats
   &action=tokensupplyhistory
   &contractaddress=0xc9849e6fdb743d08faee3e34dd2d1bc69ea11a51
   &blockno=4000000
   &apikey=YourApiKeyToken 

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
contractaddress	the contract address of the BEP-20 token
blockno	the integer block number to check total supply for eg. 4000000

Response

Sample Response

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

📈 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 BEP-20 Token Account Balance by ContractAddress & BlockNo

Returns the balance of a BEP-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.bscscan.com/api
   ?module=account
   &action=tokenbalancehistory
   &contractaddress=0xc9849e6fdb743d08faee3e34dd2d1bc69ea11a51
   &address=0x7bb89460599dbf32ee3aa50798bbceae2a5f7f6a
   &blockno=4000000
   &apikey=YourApiKeyToken 

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
contractaddress	the contract address of the BEP-20 token
address	the string representing the address to check for balance
blockno	the integer block number to check total supply for eg. 400000

Response

Sample Response

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

📈 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 Token Holder List by Contract Address

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

https://api.bscscan.com/api
   ?module=token
   &action=tokenholderlist
   &contractaddress=0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82
   &page=1
   &offset=10
   &apikey=YourApiKeyToken 

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
contractaddress	the contract address of the BEP-20 token
page	the integer page number, if pagination is enabled
offset	the number of transactions displayed per page

Response

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "TokenHolderAddress":"0x0000000000000000000000000000000000000000",
         "TokenHolderQuantity":"0"
      },
      {
         "TokenHolderAddress":"0x0000000000000000000000000000000000000001",
         "TokenHolderQuantity":"1136630046187908600061"
      },
      {
         "TokenHolderAddress":"0x0000000000000000000000000000000000001004",
         "TokenHolderQuantity":"385642396146098637680574"
      },
      {
         "TokenHolderAddress":"0x00000000100f9d75535cbf23f82e23db5558e8c1",
         "TokenHolderQuantity":"25536632618506"
      }
   ]
}

Get Token Info by ContractAddress

Returns project information and social media links of a BEP-20/BEP-721 token.

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

https://api.bscscan.com/api
   ?module=token
   &action=tokeninfo
   &contractaddress=0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82
   &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
contractaddress	the contract address of the BEP-20/BEP721 token to retrieve token info

Response

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "contractAddress":"0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82",
         "tokenName":"PancakeSwap Token",
         "symbol":"Cake",
         "divisor":"18",
         "tokenType":"ERC20",
         "totalSupply":"431889535.843059000000000000",
         "blueCheckmark":"true",
         "description":"PancakeSwap is a yield farming project whereby users can get FLIP (LP token) for staking and get CAKE token as reward. CAKE holders can swap CAKE for SYRUP for additional incentivized staking.",
         "website":"https://pancakeswap.finance/",
         "email":"[e-mail]",
         "blog":"https://medium.com/@pancakeswap",
         "reddit":"",
         "slack":"",
         "facebook":"",
         "twitter":"https://twitter.com/pancakeswap",
         "bitcointalk":"",
         "github":"https://github.com/pancakeswap",
         "telegram":"https://t.me/PancakeSwap",
         "wechat":"",
         "linkedin":"",
         "discord":"",
         "whitepaper":"",
         "tokenPriceUSD":"23.9300000000"
      }
   ]
}

Get Address BEP20 Token Holding

Returns the BEP-20 tokens and amount held by an address.

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

https://api.bscscan.com/api
   ?module=account
   &action=addresstokenbalance
   &address=0x99817ce62abf5b17f58e71071e590cf958e5a1bf
   &page=1
   &offset=100
   &apikey=YourApiKeyToken

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
address	the string representing the address to check for balance
page	the integer page number, if pagination is enabled
offset	the number of transactions displayed per page

Response

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "TokenAddress":"0xfcb5DF42e06A39E233dc707bb3a80311eFD11576",
         "TokenName":"www.METH.co.in",
         "TokenSymbol":"METH",
         "TokenQuantity":"1337000",
         "TokenDivisor":"18"
      },
      {
         "TokenAddress":"0xdf1f0026374d4bcc490be5e316963cf6df2fff19",
         "TokenName":"InnovativeBioresearchCoin",
         "TokenSymbol":"INNBC",
         "TokenQuantity":"2000000000",
         "TokenDivisor":"6"
      },
      {
         "TokenAddress":"0x78e1936f065fd4082387622878c7d11c9f05ecf4",
         "TokenName":"JNTR/b",
         "TokenSymbol":"JNTR/b",
         "TokenQuantity":"163000000000000000000",
         "TokenDivisor":"18"
      },
      {
         "TokenAddress":"0x12e34cdf6a031a10fe241864c32fb03a4fdad739",
         "TokenName":"FREE coin BSC",
         "TokenSymbol":"FREE",
         "TokenQuantity":"21144000000000000000000",
         "TokenDivisor":"18"
      },
      {
         "TokenAddress":"0xef5ceb00ae3eb617773016b4ca886b61fa4e027e",
         "TokenName":"BURNING",
         "TokenSymbol":"BURN",
         "TokenQuantity":"50000000000000000",
         "TokenDivisor":"18"
      }
   ]
}

Get Address BEP721 Token Holding

Returns the BEP-721 tokens and amount held by an address.

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

https://api.bscscan.com/api
   ?module=account
   &action=addresstokennftbalance
   &address=0x99817ce62abf5b17f58e71071e590cf958e5a1bf
   &page=1
   &offset=100
   &apikey=YourApiKeyToken 

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
address	the string representing the address to check for balance
page	the integer page number, if pagination is enabled
offset	the number of transactions displayed per page

Response

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
         "TokenName":"Pancake Lottery Ticket",
         "TokenSymbol":"PLT",
         "TokenQuantity":"18"
      },
      {
         "TokenAddress":"0xdf7952b35f24acf7fc0487d01c8d5690a60dba07",
         "TokenName":"Pancake Bunnies",
         "TokenSymbol":"PB",
         "TokenQuantity":"1"
      }
   ]
}

Get Address BEP721 Token Inventory By Contract Address

Returns the BEP-721 token inventory of an address, filtered by contract address.

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

https://api.bscscan.com/api
   ?module=account
   &action=addresstokennftinventory
   &address=0x99817ce62abf5b17f58e71071e590cf958e5a1bf
   &contractaddress=0x5e74094cd416f55179dbd0e45b1a8ed030e396a1
   &page=1
   &offset=100
   &apikey=YourApiKeyToken 

Try this endpoint in your browser 🔗

Request

Query Parameters

Parameter	Description
address	the string representing the address to check for inventory
contractaddress	the string representing the BEP-721 token contractaddress to check for inventory
page	the integer page number, if pagination is enabled
offset	the number of records displayed per page limited to 1000 records per query, use the page parameter for subsequent records

Response

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
         "TokenId":"5077"
      },
      {
         "TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
         "TokenId":"7543"
      },
      {
         "TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
         "TokenId":"7544"
      },
      {
         "TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
         "TokenId":"7545"
      },
      {
         "TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
         "TokenId":"121878"
      },
      {
         "TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
         "TokenId":"121879"
      }
   ]
}