Get balance

This endpoint requires authentication. Include your API key in the X-API-KEY header with every request.

GET/hoster/v1/balance

The hoster's balance in integer cents (available / pending / total). Read availableCents before enabling self-rent to avoid a 402.

Example Request
curl -X GET "https://api.proxied.com/hoster/v1/balance" \
  -H "X-API-KEY: <api-key>"

Response Body

  • success
    boolean

    Always true on a successful response.

  • data
    object

    The hoster's balance, in integer cents.

    • availableCents
      number

      Spendable now, in integer cents: the spending balance plus cleared earnings. Can be negative after a refund claw-back or a staff debit.

    • pendingCents
      number

      Sale earnings still inside their 30-day hold, in integer cents; not spendable yet.

    • totalCents
      number

      availableCents plus pendingCents, in integer cents.

200 Response
{
  "success": true,
  "data": {
    "availableCents": 1250,
    "pendingCents": 4000,
    "totalCents": 5250
  }
}

Error Responses

Error shape
{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "readable message"
  }
}
StatusCodeDescription
401
MISSING_API_KEYMissing API key.
403
INVALID_API_KEYInvalid key or suspended account.
403
HOSTER_BANNEDInvalid key or suspended account.
500
INTERNAL_ERRORInternal error.