Skip to main content
GET
/
v1
/
usage
/
credits
Get your current credit usage and remaining limit
curl --request GET \
  --url https://api.coinstats.app/v1/usage/credits \
  --header 'X-API-KEY: <api-key>'
import requests

url = "https://api.coinstats.app/v1/usage/credits"

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.coinstats.app/v1/usage/credits', 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.coinstats.app/v1/usage/credits",
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.coinstats.app/v1/usage/credits"

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.coinstats.app/v1/usage/credits")
.header("X-API-KEY", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.coinstats.app/v1/usage/credits")

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
{
  "totalCredits": 100000,
  "usedCredits": 45000,
  "remainingCredits": 55000,
  "subscription": "PRO"
}
{
"statusCode": 401,
"message": "Unauthorized",
"requestId": "11111111-2222-3333-4444-555555555555",
"path": "/usage/credits"
}
{
"statusCode": 429,
"message": "Rate limit exceeded",
"requestId": "11111111-2222-3333-4444-555555555555",
"path": "/usage/credits"
}
Check how many API credits you have remaining for the current billing period.
  • Total credits available for your subscription, including active top-ups
  • Credits already used
  • Remaining credits
  • Your current subscription plan

Authorizations

X-API-KEY
string
header
required

API key required to access the endpoints. Generate one from your dashboard at https://openapi.coinstats.app and pass it in the X-API-KEY request header. Never expose your key in client-side code.

Response

Get current credit usage and remaining limit

totalCredits
number
required

Total credit limit for the current billing period, including active top-ups

Example:

100000

usedCredits
number
required

Credits already used in the current billing period

Example:

45000

remainingCredits
number
required

Remaining credits available for the current billing period

Example:

55000

subscription
string
required

Current subscription plan name

Example:

"PRO"