Skip to main content
GET
/
api
/
v1
/
usage
curl "/api/v1/usage?fromDate=2025-01-01T00:00:00.000Z&toDate=2025-01-31T23:59:59.000Z" \
  -H "x-api-key: mh_live_abc123..."
{
  "totalTransfers": 142,
  "completedTransfers": 130,
  "failedTransfers": 5,
  "totalVolumeRaw": "142000000000",
  "totalFlatFeeEarned": 5460000,
  "totalPayouts": 0,
  "isTestMode": false
}

Query parameters

fromDate
string
ISO 8601 start date (e.g. 2025-01-01T00:00:00.000Z).
toDate
string
ISO 8601 end date.

Response

totalTransfers
integer
Total number of transfers in the period.
completedTransfers
integer
Number of successfully completed transfers.
failedTransfers
integer
Number of failed transfers.
totalVolumeRaw
string
Total transfer volume in base token units (returned as a string to preserve bigint precision).
totalFlatFeeEarned
integer
Total flat fee earned by your integration in lamports.
totalPayouts
integer
Number of integrator reward payouts settled on-chain in the period.
isTestMode
boolean
Whether this summary reflects test-mode transfers.
curl "/api/v1/usage?fromDate=2025-01-01T00:00:00.000Z&toDate=2025-01-31T23:59:59.000Z" \
  -H "x-api-key: mh_live_abc123..."
{
  "totalTransfers": 142,
  "completedTransfers": 130,
  "failedTransfers": 5,
  "totalVolumeRaw": "142000000000",
  "totalFlatFeeEarned": 5460000,
  "totalPayouts": 0,
  "isTestMode": false
}