PolygonScan
HomeTwitterKnowledge Base API PRO
PolygonScan
PolygonScan
  • Introduction
  • ✨Getting Started
    • Creating an Account
    • Getting an API Key
    • Endpoint URLs
  • 🎯API Endpoints
    • Accounts
    • Contracts
    • Transactions
    • Blocks
    • Logs
    • Geth Proxy
    • Tokens
    • Gas Tracker
    • Stats
  • 🏆API PRO
    • PolygonScan API PRO
    • API PRO Endpoints
  • 📖Tutorials
    • Read/Write Smart Contracts
    • Verifying Contracts Programmatically
  • 🔧Misc Tools & Utilities
    • Libraries
    • Plugins
  • 🤝Support
    • FAQ
    • Rate Limits
    • Common Error Messages
    • Getting Help
  • Visit PolygonScan.com
Powered by GitBook
On this page
  • Get Historical POL Balance for a Single Address by BlockNo
  • Get Daily Average Block Size
  • Get Daily Block Count and Rewards
  • Get Daily Block Rewards
  • Get Daily Average Time for A Block to be Included in the Polygon POS Chain
  • Get Historical ERC-20 Token TotalSupply by ContractAddress & BlockNo
  • Get Historical ERC-20 Token Account Balance by ContractAddress & BlockNo
  • Get Token Info by ContractAddress
  • Get Address ERC20 Token Holding
  • Get Address ERC721 Token Holding
  • Get Address ERC721 Token Inventory By Contract Address
  • Get Daily Average Gas Limit
  • Get Polygon Daily Total Gas Used
  • Get Daily Average Gas Price
  • Get POL Historical Price
  • Get Daily Network Transaction Fee
  • Get Daily New Address Count
  • Get Daily Network Utilization
  • Get Daily Transaction Count
  1. API PRO

API PRO Endpoints

PreviousPolygonScan API PRONextRead/Write Smart Contracts

Last updated 5 months ago

The following is a complete list of additional API endpoints available under the API PRO subscription.

To upgrade your API plan, kindly visit

Get Historical POL Balance for a Single Address by BlockNo

Returns the historical POL balance of an address at a certain block height.

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

https://api.polygonscan.com/api
   ?module=account
   &action=balancehistory
   &address=0x23eA5Ec7Ea2d4282012313c9899Cdc07bd45243d
   &blockno=18798641
   &apikey=YourApiKeyToken

Try this endpoint in your

Query Parameters

Parameter
Description

address

the strings representing the addresses to check for balance, separated by , commas

blockno

the integer block number to check balance for eg. 2000000

Sample Response

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

Tip: The result is returned in

Convert POL units using our

Get Daily Average Block Size

Returns the daily average block size within a date range.

https://api.polygonscan.com/api
   ?module=stats
   &action=dailyavgblocksize
   &startdate=2021-08-01
   &enddate=2021-08-31
   &sort=asc
   &apikey=YourApiKeyToken

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2021-08-01

enddate

the ending date in yyyy-MM-dd format, eg. 2021-08-31

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "UTCDate":"2021-08-01",
         "unixTimeStamp":"1627776000",
         "blockSize_bytes":65856
      },
      {
         "UTCDate":"2021-08-02",
         "unixTimeStamp":"1627862400",
         "blockSize_bytes":62925
      },
      {
         "UTCDate":"2021-08-03",
         "unixTimeStamp":"1627948800",
         "blockSize_bytes":63967
      },
      {
         "UTCDate":"2021-08-04",
         "unixTimeStamp":"1628035200",
         "blockSize_bytes":59825
      }
   ]
}

Returns the number of blocks validated daily and the amount of block rewards.

https://api.polygonscan.com/api
   ?module=stats
   &action=dailyblkcount
   &startdate=2021-08-01
   &enddate=2021-08-31
   &sort=asc
   &apikey=YourApiKeyToken

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2021-08-01

enddate

the ending date in yyyy-MM-dd format, eg. 2021-08-31

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
    "status":"1",
    "message":"OK",
    "result":[
       {
          "UTCDate":"2021-08-01",
          "unixTimeStamp":"1627776000",
          "blockCount":38385,
          "blockRewards_Eth":"13512.99629741489684839"
       },
       {
          "UTCDate":"2021-08-02",
          "unixTimeStamp":"1627862400",
          "blockCount":36898,
          "blockRewards_Eth":"10415.4627450065115572"
       },
       {
          "UTCDate":"2021-08-03",
          "unixTimeStamp":"1627948800",
          "blockCount":39485,
          "blockRewards_Eth":"21340.315061898381392963"
       },
       {
          "UTCDate":"2021-08-04",
          "unixTimeStamp":"1628035200",
          "blockCount":37536,
          "blockRewards_Eth":"12519.334060666034768668"
       }
    ]
 }

Returns the amount of block rewards distributed to validators daily.

https://api.polygonscan.com/api
   ?module=stats
   &action=dailyblockrewards
   &startdate=2021-08-01
   &enddate=2021-08-31
   &sort=asc
   &apikey=YourApiKeyToken

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2021-08-01

enddate

the ending date in yyyy-MM-dd format, eg. 2021-08-31

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
    "status":"1",
    "message":"OK",
    "result":[
       {
          "UTCDate":"2021-08-01",
          "unixTimeStamp":"1627776000",
          "blockRewards_Eth":"0"
       },
       {
          "UTCDate":"2021-08-02",
          "unixTimeStamp":"1627862400",
          "blockRewards_Eth":"0"
       },
       {
          "UTCDate":"2021-08-03",
          "unixTimeStamp":"1627948800",
          "blockRewards_Eth":"0"
       }
    ]
 }

Returns the daily average of time needed for a block to be successfully validated.

https://api.polygonscan.com/api
   ?module=stats
   &action=dailyavgblocktime
   &startdate=2021-08-01
   &enddate=2021-08-31
   &sort=asc
   &apikey=YourApiKeyToken

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2021-08-01

enddate

the ending date in yyyy-MM-dd format, eg. 2021-08-31

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
    "status":"1",
    "message":"OK",
    "result":[
       {
          "UTCDate":"2021-08-01",
          "unixTimeStamp":"1627776000",
          "blockTime_sec":"2.26"
       },
       {
          "UTCDate":"2021-08-02",
          "unixTimeStamp":"1627862400",
          "blockTime_sec":"2.36"
       },
       {
          "UTCDate":"2021-08-03",
          "unixTimeStamp":"1627948800",
          "blockTime_sec":"2.19"
       }
    ]
 }

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

https://api.polygonscan.com/api
   ?module=stats
   &action=tokensupplyhistory
   &contractaddress=0x831753dd7087cac61ab5644b308642cc1c33dc13
   &blockno=20071631
   &apikey=YourApiKeyToken

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"
}

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

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

https://api.polygonscan.com/api
   ?module=account
   &action=tokenbalancehistory
   &contractaddress=0x831753dd7087cac61ab5644b308642cc1c33dc13
   &address=0x019ba0325f1988213d448b3472fa1cf8d07618d7
   &blockno=20169066
   &apikey=YourApiKeyToken

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":"21475814538620954598134"
}

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

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

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

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":"support@chain.link",
         "blog":"",
         "reddit":"",
         "slack":"",
         "facebook":"",
         "twitter":"https://twitter.com/chainlink",
         "bitcointalk":"",
         "github":"",
         "telegram":"",
         "wechat":"",
         "linkedin":"",
         "discord":"",
         "whitepaper":"https://link.smartcontract.com/whitepaper",
         "tokenPriceUSD":"24.5400000000"
      }
   ]
}

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

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

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

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

{
    "status": "1",
    "message": "OK",
    "result": [
        {
            "TokenAddress": "0xba6f652fa17384af20a2d59813345b0ee0128d48",
            "TokenName": "AAVEPool.org",
            "TokenSymbol": "AAVE",
            "TokenQuantity": "7638",
            "TokenDivisor": "2"
        },
        {
            "TokenAddress": "0x85b9406bcbe33ba5cec12434b3c0818446c621fd",
            "TokenName": "AAVEPool.org",
            "TokenSymbol": "AAVE",
            "TokenQuantity": "5602",
            "TokenDivisor": "2"
        }
    ]
}

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

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

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

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

{
    "status": "1",
    "message": "OK",
    "result": [
        {
            "TokenAddress": "0x0c88de91cd73b16e570a08efb068f7eade5e6107",
            "TokenName": "ETHStation 1672549036942",
            "TokenSymbol": "ETHStation 1672549036942",
            "TokenQuantity": "1"
        },
        {
            "TokenAddress": "0xbf6f84eb656d8bb2a1b15a0aeb3c881557e5093f",
            "TokenName": "MiningSite 1682068466711",
            "TokenSymbol": "MiningSite 1682068466711",
            "TokenQuantity": "1"
        }
    ]
}

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

https://api.polygonscan.com/api
   ?module=account
   &action=addresstokennftinventory
   &address=0x04c9874AC0D2d9a460Fe8057ed3818F1005538e2
   &contractaddress=0x9e8ea82e76262e957d4cc24e04857a34b0d8f062
   &page=1
   &offset=100
   &apikey=YourApiKeyToken

Query Parameters

Parameter
Description

address

the string representing the address to check for inventory

contractaddress

the string representing the ERC-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

Sample Response

{
    "status": "1",
    "message": "OK",
    "result": [
        {
            "TokenAddress": "0x9e8ea82e76262e957d4cc24e04857a34b0d8f062",
            "TokenId": "11439"
        },
        {
            "TokenAddress": "0x9e8ea82e76262e957d4cc24e04857a34b0d8f062",
            "TokenId": "11472"
        }
    ]
}

Returns the historical daily average gas limit of the Polygon network.

 https://api.polygonscan.com/api
    ?module=stats
    &action=dailyavggaslimit
    &startdate=2021-02-01
    &enddate=2021-02-28
    &sort=asc
    &apikey=YourApiKeyToken 

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2019-01-31

enddate

the ending date in yyyy-MM-dd format, eg. 2019-02-28

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "UTCDate":"2021-02-01",
         "unixTimeStamp":"1612137600",
         "gasLimit":"19995225"
      },
      {
         "UTCDate":"2021-02-02",
         "unixTimeStamp":"1612224000",
         "gasLimit":"19992137"
      },
      {
         "UTCDate":"2021-02-03",
         "unixTimeStamp":"1612310400",
         "gasLimit":"19994117"
      }
   ]
}

Returns the total amount of gas used daily for transactions on the Polygon network.

 https://api.polygonscan.com/api
    ?module=stats
    &action=dailygasused
    &startdate=2021-02-01
    &enddate=2021-02-28
    &sort=asc
    &apikey=YourApiKeyToken 

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2019-01-31

enddate

the ending date in yyyy-MM-dd format, eg. 2019-02-28

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "UTCDate":"2021-02-01",
         "unixTimeStamp":"1612137600",
         "gasUsed":"15209687825"
      },
      {
         "UTCDate":"2021-02-02",
         "unixTimeStamp":"1612224000",
         "gasUsed":"15486974769"
      },
      {
         "UTCDate":"2021-02-03",
         "unixTimeStamp":"1612310400",
         "gasUsed":"14214840593"
      }
   ]
}

Returns the daily average gas price used on the Polygon network.

 https://api.polygonscan.com/api
    ?module=stats
    &action=dailyavggasprice
    &startdate=2021-02-01
    &enddate=2021-02-28
    &sort=asc
    &apikey=YourApiKeyToken 

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2019-01-31

enddate

the ending date in yyyy-MM-dd format, eg. 2019-02-28

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
   "status":"1",
   "message":"OK",
   "result":[
      {
         "UTCDate":"2021-02-01",
         "unixTimeStamp":"1612137600",
         "maxGasPrice_Wei":"243000000000",
         "minGasPrice_Wei":"1000000000",
         "avgGasPrice_Wei":"2565412962"
      },
      {
         "UTCDate":"2021-02-02",
         "unixTimeStamp":"1612224000",
         "maxGasPrice_Wei":"338000000000",
         "minGasPrice_Wei":"1000000000",
         "avgGasPrice_Wei":"2815449842"
      },
      {
         "UTCDate":"2021-02-03",
         "unixTimeStamp":"1612310400",
         "maxGasPrice_Wei":"328000000000",
         "minGasPrice_Wei":"1000000000",
         "avgGasPrice_Wei":"3135220373"
      }
   ]
}

Returns the historical price of 1 POL.

https://api.polygonscan.com/api
   ?module=stats
   &action=ethdailyprice
   &startdate=2021-08-01
   &enddate=2021-08-31
   &sort=asc
   &apikey=YourApiKeyToken

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2021-08-01

enddate

the ending date in yyyy-MM-dd format, eg. 2021-08-28

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
    "status":"1",
    "message":"OK",
    "result":[
       {
          "UTCDate":"2021-08-01",
          "unixTimeStamp":"1627776000",
          "value":"1.05"
       },
       {
          "UTCDate":"2021-08-02",
          "unixTimeStamp":"1627862400",
          "value":"1.05"
       },
       {
          "UTCDate":"2021-08-03",
          "unixTimeStamp":"1627948800",
          "value":"1.02"
       }
    ]
 }

Returns the historical amount of transaction fees paid to validators per day.

https://api.polygonscan.com/api?
   module=stats
   &action=dailytxnfee
   &startdate=2020-10-01
   &enddate=2020-10-31
   &sort=asc
   &apikey=YourApiKeyToken 

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2020-10-01

enddate

the ending date in yyyy-MM-dd format, eg. 2020-10-31

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
    "status":"1",
    "message":"OK",
    "result":[
       {
          "UTCDate":"2020-10-01",
          "unixTimeStamp":"1601510400",
          "transactionFee_Eth":"14.25013925284"
       },
       {
          "UTCDate":"2020-10-02",
          "unixTimeStamp":"1601596800",
          "transactionFee_Eth":"12.01774328819"
       },
       {
          "UTCDate":"2020-10-03",
          "unixTimeStamp":"1601683200",
          "transactionFee_Eth":"12.13871641757844851"
       }
    ]
 }

Returns the historical number of new Polygon POS Chain addresses created per day.

https://api.polygonscan.com/api
   ?module=stats
   &action=dailynewaddress
   &startdate=2020-10-01
   &enddate=2020-10-31
   &sort=asc
   &apikey=YourApiKeyToken

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2020-10-01

enddate

the ending date in yyyy-MM-dd format, eg. 2020-10-31

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
    "status":"1",
    "message":"OK",
    "result":[
       {
          "UTCDate":"2020-10-01",
          "unixTimeStamp":"1601510400",
          "newAddressCount":2131
       },
       {
          "UTCDate":"2020-10-02",
          "unixTimeStamp":"1601596800",
          "newAddressCount":1405
       },
       {
          "UTCDate":"2020-10-03",
          "unixTimeStamp":"1601683200",
          "newAddressCount":124
       }
    ]
 }

Returns the daily average gas used over gas limit percentage.

https://api.polygonscan.com/api
   ?module=stats
   &action=dailynetutilization
   &startdate=2021-07-01
   &enddate=2021-07-31
   &sort=asc
   &apikey=YourApiKeyToken

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2021-07-01

enddate

the ending date in yyyy-MM-dd format, eg. 2021-07-28

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
    "status":"1",
    "message":"OK",
    "result":[
       {
          "UTCDate":"2021-07-01",
          "unixTimeStamp":"1625097600",
          "networkUtilization":"0.8838"
       },
       {
          "UTCDate":"2021-07-02",
          "unixTimeStamp":"1625184000",
          "networkUtilization":"0.7714"
       },
       {
          "UTCDate":"2021-07-03",
          "unixTimeStamp":"1625270400",
          "networkUtilization":"0.7928"
       }
    ]
 }

Returns the number of transactions performed on the Polygon POS Chain per day.

https://api.polygonscan.com/api
   ?module=stats
   &action=dailytx
   &startdate=2021-07-01
   &enddate=2021-07-31
   &sort=asc
   &apikey=YourApiKeyToken

Query Parameters

Parameter
Description

startdate

the starting date in yyyy-MM-dd format, eg. 2021-07-01

enddate

the ending date in yyyy-MM-dd format, eg. 2021-07-28

sort

the sorting preference, use asc to sort by ascending and desc to sort by descending

Sample Response

{
    "status":"1",
    "message":"OK",
    "result":[
       {
          "UTCDate":"2021-07-01",
          "unixTimeStamp":"1625097600",
          "transactionCount":8228730
       },
       {
          "UTCDate":"2021-07-02",
          "unixTimeStamp":"1625184000",
          "transactionCount":5954493
       },
       {
          "UTCDate":"2021-07-03",
          "unixTimeStamp":"1625270400",
          "transactionCount":6247611
       }
    ]
 }

Try this endpoint in your

Get Daily Block Count and Rewards

Try this endpoint in your

Get Daily Block Rewards

Try this endpoint in your

Get Daily Average Time for A Block to be Included in the Polygon POS Chain

Try this endpoint in your

Get Historical ERC-20 Token TotalSupply by ContractAddress & BlockNo

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

Try this endpoint in your

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

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

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

Try this endpoint in your

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

Get Token Info by ContractAddress

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

Try this endpoint in your

Get Address ERC20 Token Holding

Try this endpoint in your

Get Address ERC721 Token Holding

Try this endpoint in your

Get Address ERC721 Token Inventory By Contract Address

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

Try this endpoint in your

Get Daily Average Gas Limit

Try this endpoint in your

Get Polygon Daily Total Gas Used

Try this endpoint in your

Get Daily Average Gas Price

Try this endpoint in your

Get POL Historical Price

Try this endpoint in your

Tip : The value is represented in US Dollars ( USD ).

Get Daily Network Transaction Fee

Try this endpoint in your

Get Daily New Address Count

Try this endpoint in your

Get Daily Network Utilization

Try this endpoint in your

Get Daily Transaction Count

Try this endpoint in your

🏆
📝
📈
📝
📈
📝
📝
💰
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
🔗
browser
📝
🔗
📖
PolygonScan APIs.
browser
wei.
Unit Converter.