Check remaining credits
curl --request GET \
--url https://api.govfiles.dev/v2/credits \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.govfiles.dev/v2/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.govfiles.dev/v2/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.govfiles.dev/v2/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.govfiles.dev/v2/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.govfiles.dev/v2/credits")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.govfiles.dev/v2/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{
"balance": 1000,
"overage_enabled": true,
"overage_amount": 10000,
"auto_topup_enabled": true,
"auto_topup_threshold_credits": 5000,
"auto_topup_target_credits": 15000
}Miscellaneous
Check remaining credits
Return the remaining API credit balance for the account tied to the API key.
GET
/
v2
/
credits
Check remaining credits
curl --request GET \
--url https://api.govfiles.dev/v2/credits \
--header 'X-API-Key: <api-key>'import requests
url = "https://api.govfiles.dev/v2/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.govfiles.dev/v2/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.govfiles.dev/v2/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.govfiles.dev/v2/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.govfiles.dev/v2/credits")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.govfiles.dev/v2/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{
"balance": 1000,
"overage_enabled": true,
"overage_amount": 10000,
"auto_topup_enabled": true,
"auto_topup_threshold_credits": 5000,
"auto_topup_target_credits": 15000
}Return the remaining API credit balance for the account tied to your API key. Checking your balance is free and never deducts credits.
Authorizations
Response
Remaining credit balance.
Remaining API credits for the account tied to this API key.
Example:
1000
Whether the account may continue using credits below zero.
How far below zero the balance may fall, or null when overage is disabled.
Example:
10000
Whether automatic credit top-ups are enabled for the account.
Balance that triggers an auto top-up, or null when auto top-up is disabled.
Example:
5000
Balance restored by an auto top-up, or null when auto top-up is disabled.
Example:
15000