Skip to main content
GET
/
v1
/
partner
/
stats
Get partner analytics
curl --request GET \
  --url https://api.hypermid.io/v1/partner/stats \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "period": "30d",
    "totalVolumeUSD": "1250000.00",
    "totalTransactions": 4523,
    "successfulTransactions": 4401,
    "failedTransactions": 122,
    "successRate": 97.3,
    "totalFeesEarnedUSD": "1875.00",
    "averageTransactionUSD": "276.32",
    "topChains": [
      { "chainId": 1, "name": "Ethereum", "volumeUSD": "450000.00", "count": 1200 },
      { "chainId": 42161, "name": "Arbitrum", "volumeUSD": "320000.00", "count": 1100 },
      { "chainId": 137, "name": "Polygon", "volumeUSD": "180000.00", "count": 850 }
    ],
    "dailyStats": [
      {
        "date": "2024-03-25",
        "volumeUSD": "42000.00",
        "transactions": 156,
        "feesEarnedUSD": "63.00"
      },
      {
        "date": "2024-03-24",
        "volumeUSD": "38500.00",
        "transactions": 142,
        "feesEarnedUSD": "57.75"
      }
    ]
  },
  "error": null,
  "meta": {
    "requestId": "x4a5b6c7-d8e9-0123-7890-234567890123",
    "timestamp": 1711234582,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1976,
      "reset": 1711234627
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.hypermid.io/llms.txt

Use this file to discover all available pages before exploring further.

Returns aggregated statistics for your partner account, including total volume, transaction counts, and revenue metrics.
​
period
string
Time period for stats: 24h, 7d, 30d, 90d, all. Default: 30d.
​
groupBy
string
Group results by: day, week, month. Default: day.
{
  "data": {
    "period": "30d",
    "totalVolumeUSD": "1250000.00",
    "totalTransactions": 4523,
    "successfulTransactions": 4401,
    "failedTransactions": 122,
    "successRate": 97.3,
    "totalFeesEarnedUSD": "1875.00",
    "averageTransactionUSD": "276.32",
    "topChains": [
      { "chainId": 1, "name": "Ethereum", "volumeUSD": "450000.00", "count": 1200 },
      { "chainId": 42161, "name": "Arbitrum", "volumeUSD": "320000.00", "count": 1100 },
      { "chainId": 137, "name": "Polygon", "volumeUSD": "180000.00", "count": 850 }
    ],
    "dailyStats": [
      {
        "date": "2024-03-25",
        "volumeUSD": "42000.00",
        "transactions": 156,
        "feesEarnedUSD": "63.00"
      },
      {
        "date": "2024-03-24",
        "volumeUSD": "38500.00",
        "transactions": 142,
        "feesEarnedUSD": "57.75"
      }
    ]
  },
  "error": null,
  "meta": {
    "requestId": "x4a5b6c7-d8e9-0123-7890-234567890123",
    "timestamp": 1711234582,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1976,
      "reset": 1711234627
    }
  }
}

const stats = await client.getPartnerStats({ period: "30d" });

console.log("Total volume:", stats.data.totalVolumeUSD, "USD");
console.log("Transactions:", stats.data.totalTransactions);
console.log("Success rate:", stats.data.successRate, "%");
console.log("Fees earned:", stats.data.totalFeesEarnedUSD, "USD");

Authorizations

​
X-API-Key
string
header
required

Partner API key. Optional for public endpoints, required for /v1/partner/*.

Query Parameters

​
from
string<date>

Start date (YYYY-MM-DD)

​
to
string<date>

End date (YYYY-MM-DD)

Response

Stats data

​
data
object
required

Response payload (null on error)

​
error
object
required
​
meta
object
required