API reference / Tax

Tax balances

Fetches the user's current balances: the NOK balance, and the balance of each bitcoin account.

View Markdown

GET https://api.bb.no/v1/tax/balance

Authentication

API key

Send x-bb-api-key. No nonce or signature is required.

OAuth

Send an access token in Authorization: Bearer.

Required scopes:

api:accounts:bitcoin:read

Authentication guide →

Parameters

includeDeletedquery · boolean

Include accounts that have previously been deleted. Useful for resolving the name of an account referenced by an older transaction.

Responses

200 · OK

application/json

GetTaxBalanceResponse

Show fields

balanceNokstring

Stringified decimal number: the user's NOK balance.

Example: "12500.5"

bitcoinAccountsarray of TaxAccountBalance

Items:

TaxAccountBalance

Show fields

idstring

Example: "acc_01HQZX3V9KJ4M2P8R6T0W5Y7BC"

namestring

Example: "Sparekonto"

balanceBtcstring

Stringified decimal number with 8 decimal places: the BTC balance of the account.

Example: "1.89975850"

deleteTimestring · date-time

When this account was deleted. Empty if the account is not deleted. Only ever set when the request asked for deleted accounts.

Example: "2025-11-14T09:03:11Z"

Request example

GET/v1/tax/balanceAPI key

curl -X GET \
  https://api.bb.no/v1/tax/balance \
  -H "x-bb-api-key: $BB_API_KEY"

GET/v1/tax/balanceOAuth

curl -X GET \
  https://api.bb.no/v1/tax/balance \
  -H "Authorization: Bearer $BB_TOKEN"

Replace example identifiers and set credentials in environment variables before running.

Response example

Response200

{
  "balanceNok": "12500.5",
  "bitcoinAccounts": [
    {
      "id": "acc_01HQZX3V9KJ4M2P8R6T0W5Y7BC",
      "name": "Sparekonto",
      "balanceBtc": "1.89975850",
      "deleteTime": "2025-11-14T09:03:11Z"
    }
  ]
}