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

Description

Retrieves comprehensive treasury transaction data for all deployed tokens on the platform. The treasury tracks all token circulation events including minting new tokens, burning tokens, and transfers that affect total supply. This report provides visibility into token lifecycle operations.

Input

No input parameters required. The report aggregates treasury data across all deployed tokens.

Output

Returns a collection of ReportTreasureModel objects, each containing:
  • tokenSymbol (string) — The symbol of the deployed token.
  • transactionType (string) — Type of operation (Mint, Burn, Transfer).
  • amount (decimal) — Amount of tokens involved in the transaction.
  • circulatingSupply (decimal) — Total circulating supply after the transaction.
  • timestamp (DateTime) — When the transaction occurred.
  • blockchain (string) — The blockchain network where the transaction was recorded.

Examples

Request
GET /api/platform/reports/treasury
Response (200 OK)
{
  "isSuccess": true,
  "value": [
    {
      "tokenSymbol": "ACME",
      "transactionType": "Mint",
      "amount": 50000.00,
      "circulatingSupply": 250000.00,
      "timestamp": "2024-01-15T14:32:00Z",
      "blockchain": "Ethereum"
    },
    {
      "tokenSymbol": "CORP",
      "transactionType": "Burn",
      "amount": 10000.00,
      "circulatingSupply": 140000.00,
      "timestamp": "2024-01-15T13:20:00Z",
      "blockchain": "Polygon"
    }
  ]
}

Errors

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

Notes

This endpoint requires platform administrator privileges. Treasury operations directly affect token supply and must be balanced with reserve holdings. All transactions are recorded on-chain and reflected in this report.

Query Parameters

api-version
string | null

Response

Successfully retrieved treasury 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.