Health check

Check API availability.

GEThttps://api-v2.syncrone.fi/api/catalog/health

Service and data health. Returns 503 when indexing looks stopped (no vault indexed in 30 h) or more than a tenth of the vaults are stale, so a monitor can alert on it.

← Vaults API overview

Try it#

GET/health

API keyx-api-key

Kept in this browser tab only, and sent to Syncrone with each request. No key yet? Create one ↗

Response

Paste an API key, then press Send. The parameters are pre-filled with a real example.

curl

curl "https://api-v2.syncrone.fi/api/catalog/health" \
  -H "x-api-key: $SYNCRONE_API_KEY"

Example#

A real response to the pre-filled Try it request, recorded from Syncrone data. Values move with every indexing run.

503GET /health

{
  "status": "Degraded",
  "message": "18 of 157 vaults are stale",
  "vaults": 157,
  "staleVaults": 18,
  "notIndexedVaults": 94,
  "newestUpdateTimestamp": 1791849600,
  "stale": [
    {
      "vaultId": "0x9D39A5DE30e57443BfF2A8307A4256c8797A3497",
      "slug": "ethena-eth-susde",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0x35fA164735182de50811E8e2E824cFb9B6118ac2",
      "slug": "ether-fi-eth-eeth",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0xb45ad160634c528Cc3D2926d9807104FA3157305",
      "slug": "inverse-eth-sdola",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0xA1290d69c65A6Fe4DF752f95823fae25cB99e5A7",
      "slug": "kelp-eth-rseth",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0x6D1a4C0878aD24793b1655ae1f78Cfa4522Ba765",
      "slug": "kpk-mainnet-usd-alpha",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0xae7ab96520DE3A18E5e111B5EaAb095312D7fE84",
      "slug": "lido-eth-steth",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0x530824DA86689C9C17CdC2871Ff29B058345b44a",
      "slug": "matrixdock-eth-stbt",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0xcAFeAA466736ac01e0AC9Ca72644beF348694731",
      "slug": "nexus-mutual-eth-rwi-vault-usdc",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0x1B19C19393e2d034D8Ff31ff34c81252FcBbee92",
      "slug": "ondo-eth-ousg",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0xdd50C053C096CB04A3e3362E2b622529EC5f2e8a",
      "slug": "openeden-eth-tbill",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0x856c4Efb76C1D1AE02e20CEB03A2A6a08b0b8dC3",
      "slug": "origin-eth-oeth",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0x5475611Dffb8ef4d697Ae39df9395513b6E947d7",
      "slug": "reservoir-eth-srusd",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0xae78736Cd615f374D3085123A210448E74Fc6393",
      "slug": "rocket-pool-eth-reth",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0x48bf8fCd44e2977c8a9A744658431A8e6C0d866c",
      "slug": "seamless-base-weth",
      "network": "base",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0x5362D5086FDef73450145492a66F8EBF210c5B9C",
      "slug": "silo-eth-optima-usdc",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0xA35b1B31Ce002FBF2058D22F30f95D405200A15b",
      "slug": "stader-eth-ethx",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0xf951E335afb289353dc249e82926178EaC7DEd78",
      "slug": "swell-eth-sweth",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    },
    {
      "vaultId": "0x697c54a84D83F37380d034e2BfC6F7cE8d89F4Ee",
      "slug": "term-eth-usdc-meta-vault",
      "network": "mainnet",
      "lastUpdateTimestamp": 1791763200
    }
  ]
}

Parameters#

None.

Response#

200 returns JSON with these fields. APY values are fractions (0.04 = 4%); timestamps are Unix seconds.

Field	Type	Description
status	`string`	`Success`, or `Degraded` with HTTP 503.
message	`string`	Why the catalog is degraded, else a healthy message.
vaults	`integer`	Vaults in the catalog.
staleVaults	`integer`	Vaults that missed an indexing run.
notIndexedVaults	`integer`	Registered vaults with no data yet. Hidden from the catalog until their first run; not a failure.
newestUpdateTimestamp	`integer \| null`	Unix seconds of the freshest bar.
stale[]	`object`	Up to 50 stale vaults: `vaultId`, `slug`, `network`, `lastUpdateTimestamp`.
checkedTimestamp	`integer`	Unix seconds when this check ran. Answers are cached for up to an hour.

Errors#

Status	Meaning
401	Missing or rejected API key.
429	Too many requests from the docs playground. Wait a minute.
500	The service failed.
503	Data is stale or indexing stopped; the body says why.

Error bodies carry error and, for invalid parameters, details.

← PreviousList protocols Next →List advanced vaults