/l2beat/projects/tvs

POST /api/l2beat/projects/tvs

Price: 5 credits

Get the value-secured (TVS) history and current breakdown for an L2BEAT scaling project

How to use it

Get the value-secured (TVS) time series for a single Ethereum layer-two scaling project, plus its current TVS breakdown by bridge type (canonical, external, native) and asset category (ether, stablecoin, btc, other, real-world assets). Each chart point carries the per-category USD values and the ETH price at that time, ordered oldest-first. Optionally limit to the most recent N points.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• project string required — Project slug or project URL (examples: "arbitrum", "base", "https://l2beat.com/scaling/projects/optimism"; minLength: 1)
• range string — Time window for the value-secured history (default: "1y"; one of: "1d", "7d", "30d", "90d", "180d", "1y", "max")
• count integer nullable — Return only the most recent N chart points (min: 1)

Response

• @type string (default: "L2beatProjectTvsHistory")
• id string required
• tvs object nullable
  • @type string (default: "L2beatProjectTvs")
  • total number nullable
  • native number nullable
  • canonical number nullable
  • external number nullable
  • ether number nullable
  • stablecoin number nullable
  • btc number nullable
  • other number nullable
  • rwa_restricted number nullable
  • rwa_public number nullable
  • associated number nullable
  • change_7d number nullable
  • associated_tokens array (default: [])
    • @type string (default: "L2beatProjectToken")
    • symbol string required
    • icon string nullable
• chart array (default: [])
  • @type string (default: "L2beatTvsPoint")
  • timestamp integer required
  • eth_price number nullable
  • native number nullable
  • canonical number nullable
  • external number nullable
  • ether number nullable
  • stablecoin number nullable
  • btc number nullable
  • other number nullable
  • rwa_restricted number nullable
  • rwa_public number nullable
• synced_until integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Project not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.