GET /api/adbalance

Request	`GET /api/adbalance`
Authentication	Session cookie required
Handler	`backend/adbalance.py`

What it does

The balance in minor units and formatted, the ledger rows behind it, and the pending top-ups not yet confirmed. When payments are not configured on this machine the response says so, because a top-up control must not render as if it works.

Authentication

Session cookie required. Send the ff_session cookie. Without one the engine treats the caller as a new visitor with no holds and no claims, and returns a new cookie to use from then on.

Parameters

Parameter	In	Type	Required	Description
`ff_session`	cookie	`string`	Optional	The session identifier. Omit it on the first call and store the value the response sets; every later call must send the same one or the engine treats the caller as a new visitor with no holds and no claims.

Request

The cookie jar carries the session between calls. Angle-bracketed values are the parameter types from the table above.

cURLJavaScriptPython

curl -s -b cookies.txt -c cookies.txt \
  "https://flowfinds.ai/api/adbalance"

const res = await fetch("https://flowfinds.ai/api/adbalance", {
  method: "GET",
  credentials: "include",
});
const data = await res.json();

import requests

s = requests.Session()
r = s.get("https://flowfinds.ai/api/adbalance")
data = r.json()

Recorded example

curl -s -b cookies.txt -c cookies.txt \
  "$FLOWFINDS_ORIGIN/api/adbalance"

Responses

`200` — Always.

Field	Type	Description
`account`	`boolean`	Whether a subject account was resolved.
`balance_minor`	`integer`	The balance in the currency's minor units.
`currency`	`string`	The ledger currency.
`balance`	`string`	The balance formatted for display.
`ledger`	`array`	The rows behind the balance.
`pending`	`array`	Top-ups started but not yet confirmed with the provider.

Errors

This endpoint has no failure path of its own. An uncaught exception anywhere in the engine is still returned as structured JSON by the shared guard.

GET /api/ad — The ad artifact for the session's product, with its pass criteria.
POST /api/ad/edit — Override the ad copy, or reset it to the generated version.
POST /api/growth/edit — Edit a growth artifact in natural language.
GET /api/ads-manager — The campaign book.
POST /api/ads-manager — Save the campaign book.
POST /api/adbalance — Start a balance top-up.
GET /api/adbalance/confirm — Retired. Balance confirmation is no longer client-driven.
POST /api/organic/research — Research an organic campaign for named platforms.

Back to the API reference index, or read the cookbook for recipes that compose this endpoint with others.