> For the complete documentation index, see [llms.txt](https://gitbook-docs.coinmetrics.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://gitbook-docs.coinmetrics.io/cm-api-spec/meta-data/reference-data/protocols.md).
# Protocols
Returns a list of blockchain protocol metadata.
```json
{"openapi":"3.0.2","info":{"title":"Coin Metrics API v4","version":"4.0.0"},"tags":[{"name":"Reference Data","description":"Metadata information of entities supported by Coin Metrics.\n\n**Endpoints on this page:**\n- `GET /reference-data/asset-metrics` — Asset metrics\n- `GET /reference-data/assets` — Assets\n- `GET /reference-data/exchange-asset-metrics` — Exchange asset metrics\n- `GET /reference-data/exchange-metrics` — Exchange metrics\n- `GET /reference-data/exchange-pair-metrics` — Exchange pair metrics\n- `GET /reference-data/exchanges` — Exchanges\n- `GET /reference-data/indexes` — Indexes\n- `GET /reference-data/institution-metrics` — Institution metrics\n- `GET /reference-data/market-metrics` — Market metrics\n- `GET /reference-data/markets` — Markets\n- `GET /reference-data/pair-metrics` — Pair metrics\n- `GET /reference-data/pairs` — Pairs\n- `GET /reference-data/protocols` — Protocols"}],"servers":[{"url":"https://api.coinmetrics.io/v4"},{"url":"wss://api.coinmetrics.io/v4"},{"url":"https://community-api.coinmetrics.io/v4"}],"security":[{"api_key":[]}],"components":{"securitySchemes":{"api_key":{"description":"Coin Metrics API key can be specified as `?api_key=` query parameter.","in":"query","name":"api_key","type":"apiKey"}},"parameters":{"Protocols":{"description":"Comma separated list of protocols like `aave_v3` or `morpho_blue`.","in":"query","name":"protocols","schema":{"type":"array","items":{"type":"string"}},"explode":false},"ProtocolChains":{"description":"Comma separated list of protocol chains like `ethereum` or `base`.","in":"query","name":"chains","schema":{"type":"array","items":{"type":"string"}},"explode":false},"ProtocolMarkets":{"description":"Comma separated list of protocol markets like `core-weth` or `steakusdc`.","in":"query","name":"markets","schema":{"type":"array","items":{"type":"string"}},"explode":false},"PageSize":{"description":"Number of items per single page of results.
The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.","in":"query","name":"page_size","schema":{"default":100,"type":"integer","format":"int32","minimum":1,"maximum":10000}},"PagingFromWithStartByDefault":{"description":"Where does the first page start, at the start of the interval or at the end.
The value of this parameter is ignored if the endpoint supports the `format` parameter and its value is set to `json_stream`.","in":"query","name":"paging_from","schema":{"default":"start","enum":["start","end"],"type":"string","format":"PagingFrom"}},"NextPageToken":{"description":"Token for receiving the results from the next page of a query.
Should not be used directly. To iterate through pages just use `next_page_url` response field.","in":"query","name":"next_page_token","schema":{"type":"string"}},"CatalogResponseFormat":{"description":"Format of the response. Supported values are `json`, `json_stream`.","in":"query","name":"format","schema":{"type":"string","default":"json"}},"Pretty":{"description":"Human-readable formatting of JSON responses.","in":"query","name":"pretty","schema":{"type":"boolean","default":false}}},"responses":{"ReferenceDataProtocols":{"description":"Protocol metadata.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceDataProtocolsResponse"}}}},"ProtocolNotFound":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Protocol not found."},"Unauthorized":{"description":"Requested resource requires authorization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UriTooLong":{"description":"Provided URI is too long. It must not be greater than 10000 symbols."}},"schemas":{"ReferenceDataProtocolsResponse":{"description":"Blockchain protocol reference data response.","properties":{"data":{"$ref":"#/components/schemas/ReferenceDataProtocols"},"next_page_token":{"$ref":"#/components/schemas/NextPageToken"},"next_page_url":{"$ref":"#/components/schemas/NextPageUrl"},"warning":{"$ref":"#/components/schemas/WarningObject"}},"required":["data"],"type":"object"},"ReferenceDataProtocols":{"type":"array","items":{"$ref":"#/components/schemas/ReferenceDataProtocol"}},"ReferenceDataProtocol":{"description":"Protocol reference data response.","properties":{"market":{"description":"Protocol market.","type":"string"},"full_name":{"description":"Full human-readable name of the protocol market.","type":"string"},"protocol":{"description":"Protocol name.","type":"string"},"type":{"description":"Protocol type.","type":"string"},"chains":{"type":"array","items":{"$ref":"#/components/schemas/ProtocolChain"}}},"required":["market","full_name","protocol","type","chains"],"type":"object"},"ProtocolChain":{"description":"Protocol chain.","properties":{"chain":{"description":"Protocol chain.","type":"string"},"address":{"description":"Primary contract address for the protocol entity. Aave: lending pool. Morpho vault: vault contract. Morpho market: market ID.\n","$ref":"#/components/schemas/ProtocolAddress"},"asset":{"description":"Primary asset. Aave: reserve/underlying asset. Morpho vault: deposit asset. Morpho market: loan asset.\n","$ref":"#/components/schemas/ProtocolAsset"},"asset_address":{"description":"Address of the primary asset token.","$ref":"#/components/schemas/ProtocolAddress"},"asset_decimals":{"description":"Decimal conversion.","type":"string"},"configurator_address":{"$ref":"#/components/schemas/ProtocolAddress"},"atoken_address":{"$ref":"#/components/schemas/ProtocolAddress"},"atoken_asset":{"$ref":"#/components/schemas/ProtocolAsset"},"variable_debt_token_address":{"$ref":"#/components/schemas/ProtocolAddress"},"variable_debt_asset":{"$ref":"#/components/schemas/ProtocolAsset"},"stable_debt_token_address":{"$ref":"#/components/schemas/ProtocolAddress"},"curator_address":{"$ref":"#/components/schemas/ProtocolAddress"},"curator_name":{"$ref":"#/components/schemas/ProtocolAddressName"},"guardian_address":{"$ref":"#/components/schemas/ProtocolAddress"},"guardian_name":{"$ref":"#/components/schemas/ProtocolAddressName"},"collateral_asset":{"description":"Collateral asset posted by borrowers.","$ref":"#/components/schemas/ProtocolAsset"},"collateral_asset_address":{"$ref":"#/components/schemas/ProtocolAddress"},"oracle_address":{"description":"Price oracle contract for the market.","$ref":"#/components/schemas/ProtocolAddress"},"irm_address":{"description":"Interest rate model contract for the market.","$ref":"#/components/schemas/ProtocolAddress"},"lltv":{"description":"Liquidation loan-to-value ratio for the market.","type":"string"}},"required":["chain"],"type":"object"},"ProtocolAddress":{"description":"Address of the protocol contract.","type":"string"},"ProtocolAsset":{"description":"Protocol asset symbol.","type":"string"},"ProtocolAddressName":{"description":"Name associated with the address.","type":"string"},"NextPageToken":{"description":"Token of the next page results for a given request.","type":"string"},"NextPageUrl":{"description":"URL of the next page results for a given request.","type":"string"},"WarningObject":{"properties":{"type":{"description":"Warning type string. Can be used for warning identification.","type":"string"},"message":{"description":"Human-friendly warning description. Do not use for warning identification in your code.","type":"string"}},"required":["type","message"],"type":"object"},"ErrorResponse":{"properties":{"error":{"$ref":"#/components/schemas/ErrorObject"}},"required":["error"],"type":"object"},"ErrorObject":{"properties":{"type":{"description":"Error type string. Can be used for error identification.","type":"string"},"message":{"description":"Human-friendly error description. Can be amended without prior notification. Do not use for error identification in your code.","type":"string"}},"required":["type","description"],"type":"object"}}},"paths":{"/reference-data/protocols":{"get":{"summary":"Protocols","description":"Returns a list of blockchain protocol metadata.","operationId":"getReferenceDataProtocols","tags":["Reference Data"],"parameters":[{"$ref":"#/components/parameters/Protocols"},{"$ref":"#/components/parameters/ProtocolChains"},{"$ref":"#/components/parameters/ProtocolMarkets"},{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PagingFromWithStartByDefault"},{"$ref":"#/components/parameters/NextPageToken"},{"$ref":"#/components/parameters/CatalogResponseFormat"},{"$ref":"#/components/parameters/Pretty"}],"responses":{"200":{"$ref":"#/components/responses/ReferenceDataProtocols"},"400":{"$ref":"#/components/responses/ProtocolNotFound"},"401":{"$ref":"#/components/responses/Unauthorized"},"414":{"$ref":"#/components/responses/UriTooLong"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://gitbook-docs.coinmetrics.io/cm-api-spec/meta-data/reference-data/protocols.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.