Check Capabilities

This endpoint provides comprehensive information about your account, including current usage and capabilities based on your subscription package.

Overview

The endpoint returns the following account details:

  • Remaining data credits at the account level
  • Total credit allowance
  • Plan information

Pricing

📊 Free to Use

There is no cost in terms of data credits for querying this endpoint. It's completely free to use as part of your account management.

Endpoint

GET /api/user/capabilities?api_key={{YOUR_SIMILARWEB_API_KEY}}

Response Format

{
  "allowance": 10000,
  "plan":"FREE",
  "remain_credits": 9937
}

Response Fields

FieldTypeDescription
allowancenumberTotal credit allowance allocated to your account
planstringYour current subscription plan (e.g., "FREE", "BASIC", "PRO")
remain_creditsnumberNumber of credits remaining in your current billing period

Example Request

curl -X GET "https://api.boxapi.com/user/capabilities" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Example Response

{
  "allowance": 10000,
  "plan":"FREE",
  "remain_credits": 9937
}

Usage Examples

JavaScript/Node.js

const response = await fetch('/api/user/capabilities', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});

const accountInfo = await response.json();
console.log(`Credits: ${accountInfo.remain_credits}/${accountInfo.allowance}`);

Python

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.boxapi.com/user/capabilities', headers=headers)
account_info = response.json()

print(f"Credits: {account_info['remain_credits']}/{account_info['allowance']}")