Cloud Counter API - APIVerve Documentation

API Overview

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 a free account 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

View API in Directory

Client Libaries

To get started with minimal code, most of our APIs are available through client libraries:

Get Counter Value

1 Token

Get the current value of the counter

	
#GET Request
https://api.apiverve.com/v1/counter?id=test_counter

x-api-key (required)

This is a required header on every request. Your API Key is found from within your dashboard

accept

This is an optional header. Set the value to application/json, application/xml, or application/yaml

idstring(required)

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

Sample Request

	
import requests

url = "https://api.apiverve.com/v1/counter"

querystring = {'id': 'test_counter'}

headers = {
	"x-api-key": "YOUR_API_KEY"
}

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

print(response.json())

	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Get,
	RequestUri = new Uri("https://api.apiverve.com/v1/counter?id=test_counter"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}

	
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('GET', 'https://api.apiverve.com/v1/counter?id=test_counter');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);

	
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.apiverve.com/v1/counter?id=test_counter',
  headers: {
    'x-api-key': 'YOUR_API_KEY'
  }
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});

	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/counter?id=test_counter"))
		.header("x-api-key", "YOUR_API_KEY")
		.method("GET", HttpRequest.BodyPublishers.noBody())
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/counter?id=test_counter")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()

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

Sample Response

	
{
  "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
}

	
<Root>
  <status>ok</status>
  <error />
  <data>
    <created>2024-04-26 22:09:46</created>
    <id>test_counter</id>
    <lastAction>get</lastAction>
    <lastRead>2024-09-01 09:27:53</lastRead>
    <lastUpdated>2024-04-26 22:09:46</lastUpdated>
    <numberOfDigits>1</numberOfDigits>
    <ordinal>zeroth</ordinal>
    <value>0</value>
    <words>zero</words>
  </data>
  <code>200</code>
</Root>

	
status: ok
error: 
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

Live Test API in Playground

List all your counters

1 Token

List all the counters you have created

	
#GET Request
https://api.apiverve.com/v1/counter?action=list

x-api-key (required)

This is a required header on every request. Your API Key is found from within your dashboard

accept

This is an optional header. Set the value to application/json, application/xml, or application/yaml

actionstring(required)

The action to perform on the counter (list)

Sample Request

	
import requests

url = "https://api.apiverve.com/v1/counter"

querystring = {'id': 'test_counter'}

headers = {
	"x-api-key": "YOUR_API_KEY"
}

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

print(response.json())

	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Get,
	RequestUri = new Uri("https://api.apiverve.com/v1/counter?id=test_counter"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}

	
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('GET', 'https://api.apiverve.com/v1/counter?id=test_counter');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);

	
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.apiverve.com/v1/counter?id=test_counter',
  headers: {
    'x-api-key': 'YOUR_API_KEY'
  }
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});

	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/counter?id=test_counter"))
		.header("x-api-key", "YOUR_API_KEY")
		.method("GET", HttpRequest.BodyPublishers.noBody())
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/counter?id=test_counter")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()

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

Live Test API in Playground

Increment a Counter

1 Token

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

	
#GET Request
https://api.apiverve.com/v1/counter?id=test_counter&action=up

x-api-key (required)

This is a required header on every request. Your API Key is found from within your dashboard

accept

This is an optional header. Set the value to application/json, application/xml, or application/yaml

idstring(required)

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

actionstring(required)

The action to perform on the counter (up, down, reset, get)

valueint

The value to increment the counter by

Sample Request

	
import requests

url = "https://api.apiverve.com/v1/counter"

querystring = {'id': 'test_counter'}

headers = {
	"x-api-key": "YOUR_API_KEY"
}

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

print(response.json())

	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Get,
	RequestUri = new Uri("https://api.apiverve.com/v1/counter?id=test_counter"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}

	
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('GET', 'https://api.apiverve.com/v1/counter?id=test_counter');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);

	
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.apiverve.com/v1/counter?id=test_counter',
  headers: {
    'x-api-key': 'YOUR_API_KEY'
  }
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});

	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/counter?id=test_counter"))
		.header("x-api-key", "YOUR_API_KEY")
		.method("GET", HttpRequest.BodyPublishers.noBody())
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/counter?id=test_counter")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()

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

Live Test API in Playground

Decrement a Counter

1 Token

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

	
#GET Request
https://api.apiverve.com/v1/counter?id=test_counter&action=down

x-api-key (required)

This is a required header on every request. Your API Key is found from within your dashboard

accept

This is an optional header. Set the value to application/json, application/xml, or application/yaml

idstring(required)

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

actionstring(required)

The action to perform on the counter (up, down, reset, get)

valueint

The amount to decrement the counter by

Sample Request

	
import requests

url = "https://api.apiverve.com/v1/counter"

querystring = {'id': 'test_counter'}

headers = {
	"x-api-key": "YOUR_API_KEY"
}

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

print(response.json())

	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Get,
	RequestUri = new Uri("https://api.apiverve.com/v1/counter?id=test_counter"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}

	
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('GET', 'https://api.apiverve.com/v1/counter?id=test_counter');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);

	
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.apiverve.com/v1/counter?id=test_counter',
  headers: {
    'x-api-key': 'YOUR_API_KEY'
  }
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});

	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/counter?id=test_counter"))
		.header("x-api-key", "YOUR_API_KEY")
		.method("GET", HttpRequest.BodyPublishers.noBody())
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/counter?id=test_counter")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()

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

Live Test API in Playground

Set a Counter Value

1 Token

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

	
#GET Request
https://api.apiverve.com/v1/counter?id=test_counter&action=set&value=25

x-api-key (required)

This is a required header on every request. Your API Key is found from within your dashboard

accept

This is an optional header. Set the value to application/json, application/xml, or application/yaml

idstring(required)

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

valueint(required)

The value to set the counter to (between 0 and 100000000)

Sample Request

	
import requests

url = "https://api.apiverve.com/v1/counter"

querystring = {'id': 'test_counter'}

headers = {
	"x-api-key": "YOUR_API_KEY"
}

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

print(response.json())

	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Get,
	RequestUri = new Uri("https://api.apiverve.com/v1/counter?id=test_counter"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}

	
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('GET', 'https://api.apiverve.com/v1/counter?id=test_counter');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);

	
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.apiverve.com/v1/counter?id=test_counter',
  headers: {
    'x-api-key': 'YOUR_API_KEY'
  }
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});

	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/counter?id=test_counter"))
		.header("x-api-key", "YOUR_API_KEY")
		.method("GET", HttpRequest.BodyPublishers.noBody())
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/counter?id=test_counter")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()

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

Live Test API in Playground

Delete a Counter

1 Token

Delete the counter

	
#GET Request
https://api.apiverve.com/v1/counter?id=test_counter&action=delete

x-api-key (required)

This is a required header on every request. Your API Key is found from within your dashboard

accept

This is an optional header. Set the value to application/json, application/xml, or application/yaml

idstring(required)

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

actionstring(required)

The action to perform on the counter (delete)

Sample Request

	
import requests

url = "https://api.apiverve.com/v1/counter"

querystring = {'id': 'test_counter'}

headers = {
	"x-api-key": "YOUR_API_KEY"
}

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

print(response.json())

	
using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
	Method = HttpMethod.Get,
	RequestUri = new Uri("https://api.apiverve.com/v1/counter?id=test_counter"),
	Headers =
	{
		{ "x-api-key", "YOUR_API_KEY" }
	},
};
using (var response = await client.SendAsync(request))
{
	response.EnsureSuccessStatusCode();
	var body = await response.Content.ReadAsStringAsync();
	Console.WriteLine(body);
}

	
const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open('GET', 'https://api.apiverve.com/v1/counter?id=test_counter');
xhr.setRequestHeader('x-api-key', 'YOUR_API_KEY');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Accept', 'application/json');

xhr.send(data);

	
const request = require('request');

const options = {
  method: 'GET',
  url: 'https://api.apiverve.com/v1/counter?id=test_counter',
  headers: {
    'x-api-key': 'YOUR_API_KEY'
  }
};

request(options, function (error, response, body) {
	if (error) throw new Error(error);

	console.log(body);
});

	
HttpRequest request = HttpRequest.newBuilder()
		.uri(URI.create("https://api.apiverve.com/v1/counter?id=test_counter"))
		.header("x-api-key", "YOUR_API_KEY")
		.method("GET", HttpRequest.BodyPublishers.noBody())
		.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

	
import Foundation

let headers = [
	"x-api-key": "YOUR_API_KEY"
]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.apiverve.com/v1/counter?id=test_counter")! as URL,
				cachePolicy: .useProtocolCachePolicy,
                timeoutInterval: 10.0)

request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
	if (error != nil) {
		print(error as Any)
	} else {
		let httpResponse = response as? HTTPURLResponse
		print(httpResponse)
	}
})

dataTask.resume()

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

Live Test API in Playground

Response 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

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": "tokens have been depleted",
    "code": 429
}

Each subscription has its own monthly token limit. Your token count is based on your subscription plan. If you reach 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 detailed 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.

Error Codes

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.

Cloud Counter API Reference

API Overview

Client Libaries

Get Counter Value

Request Headers

Request Parameters

Sample Request

Sample Response

List all your counters

Request Headers

Request Parameters

Sample Request

Increment a Counter

Request Headers

Request Parameters

Sample Request

Decrement a Counter

Request Headers

Request Parameters

Sample Request

Set a Counter Value

Request Headers

Request Parameters

Sample Request

Delete a Counter

Request Headers

Request Parameters

Sample Request

Response Types

Authentication

Rate Limits

Error Codes

ON THIS PAGE