Overview
Counter works by incrementing, decrementing, and resetting a cloud counter. It uses advanced algorithms to ensure the counter is updated accurately and returns the current value of the counter.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl "https://api.apiverve.com/v1/counter?id=test_counter" \
-H "x-api-key: your_api_key_here"const res = await fetch('https://api.apiverve.com/v1/counter?id=test_counter', {
headers: { 'x-api-key': 'your_api_key_here' },
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.get(
"https://api.apiverve.com/v1/counter?id=test_counter",
headers={"x-api-key": "your_api_key_here"},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/counter?id=test_counter", nil)
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent in the query string. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
idRequired | string | The ID of the counter (e.g., test_counter) |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"created": "2024-04-26T22:09:46.000Z",
"id": "test_counter",
"lastAction": "get",
"lastRead": "2025-12-16T22:21:45.000Z",
"lastUpdated": "2024-04-26T22:09:46.000Z",
"numberOfDigits": 1,
"ordinal": "zeroth",
"value": 0,
"words": "zero",
"isEven": true,
"isNegative": false,
"isZero": true,
"isPrime": false
}
}
Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
created | string | "2024-04-26T22:09:46.000Z" | ISO timestamp of when the counter was first created |
id | string | "test_counter" | The identifier of the counter |
lastAction | string | "get" | The most recent action performed on the counter (e.g., get, up, down, set) |
lastRead | string | "2025-12-16T22:21:45.000Z" | ISO timestamp of when the counter was most recently queried |
lastUpdated | string | "2024-04-26T22:09:46.000Z" | ISO timestamp of when the counter's value was last changed |
numberOfDigits | number | 1 | The number of digits in the counter's current value, not counting a negative sign |
ordinal | string | "zeroth" | The counter's current value spelled out as an ordinal word (e.g., "zeroth") |
value | number | 0 | The counter's current numeric value |
words | string | "zero" | The counter's current value spelled out in words (e.g., "zero") |
isEven | boolean | true | Whether the counter value is even |
isNegative | boolean | false | Whether the counter value is negative |
isZero | boolean | true | Whether the counter value is zero |
isPrime | boolean | false | Whether the counter value is a prime number |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Article View Counts
- Increment a page tally each time a reader loads a blog post, returning the fresh total without querying a local database.
- Feature Usage Quotas
- To enforce monthly limits, SaaS backends increase a user action counter and check whether the total crosses allowed thresholds.
- Live Score Tracking
- Gaming servers adjust player points up or down during matches while fetching parity and formatted word representations.
- Inventory Stock Adjustments
- When shoppers complete checkout, decrement item tallies and inspect the remaining balance without maintaining dedicated database tables.
Other ways to use Cloud Counter
Set up Cloud Counter on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in Data Processing: