buzzabout docs
API referenceEndpoints

Prices

GET /v1/prices — your account's price in US dollars for each of the four public categories.

GET /v1/prices returns the price in US dollars for one result in each of the four public categories, at the rate that applies to the calling account. Authenticated with your API key like every other public route.

Replaces GET /v1/credit_prices

GET /v1/credit_prices has been removed. buzzabout no longer bills in credits — your account holds a balance in US dollars and every chargeable call debits dollars. There is no deprecation window and no dual-serve: switch to GET /v1/prices and read dollars. See Pricing.

Pricing

Free — this endpoint costs nothing. See Pricing for the model behind the numbers it returns.

Endpoint

GET
/v1/prices

Authorization

ApiKeyAuth
x-api-key<token>

Buzzabout API key, beginning with bz_live_ (or bz_test_ for staging-only keys).

In: header

Response Body

application/json

curl -X GET "https://example.com/v1/prices"
{
  "status": "info",
  "data": {
    "currency": "usd",
    "prices": {
      "audience_profile": 0.021,
      "mention": 0.007,
      "post_processing": 0.0035,
      "preview_generation": 0.007
    },
    "rate": 0.007
  }
}

Why this exists

So your agent or dashboard can ground cost reasoning in live prices without scraping the docs — and, now that prices are per-account, so you never have to guess which rate you are on. The shape is flat and stable; new categories ship as additive fields.

{
  "status": "success",
  "data": {
    "currency": "usd",
    "rate": 0.007,
    "prices": {
      "mention": 0.007,
      "audience_profile": 0.021,
      "post_processing": 0.0035,
      "preview_generation": 0.007
    }
  }
}

Prices depend on your plan

Every action has a fixed unit ratio that is the same for everybody — one collected mention is 1 unit, an audience profile is 3 units, a processed post is 0.5 units. What differs per account is the rate: the dollars one unit costs on your plan. A higher plan buys a cheaper unit.

price for a category  =  units × your rate

rate is your account's dollars-per-unit, and each entry under prices is that rate already multiplied out for you. The example above is an account on a 0.007 rate, so a mention (1 unit) is $0.007 and a processed post (0.5 units) is $0.0035.

Read the exact value — do not round

Prices are small numbers and are returned exactly. 0.0035 rounded to two decimals is $0.00, which makes cost reasoning impossible. Keep the full value through your arithmetic and round only at the point of display.

Categories

preview_generation is the per-source price for a research preview; url previews refund sources that returned no data.

mention covers both dataset runs and tracking-agent re-scrapes — they are priced identically and presented to public clients as a single category.

Pricing model context

See Pricing for which endpoints charge which category, and which categories are reservation-based.

Next steps

On this page