Skip to main content
GET
/
platform
/
admin
/
reports
/
reserves
Get reserves report
curl --request GET \
  --url https://api.example.com/platform/admin/reports/reserves
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

Retrieves comprehensive reserve transaction data for all tokens on the platform. Reserves represent the backing assets (such as USDC or USDT) held to support deployed tokens. This report includes all reserve-related transactions including deposits, withdrawals, and transfers.

​
Input

No input parameters required. The report aggregates data across all tokens and reserve accounts.

​
Output

Returns a collection of ReportReservesModel objects, each containing:
  • tokenSymbol (string) — The symbol of the token (e.g., USDC, USDT).
  • reserveAmount (decimal) — Current reserve balance for the token.
  • transactionCount (int) — Number of reserve transactions.
  • lastTransactionDate (DateTime) — Timestamp of the most recent reserve transaction.
  • blockchain (string) — The blockchain network where reserves are held.

​
Examples

Request 
GET /api/platform/reports/reserves
Response (200 OK) 
{
  "isSuccess": true,
  "value": [
    {
      "tokenSymbol": "USDC",
      "reserveAmount": 1500000.00,
      "transactionCount": 342,
      "lastTransactionDate": "2024-01-15T14:32:00Z",
      "blockchain": "Ethereum"
    },
    {
      "tokenSymbol": "USDT",
      "reserveAmount": 850000.00,
      "transactionCount": 198,
      "lastTransactionDate": "2024-01-15T13:45:00Z",
      "blockchain": "Polygon"
    }
  ]
}

​
Errors

  • 401 Unauthorized: Authentication required to access platform reports.
  • 403 Forbidden: Insufficient permissions to view reserve data.
  • 500 Internal Server Error: Failed to retrieve reserve data from blockchain or database.

​
Notes

This endpoint requires platform administrator privileges. Reserve amounts represent the total backing assets held to support token deployments. All amounts are denominated in the reserve token’s native units.

Query Parameters

​
api-version
string | null

Response

Successfully retrieved reserves report.

Wrapper for API operation results containing success status, error information, and return value.

​
isSuccess
boolean

True if the operation completed successfully, false otherwise.

Example:

true

​
isFailure
boolean

True if the operation failed, false otherwise.

Example:

false

​
error
object

Error information returned when the operation fails.

Example:
{
  "code": "ValidationError",
  "message": "The request parameters failed validation.",
  "info": [
    "The Name field is required.",
    "The Id field must be greater than 0."
  ]
}
​
value
object[] | null

The result value returned when the operation is successful.