User Statistics

Overview

The User Statistics endpoint returns current subscription usage information for the authenticated API account. Use it to monitor:

How many unique companies you have requested during the current subscription period
Your maximum allowed company request limit (if applicable)
When your subscription expires

This is useful for quota management and integration health monitoring.

All requests require authentication. Include your access token in the Authorization header:

Authorization: Bearer <access-token>

The statistics returned are scoped to the user identified by the access token.

If authentication fails, the endpoint returns HTTP 401 Unauthorized.

Example request:

GET /v2/user-statistics
Authorization: Bearer <access-token>

No request body or query parameters are required.

Returns a GetUserStatisticsResponse JSON body.

Example response:

{
  "UserName": "your-username",
  "SubscriptionEndOn": "2026-12-31T23:59:59Z",
  "NoRequestedCompanies": 1523,
  "MaxRequestedCompanies": 10000
}

Returned with an empty body when the authenticated user account cannot be found in the system.

Returned with an empty body when authentication fails.

Field	Type	Condition	Description
`UserName`	`string`	Omitted when null	The authenticated API account username.
`SubscriptionEndOn`	`datetime`	Omitted when null	UTC date and time when the current subscription period ends (ISO 8601).
`NoRequestedCompanies`	`integer`	Always	Number of unique companies requested during the current subscription period.
`MaxRequestedCompanies`	`integer`	Omitted when null	Maximum number of unique companies allowed per subscription period. `null` means no limit is enforced.

Understanding company request limits:

Each unique company accessed via search or detail endpoints counts toward NoRequestedCompanies.
When MaxRequestedCompanies is set and NoRequestedCompanies reaches the limit, further company data requests may be restricted.
When MaxRequestedCompanies is null, your subscription has unlimited company requests.