Cloud Counter API Documentation


# Use this endpoint to make a GET requests to the API
https://api.apiverve.com/v1/counter

Counter is a simple tool for incrementing, decrementing, and resetting a cloud counter. It returns the current value of the counter.

To use this API, you need an API key. You can get one by creating an account on apiverve.com and visiting your dashboard.

Important: Ensure that this API is enabled from within your dashboard to use it in your application. If not, you may receive a 403 error

Most of our APIs are also available on and


{
  "status": "ok",
  "error": null,
  "data": {
    "created": "2024-04-26 22:09:46",
    "id": "test_counter",
    "lastAction": "get",
    "lastRead": "2024-09-01 09:27:53",
    "lastUpdated": "2024-04-26 22:09:46",
    "numberOfDigits": 1,
    "ordinal": "zeroth",
    "value": 0,
    "words": "zero"
  },
  "code": 200
}

Get Counter Value

Token Usage: 1

Get the current value of the counter

QUERY PARAMETERS

Field	Type	Description
id	string	`(Required)` The ID of the counter (e.g., test_counter)

SAMPLE REQUEST QUERY


curl --request GET \
--url 'https://api.apiverve.com/v1/counter?id=test_counter' \
--header 'x-api-key: YOUR_API_KEY'

List all your counters

Token Usage: 1

List all the counters you have created

QUERY PARAMETERS

Field	Type	Description
action	string	`(Required)` The action to perform on the counter (list)

SAMPLE REQUEST QUERY


curl --request GET \
--url 'https://api.apiverve.com/v1/counter?action=list' \
--header 'x-api-key: YOUR_API_KEY'

Increment a Counter

Token Usage: 1

Increment the counter (Default is 1 if value is not specified)

QUERY PARAMETERS

Field	Type	Description
id	string	`(Required)` The ID of the counter (e.g., test_counter)
action	string	`(Required)` The action to perform on the counter (up, down, reset, get)
value	int	The value to increment the counter by

SAMPLE REQUEST QUERY


curl --request GET \
--url 'https://api.apiverve.com/v1/counter?id=test_counter&action=up' \
--header 'x-api-key: YOUR_API_KEY'

Decrement a Counter

Token Usage: 1

Decrement the counter (Default is 1 if value is not specified)

QUERY PARAMETERS

Field	Type	Description
id	string	`(Required)` The ID of the counter (e.g., test_counter)
action	string	`(Required)` The action to perform on the counter (up, down, reset, get)
value	int	The amount to decrement the counter by

SAMPLE REQUEST QUERY


curl --request GET \
--url 'https://api.apiverve.com/v1/counter?id=test_counter&action=down' \
--header 'x-api-key: YOUR_API_KEY'

Set a Counter Value

Token Usage: 1

Set the counter to a specific value. (Setting 0 will reset the counter)

QUERY PARAMETERS

Field	Type	Description
id	string	`(Required)` The ID of the counter (e.g., test_counter)
value	int	`(Required)` The value to set the counter to (between 0 and 100000000)

SAMPLE REQUEST QUERY


curl --request GET \
--url 'https://api.apiverve.com/v1/counter?id=test_counter&action=set&value=25' \
--header 'x-api-key: YOUR_API_KEY'

Delete a Counter

Token Usage: 1

Delete the counter

QUERY PARAMETERS

Field	Type	Description
id	string	`(Required)` The ID of the counter (e.g., test_counter)
action	string	`(Required)` The action to perform on the counter (delete)

SAMPLE REQUEST QUERY


curl --request GET \
--url 'https://api.apiverve.com/v1/counter?id=test_counter&action=delete' \
--header 'x-api-key: YOUR_API_KEY'

RESPONSE CONTENT TYPES

The Cloud Counter API supports the following response content types:

application/json, application/xml, application/yaml

You can specify the response content type by setting the Accept header in your request. If you don't specify a content type, the API will default to application/json.

Authentication


# Here is a curl example
curl \
-X GET https://api.apiverve.com/v1/counter \
-H 'x-api-key={{YOUR-API-KEY}}' \
-F 'auth=true' \

The Cloud Counter API uses an API Key to authenticate requests. You can view and manage your API key by visiting your dashboard.

Your API keys carry many privileges. To keep them from being abused, please do not share the keys on client-side code or Github etc. Keep them very secure.

To use any API, you must have it enabled from within your dashboard. Disabled APIs will fail to respond to your requests.

All requests made to the API must contain the header x-api-key in each of your requests. API requests without authentication will fail.

All API requests must also be made over secure HTTPS. Requests made over plain HTTP will fail.

Error Code	Meaning
401	Your request was made with invalid credentials. This error also appears when you don't pass the `x-api-key` header in your request.
403	Typically, this occurs when you are trying to access an API that you have not enabled.

Rate Limits


{
    "status": "error",
    "data": null,
    "error": "Rate limit exceeded. Please upgrade your subscription plan."
}

Each subscription has its own rate limit. Your limit is based on your subscription plan (free or paid). If you exceed your limits, don't worry. You can always upgrade or downgrade at any time.

When you reach your limit, the service will stop responding and typically return an HTTP 429 response status code. The error will also contain a details JSON.

The Cloud Counter API uses the following error code:

Error Code	Meaning
429	You have exceeded your rate limit and further requests will be denied until the next cycle.

Errors

For reference, the Cloud Counter API uses the following error codes:

Error Code	Meaning
Code	Message
200	The request was successful. The response will include the requested data.
400	The request was invalid. The response will include a message that explains the error.
401	The request was not authorized. Usually, this means that the API key is missing or invalid.
403	This means that the request was trying to access a resource that it does not have permission to access.
404	This means that the resource you are trying to access does not exist.
429	This means that you have reached the rate limit. The response will include a Retry-After header that indicates how many seconds you need to wait before making a new request.
500	This means that there was an error on the server side. We are alerted when this happens and we will work to fix it as soon as possible.