> ## Documentation Index
> Fetch the complete documentation index at: https://docs.avnu.fi/llms.txt
> Use this file to discover all available pages before exploring further.

# Monitor Sponsor Activity

> Monitor your API key's sponsorship metrics and remaining credits

## Overview

Returns detailed usage metrics for your API key's sponsored transactions including transaction counts, gas fees consumed in ETH and STRK, and remaining credits.

<Info>
  This endpoint requires an API key and returns data for that specific key only.
</Info>

## Headers

<ParamField header="api-key" type="string" required>
  Your paymaster API key for authentication
</ParamField>

## Query Parameters

<ParamField query="startDate" type="string">
  Start date for activity query (ISO 8601 date-time). Default: 7 days ago
</ParamField>

<ParamField query="endDate" type="string">
  End date for activity query (ISO 8601 date-time). Default: now
</ParamField>

## Response

<ResponseField name="name" type="string">
  The sponsor's name
</ResponseField>

<ResponseField name="txCount" type="integer">
  Total number of executed transactions
</ResponseField>

<ResponseField name="succeededTxCount" type="integer">
  Number of successful transactions
</ResponseField>

<ResponseField name="revertedTxCount" type="integer">
  Number of reverted transactions
</ResponseField>

<ResponseField name="gasFees" type="string">
  Total ETH paid for all transactions
</ResponseField>

<ResponseField name="succeededGasFees" type="string">
  ETH paid for successful transactions
</ResponseField>

<ResponseField name="revertedGasFees" type="string">
  ETH paid for reverted transactions
</ResponseField>

<ResponseField name="strkGasFees" type="string">
  Total STRK paid for all transactions
</ResponseField>

<ResponseField name="succeededStrkGasFees" type="string">
  STRK paid for successful transactions
</ResponseField>

<ResponseField name="revertedStrkGasFees" type="string">
  STRK paid for reverted transactions
</ResponseField>

<ResponseField name="remainingCredits" type="string">
  Remaining ETH credits (contact support to recharge when zero)
</ResponseField>

<ResponseField name="remainingStrkCredits" type="string">
  Remaining STRK credits (contact support to recharge when zero)
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl "https://starknet.api.avnu.fi/paymaster/v1/sponsor-activity?startDate=2024-11-01T00:00:00Z&endDate=2024-12-01T00:00:00Z"
  ```

  ```typescript TypeScript theme={null}
  async function getSponsorActivity(apiKey: string) {
    const startDate = new Date(Date.now() - 7 * 24 * 60 * 60 * 1000).toISOString();
    const endDate = new Date().toISOString();

    const params = new URLSearchParams({
      startDate,
      endDate
    });

    const response = await fetch(
      `https://starknet.api.avnu.fi/paymaster/v1/sponsor-activity?${params}`,
      {
        headers: {
          'api-key': apiKey
        }
      }
    );

    return await response.json();
  }
  ```

  ```python Python theme={null}
  import requests
  from datetime import datetime, timedelta

  def get_sponsor_activity(api_key):
      start_date = (datetime.now() - timedelta(days=7)).isoformat()
      end_date = datetime.now().isoformat()

      params = {
          'startDate': start_date,
          'endDate': end_date
      }

      headers = {
          'api-key': api_key
      }

      response = requests.get(
          'https://starknet.api.avnu.fi/paymaster/v1/sponsor-activity',
          params=params,
          headers=headers
      )

      return response.json()
  ```
</RequestExample>

<ResponseExample>
  ```json Success theme={null}
  {
      "name": "my app",
      "succeededTxCount": 8297,
      "revertedTxCount": 0,
      "txCount": 8297,
      "succeededGasFees": "0x0",
      "revertedGasFees": "0x0",
      "gasFees": "0x0",
      "succeededStrkGasFees": "0x9b4bc7d495ab90fe0",
      "revertedStrkGasFees": "0x0",
      "strkGasFees": "0x9b4bc7d495ab90fe0",
      "remainingCredits": "0x0",
      "remainingStrkCredits": "0x8de42a4ed5ea442ee"
  }
  ```
</ResponseExample>

## Need More Credits?

<Card title="Contact Support" icon="telegram" href="https://t.me/avnu_developers">
  Reach out to recharge your sponsorship credits
</Card>
