GET
/
avs
/
{address}
curl --request GET \
  --url https://api.eigenexplorer.com/avs/{address} \
  --header 'X-API-Token: <x-api-token>'
{
  "address": "0x35f4f28a8d3ff20eed10e087e8f96ea2641e6aa1",
  "metadataName": "Example AVS",
  "metadataDescription": "This is an example AVS",
  "metadataDiscord": "https://discord.com/invite/abcdefghij",
  "metadataLogo": "<string>",
  "metadataTelegram": "https://t.me/acme",
  "metadataWebsite": "https://acme.com",
  "metadataX": "https://twitter.com/acme",
  "totalStakers": 10,
  "totalOperators": 10,
  "maxApy": "1.0",
  "createdAtBlock": "19631203",
  "updatedAtBlock": "19631203",
  "createdAt": "2024-04-11T08:31:11.000Z",
  "updatedAt": "2024-04-11T08:31:11.000Z",
  "curatedMetadata": {
    "avsAddress": "0x2344c0fe02ccd2b32155ca0ffcb1978a6d96a552",
    "metadataName": "Example AVS",
    "metadataDescription": "This is an example AVS",
    "metadataDiscord": "https://discord.com/invite/example",
    "metadataLogo": "The URL of the AVS's logo",
    "metadataTelegram": "The URL of the AVS's Telegram channel",
    "metadataWebsite": "https://example.com",
    "metadataX": "https://twitter.com/example",
    "metadataGithub": "https://github.com/example",
    "metadataTokenAddress": "0x2344c0fe02ccd2b32155ca0ffcb1978a6d96a552",
    "tags": [
      "Example tag 1",
      "Example tag 2"
    ],
    "isVisible": true,
    "isVerified": true
  },
  "shares": [
    {
      "strategyAddress": "0x93c4b944d05dfe6df7645a86cd2206016c51564d",
      "shares": "1000000000000000000000"
    },
    {
      "strategyAddress": "0x54945180db7943c0ed0fee7edab2bd24620256bc",
      "shares": "1000000000000000000000"
    }
  ],
  "tvl": {
    "tvl": 1000000,
    "tvlBeaconChain": 1000000,
    "tvlWETH": 1000000,
    "tvlRestaking": 1000000,
    "tvlStrategies": {
      "Eigen": 1000000,
      "cbETH": 2000000
    },
    "tvlStrategiesEth": {
      "stETH": 1000000,
      "cbETH": 2000000
    }
  },
  "rewards": {
    "strategyApys": [
      {
        "strategyAddress": "0xbeac0eeeeeeeeeeeeeeeeeeeeeeeeeeeeeebeac0",
        "apy": 0.1,
        "tokens": [
          {
            "tokenAddress": "0xc02aaa39b223fe8d0a0e5c4f27ead9083c756cc2",
            "apy": 0.1
          }
        ]
      }
    ]
  }
}

Headers

X-API-Token
string
required

API Token for authentication

Path Parameters

address
string
required

AVS service manager contract address

Example:

"0x870679e138bcdf293b7ff14dd44b70fc97e12fc0"

Query Parameters

withTvl
enum<string>
default:false

Toggle whether the route should calculate the TVL from shares

Available options:
true,
false
Example:

"false"

withCuratedMetadata
enum<string>
default:false

Toggle whether the route should send curated metadata

Available options:
true,
false
Example:

"false"

withRewards
enum<string>
default:false

Toggle whether the route should return Avs/Operator rewards APY data

Available options:
true,
false
Example:

"false"

Response

200
application/json
The AVS record found.
address
string
required

AVS service manager contract address

Example:

"0x35f4f28a8d3ff20eed10e087e8f96ea2641e6aa1"

metadataName
string
required

The name of the AVS

Example:

"Example AVS"

metadataDescription
string | null
required

The description of the AVS

Example:

"This is an example AVS"

metadataDiscord
string | null
required

The URL of the AVS's Discord server

Example:

"https://discord.com/invite/abcdefghij"

The URL of the AVS's logo

metadataTelegram
string | null
required

The URL of the AVS's Telegram channel

Example:

"https://t.me/acme"

metadataWebsite
string | null
required

The URL of the AVS's website

Example:

"https://acme.com"

metadataX
string | null
required

The URL of the AVS's X

Example:

"https://twitter.com/acme"

totalStakers
number
required

The total number of stakers staking in the AVS

Example:

10

totalOperators
number
required

The total number of operators operating the AVS

Example:

10

maxApy
string
required

The max APY for the AVS across all the strategies

Example:

"1.0"

createdAtBlock
string
required

The block number at which the AVS was created

Example:

"19631203"

updatedAtBlock
string
required

The block number at which the AVS was last updated

Example:

"19631203"

createdAt
string
required

The time stamp at which the AVS was created

Example:

"2024-04-11T08:31:11.000Z"

updatedAt
string
required

The time stamp at which the AVS was last updated

Example:

"2024-04-11T08:31:11.000Z"

shares
object[]
required

The strategy shares held in the AVS

Example:
[
  {
    "strategyAddress": "0x93c4b944d05dfe6df7645a86cd2206016c51564d",
    "shares": "1000000000000000000000"
  },
  {
    "strategyAddress": "0x54945180db7943c0ed0fee7edab2bd24620256bc",
    "shares": "1000000000000000000000"
  }
]
rewards
object
required

The reward details for the AVS, including strategies and APYs

curatedMetadata
object

To curate visibility and additional information of the AVS

Example:
{
  "avsAddress": "0x2344c0fe02ccd2b32155ca0ffcb1978a6d96a552",
  "metadataName": "Example AVS",
  "metadataDescription": "This is an example AVS",
  "metadataDiscord": "https://discord.com/invite/example",
  "metadataLogo": "The URL of the AVS's logo",
  "metadataTelegram": "The URL of the AVS's Telegram channel",
  "metadataWebsite": "https://example.com",
  "metadataX": "https://twitter.com/example",
  "metadataGithub": "https://github.com/example",
  "metadataTokenAddress": "0x2344c0fe02ccd2b32155ca0ffcb1978a6d96a552",
  "tags": ["Example tag 1", "Example tag 2"],
  "isVisible": true,
  "isVerified": true
}
tvl
object

The total value locked (TVL) in the AVS

Example:
{
  "tvl": 1000000,
  "tvlBeaconChain": 1000000,
  "tvlWETH": 1000000,
  "tvlRestaking": 1000000,
  "tvlStrategies": { "Eigen": 1000000, "cbETH": 2000000 },
  "tvlStrategiesEth": { "stETH": 1000000, "cbETH": 2000000 }
}