Credit balance

When to use this

Use it to check your balance before a batch of calls. It's free, and every other response also carries credits_remaining.

Once a day (UTC), if your balance is below 20 credits, your first call tops it up to 20. With a playground token instead of a key, credits_remaining is the free tries left today.

Example request

Copy one and replace YOUR_API_KEY with your API key (get one free). The code versions read the key from the LURKAPI_API_KEY environment variable instead.

curl "https://api.lurkapi.com/v1/account/credit-balance" \
  -H "x-api-key: YOUR_API_KEY"

const res = await fetch("https://api.lurkapi.com/v1/account/credit-balance", {
  headers: { "x-api-key": process.env.LURKAPI_API_KEY },
});
const data = await res.json();
if (!data.success) throw new Error(`${data.code}: ${data.error}`);
console.log(data);

import os
import requests

res = requests.get(
    "https://api.lurkapi.com/v1/account/credit-balance",
    headers={"x-api-key": os.environ["LURKAPI_API_KEY"]},
    timeout=60,
)
data = res.json()
if not data["success"]:
    raise RuntimeError(f"{data['code']}: {data['error']}")
print(data)

package main

import (
	"encoding/json"
	"fmt"
	"net/http"
	"os"
	"time"
)

func main() {
	req, _ := http.NewRequest("GET", "https://api.lurkapi.com/v1/account/credit-balance", nil)
	req.Header.Set("x-api-key", os.Getenv("LURKAPI_API_KEY"))

	client := &http.Client{Timeout: 60 * time.Second}
	res, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	var data map[string]any
	if err := json.NewDecoder(res.Body).Decode(&data); err != nil {
		panic(err)
	}
	if data["success"] != true {
		panic(fmt.Sprintf("%v: %v", data["code"], data["error"]))
	}
	out, _ := json.MarshalIndent(data, "", "  ")
	fmt.Println(string(out))
}

<?php
$context = stream_context_create(['http' => [
    'header' => 'x-api-key: ' . getenv('LURKAPI_API_KEY'),
    'timeout' => 60,
    'ignore_errors' => true,
]]);
$body = file_get_contents('https://api.lurkapi.com/v1/account/credit-balance', false, $context);
$data = json_decode($body, true);
if (!$data['success']) {
    throw new Exception("{$data['code']}: {$data['error']}");
}
print_r($data);

require 'json'
require 'net/http'

uri = URI('https://api.lurkapi.com/v1/account/credit-balance')
req = Net::HTTP::Get.new(uri)
req['x-api-key'] = ENV.fetch('LURKAPI_API_KEY')
res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https', read_timeout: 60) do |http|
  http.request(req)
end
data = JSON.parse(res.body)
raise "#{data['code']}: #{data['error']}" unless data['success']
puts JSON.pretty_generate(data)

Parameters

This endpoint takes no parameters.

Example response

A real response, captured from the live API. Lists are trimmed to a couple of items, and long text such as media links is cut short with ….

{
  "success": true,
  "credits_remaining": 4985,
  "credits_charged": 0,
  "daily_top_up": 25,
  "next_top_up_at": "2026-10-01T00:00:00.000Z"
}

Response fields

Every field in a successful response, and what it means.

Cost and freshness

Free to call.

Not cached. Every call fetches fresh data.

Errors

A failed call returns success: false, an error message, a code your program can check, and a docs link. These are the errors this endpoint can return. All error codes.

Use it in Claude

Connect LurkAPI to Claude and ask in plain English. This endpoint is the account_credit_balance tool. For example:

Use LurkAPI's account_credit_balance tool, then summarize what you find.

Claude calls account_credit_balance with arguments like these:

{}

To save tokens, tool results leave out empty fields, keep one URL per image or video, and give transcripts as plain text unless you pass timestamps=true. A result over 45,000 characters comes in parts. Its _note gives the offset for the next part, and later parts are free for 15 minutes. Pass trim=false for the full response.