Skip to main content
GET
/
v1
/
usage
Your current monthly usage and tier limits.
curl --request GET \
  --url https://api.keplerinsights.us/v1/usage \
  --header 'X-API-Key: <api-key>'
import requests

url = "https://api.keplerinsights.us/v1/usage"

headers = {"X-API-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.keplerinsights.us/v1/usage', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.keplerinsights.us/v1/usage",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.keplerinsights.us/v1/usage"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.keplerinsights.us/v1/usage")
  .header("X-API-Key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.keplerinsights.us/v1/usage")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "mode": "<string>",
  "user_id": "<string>",
  "period": "2026-05",
  "tier": "<string>",
  "total_calls": 123,
  "cold_calls": 123,
  "cached_calls": 123,
  "last_reset": "2023-11-07T05:31:56Z",
  "next_reset": "2023-11-07T05:31:56Z",
  "tier_limits": {
    "cached_calls_included": 123,
    "cold_calls_included": 123,
    "freshness_window_hours": 123
  }
}
{
  "error": "unauthorized",
  "message": "<string>",
  "reason": "<string>"
}
A read of where you stand against your tier’s quota for the current calendar month. Does not increment any counter — checking your balance shouldn’t move it.

​
When to use it

  • Render a dashboard with “X / 250 cold calls used this month”.
  • Detect a runaway script before it hits the per-account 24h circuit breaker.
  • Confirm an overage rate or freshness window without paginating any docs.

​
Response

{
  "user_id": "uuid-of-your-account",
  "period": "2026-05",
  "tier": "growth",
  "total_calls":   1042,
  "cold_calls":      38,
  "cached_calls": 1004,
  "last_reset": "2026-05-01T00:00:00Z",
  "next_reset": "2026-06-01T00:00:00Z",
  "tier_limits": {
    "cached_calls_included":  5000,
    "cold_calls_included":     250,
    "freshness_window_hours":    6
  }
}

​
Counter semantics

  • total_calls = cached_calls + cold_calls. Both meters count.
  • cold_calls is what bills against your tier’s included monthly budget. When this reaches tier_limits.cold_calls_included, further POST /v1/score calls that would trigger a cold run return 429 cold_budget_exhausted until the next monthly reset.
  • null in tier_limits means unmetered (Enterprise / admin).
  • No overage counter in v1.0. Metered overage is on the v1.5 roadmap; when it ships, an additional counter will appear here for accounts that opt in.

​
Zero-state

If you haven’t made any calls yet this period (or it’s the first of the month and counters just reset), every counter reads 0 and last_reset reads the current period’s start. There’s no 404 for “never called the API” — we treat that as zero state.

​
Counter reset

Counters reset on the first of the month at 00:00 UTC. Reset is lazy — the first call after the rollover sets last_reset to the new period start and zeroes the per-period meters. Historical periods are retained 14 months for billing reconciliation but are not exposed via this endpoint.

​
Why no increment

Stripe’s /v1/subscription doesn’t bill you for reading your subscription state. Same principle. Calling /v1/usage is free — go nuts.

Authorizations

​
X-API-Key
string
header
required

Live keys are prefixed ki_live_, test keys ki_test_. Issue + revoke keys at https://console.keplerinsights.us. Never embed a key in client-side code — every endpoint is backend-to-API only.

Response

Usage state.

​
mode
string
​
user_id
string
​
period
string
Example:

"2026-05"

​
tier
string
​
total_calls
integer
​
cold_calls
integer
​
cached_calls
integer
​
last_reset
string<date-time>
​
next_reset
string<date-time>
​
tier_limits
object