Skip to main content
Returns your fee earnings broken down by ecosystem and settlement state. Earnings are recorded at swap-quote time and accumulate as pending until the Hypermid operations team triggers a settlement payout to your registered fee wallets.
Settlements are run periodically by the operations team via a Ledger device. Once a row moves from pendingsettled, the corresponding payout has been broadcast on-chain.

Authentication

Requires a partner API key in the X-API-Key header.

Response

{
  "data": {
    "partnerId": "partner-1718956800-a1b2",
    "pending": [
      { "ecosystem": "evm",     "totalUsd": "1284.50", "rowCount": 312 },
      { "ecosystem": "solana",  "totalUsd": "172.10",  "rowCount": 41 },
      { "ecosystem": "near",    "totalUsd": "58.20",   "rowCount": 17 }
    ],
    "settled": [
      { "ecosystem": "evm",     "totalUsd": "9817.30", "rowCount": 2104 },
      { "ecosystem": "solana",  "totalUsd": "1093.40", "rowCount": 287 }
    ],
    "notes": "Earnings are recorded at quote time. 'pending' rows await manual settlement (operations triggers payouts via a Ledger device)."
  },
  "error": null,
  "meta": { "requestId": "...", "timestamp": 1718956800, "rateLimit": { "limit": 2000, "remaining": 1999, "reset": 1718956860 } }
}

Response fields

FieldTypeDescription
partnerIdstringYour partner ID (echoed from auth)
pendingarrayEarnings awaiting settlement, grouped by ecosystem
pending[].ecosystemstringOne of evm, solana, bitcoin, sui, near
pending[].totalUsdstringSum of fees in USD (string to avoid float precision loss)
pending[].rowCountnumberNumber of swap-fee-ledger rows aggregated
settledarraySame shape as pending, for fees already paid out
notesstringOperational note on settlement cadence
The pending and settled arrays only include ecosystems where you have non-zero balances — they may be empty.

Example

curl https://api.hypermid.io/v1/partner/me/earnings \
  -H "X-API-Key: pk_live_yourkey"
Earnings rows are paginated implicitly by ecosystem. For a per-swap breakdown, use /v1/partner/transactions and filter by feeUsd > 0.