/defillama/protocols

POST /api/defillama/protocols

Price: 20 credits

Get DeFiLlama protocol details by slug or protocol URL

How to use it

Get full details of a DeFi protocol on DeFiLlama by its slug (e.g. 'aave', 'uniswap') or a DeFiLlama protocol URL. Returns name, symbol, description, website, social links, supported chains, current total value locked (TVL), per-chain TVL snapshot, market cap, audits, funding rounds, notable timeline events, and related sub-protocols.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• protocol string required — Protocol slug or a DeFiLlama protocol URL (examples: "aave", "uniswap", "lido", "https://defillama.com/protocol/aave"; minLength: 1)

Response

• @type string (default: "DefillamaProtocol")
• id string required
• name string required
• symbol string nullable
• alias string required
• url string nullable
• description string nullable
• image string nullable
• chains array (default: [])
• gecko_id string nullable
• cmc_id string nullable
• twitter string nullable
• github array (default: [])
• address string nullable
• treasury string nullable
• governance_id array (default: [])
• stablecoins array (default: [])
• audit_links array (default: [])
• category string nullable
• mcap number nullable
• tvl number nullable
• is_parent_protocol boolean (default: false)
• wrong_liquidity boolean (default: false)
• current_chain_tvls object (default: {})
  • * number
• other_protocols array (default: [])
• raises array (default: [])
  • @type string (default: "DefillamaProtocolRaise")
  • name string nullable
  • round string nullable
  • amount number nullable
  • date integer nullable
  • sector string nullable
  • category string nullable
  • source string nullable
  • valuation number nullable
  • chains array (default: [])
  • lead_investors array (default: [])
  • other_investors array (default: [])
• hallmarks array (default: [])
  • @type string (default: "DefillamaProtocolHallmark")
  • date integer required
  • text string required

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 — Protocol 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.