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

​
Description

Retrieves reserve requirement calculations for all deployed tokens on the platform. This report shows the required reserve backing for each token based on its circulating supply and configuration, along with the actual reserve holdings to assess compliance. This is critical for ensuring tokens maintain proper backing ratios.

​
Input

No input parameters required. The report calculates requirements for all deployed token configurations.

​
Output

Returns a collection of ReserveRequirementsModel objects, each containing:
  • tokenSymbol (string) — The symbol of the deployed token.
  • circulatingSupply (decimal) — Current number of tokens in circulation.
  • requiredReserve (decimal) — Minimum reserve amount required based on token configuration.
  • actualReserve (decimal) — Current reserve balance held for this token.
  • complianceStatus (string) — Whether reserves meet requirements (Compliant, Underfunded, Overfunded).
  • reserveRatio (decimal) — Percentage of required reserves currently held.
  • blockchain (string) — The blockchain network where the token is deployed.

​
Examples

Request 
GET /api/platform/reports/reserve-requirements
Response (200 OK) 
{
  "isSuccess": true,
  "value": [
    {
      "tokenSymbol": "ACME",
      "circulatingSupply": 250000.00,
      "requiredReserve": 250000.00,
      "actualReserve": 265000.00,
      "complianceStatus": "Compliant",
      "reserveRatio": 106.0,
      "blockchain": "Ethereum"
    },
    {
      "tokenSymbol": "CORP",
      "circulatingSupply": 140000.00,
      "requiredReserve": 140000.00,
      "actualReserve": 135000.00,
      "complianceStatus": "Underfunded",
      "reserveRatio": 96.43,
      "blockchain": "Polygon"
    }
  ]
}

​
Errors

  • 401 Unauthorized: Authentication required to access platform reports.
  • 403 Forbidden: Insufficient permissions to view reserve requirement data.
  • 500 Internal Server Error: Failed to calculate reserve requirements or retrieve configuration data.

​
Notes

This endpoint requires platform administrator privileges. Reserve requirements are calculated based on each token’s configured backing ratio and circulating supply. Tokens showing Underfunded status require immediate attention to maintain compliance. Reserve ratios above 100 percent indicate excess backing.

Query Parameters

​
api-version
string | null

Response

Successfully retrieved reserve requirements 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.