Current Plan Usage (Unlimited Plans)
Check your unlimited plan’s consumption: single searches used against the monthly cap, bulk searches used against the daily limit, and when each resets.
curl --request GET \
--url https://api.orbisearch.com/v1/unlimited/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.orbisearch.com/v1/unlimited/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.orbisearch.com/v1/unlimited/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.orbisearch.com/v1/unlimited/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.orbisearch.com/v1/unlimited/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.orbisearch.com/v1/unlimited/usage")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbisearch.com/v1/unlimited/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{
"single_monthly_cap": 100000,
"single_used": 4211,
"single_remaining": 95789,
"single_rps": 10,
"bulk_searches_per_day": 10000,
"bulk_searches_used_today": 2500,
"bulk_searches_reset_at": "2026-07-29T00:00:00Z",
"current_period_start": "2026-07-01T00:00:00Z",
"current_period_end": "2026-08-01T00:00:00Z"
}{
"detail": "API key required in X-API-Key header"
}{
"detail": "No active subscription. This key resumes working when the subscription is reinstated.",
"code": "subscription_inactive"
}{
"detail": "This endpoint requires an unlimited API key. Pay-as-you-go keys use the credit-metered /v1 endpoints.",
"code": "wrong_key_plan"
}{
"detail": "Rate limit exceeded. Maximum 20 requests per second per account. Contact us to discuss higher limits.",
"code": "rate_limited"
}| Meter | Fields | Resets |
|---|---|---|
| Monthly single search cap | single_monthly_cap, single_used, single_remaining | At the end of the current billing period (current_period_end) |
| Daily bulk search limit | bulk_searches_per_day, bulk_searches_used_today | At the next UTC midnight (bulk_searches_reset_at) |
single_rps (your plan’s per-account requests-per-second limit for single searches) and the billing period bounds (current_period_start, current_period_end). All timestamps are ISO 8601 in UTC.
Calling this endpoint is free: it consumes neither the monthly cap nor the daily search limit. It does share the per-account request-rate window with the rest of the API, so avoid polling it in a tight loop.
The daily bulk search meter is per account, so its numbers include dashboard bulk finder jobs run on your plan, not just API submissions.
Requires an Unlimited API key with an active subscription; the same 402 subscription_inactive and 403 wrong_key_plan rules apply as on the other unlimited endpoints.Authorizations
API key for authentication
Response
Successful Response
Current-period consumption for an unlimited plan (/v1/unlimited/usage).
Plan's single search requests per billing period.
Single search requests consumed this billing period.
Requests remaining before the monthly cap (never negative).
Plan's single search requests-per-second limit (per account).
Plan's daily bulk search limit (per account, UTC day).
Bulk searches consumed in the current daily window.
When the daily bulk search limit resets (next UTC midnight).
Start of the current billing period (cap window).
End of the current billing period, when the cap resets.
curl --request GET \
--url https://api.orbisearch.com/v1/unlimited/usage \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.orbisearch.com/v1/unlimited/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.orbisearch.com/v1/unlimited/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.orbisearch.com/v1/unlimited/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.orbisearch.com/v1/unlimited/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.orbisearch.com/v1/unlimited/usage")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orbisearch.com/v1/unlimited/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{
"single_monthly_cap": 100000,
"single_used": 4211,
"single_remaining": 95789,
"single_rps": 10,
"bulk_searches_per_day": 10000,
"bulk_searches_used_today": 2500,
"bulk_searches_reset_at": "2026-07-29T00:00:00Z",
"current_period_start": "2026-07-01T00:00:00Z",
"current_period_end": "2026-08-01T00:00:00Z"
}{
"detail": "API key required in X-API-Key header"
}{
"detail": "No active subscription. This key resumes working when the subscription is reinstated.",
"code": "subscription_inactive"
}{
"detail": "This endpoint requires an unlimited API key. Pay-as-you-go keys use the credit-metered /v1 endpoints.",
"code": "wrong_key_plan"
}{
"detail": "Rate limit exceeded. Maximum 20 requests per second per account. Contact us to discuss higher limits.",
"code": "rate_limited"
}