Documentation

Balance

GET /api/v1/balance: available credit and the per-report prices this account pays.

API reference

Base URL: https://api.roofquery.com. Authenticate with Authorization: Bearer <your key> — except the four file routes, which take no key.

Copies this whole page as Markdown, so you can paste it into an assistant and have it write the integration. Nothing secret goes on the clipboard — your keys aren't included.

GET /api/v1/balance

One balance funds every RoofQuery product, which is why this sits outside /reports. Read live from Stripe, so credit added by hand in the Stripe dashboard shows up immediately. Spend that hasn't finished settling is already subtracted — available is what you can order against right now.

Also reachable at /api/v1/reports/balance, with an identical response, for integrations that found it there first.

curl -H "Authorization: Bearer rq_live_sk_..." \
  "https://api.roofquery.com/api/v1/balance"
{
  "available": 247,
  "currency": "usd",
  "setupRequired": false,
  "prices": {
    "reports": { "residential": 13, "commercial": 35 }
  },
  "residentialReportsRemaining": 19
}

residentialReportsRemaining is a convenience quoted at the residential rate. A commercial report costs more, so treat it as an upper bound. setupRequired: true means no card and no balance yet — see BILLING_SETUP_REQUIRED under Errors.