/l2beat/interop/protocols/search

POST /api/l2beat/interop/protocols/search

Price: 20 credits

Search and list L2BEAT interoperability (bridge/messaging) protocols ranked by volume

How to use it

List cross-chain interoperability protocols (bridges and messaging layers such as CCTP, LayerZero, Across, Stargate, Wormhole, Axelar) tracked by L2BEAT, ranked from highest to lowest transfer volume. Each result carries the protocol name, description, type, bridge mechanism types, total volume, transfer count, and average transfer value. Optionally restrict the aggregation to specific chains or protocol slugs.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• count integer required — Max number of results (min: 1)
• chains array nullable — Restrict volume aggregation to these chain slugs
• protocol_ids array nullable — Restrict to these interoperability protocol slugs

Response

• @type string (default: "L2beatInteropProtocol")
• id string required
• alias string nullable
• name string required
• description string nullable
• type string nullable
• bridge_types array (default: [])
• volume number nullable
• transfer_count integer nullable
• average_value number nullable
• image 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 — The entity was not found, or a precondition failed 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.