/l2beat/projects

POST /api/l2beat/projects

Price: 20 credits

Get a single L2BEAT scaling project's full profile by slug or project URL

How to use it

Get the complete profile of a single Ethereum layer-two scaling project tracked by L2BEAT, by its slug (e.g. 'arbitrum', 'base', 'optimism') or project URL. Returns the project's description, category, proof system, maturity stage with the full Stage 0/1/2 requirement checklist and what is missing for the next stage, the five risk pillars (sequencer failure, state validation, data availability, exit window, proposer failure) with sentiment and detail, value secured (TVS) breakdown, official links, the full technology analysis (data availability, operator, withdrawals, sequencing, state validation, state derivation, upgrades and governance) with per-item risks, on-chain permissioned actors and their addresses, deployed smart contracts per chain, and the milestones and incidents timeline.

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 an L2BEAT project URL (examples: "arbitrum", "base", "optimism", "https://l2beat.com/scaling/projects/arbitrum"; minLength: 1)

Response

• @type string (default: "L2beatProjectDetail")
• id string required
• name string required
• alias string nullable
• image string nullable
• type string nullable
• host_chain string nullable
• category string nullable
• proof_system_type string nullable
• stage string nullable
• description string nullable
• is_appchain boolean (default: false)
• providers array (default: [])
• purposes array (default: [])
• is_archived boolean (default: false)
• is_under_review boolean (default: false)
• next_stage string nullable
• missing_requirements array (default: [])
• badges array (default: [])
  • @type string (default: "L2beatProjectBadge")
  • id string nullable
  • type string nullable
  • name string nullable
  • description string nullable
• 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
• links array (default: [])
  • @type string (default: "L2beatProjectLink")
  • name string required
  • urls array (default: [])
• risk_pillars array (default: [])
  • @type string (default: "L2beatRiskPillar")
  • name string required
  • value string nullable
  • sentiment string nullable
  • description string nullable
  • second_line string nullable
  • execution_delay integer nullable
• stage_summary array (default: [])
  • @type string (default: "L2beatStageSummary")
  • stage string required
  • requirements array (default: [])
    • @type string (default: "L2beatStageRequirement")
    • satisfied boolean nullable
    • description string required
• technology array (default: [])
  • @type string (default: "L2beatTechnologySection")
  • id string nullable
  • content string nullable
  • items array (default: [])
    • @type string (default: "L2beatTechnologyItem")
    • id string nullable
    • name string required
    • description string nullable
    • is_under_review boolean (default: false)
    • references array (default: [])
    • risks array (default: [])
  • risks array (default: [])
    • @type string (default: "L2beatTechnologyRisk")
    • text string required
    • is_critical boolean nullable
• permissions array (default: [])
  • @type string (default: "L2beatPermissionActor")
  • id string nullable
  • name string required
  • chain string nullable
  • description string nullable
  • addresses array (default: [])
    • @type string (default: "L2beatAddress")
    • name string nullable
    • address string required
    • verification_status string nullable
    • href string nullable
  • admins array (default: [])
    • @type string (default: "L2beatAddress")
    • name string nullable
    • address string required
    • verification_status string nullable
    • href string nullable
• contracts array (default: [])
  • @type string (default: "L2beatContract")
  • id string nullable
  • name string required
  • chain string nullable
  • description string nullable
  • addresses array (default: [])
    • @type string (default: "L2beatAddress")
    • name string nullable
    • address string required
    • verification_status string nullable
    • href string nullable
  • admins array (default: [])
    • @type string (default: "L2beatAddress")
    • name string nullable
    • address string required
    • verification_status string nullable
    • href string nullable
• milestones array (default: [])
  • @type string (default: "L2beatMilestone")
  • type string nullable
  • date string nullable
  • description string nullable
  • url string 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.