Skip to main content
GET
/
tenant
/
{tenantId}
/
admin
/
gas_stations
GetFullGasStationWalletsReport
curl --request GET \
  --url https://api.example.com/tenant/{tenantId}/admin/gas_stations
{
  "isSuccess": true,
  "isFailure": false,
  "error": null,
  "value": {
    "id": 42,
    "name": "Example"
  }
}

​
Description

This endpoint retrieves a full report of all gas station wallets associated with a tenant, including wallet details, balances, network information, custodian relationships, refuel configurations, and connection statistics.

​
Input

  • tenantId (path, required): Identifier of the tenant requesting the report
  • request (query, optional): Report filtering parameters
  • ct (optional): Token to cancel the asynchronous operation

​
Output

Returns a Result<WalletReportResponse> containing a collection of wallet reports with comprehensive details including:
  • Wallet identification (ID, tenant ID, name, address)
  • Network information (blockchain name, network icon, native token)
  • Balance and asset valuation
  • Custodian configuration (default, available, active custodians)
  • Gas station configuration (enabled status, connected wallets count)
  • Auto-refuel settings (enabled, source wallet, minimum balance, refill amount)
  • Treasury wallet status and metrics

​
Examples

Request: 
GET /api/tenant/1024/gas-station-wallets/report
Response (200 OK): 
{
  "data": {
    "wallets": [
      {
        "walletId": 501,
        "walletTenantId": 2048,
        "name": "Primary Gas Station",
        "network": "Ethereum Sepolia",
        "address": "0xABCD...EF01",
        "status": "Active",
        "visible": "Yes",
        "active": "Yes",
        "walletType": "GasStation",
        "networkIcon": "iVBORw0KGgoAAAA...",
        "nativeToken": "ETH",
        "nativeTokenSupply": 1.25,
        "nativeTokenValue": 2500.00,
        "defaultCustodian": "Fireblocks",
        "custodiansAvailable": "Fireblocks,SelfCustody",
        "custodiansActive": "Fireblocks",
        "refuelEnabled": true,
        "refuelSource": "Treasury Wallet",
        "refuelSourceAddress": "0x9876...5432",
        "refuelMinBalance": 0.1,
        "refuelFillAmt": 0.5,
        "gasStation": "Enabled",
        "gasStationConnections": 5,
        "gasStationCustodian": "Fireblocks",
        "blockchainId": 42
      }
    ]
  },
  "isSuccess": true
}

​
Errors

  • 400 Bad Request: Invalid tenant identifier or request parameters
  • 401 Unauthorized: Authentication credentials are missing or invalid
  • 403 Forbidden: User lacks permission to view gas station wallet reports
  • 404 Not Found: Tenant does not exist
  • 500 Internal Server Error: Unexpected server error occurred during report generation

​
Notes

  • Report includes all wallets configured as gas stations for the tenant
  • Balance and valuation information reflects real-time state
  • Connection counts show number of wallets depending on each gas station
  • Report useful for monitoring gas station health and capacity

Path Parameters

​
TenantId
integer<int64>
required

Query Parameters

​
tenantId
integer<int64>

Identifier of the tenant.

Response

Report retrieved successfully.

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

The result value returned when the operation is successful.