token overview

API Endpoint: /defi/token_overview

Description: Retrieve an overview of a specific token based on its address. This API provides comprehensive details about the token's metrics, price changes, trading activity, and more.

Request Method: GET

Data Coverage: Multi-chain

Parameters:

  • address (string): The address of the token for which you want to retrieve an overview.

Request Headers:

accept: application/json
x-chain: any chains that Birdeye supports. Example: solana, ethereum
X-API-KEY: YOUR_API_KEY

Example Request:

curl -X 'GET' \
  'https://public-api.birdeye.so/defi/token_overview?address=So11111111111111111111111111111111111111112' \
  -H 'accept: application/json' \
  -H 'x-chain: solana' \
  -H 'X-API-KEY: YOUR_API_KEY'

Sample Response:

{
  "data": {
    "address": "So11111111111111111111111111111111111111112",
    "decimals": 9,
    "symbol": "SOL",
    "name": "Wrapped SOL",
    "extensions": {
      "coingeckoId": "solana",
      "serumV3Usdc": "9wFFyRfZBsuAha4YcuxcXLKwMxJR43S7fPfQLusDBzvT",
      "serumV3Usdt": "HWHvQhFmJB3NUcu1aihKmrKegfVxBEHzwVX6yZCKEsi1",
      "website": "https://solana.com/",
      "telegram": null,
      "twitter": "https://twitter.com/solana",
      "description": "Wrapped Solana ",
      "discord": "https://discordapp.com/invite/pquxPsq",
      "medium": "https://medium.com/solana-labs"
    },
    "logoURI": "https://img.fotofolio.xyz/?url=https%3A%2F%2Fraw.githubusercontent.com%2Fsolana-labs%2Ftoken-list%2Fmain%2Fassets%2Fmainnet%2FSo11111111111111111111111111111111111111112%2Flogo.png",
    "liquidity": 286160837.0927743,
    "price": 100.73038300653013,
    "history30mPrice": 102.2869040306967,
    "priceChange30mPercent": -1.3108240597978833,
    "history1hPrice": 102.47604553399863,
    "priceChange1hPercent": -1.492976083714196,
    "history2hPrice": 101.77521514676324,
    "priceChange2hPercent": -0.8146506621751438,
    "history4hPrice": 100.7027002580333,
    "priceChange4hPercent": 0.24170397018449385,
    "history6hPrice": 100.46174850746715,
    "priceChange6hPercent": 0.4821279565294545,
    "history8hPrice": 101.3284322782621,
    "priceChange8hPercent": -0.37731719224887234,
    "history12hPrice": 105.53882281856598,
    "priceChange12hPercent": -4.351687855966953,
    "history24hPrice": 97.8534210982211,
    "priceChange24hPercent": 3.1605247417099016,
    "uniqueWallet30m": 7559,
    "uniqueWalletHistory30m": 8537,
    "uniqueWallet30mChangePercent": -11.456014993557456,
    "uniqueWallet1h": 13249,
    "uniqueWalletHistory1h": 13056,
    "uniqueWallet1hChangePercent": 1.4782475490196079,
    "uniqueWallet2h": 21129,
    "uniqueWalletHistory2h": 19572,
    "uniqueWallet2hChangePercent": 7.955242182709994,
    "uniqueWallet4h": 33368,
    "uniqueWalletHistory4h": 33403,
    "uniqueWallet4hChangePercent": -0.10478100769391971,
    "uniqueWallet6h": 45176,
    "uniqueWalletHistory6h": 51082,
    "uniqueWallet6hChangePercent": -11.561802591911045,
    "uniqueWallet8h": 55603,
    "uniqueWalletHistory8h": 70704,
    "uniqueWallet8hChangePercent": -21.35805612129441,
    "uniqueWallet12h": 79381,
    "uniqueWalletHistory12h": 97172,
    "uniqueWallet12hChangePercent": -18.308772074260073,
    "uniqueWallet24h": 139996,
    "uniqueWalletHistory24h": 149330,
    "uniqueWallet24hChangePercent": -6.2505859505792545,
    "lastTradeUnixTime": 1704451095,
    "lastTradeHumanTime": "2024-01-05T10:38:15.000Z",
    "supply": 566386746.204681,
    "mc": 57174534640.46407,
    "trade30m": 44825,
    "tradeHistory30m": 45289,
    "trade30mChangePercent": -1.0245313431517586,
    "sell30m": 24699,
    "sellHistory30m": 24138,
    "sell30mChangePercent": 2.3241362167536663,
    "buy30m": 20126,
    "buyHistory30m": 21151,
    "buy30mChangePercent": -4.846106567065387,
    "v30m": 86424.440537301,
    "v30mUSD": 8762140.040095054,
    "vHistory30m": 90664.497744561,
    "vHistory30mUSD": 9274976.695088223,
    "v30mChangePercent": -4.676645558888972,
    "vBuy30m": 38026.293317214,
    "vBuy30mUSD": 3856304.692015025,
    "vBuyHistory30m": 44235.704079318,
    "vBuyHistory30mUSD": 4525909.0182105955,
    "vBuy30mChangePercent": -14.037101683676276,
    "vSell30m": 48398.147220087,
    "vSell30mUSD": 4905835.348080029,
    "vSellHistory30m": 46428.793665243,
    "vSellHistory30mUSD": 4749067.676877627,
    "vSell30mChangePercent": 4.241664276361057,
    "trade1h": 90018,
    "tradeHistory1h": 93282,
    "trade1hChangePercent": -3.499067344182157,
    "sell1h": 48771,
    "sellHistory1h": 48804,
    "sell1hChangePercent": -0.06761740840914679,
    "buy1h": 41247,
    "buyHistory1h": 44478,
    "buy1hChangePercent": -7.26426547956293,
    "v1h": 177037.399451086,
    "v1hUSD": 18031837.960302543,
    "vHistory1h": 221503.325014702,
    "vHistory1hUSD": 22627169.837834742,
    "v1hChangePercent": -20.07460861396307,
    "vBuy1h": 82236.97739344,
    "vBuy1hUSD": 8379651.074094415,
    "vBuyHistory1h": 112465.661726459,
    "vBuyHistory1hUSD": 11491216.111813571,
    "vBuy1hChangePercent": -26.878145621498007,
    "vSell1h": 94800.422057646,
    "vSell1hUSD": 9652186.886208128,
    "vSellHistory1h": 109037.663288243,
    "vSellHistory1hUSD": 11135953.72602117,
    "vSell1hChangePercent": -13.057177493762492,
    "trade2h": 183185,
    "tradeHistory2h": 164342,
    "trade2hChangePercent": 11.465723917197064,
    "sell2h": 97503,
    "sellHistory2h": 85332,
    "sell2hChangePercent": 14.263113486148221,
    "buy2h": 85682,
    "buyHistory2h": 79010,
    "buy2hChangePercent": 8.444500696114416,
    "v2h": 398463.624728809,
    "v2hUSD": 40651151.06469577,
    "vHistory2h": 295984.172067957,
    "vHistory2hUSD": 30060808.959732912,
    "v2hChangePercent": 34.62328811194777,
    "vBuy2h": 194679.283637557,
    "vBuy2hUSD": 19868486.121879764,
    "vBuyHistory2h": 151651.769051142,
    "vBuyHistory2hUSD": 15404543.086043594,
    "vBuy2hChangePercent": 28.372576762955326,
    "vSell2h": 203784.341091252,
    "vSell2hUSD": 20782664.942816004,
    "vSellHistory2h": 144332.403016815,
    "vSellHistory2hUSD": 14656265.873689318,
    "vSell2hChangePercent": 41.190984721227665,
    "trade4h": 347698,
    "tradeHistory4h": 399786,
    "trade4hChangePercent": -13.028970499217083,
    "sell4h": 182926,
    "sellHistory4h": 210542,
    "sell4hChangePercent": -13.116622811600537,
    "buy4h": 164772,
    "buyHistory4h": 189244,
    "buy4hChangePercent": -12.931453573164802,
    "v4h": 694804.1476101701,
    "v4hUSD": 70747886.17652822,
    "vHistory4h": 789065.01582494,
    "vHistory4hUSD": 79814175.57443635,
    "v4hChangePercent": -11.945893725401517,
    "vBuy4h": 346661.851851831,
    "vBuy4hUSD": 35306382.62882059,
    "vBuyHistory4h": 392927.737744297,
    "vBuyHistory4hUSD": 39752863.435195215,
    "vBuy4hChangePercent": -11.774655095124425,
    "vSell4h": 348142.295758339,
    "vSell4hUSD": 35441503.54770762,
    "vSellHistory4h": 396137.278080643,
    "vSellHistory4hUSD": 40061312.13924114,
    "vSell4hChangePercent": -12.115744964687087,
    "trade6h": 546721,
    "tradeHistory6h": 662089,
    "trade6hChangePercent": -17.424847716847736,
    "sell6h": 288254,
    "sellHistory6h": 344108,
    "sell6hChangePercent": -16.231531960896,
    "buy6h": 258467,
    "buyHistory6h": 317981,
    "buy6hChangePercent": -18.716212603897716,
    "v6h": 1048307.7791230949,
    "v6hUSD": 106553101.95987056,
    "vHistory6h": 1631759.636709736,
    "vHistory6hUSD": 167703232.082972,
    "v6hChangePercent": -35.75599276147728,
    "vBuy6h": 524707.269562656,
    "vBuy6hUSD": 53344312.3805387,
    "vBuyHistory6h": 798957.819228734,
    "vBuyHistory6hUSD": 82111024.6125867,
    "vBuy6hChangePercent": -34.32603612676613,
    "vSell6h": 523600.509560439,
    "vSell6hUSD": 53208789.57933186,
    "vSellHistory6h": 832801.817481002,
    "vSellHistory6hUSD": 85592207.47038527,
    "vSell6hChangePercent": -37.12783779168644,
    "trade8h": 747120,
    "tradeHistory8h": 947645,
    "trade8hChangePercent": -21.160350131114498,
    "sell8h": 393267,
    "sellHistory8h": 492814,
    "sell8hChangePercent": -20.19971023550467,
    "buy8h": 353853,
    "buyHistory8h": 454831,
    "buy8hChangePercent": -22.201213197869098,
    "v8h": 1483572.63330977,
    "v8hUSD": 150531117.01590806,
    "vHistory8h": 2479404.20927107,
    "vHistory8hUSD": 259763216.8294539,
    "v8hChangePercent": -40.1641479932015,
    "vBuy8h": 739341.911163793,
    "vBuy8hUSD": 75033850.87899134,
    "vBuyHistory8h": 1213506.579572564,
    "vBuyHistory8hUSD": 127142539.76042959,
    "vBuy8hChangePercent": -39.073926453351994,
    "vSell8h": 744230.722145977,
    "vSell8hUSD": 75497266.13691674,
    "vSellHistory8h": 1265897.629698506,
    "vSellHistory8hUSD": 132620677.06902431,
    "vSell8hChangePercent": -41.209249098347115,
    "trade12h": 1208683,
    "tradeHistory12h": 1363052,
    "trade12hChangePercent": -11.325246579000654,
    "sell12h": 632312,
    "sellHistory12h": 717062,
    "sell12hChangePercent": -11.819061671096781,
    "buy12h": 576371,
    "buyHistory12h": 645990,
    "buy12hChangePercent": -10.77710181272156,
    "v12h": 2680342.83329903,
    "v12hUSD": 274277502.93705654,
    "vHistory12h": 3298889.9609878464,
    "vHistory12hUSD": 340447126.1247916,
    "v12hChangePercent": -18.750159447682623,
    "vBuy12h": 1323659.868364753,
    "vBuy12hUSD": 135452056.09494278,
    "vBuyHistory12h": 1625141.20349049,
    "vBuyHistory12hUSD": 167737803.11660245,
    "vBuy12hChangePercent": -18.551085559717105,
    "vSell12h": 1356682.964934277,
    "vSell12hUSD": 138825446.84211373,
    "vSellHistory12h": 1673748.757497356,
    "vSellHistory12hUSD": 172709323.00818914,
    "vSell12hChangePercent": -18.943452005136425,
    "trade24h": 2571727,
    "tradeHistory24h": 2890442,
    "trade24hChangePercent": -11.026514283974562,
    "sell24h": 1349349,
    "sellHistory24h": 1522943,
    "sell24hChangePercent": -11.39858812838038,
    "buy24h": 1222378,
    "buyHistory24h": 1367499,
    "buy24hChangePercent": -10.61214669992446,
    "v24h": 5977615.78137567,
    "v24hUSD": 614568063.9703004,
    "vHistory24h": 8297695.31863122,
    "vHistory24hUSD": 826093866.4537266,
    "v24hChangePercent": -27.96052937791247,
    "vBuy24h": 2949117.30035761,
    "vBuy24hUSD": 303222110.8609985,
    "vBuyHistory24h": 4011122.668178656,
    "vBuyHistory24hUSD": 399343898.26031965,
    "vBuy24hChangePercent": -26.476511831618314,
    "vSell24h": 3028498.48101806,
    "vSell24hUSD": 311345953.109302,
    "vSellHistory24h": 4286572.650452564,
    "vSellHistory24hUSD": 426749968.193407,
    "vSell24hChangePercent": -29.349185748704855,
    "watch": 1430,
    "view30m": 160,
    "viewHistory30m": 175,
    "view30mChangePercent": -8.571428571428571,
    "view1h": 335,
    "viewHistory1h": 302,
    "view1hChangePercent": 10.927152317880795,
    "view2h": 637,
    "viewHistory2h": 592,
    "view2hChangePercent": 7.601351351351352,
    "view4h": 1229,
    "viewHistory4h": 1921,
    "view4hChangePercent": -36.022904737116086,
    "view6h": 2142,
    "viewHistory6h": 3101,
    "view6hChangePercent": -30.9255079006772,
    "view8h": 3148,
    "viewHistory8h": 5024,
    "view8hChangePercent": -37.34076433121019,
    "view12h": 5246,
    "viewHistory12h": 7425,
    "view12hChangePercent": -29.34680134680135,
    "view24h": 12670,
    "viewHistory24h": 15437,
    "view24hChangePercent": -17.924467189220703,
    "uniqueView30m": 98,
    "uniqueViewHistory30m": 105,
    "uniqueView30mChangePercent": -6.666666666666667,
    "uniqueView1h": 186,
    "uniqueViewHistory1h": 196,
    "uniqueView1hChangePercent": -5.1020408163265305,
    "uniqueView2h": 362,
    "uniqueViewHistory2h": 388,
    "uniqueView2hChangePercent": -6.701030927835052,
    "uniqueView4h": 715,
    "uniqueViewHistory4h": 1339,
    "uniqueView4hChangePercent": -46.601941747572816,
    "uniqueView6h": 1440,
    "uniqueViewHistory6h": 1847,
    "uniqueView6hChangePercent": -22.035733622089875,
    "uniqueView8h": 1978,
    "uniqueViewHistory8h": 2911,
    "uniqueView8hChangePercent": -32.050841635176916,
    "uniqueView12h": 3122,
    "uniqueViewHistory12h": 4141,
    "uniqueView12hChangePercent": -24.607582709490462,
    "uniqueView24h": 6797,
    "uniqueViewHistory24h": 6747,
    "uniqueView24hChangePercent": 0.7410701052319549,
    "numberMarkets": 134772
  },
  "success": true
}

Response: The response provides an extensive overview of the token, including address, decimals, symbol, name, extensions (additional information about the token), logo URI, historical price changes, trading volume, liquidity, and various trading metrics over different time intervals.

Please note that the example response has been truncated for brevity. Refer to the API documentation for a complete list of available fields and their meanings.