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

Get BEP-20 Token TotalSupply by ContractAddress

Returns the total supply of a BEP-20 token.
1
https://api.bscscan.com/api
2
?module=stats
3
&action=tokensupply
4
&contractaddress=0xe9e7cea3dedca5984780bafc599bd69add087d56
5
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
Query Parameters
Parameter
Description
contractaddress
the contract address of the BEP-20 token
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":"4200999399996203280118532144"
5
}
Copied!
​
πŸ“ˆ
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 CirculatingSupply by ContractAddress

Returns the current circulating supply of a BEP-20 token.
1
https://api.bscscan.com/api
2
?module=stats
3
&action=tokenCsupply
4
&contractaddress=0xe9e7cea3dedca5984780bafc599bd69add087d56
5
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
Query Parameters
Parameter
Description
contractaddress
the contract address of the BEP-20 token
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":"4080173012393207910118532144"
5
}
Copied!
​
πŸ“ˆ
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.
1
https://api.bscscan.com/api
2
?module=account
3
&action=tokenbalance
4
&contractaddress=0xe9e7cea3dedca5984780bafc599bd69add087d56
5
&address=0x89e73303049ee32919903c09e8de5629b84f59eb
6
&tag=latest
7
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
Query Parameters
Parameter
Description
contractaddress
the contract address of the BEP-20 token
address
the string representing the address to check for token balance
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":"1420514928941209"
5
}
Copied!
​
πŸ“ˆ
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 token holders and number of tokens held.
1
https://api.bscscan.com/api
2
?module=token
3
&action=tokenholderlist
4
&contractaddress=0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82
5
&page=1
6
&offset=10
7
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
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
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":[
5
{
6
"TokenHolderAddress":"0x0000000000000000000000000000000000000000",
7
"TokenHolderQuantity":"0"
8
},
9
{
10
"TokenHolderAddress":"0x0000000000000000000000000000000000000001",
11
"TokenHolderQuantity":"1136630046187908600061"
12
},
13
{
14
"TokenHolderAddress":"0x0000000000000000000000000000000000001004",
15
"TokenHolderQuantity":"385642396146098637680574"
16
},
17
{
18
"TokenHolderAddress":"0x00000000100f9d75535cbf23f82e23db5558e8c1",
19
"TokenHolderQuantity":"25536632618506"
20
}
21
]
22
}
Copied!

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.
1
https://api.bscscan.com/api
2
?module=stats
3
&action=tokensupplyhistory
4
&contractaddress=0xc9849e6fdb743d08faee3e34dd2d1bc69ea11a51
5
&blockno=4000000
6
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
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
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":"21265524714464"
5
}
Copied!
​
πŸ“ˆ
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.
1
https://api.bscscan.com/api
2
?module=account
3
&action=tokenbalancehistory
4
&contractaddress=0xc9849e6fdb743d08faee3e34dd2d1bc69ea11a51
5
&address=0x7bb89460599dbf32ee3aa50798bbceae2a5f7f6a
6
&blockno=4000000
7
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
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
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":"135499"
5
}
Copied!
​
πŸ“ˆ
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 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.
1
https://api.bscscan.com/api
2
?module=token
3
&action=tokeninfo
4
&contractaddress=0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82
5
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
Query Parameters
Parameter
Description
contractaddress
the contract address of the BEP-20/BEP721 token to retrieve token info
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":[
5
{
6
"contractAddress":"0x0e09fabb73bd3ade0a17ecc321fd13a19e81ce82",
7
"tokenName":"PancakeSwap Token",
8
"symbol":"Cake",
9
"divisor":"18",
10
"tokenType":"ERC20",
11
"totalSupply":"431889535.843059000000000000",
12
"blueCheckmark":"true",
13
"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.",
14
"website":"https://pancakeswap.finance/",
15
"email":"[email protected]",
16
"blog":"https://medium.com/@pancakeswap",
17
"reddit":"",
18
"slack":"",
19
"facebook":"",
20
"twitter":"https://twitter.com/pancakeswap",
21
"bitcointalk":"",
22
"github":"https://github.com/pancakeswap",
23
"telegram":"https://t.me/PancakeSwap",
24
"wechat":"",
25
"linkedin":"",
26
"discord":"",
27
"whitepaper":"",
28
"tokenPriceUSD":"23.9300000000"
29
}
30
]
31
}
Copied!

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.
1
https://api.bscscan.com/api
2
?module=account
3
&action=addresstokenbalance
4
&address=0x99817ce62abf5b17f58e71071e590cf958e5a1bf
5
&page=1
6
&offset=100
7
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
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
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":[
5
{
6
"TokenAddress":"0xfcb5DF42e06A39E233dc707bb3a80311eFD11576",
7
"TokenName":"www.METH.co.in",
8
"TokenSymbol":"METH",
9
"TokenQuantity":"1337000",
10
"TokenDivisor":"18"
11
},
12
{
13
"TokenAddress":"0xdf1f0026374d4bcc490be5e316963cf6df2fff19",
14
"TokenName":"InnovativeBioresearchCoin",
15
"TokenSymbol":"INNBC",
16
"TokenQuantity":"2000000000",
17
"TokenDivisor":"6"
18
},
19
{
20
"TokenAddress":"0x78e1936f065fd4082387622878c7d11c9f05ecf4",
21
"TokenName":"JNTR/b",
22
"TokenSymbol":"JNTR/b",
23
"TokenQuantity":"163000000000000000000",
24
"TokenDivisor":"18"
25
},
26
{
27
"TokenAddress":"0x12e34cdf6a031a10fe241864c32fb03a4fdad739",
28
"TokenName":"FREE coin BSC",
29
"TokenSymbol":"FREE",
30
"TokenQuantity":"21144000000000000000000",
31
"TokenDivisor":"18"
32
},
33
{
34
"TokenAddress":"0xef5ceb00ae3eb617773016b4ca886b61fa4e027e",
35
"TokenName":"BURNING",
36
"TokenSymbol":"BURN",
37
"TokenQuantity":"50000000000000000",
38
"TokenDivisor":"18"
39
}
40
]
41
}
Copied!

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.
1
https://api.bscscan.com/api
2
?module=account
3
&action=addresstokennftbalance
4
&address=0x99817ce62abf5b17f58e71071e590cf958e5a1bf
5
&page=1
6
&offset=100
7
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
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
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":[
5
{
6
"TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
7
"TokenName":"Pancake Lottery Ticket",
8
"TokenSymbol":"PLT",
9
"TokenQuantity":"18"
10
},
11
{
12
"TokenAddress":"0xdf7952b35f24acf7fc0487d01c8d5690a60dba07",
13
"TokenName":"Pancake Bunnies",
14
"TokenSymbol":"PB",
15
"TokenQuantity":"1"
16
}
17
]
18
}
Copied!

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.
1
https://api.bscscan.com/api
2
?module=account
3
&action=addresstokennftinventory
4
&address=0x99817ce62abf5b17f58e71071e590cf958e5a1bf
5
&contractaddress=0x5e74094cd416f55179dbd0e45b1a8ed030e396a1
6
&page=1
7
&offset=100
8
&apikey=YourApiKeyToken
Copied!
Try this endpoint in your browser
πŸ”—
Request
Response
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 transactions displayed per page
Sample Response
1
{
2
"status":"1",
3
"message":"OK",
4
"result":[
5
{
6
"TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
7
"TokenId":"5077"
8
},
9
{
10
"TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
11
"TokenId":"7543"
12
},
13
{
14
"TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
15
"TokenId":"7544"
16
},
17
{
18
"TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
19
"TokenId":"7545"
20
},
21
{
22
"TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
23
"TokenId":"121878"
24
},
25
{
26
"TokenAddress":"0x5e74094cd416f55179dbd0e45b1a8ed030e396a1",
27
"TokenId":"121879"
28
}
29
]
30
}
Copied!