Skip to main content
GET
/
v1
/
partner
/
transactions
List partner transactions
curl --request GET \
  --url https://api.hypermid.io/v1/partner/transactions \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "transactions": [
      {
        "id": "txn_abc123",
        "type": "swap",
        "status": "DONE",
        "fromChain": 1,
        "toChain": 42161,
        "fromToken": { "symbol": "ETH", "address": "0x0000000000000000000000000000000000000000" },
        "toToken": { "symbol": "USDC", "address": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831" },
        "fromAmount": "1000000000000000000",
        "toAmount": "3237500000",
        "fromAmountUSD": "3250.00",
        "toAmountUSD": "3237.50",
        "fromAddress": "0xSenderAddress",
        "toAddress": "0xReceiverAddress",
        "sourceTxHash": "0xSourceTxHash",
        "destinationTxHash": "0xDestTxHash",
        "tool": "stargate",
        "feeUSD": "4.88",
        "createdAt": "2024-03-25T10:30:00Z",
        "completedAt": "2024-03-25T10:32:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 4523,
      "totalPages": 227
    }
  },
  "error": null,
  "meta": {
    "requestId": "y5b6c7d8-e9f0-1234-8901-345678901234",
    "timestamp": 1711234583,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1975,
      "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 a paginated list of transactions associated with your partner account.
​
page
number
Page number (1-based). Default: 1.
​
limit
number
Results per page (max 100). Default: 20.
​
status
string
Filter by status: PENDING, DONE, FAILED.
​
fromChain
number
Filter by source chain ID.
​
toChain
number
Filter by destination chain ID.
​
fromDate
string
Filter by start date (ISO 8601 format).
​
toDate
string
Filter by end date (ISO 8601 format).
{
  "data": {
    "transactions": [
      {
        "id": "txn_abc123",
        "type": "swap",
        "status": "DONE",
        "fromChain": 1,
        "toChain": 42161,
        "fromToken": { "symbol": "ETH", "address": "0x0000000000000000000000000000000000000000" },
        "toToken": { "symbol": "USDC", "address": "0xaf88d065e77c8cC2239327C5EDb3A432268e5831" },
        "fromAmount": "1000000000000000000",
        "toAmount": "3237500000",
        "fromAmountUSD": "3250.00",
        "toAmountUSD": "3237.50",
        "fromAddress": "0xSenderAddress",
        "toAddress": "0xReceiverAddress",
        "sourceTxHash": "0xSourceTxHash",
        "destinationTxHash": "0xDestTxHash",
        "tool": "stargate",
        "feeUSD": "4.88",
        "createdAt": "2024-03-25T10:30:00Z",
        "completedAt": "2024-03-25T10:32:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 20,
      "total": 4523,
      "totalPages": 227
    }
  },
  "error": null,
  "meta": {
    "requestId": "y5b6c7d8-e9f0-1234-8901-345678901234",
    "timestamp": 1711234583,
    "rateLimit": {
      "limit": 2000,
      "remaining": 1975,
      "reset": 1711234627
    }
  }
}

const txns = await client.getPartnerTransactions({
  page: 1,
  limit: 20,
  status: "DONE",
  fromChain: 1,
});

console.log(`Page 1 of ${txns.data.pagination.totalPages}`);
for (const tx of txns.data.transactions) {
  console.log(`${tx.id}: ${tx.fromAmountUSD} USD via ${tx.tool} — ${tx.status}`);
}

Authorizations

​
X-API-Key
string
header
required

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

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100

Response

Transaction list

​
data
any
required

Response payload (null on error)

​
error
object
required
​
meta
object
required