Account API

Overview

The Account API allows you to manage your API account, check credit balance, monitor usage, and configure webhooks.

Endpoints

Endpoint	Description
`GET /api/v1/account/info`	Get account information
`GET /api/v1/account/credits`	Check credit balance
`GET /api/v1/account/usage`	View usage statistics
`GET /api/v1/account/history`	Paginated request history
`POST /api/v1/account/webhook`	Set your webhook URL

All account endpoints are free — they never consume credits.

Get Account Info

Retrieve your account details and plan information.

GET /api/v1/account/info

curl -X GET "https://api.bouncewatch.com/api/v1/account/info" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch('https://api.bouncewatch.com/api/v1/account/info', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' }
});
const data = await response.json();

response = requests.get(
    'https://api.bouncewatch.com/api/v1/account/info',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)

$ch = curl_init('https://api.bouncewatch.com/api/v1/account/info');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-API-Key: YOUR_API_KEY']);
$response = curl_exec($ch);
$data = json_decode($response, true);

Response

{
  "success": true,
  "data": {
    "account": {
      "id": 1042,
      "name": "John Doe",
      "email": "[email protected]",
      "company_name": "Acme Corp",
      "plan_type": "professional",
      "status": "active",
      "created_at": "2026-01-15T10:00:00.000000Z"
    },
    "limits": {
      "credits_per_month": 25000,
      "rate_per_minute": 150,
      "rate_per_day": 5000
    },
    "plan_defaults": {
      "credits_per_month": 25000,
      "rate_per_minute": 150,
      "rate_per_day": 5000
    },
    "rate_limits": {
      "per_minute": 150,
      "per_day": 5000
    }
  }
}

Field	Description
`limits`	What is actually enforced on your account. Read this one.
`plan_defaults`	The catalogue values for your plan. Differs from `limits` only if a limit was raised for you individually.
`rate_limits`	The rate half of `limits`, kept for backwards compatibility.

Get Credit Balance

Check your current credit balance and usage.

GET /api/v1/account/credits

curl -X GET "https://api.bouncewatch.com/api/v1/account/credits" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch('https://api.bouncewatch.com/api/v1/account/credits', {
  headers: { 'X-API-Key': 'YOUR_API_KEY' }
});

response = requests.get(
    'https://api.bouncewatch.com/api/v1/account/credits',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)

$ch = curl_init('https://api.bouncewatch.com/api/v1/account/credits');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-API-Key: YOUR_API_KEY']);
$response = curl_exec($ch);
$data = json_decode($response, true);

Response

{
  "success": true,
  "data": {
    "credits": {
      "balance": 21000,
      "used": 4000,
      "limit": 25000,
      "total_purchased": 0,
      "percentage_used": 16,
      "resets_at": "2026-02-01T09:14:22.000000Z"
    }
  }
}

Field	Description
`balance`	Credits you can still spend this period. This is the number to watch.
`used`	Credits consumed this period. Returns to `0` at each renewal.
`limit`	Your plan’s allowance for the period.
`total_purchased`	Lifetime total ever added by purchase. `0` on a free trial.
`percentage_used`	`used / limit`, as a percentage of this period’s allowance.
`resets_at`	When the allowance was last renewed. `null` if it never has been.

Credits do not roll over. Each period starts at limit, whatever was left of the previous one — 25,000 with 8,000 unspent renews at 25,000, not 33,000.

Get Usage Statistics

View detailed usage statistics for your account.

GET /api/v1/account/usage

This endpoint always reports the current calendar month and takes no parameters. For a longer or arbitrary window, page through /account/history.

curl -X GET "https://api.bouncewatch.com/api/v1/account/usage" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch(
  'https://api.bouncewatch.com/api/v1/account/usage',
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);

response = requests.get(
    'https://api.bouncewatch.com/api/v1/account/usage',
    headers={'X-API-Key': 'YOUR_API_KEY'}
)

$ch = curl_init('https://api.bouncewatch.com/api/v1/account/usage');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-API-Key: YOUR_API_KEY']);
$response = curl_exec($ch);
$data = json_decode($response, true);

Response

{
  "success": true,
  "data": {
    "current_limits": {
      "requests_today": 45,
      "requests_this_minute": 2,
      "last_request": "2026-02-10T14:22:05.000000Z"
    },
    "monthly_usage": {
      "requests": 1250,
      "credits_consumed": 3200,
      "period": {
        "start": "2026-02-01T00:00:00.000000Z",
        "end": "2026-02-28T23:59:59.999999Z"
      }
    },
    "top_endpoints": [
      {
        "endpoint": "/api/v1/company/stripe.com",
        "requests": 42,
        "credits_used": 520,
        "avg_credits_per_request": 12.38
      }
    ],
    "recent_requests": [
      {
        "id": 90211,
        "endpoint": "/api/v1/company/stripe.com",
        "method": "GET",
        "credits_consumed": 26,
        "response_status": 202,
        "response_time": 0.184,
        "error_message": null,
        "requested_at": "2026-02-10T14:22:05.000000Z"
      }
    ]
  }
}

Field	Description
`current_limits`	Live counters behind your rate limits
`monthly_usage`	Totals for the current calendar month
`top_endpoints`	Your ten busiest endpoints this month
`recent_requests`	Your last 20 requests

Get Request History

Page through your full request log, newest first.

GET /api/v1/account/history

integer

default:"50"

Records to return. Capped at 100.

integer

default:"0"

Records to skip.

curl -X GET "https://api.bouncewatch.com/api/v1/account/history?limit=50&offset=0" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch(
  'https://api.bouncewatch.com/api/v1/account/history?limit=50&offset=0',
  { headers: { 'X-API-Key': 'YOUR_API_KEY' } }
);

response = requests.get(
    'https://api.bouncewatch.com/api/v1/account/history',
    headers={'X-API-Key': 'YOUR_API_KEY'},
    params={'limit': 50, 'offset': 0}
)

$ch = curl_init('https://api.bouncewatch.com/api/v1/account/history?limit=50&offset=0');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['X-API-Key: YOUR_API_KEY']);
$response = curl_exec($ch);
$data = json_decode($response, true);

Response

{
  "success": true,
  "data": {
    "requests": [
      {
        "id": 90211,
        "endpoint": "/api/v1/company/stripe.com",
        "method": "GET",
        "credits_consumed": 26,
        "response_status": 202,
        "response_time": 0.184,
        "requested_at": "2026-02-10T14:22:05.000000Z"
      }
    ],
    "pagination": {
      "total": 1250,
      "limit": 50,
      "offset": 0,
      "has_more": true
    }
  }
}

Set Your Webhook URL

Store a default webhook URL on your account, so you don’t have to send X-Webhook-URL on every request.

POST /api/v1/account/webhook

string

required

Your webhook endpoint. Must be https:// — plain http is rejected.

There is nothing to subscribe to. One URL receives every event for your account: enrichment.completed, enrichment.failed and enrichment.no_data_found. There is no events array and no per-event filtering — see Webhooks for the payloads.

Placeholder hosts are rejected with 422 invalid_webhook_url. That includes example.com, your-domain.com, localhost and 127.0.0.1 — so don’t paste the literal example from a tutorial. Use a webhook.site URL to test.

curl -X POST "https://api.bouncewatch.com/api/v1/account/webhook" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"webhook_url": "https://webhook.site/YOUR-ID"}'

const response = await fetch('https://api.bouncewatch.com/api/v1/account/webhook', {
  method: 'POST',
  headers: {
    'X-API-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({ webhook_url: 'https://webhook.site/YOUR-ID' })
});

response = requests.post(
    'https://api.bouncewatch.com/api/v1/account/webhook',
    headers={
        'X-API-Key': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    },
    json={'webhook_url': 'https://webhook.site/YOUR-ID'}
)

$ch = curl_init('https://api.bouncewatch.com/api/v1/account/webhook');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: YOUR_API_KEY',
    'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode([
    'webhook_url' => 'https://webhook.site/YOUR-ID'
]));
$response = curl_exec($ch);
$data = json_decode($response, true);

Response

{
  "success": true,
  "message": "Webhook URL updated successfully",
  "data": {
    "webhook_url": "https://webhook.site/YOUR-ID"
  }
}

Your signing secret is not returned here. It is generated once with your account and shown in the API Panel → Webhooks page, where you can also rotate it.

Webhook Setup Guide

Learn how to handle and verify webhook events →

Getting Started

Core Concepts

AI Agents (MCP)

API Reference

API Playground

Overview

Endpoints

Get Account Info

Response

Get Credit Balance

Response

Get Usage Statistics

Response

Get Request History

Response

Set Your Webhook URL

Response

Webhook Setup Guide

​Overview

​Endpoints

​Get Account Info

​Response

​Get Credit Balance

​Response

​Get Usage Statistics

​Response

​Get Request History

​Response

​Set Your Webhook URL

​Response

Webhook Setup Guide

Overview

Endpoints

Get Account Info

Response

Get Credit Balance

Response

Get Usage Statistics

Response

Get Request History

Response

Set Your Webhook URL

Response