Skip to main content
GET
Get IP2Company API usage
See IP2Company credits and reporting. Request outcomes and consumed credits are separate; historical charges remain recorded.

Authorizations

X-API-Key
string
header
required

Organization API key (sk_...). Get yours from Settings > API Keys in the dashboard.

Query Parameters

from
string

Inclusive UTC day; defaults to 30 days before to.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-11-01"

to
string

Exclusive UTC day; defaults to tomorrow. Maximum range 31 days.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-11-13"

apiKeyId
string<uuid>

Optional organization API-key ID filter. Never a key secret.

Example:

"11111111-1111-4111-8111-111111111111"

Response

Request outcomes and independent IP2Company credit balance.

organizationId
string<uuid>
required
from
string<date-time>
required
to
string<date-time>
required
timezone
enum<string>
required
Available options:
UTC
totals
object
required
byKey
object[]
required
credits
object
required