Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/redstone-credora/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"label": "What is Credora?",
"position": 9,
"collapsed": true
}
9 changes: 9 additions & 0 deletions docs/redstone-credora/api-documentation/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "API Documentation",
"position": 4,
"collapsed": true,
"link": {
"type": "doc",
"id": "redstone-credora/api-documentation/index"
}
}
70 changes: 70 additions & 0 deletions docs/redstone-credora/api-documentation/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
title: Credora GraphQL API Documentation
sidebar_label: API Documentation
---

# Credora GraphQL API Documentation

Credora GraphQL APIs expose ratings information alongside unique data points, powering risk management across protocols, asset managers, and active onchain participants.

## Overview

APIs are structured to provide responses across three primary categories:

- **Vaults** (Available now)
- **Assets** *(soon!)*
- **Markets** *(soon!)*

Each category exposes active Credora Ratings, providing risk metrics and analytics.

---

## Endpoint

**https://api.credora.io/graphql**

Developers can use standard POST requests to query the endpoint with a GraphQL query.
You can use tools like Postman, Insomnia, or GraphQL playgrounds to explore and test queries.

---

## Authentication

### Requesting API Access

Accessing Credora APIs requires whitelisted access.
You can request access via this **[Google Form](https://docs.google.com/forms/d/e/1FAIpQLSep4TmedhA8VKaDH3OQuIaqWtcY3nI_ro2T7269ZSN9IHL4cA/viewform)**.

### API Keys

Once approved, you will receive:

- **Client API Key:** Your unique authentication credential

Keep your API key secure and never expose it in client-side code or public repositories.

---

### Authentication Header

All GraphQL requests must include the following HTTP header:

`ClientSecret: your-api-key`


### Authentication Errors

Requests without a valid API key will return:

```json
{
"errors": [
{
"message": "Unauthorized: Invalid or missing API key",
"extensions": {
"code": "UNAUTHENTICATED",
"hint": "Provide a valid API key in the 'ClientSecret' header"
}
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"label": "Vault Ratings",
"collapsed": false
}
156 changes: 156 additions & 0 deletions docs/redstone-credora/api-documentation/vault-ratings/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
---
title: Vault Ratings
sidebar_label: Vault Ratings
---

# Vault Ratings

## Overview
The Vault Ratings API provides comprehensive rating information for DeFi vaults, derived from Credora's proprietary risk assessment methodology. Each vault rating includes quantitative risk metrics, qualitative assessments, and curator information.

## Vault Ratings Definitions
- **ID**: Unique identifier for the vault
- **Address**: On-chain address of the vault
- **Chain ID**: Standard chain identifier (e.g., `1` for Ethereum, `8453` for Base)
- **Curator**: Name of the Vault curator.
- **Name**: Human-readable name of the vault
- **Protocol**: Protocol name (e.g., *Morpho*)
- **Metrics**: Rating metrics and risk assessment data
- **Rating**: Rating output on the DeFi scale, designed to be more intuitive for all users
- **Publish Date**: The date on which the Vault Rating was last updated (format: `YYYY-MM-DD`)
- **PSL**: Probability of Significant Loss — annualized probability of a 1% loss on market supply

---

## Available Queries

---

### Get Single Vault Rating
Retrieve detailed rating information for a specific vault by its ID or address.

#### Query
```graphql
query GetVaultRating {
getVaultRating(id: "id") {
id
address
chainId
protocol
Metrics {
rating
psl
publishDate
}
curator {
name
}
}
}
```

*Example response*

```json
{
"data": {
"getVaultRating": {
"id": "cd8b167e-dc4c-475b-9265-429b2c197bb9",
"address": "0x0D05e6ec0A10f9fFE9229EAA785c11606a1d13Fb",
"chainId": 8453,
"name": "Gauntlet LBTC Core",
"protocol": "Morpho",
"curator": {
"name": "Curator Name"
},
"Metrics": {
"rating": "A-",
"psl": 0.00428,
"publishDate": "2025-19-09"
}
}
}
}
```

### Query: Get All Vault Ratings

Retrieve a paginated list of all available vault ratings.

**Pagination**

The getVaultRatings endpoint supports pagination via optional parameters:

- page: Zero-indexed page number. The default is 0.

- limit: Number of results per page. The default is 10.

#### Query

```graphql
query {
getVaultRatings(page: 0, limit: 2) {
totalCount
items {
id
address
chainId
name
protocol
Metrics {
rating
psl
publishDate
}
curator {
name
}
}
}
}

```

**Example response**

```json
{
"data": {
"getVaultRatings": {
"totalCount": 70,
"items": [
{
"id": "cd8b167e-dc4c-475b-9265-429b2c197bb9",
"address": "0x059Fc6723b9bF77DbF4283C8d7C90eA8Af44EF10",
"chainId": 1,
"name": "SwissBorg tBTC",
"protocol": "Morpho",
"Metrics": {
"rating": "A+",
"psl": 0.0011200000000000001,
"publishDate": "2025-19-09"
},
"curator": {
"name": "Gauntlet"
}
},
{
"id": "f238d012-1c90-42e4-b6d1-612dbc735947",
"address": "0x0D05e6ec0A10f9fFE9229EAA785c11606a1d13Fb",
"chainId": 8453,
"name": "Gauntlet LBTC Core",
"protocol": "Morpho",
"Metrics": {
"rating": "A-",
"psl": 0.00428,
"publishDate": "2025-19-09"
},
"curator": {
"name": "Gauntlet"
}
}
]
}
}
}
```
9 changes: 9 additions & 0 deletions docs/redstone-credora/faq/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "FAQ",
"position": 5,
"collapsed": false,
"link": {
"type": "doc",
"id": "redstone-credora/faq/index"
}
}
84 changes: 84 additions & 0 deletions docs/redstone-credora/faq/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
---
title: FAQ
sidebar_label: FAQ
---

# FAQ

## 1. Are there any live Credora ratings being used atm?
- Ratings will be live on Morpho and Spark by the end of this week.

## 2. How can I gain access to the Credora API?
- We are relaunching the API during Devconnect, limited to the vault ratings endpoint.
Market & asset ratings will follow shortly, and the expansion in vault coverage will continue as our agreements with curators progress.
Accessing Credora APIs requires whitelisted access which can be requested on this [Google Form](https://forms.gle/Fjb5MBGeUHgRJ8wU9).

## 3. What sort of risk does Credora aggregate?

### a. At the Asset Token Level:
- i. Asset Quality
- ii. Custody Risk
- iii. Network Risk
- iv. Reserve Management
- v. Regulatory Cover
- vi. User Rights
- vii. Audit Quality
- viii. Contract Maturity
- ix. Collateralization
- x. Reserves Transparency
- xi. Peg Track Record
- xii. TVL
- xiii. Governance

### b. At a Market Level:

- **i. Liquidation Probability:**
- 1. Pair Price Volatility
- 2. Market Extreme Tail events
- 3. Collateral Default
- 4. Allocated Positions
- 5. User Rebalance Profile
- 6. Market Characteristics (LTV, LIF)

- **ii. Bad debt given Liquidation Probability:**
- 1. Base Liquidity
- 2. Pair Usage across Lending Protocols
- 3. Pair Usage in the Rated Protocol
- 4. Volatility of the price pair

- iii. Oracle
- iv. Protocol

### c. At a Vault Level:
- i. Markets PSL
- ii. Curator
- iii. Governance
- iv. Guardian
- v. Timelock

## 4. What is the benefit of using Credora’s risk ratings?
- Risk transparency and enhanced ecosystem trust
- Informed risk-reward decision making
- Elevated DeFi market standards
- Early warnings on changing risk profiles
- Risk/Reward adjusted strategies

## 5. Who benefits from Credora’s risk ratings?
- Vault Curators
- End Users
- Lending Protocols
- Yield Aggregators
- CEXs
- Asset Issuers

## 6. How often are our risk ratings updated?
- Update cadence varies by component:
- i. Asset ratings: 3 months
- ii. Market ratings: 2 weeks
- iii. Vault ratings: Daily

## 7. What does the rating process look like?
- An initial call to discuss what needs to be rated, explore use cases, and determine if Credora is a good fit.
- Rating coverage analysis in order to determine what assets/markets are exposed to and how prices are determined.
- Quantify various factors of risk with methodologies, simulations, and models.
- Compose the final ratings.
9 changes: 9 additions & 0 deletions docs/redstone-credora/how-to-rate-morpho/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"label": "How to Rate Morpho",
"position": 3,
"collapsed": true,
"link": {
"type": "doc",
"id": "redstone-credora/how-to-rate-morpho/index"
}
}
Loading
Loading