Check User Usage

Returns the remaining data credits for users with an allocated allowance.

📘

Price:

Querying this endpoint does not cost any credits.

Endpoint URL:
https://api.similarweb.com/user-capabilities?api_key={{similarweb_api_key}}

Replace {{similarweb_api_key}} with your actual API key.

Parameters:

api_key: Your unique Similarweb API key. Enter it without the {{ }} brackets.

Example Request:

curl --location -g 'https://api.similarweb.com/user-capabilities?api_key={{similarweb_api_key}}'

Example Response:

The response provides a JSON object detailing the current data credit allowance and remaining credits.
Here's an example:

{
  "allowance": 10000,
  "user_remaining": 4989
}