Skip to content

Hookestdocs Postman OpenAPI llms.txt

GET/v1/wallet0 credits

Get wallet

Current monthly and top-up balances. monthly_period_end is when the monthly bucket resets.

Request parameters

No query, path, or JSON body parameters.

Response

{
  "object": "wallet",
  "monthly_balance": 180,
  "monthly_period_end": "2026-10-01T00:00:00.000Z",
  "topup_balance": 40
}

Response fields

Name	Type	Required	Description
`object`	string	Required	Always `wallet`.
`monthly_balance`	integer	Required	Credits in the monthly bucket. Spend hits this first.
`monthly_period_end`	string	Nullable	When the monthly bucket resets. ISO-8601, or `null`.
`topup_balance`	integer	Required	Credits in the top-up bucket.

hookest — zsh

curl https://api.hookest.com/v1/wallet \
  -H "Authorization: Bearer hk_live_YOUR_KEY"

const res = await fetch("https://api.hookest.com/v1/wallet", {
  headers: {
    Authorization: "Bearer hk_live_YOUR_KEY",
  },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api.hookest.com/v1/wallet",
    headers={"Authorization": "Bearer hk_live_YOUR_KEY"},
)
data = res.json()

$ch = curl_init("https://api.hookest.com/v1/wallet");
curl_setopt_array($ch, [
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer hk_live_YOUR_KEY",
  ],
]);
$data = json_decode(curl_exec($ch), true);

package main

import (
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.hookest.com/v1/wallet", nil)
  req.Header.Set("Authorization", "Bearer hk_live_YOUR_KEY")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
}