Cloud CounterCloud Counter API

OnlineCredit Usage:1 per callRefreshed 1 month ago
avg: 1022ms|p50: 930ms|p75: 1083ms|p90: 1267ms|p99: 1635ms

Overview

To use Cloud Counter, you need an API key. You can get one by creating a free account and visiting your dashboard.

GET Endpoint

URL
https://api.apiverve.com/v1/counter

Example

How to call the Cloud Counter API in different programming languages.

cURL Request
curl -X GET \
  "https://api.apiverve.com/v1/counter?id=test_counter" \
  -H "X-API-Key: your_api_key_here"
JavaScript (Fetch API)
const response = await fetch('https://api.apiverve.com/v1/counter?id=test_counter', {
  method: 'GET',
  headers: {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
  }
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here',
    'Content-Type': 'application/json'
}

response = requests.get('https://api.apiverve.com/v1/counter?id=test_counter', headers=headers)

data = response.json()
print(data)
Go (net/http)
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")
    req.Header.Set("Content-Type", "application/json")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    body, _ := io.ReadAll(resp.Body)
    fmt.Println(string(body))
}
Example Response
{
  "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
  }
}

Authentication

The Cloud Counter API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Learn more about authentication →

Interactive API Playground

Test the Cloud Counter API directly in your browser with live requests and responses.

Parameters

The Cloud Counter API supports multiple query options. Use one of the following:

Some Cloud Counter parameters marked with Premium are available exclusively on paid plans.View pricing

Option 1: Get Counter Value

ParameterTypeRequiredDescriptionDefaultExample
idstringrequired
The ID of the counter (e.g., test_counter)
-test_counter

Option 2: List all your counters

ParameterTypeRequiredDescriptionDefaultExample
actionstringrequired
The action to perform
-list

Option 3: Increment a Counter

ParameterTypeRequiredDescriptionDefaultExample
idstringrequired
The ID of the counter (e.g., test_counter)
-test_counter
actionstringrequired
The action to perform
-up
valuePremiumintegeroptional
The value to increment the counter by
11

Option 4: Decrement a Counter

ParameterTypeRequiredDescriptionDefaultExample
idstringrequired
The ID of the counter (e.g., test_counter)
-test_counter
actionstringrequired
The action to perform
-down
valuePremiumintegeroptional
The amount to decrement the counter by
11

Option 5: Set a Counter Value

ParameterTypeRequiredDescriptionDefaultExample
idstringrequired
The ID of the counter (e.g., test_counter)
-test_counter
valueintegerrequired
The value to set the counter to
-25

Option 6: Delete a Counter

ParameterTypeRequiredDescriptionDefaultExample
idstringrequired
The ID of the counter (e.g., test_counter)
-test_counter
actionstringrequired
The action to perform
-delete

Response

The Cloud Counter API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <created>2024-04-26T22:09:46.000Z</created>
    <id>test_counter</id>
    <lastAction>get</lastAction>
    <lastRead>2025-12-16T22:21:45.000Z</lastRead>
    <lastUpdated>2024-04-26T22:09:46.000Z</lastUpdated>
    <numberOfDigits>1</numberOfDigits>
    <ordinal>zeroth</ordinal>
    <value>0</value>
    <words>zero</words>
    <isEven>true</isEven>
    <isNegative>false</isNegative>
    <isZero>true</isZero>
    <isPrime>false</isPrime>
  </data>
</response>
YAML Response
200 OK
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
CSV Response
200 OK
keyvalue
created2024-04-26T22:09:46.000Z
idtest_counter
lastActionget
lastRead2025-12-16T22:21:45.000Z
lastUpdated2024-04-26T22:09:46.000Z
numberOfDigits1
ordinalzeroth
value0
wordszero
isEventrue
isNegativefalse
isZerotrue
isPrimefalse

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Learn more about response formats →

Response Data Fields

When the request is successful, the data object contains the following fields:

FieldTypeSample ValueDescription
createdstring"2024-04-26T22:09:46.000Z"
-
idstring"test_counter"
-
lastActionstring"get"
-
lastReadstring"2025-12-16T22:21:45.000Z"
-
lastUpdatedstring"2024-04-26T22:09:46.000Z"
-
numberOfDigitsnumber1
-
ordinalstring"zeroth"
-
valuenumber0
-
wordsstring"zero"
-
isEvenbooleantrue
Whether the counter value is even
isNegativebooleanfalse
Whether the counter value is negative
isZerobooleantrue
Whether the counter value is zero
isPrimebooleanfalse
Whether the counter value is a prime number

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

GraphQL AccessALPHA

Access Cloud Counter through GraphQL to combine it with other API calls in a single request. Query only the cloud counter data you need with precise field selection, and orchestrate complex data fetching workflows.

Test Cloud Counter in the GraphQL Explorer to confirm availability and experiment with queries.

Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.

GraphQL Endpoint
POST https://api.apiverve.com/v1/graphql
GraphQL Query Example
query {
  counter(
    input: {
      id: "test_counter"
    }
  ) {
    created
    id
    lastAction
    lastRead
    lastUpdated
    numberOfDigits
    ordinal
    value
    words
    isEven
    isNegative
    isZero
    isPrime
  }
}

Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.

CORS Support

The Cloud Counter API accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Cloud Counter requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Cloud Counter API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Cloud Counter

Official Cloud Counter packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

No-Code Integrations

Cloud Counter works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Frequently Asked Questions

How do I get an API key for Cloud Counter?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The same key works for Cloud Counter and all other APIVerve APIs. The free plan includes 1,000 credits plus a 500 credit bonus.
How many credits does Cloud Counter cost?

Each successful Cloud Counter API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful cloud counter lookups.

Can I use Cloud Counter in production?

The free plan is for testing and development only. For production use of Cloud Counter, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use Cloud Counter from a browser?
Yes! The Cloud Counter API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my Cloud Counter credit limit?

When you reach your monthly credit limit, Cloud Counter API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?