# Reports

## GET /reports/volume-report

> Download the backend-generated global monthly volume report as a CSV attachment. Set breakdownByVault=true to include a per-vault monthly breakdown.

```json
{"openapi":"3.0.0","info":{"title":"Nest API","version":"1.0.0"},"servers":[{"url":"https://api.nest.credit/v1","description":"Nest API Server"}],"paths":{"/reports/volume-report":{"get":{"tags":["Reports"],"description":"Download the backend-generated global monthly volume report as a CSV attachment. Set breakdownByVault=true to include a per-vault monthly breakdown.","parameters":[{"schema":{"type":"integer","nullable":true,"minimum":0,"description":"Unix timestamp in seconds (UTC)."},"required":false,"description":"Unix timestamp in seconds (UTC).","name":"startDate","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"description":"Unix timestamp in seconds (UTC)."},"required":false,"description":"Unix timestamp in seconds (UTC).","name":"endDate","in":"query"},{"schema":{"type":"string","enum":["true","false"],"description":"When true, the CSV includes monthly rows broken down by vault."},"required":false,"description":"When true, the CSV includes monthly rows broken down by vault.","name":"breakdownByVault","in":"query"}],"responses":{"200":{"description":"Global volume report CSV file","content":{"text/csv":{"schema":{"type":"string","description":"CSV export of the global monthly volume report."}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}}}}
```

## GET /reports/revenue-report

> Download the backend-generated global revenue report as a CSV attachment.

```json
{"openapi":"3.0.0","info":{"title":"Nest API","version":"1.0.0"},"servers":[{"url":"https://api.nest.credit/v1","description":"Nest API Server"}],"paths":{"/reports/revenue-report":{"get":{"tags":["Reports"],"description":"Download the backend-generated global revenue report as a CSV attachment.","parameters":[{"schema":{"type":"integer","nullable":true,"minimum":0,"description":"Unix timestamp in seconds (UTC)."},"required":false,"description":"Unix timestamp in seconds (UTC).","name":"startDate","in":"query"},{"schema":{"type":"integer","nullable":true,"minimum":0,"description":"Unix timestamp in seconds (UTC)."},"required":false,"description":"Unix timestamp in seconds (UTC).","name":"endDate","in":"query"},{"schema":{"type":"number","nullable":true,"minimum":0,"description":"Flat fee applied to each deposit transaction."},"required":false,"description":"Flat fee applied to each deposit transaction.","name":"flatDepositFee","in":"query"},{"schema":{"type":"number","nullable":true,"minimum":0,"description":"Flat fee applied to each redemption transaction."},"required":false,"description":"Flat fee applied to each redemption transaction.","name":"flatRedemptionFee","in":"query"},{"schema":{"type":"number","nullable":true,"minimum":0,"description":"Fractional deposit fee rate, for example 0.01 for 1%."},"required":false,"description":"Fractional deposit fee rate, for example 0.01 for 1%.","name":"depositFeePct","in":"query"},{"schema":{"type":"number","nullable":true,"minimum":0,"description":"Fractional redemption fee rate, for example 0.01 for 1%."},"required":false,"description":"Fractional redemption fee rate, for example 0.01 for 1%.","name":"redemptionFeePct","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":100,"description":"Optional scenario label used in the output filename."},"required":false,"description":"Optional scenario label used in the output filename.","name":"scenario","in":"query"}],"responses":{"200":{"description":"Global revenue report CSV file","content":{"text/csv":{"schema":{"type":"string","description":"CSV export of the global revenue report."}}}},"400":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}},"500":{"description":"Server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string"}},"required":["error"]}}}}}}}}}
```


---

# Agent Instructions: 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.nest.credit/developers/api/reports.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.