> For the complete documentation index, see [llms.txt](https://docs.creditcoop.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.creditcoop.xyz/developer-api-docs/benchmarks.md).

# Benchmarks

Benchmark vault APY rates computed from on-chain snapshots

## Get historical vault APY

> Returns a daily timeseries of rolling 7-day APY for any vault with on-chain snapshots. Works with both internal vaults (sharePrice) and ERC-4626 vaults (convertToAssets). Specify the vault by address or token symbol.

```json
{"openapi":"3.0.3","info":{"title":"Credit Coop API","version":"3.0.0"},"tags":[{"name":"Benchmarks","description":"Benchmark vault APY rates computed from on-chain snapshots"}],"servers":[{"url":"https://api.creditcoop.xyz"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"OAuth2":[]},{}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key in the format: cc_xxx_yyy (for customer API routes)"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Clerk authentication token (session JWT or Clerk OAuth access token) used by Credit Coop"},"OAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://clerk.creditcoop.xyz/oauth/authorize","tokenUrl":"https://clerk.creditcoop.xyz/oauth/token","scopes":{"openid":"OpenID Connect","email":"User email","profile":"User profile"}}},"description":"Credit Coop OAuth"}},"schemas":{"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"},"statusCode":{"type":"integer"}}}}},"paths":{"/v3/benchmarks/vault-apy":{"get":{"operationId":"getBenchmarkVaultApy","summary":"Get historical vault APY","tags":["Benchmarks"],"description":"Returns a daily timeseries of rolling 7-day APY for any vault with on-chain snapshots. Works with both internal vaults (sharePrice) and ERC-4626 vaults (convertToAssets). Specify the vault by address or token symbol.","parameters":[{"schema":{"type":"string"},"in":"query","name":"address","required":false,"description":"Vault contract address (e.g., 0xabc...)"},{"schema":{"type":"string"},"in":"query","name":"symbol","required":false,"description":"Token symbol to look up the vault (e.g., stataEthUSDC)"},{"schema":{"type":"string"},"in":"query","name":"networkId","required":true,"description":"CAIP-2 network identifier (e.g., eip155:1 for Ethereum, eip155:8453 for Base)"},{"schema":{"type":"string","format":"date"},"in":"query","name":"from","required":false,"description":"Start date (YYYY-MM-DD). Defaults to earliest available data."},{"schema":{"type":"string","format":"date"},"in":"query","name":"to","required":false,"description":"End date (YYYY-MM-DD). Defaults to latest available data."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["address","networkId","data"],"properties":{"address":{"type":"string"},"networkId":{"type":"string"},"symbol":{"type":"string"},"data":{"type":"array","items":{"type":"object","required":["date","apyPct7D"],"properties":{"date":{"type":"string","format":"date"},"apyPct7D":{"type":["null","number"],"description":"Rolling 7-day APY in percent (e.g., 5.25 = 5.25%)"}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## Get historical benchmark rate

> Returns a daily timeseries of a benchmark rate from the prices table. Use symbol FED\_FUNDS\_RATE for the Federal Funds Effective Rate.

```json
{"openapi":"3.0.3","info":{"title":"Credit Coop API","version":"3.0.0"},"tags":[{"name":"Benchmarks","description":"Benchmark vault APY rates computed from on-chain snapshots"}],"servers":[{"url":"https://api.creditcoop.xyz"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]},{"OAuth2":[]},{}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key in the format: cc_xxx_yyy (for customer API routes)"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"Clerk authentication token (session JWT or Clerk OAuth access token) used by Credit Coop"},"OAuth2":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://clerk.creditcoop.xyz/oauth/authorize","tokenUrl":"https://clerk.creditcoop.xyz/oauth/token","scopes":{"openid":"OpenID Connect","email":"User email","profile":"User profile"}}},"description":"Credit Coop OAuth"}},"schemas":{"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"type":"string"},"message":{"type":"string"},"statusCode":{"type":"integer"}}}}},"paths":{"/v3/benchmarks/rate":{"get":{"operationId":"getBenchmarkRate","summary":"Get historical benchmark rate","tags":["Benchmarks"],"description":"Returns a daily timeseries of a benchmark rate from the prices table. Use symbol FED_FUNDS_RATE for the Federal Funds Effective Rate.","parameters":[{"schema":{"type":"string","default":"FED_FUNDS_RATE"},"in":"query","name":"symbol","required":false,"description":"Rate symbol (e.g., FED_FUNDS_RATE). Defaults to FED_FUNDS_RATE."},{"schema":{"type":"string","format":"date"},"in":"query","name":"from","required":false,"description":"Start date (YYYY-MM-DD). Defaults to earliest available."},{"schema":{"type":"string","format":"date"},"in":"query","name":"to","required":false,"description":"End date (YYYY-MM-DD). Defaults to latest available."}],"responses":{"200":{"description":"Default Response","content":{"application/json":{"schema":{"type":"object","required":["symbol","data"],"properties":{"symbol":{"type":"string"},"data":{"type":"array","items":{"type":"object","required":["date","rate"],"properties":{"date":{"type":"string","format":"date"},"rate":{"type":"number","description":"Rate value (e.g., 4.33 = 4.33%)"}}}}}}}}},"400":{"description":"Default Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# 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:

```
GET https://docs.creditcoop.xyz/developer-api-docs/benchmarks.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.