{ "openapi": "3.0.3", "info": { "title": "Bare Bitcoin API", "description": "API for interacting with Bare Bitcoin. Most endpoints require authentication. Create API keys [here](https://barebitcoin.no/innlogget/profil/nokler). Read about API authentication [here](https://dev.barebitcoin.no/#authentication).", "contact": { "url": "https://barebitcoin.no", "email": "barebitcoin@bb.no" }, "version": "0.0.1" }, "servers": [ { "url": "https://api.bb.no", "description": "Prod environment" } ], "paths": { "/v1/deposit-destinations/bitcoin": { "get": { "tags": [ "BitcoinTransferService" ], "summary": "Fetch bitcoin deposit destinations", "description": "Fetches bitcoin deposit destinations. These destinations are always valid,\n and can be used for receiving arbitrary amounts. Onchain addresses are refreshed\n every time a deposit is made, but all prior generated addresses are still valid.", "operationId": "BitcoinTransferService_DepositDestinations", "parameters": [ { "name": "accountId", "in": "query", "description": "If empty, the default account is used.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepositDestinationsResponse" } } } } } } }, "/v1/deposit-destinations/bitcoin/invoice": { "post": { "tags": [ "BitcoinTransferService" ], "summary": "Create a new Lightning invoice", "description": "Creates a new BOLT11 Lightning invoice. Lightning invoices are requests to receive a specific\n amount of bitcoin within a set amount of time. If you don't a specific amount, consider\n using the destinations returned from /v1/deposit-destinations/bitcoin.", "operationId": "BitcoinTransferService_NewLightningInvoice", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLightningInvoiceRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewLightningInvoiceResponse" } } } } }, "security": [ { "apiKey": [], "apiHmac": [], "apiNonce": [] } ] } }, "/v1/deposit-destinations/bitcoin/invoice/{id}": { "get": { "tags": [ "BitcoinTransferService" ], "summary": "Fetch a Lightning invoice", "description": "Fetches a Lightning invoice.", "operationId": "BitcoinTransferService_GetLightningInvoice", "parameters": [ { "name": "id", "in": "path", "description": "Can be:\n 1. Deposit destination ID. Prefix: `ded_`.\n 2. The Lightning invoice itself.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetLightningInvoiceResponse" } } } } } } }, "/v1/orders": { "get": { "tags": [ "TradingService" ], "summary": "Fetch open orders", "description": "Fetches all open orders for the user. Open orders are orders that are\n not yet filled, and can be cancelled.", "operationId": "TradingService_OpenOrders", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpenOrdersResponse" } } } } } }, "post": { "tags": [ "TradingService" ], "summary": "Place a new order", "description": "Places a new order. If the endpoint returns with a 200 status, the order\n is successfully placed. If you're creating a market order, a trade is\n also created, and its ID is included in the response.", "operationId": "TradingService_NewOrder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewOrderRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewOrderResponse" } } } } }, "security": [ { "apiKey": [], "apiHmac": [], "apiNonce": [] } ] } }, "/v1/orders/{orderId}": { "delete": { "tags": [ "TradingService" ], "summary": "Cancel an order", "description": "Cancel a pending order. If the order is already filled, an error will\n be returned. It is not possible to cancel market orders.", "operationId": "TradingService_CancelOrder", "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": {} } } } }, "/v1/price/nok": { "get": { "tags": [ "PublicService" ], "summary": "Fetch BTCNOK", "description": "Fetches the current BTCNOK price.", "operationId": "PublicService_Price", "parameters": [ { "name": "amount", "in": "query", "description": "Amount NOK to trade for. If empty, defaults to 5000 NOK.", "schema": { "type": "number", "format": "double" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PriceResponse" } } } } }, "security": [ {} ] } }, "/v1/tax/balance": { "get": { "tags": [ "TaxService" ], "summary": "Fetch balances", "description": "Fetches the user's current balances: the NOK balance, and the balance of\n each bitcoin account.", "operationId": "TaxService_GetTaxBalance", "parameters": [ { "name": "includeDeleted", "in": "query", "description": "Include accounts that have previously been deleted. Useful for resolving\n the name of an account referenced by an older transaction.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTaxBalanceResponse" } } } } }, "security": [ { "apiKey": [] }, { "oauth2": [ "api:accounts:bitcoin:read" ] } ] } }, "/v1/tax/transactions": { "get": { "tags": [ "TaxService" ], "summary": "List tax transactions", "description": "Lists tax-relevant transactions done by the user within the Bare Bitcoin platform.\n Note that this does NOT include any of the third party transactions imported into\n the platform tax calculator.", "operationId": "TaxService_ListTaxTransactions", "parameters": [ { "name": "pageSize", "in": "query", "description": "Items per page (max 200). When set to 0, all matching transactions are returned.", "schema": { "type": "integer", "format": "int32" } }, { "name": "after", "in": "query", "description": "Transactions are listed oldest first (required to compute running_balance_btc\n correctly), so pagination walks forward in time. Only return transactions\n created after this time. Can be used standalone to filter down to a start\n date; pass next_after from the previous response (together with\n next_after_id) to fetch the next page.", "schema": { "type": "string", "format": "date-time" } }, { "name": "afterId", "in": "query", "description": "Pagination cursor tiebreaker: when multiple transactions share the same\n create_time, this ID breaks the tie. Pass next_after_id from the previous\n response. Only meaningful together with 'after'; ignored otherwise.", "schema": { "type": "string" } }, { "name": "before", "in": "query", "description": "Only return transactions created strictly before this time. Filter only,\n does not affect pagination direction.", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTaxTransactionsResponse" } } } } }, "security": [ { "apiKey": [] }, { "oauth2": [ "api:tax:transactions:read" ] } ] } }, "/v1/user/applications/consent/{clientId}": { "delete": { "tags": [ "UserService" ], "summary": "Revoke consent for a specific OAuth2 application", "description": "This endpoint can be called with any valid OAuth2-obtained token", "operationId": "UserService_RevokeConsent", "parameters": [ { "name": "clientId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": {} } }, "security": [ { "apiKey": [] }, { "oauth2": [] } ] } }, "/v1/user/bitcoin-accounts": { "get": { "tags": [ "UserService" ], "summary": "Fetch bitcoin accounts", "description": "Lists the bitcoin accounts for the user. Each bitcoin account has a\n separate balance. Every bitcoin transaction (withdrawal, deposit, trade,\n bonus payout) affects the balance of exactly one bitcoin account.", "operationId": "UserService_ListBitcoinAccounts", "parameters": [ { "name": "includeDeleted", "in": "query", "description": "Include accounts that have previously been deleted.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBitcoinAccountsResponse" } } } } }, "security": [ { "apiKey": [] }, { "oauth2": [ "api:accounts:bitcoin:read" ] } ] } }, "/v1/user/fiat-account": { "get": { "tags": [ "UserService" ], "summary": "Fetch user fiat information", "description": "Fetches the fiat account. The fiat account for a user holds their NOK\n balance. Every user has exactly one fiat account. Other sub-accounts for a user\n only pertains to bitcoin holdings.", "operationId": "UserService_GetFiatAccount", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFiatAccountResponse" } } } } } } }, "/v1/volume": { "get": { "tags": [ "PublicService" ], "summary": "Fetch volume statistics", "description": "Returns statistics about the volume of BTCNOK trades.", "operationId": "PublicService_Volume", "parameters": [ { "name": "date", "in": "query", "description": "The date to fetch the volume for. If empty, defaults to today.\n Format: YYYY-MM-DD", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeResponse" } } } } }, "security": [ {} ] } }, "/v1/volume/historic": { "get": { "tags": [ "PublicService" ], "summary": "Fetch historic volume statistics", "operationId": "PublicService_VolumeHistoric", "parameters": [ { "name": "date", "in": "query", "description": "The date to fetch the volume for. If empty, defaults to today.\n Format: YYYY-MM-DD", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VolumeHistoricResponse" } } } } }, "security": [ {} ] } }, "/v1/withdrawals/bitcoin": { "post": { "tags": [ "BitcoinTransferService" ], "summary": "Initiate withdrawal", "description": "Initiates a bitcoin withdrawal. The transaction is not completed until\n it is confirmed by the network it is sent onto. A success response from\n this endpoint means the transaction was successfully initiated, but\n does not guarantee completion.", "operationId": "BitcoinTransferService_SendBitcoin", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendBitcoinRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendBitcoinResponse" } } } } }, "security": [ { "apiKey": [], "apiHmac": [], "apiNonce": [] } ] } }, "/v1/withdrawals/bitcoin/{withdrawalId}": { "get": { "tags": [ "BitcoinTransferService" ], "summary": "Fetch withdrawal", "description": "Fetches a bitcoin withdrawal.", "operationId": "BitcoinTransferService_GetBitcoinWithdrawal", "parameters": [ { "name": "withdrawalId", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetBitcoinWithdrawalResponse" } } } } } } } }, "components": { "schemas": { "BitcoinAccount": { "type": "object", "properties": { "id": { "type": "string" }, "availableBtc": { "type": "number", "description": "The current BTC holdings that can be used for trading or withdrawals.", "format": "double" }, "totalBtc": { "type": "number", "description": "The BTC balance of the account.", "format": "double" }, "totalNok": { "type": "number", "description": "The NOK value of the BTC of the account, at the time of the request.", "format": "double" }, "name": { "type": "string", "description": "The name of the account." }, "createTime": { "type": "string", "description": "When this account was created.", "format": "date-time" }, "deleteTime": { "type": "string", "description": "When this account was deleted.\n Empty if the account is not deleted.", "format": "date-time" } } }, "DepositDestination": { "type": "object", "properties": { "destination": { "type": "string" }, "network": { "enum": [ "NETWORK_BITCOIN", "NETWORK_LIGHTNING" ], "type": "string", "format": "enum" } } }, "DepositDestinationsResponse": { "type": "object", "properties": { "onchainAddress": { "$ref": "#/components/schemas/DepositDestination" }, "lightningAddress": { "$ref": "#/components/schemas/DepositDestination" }, "lnurlPay": { "$ref": "#/components/schemas/DepositDestination" } } }, "GetBitcoinWithdrawalResponse": { "type": "object", "properties": { "withdrawalId": { "type": "string" }, "destination": { "type": "string", "description": "The destination of the withdrawal." }, "network": { "enum": [ "NETWORK_BITCOIN", "NETWORK_LIGHTNING" ], "type": "string", "description": "The network this withdrawal was sent on.", "format": "enum" }, "amountBtc": { "type": "number", "description": "The amount of BTC that was withdrawn.", "format": "double" }, "amountNok": { "type": "number", "description": "The value of the BTC that was withdrawn, in NOK equivalent\n at time of withdrawal.", "format": "double" }, "status": { "enum": [ "WITHDRAWAL_STATUS_PENDING", "WITHDRAWAL_STATUS_COMPLETED", "WITHDRAWAL_STATUS_FAILED" ], "type": "string", "description": "The status of the withdrawal.", "format": "enum" }, "createdAt": { "type": "string", "description": "The time the withdrawal was initiated.", "format": "date-time" }, "sentAt": { "type": "string", "description": "The time the withdrawal was sent from the platform.", "format": "date-time" } } }, "GetFiatAccountResponse": { "type": "object", "properties": { "availableNok": { "type": "number", "description": "The current NOK holdings that can be used for trading or\n withdrawals.", "format": "double" } } }, "GetLightningInvoiceResponse": { "type": "object", "properties": { "depositDestinationId": { "type": "string" }, "invoice": { "type": "string" }, "status": { "enum": [ "INVOICE_STATUS_UNPAID", "INVOICE_STATUS_PENDING", "INVOICE_STATUS_PAID", "INVOICE_STATUS_EXPIRED", "INVOICE_STATUS_CANCELED" ], "type": "string", "format": "enum" } } }, "GetTaxBalanceResponse": { "type": "object", "properties": { "balanceNok": { "example": "12500.5", "type": "string", "description": "Stringified decimal number: the user's NOK balance." }, "bitcoinAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/TaxAccountBalance" } } } }, "Info": { "type": "object", "properties": { "fullName": { "type": "string", "description": "Recipient name. For an organisation this is its registered name. Required\n for a private individual; optional for an organisation, which is identified\n by the organisasjonsnummer in nin." }, "country": { "type": "string", "description": "ISO-3166-1 alpha-2 country code" }, "address": { "type": "string" }, "nin": { "type": "string", "description": "The recipient's fødselsnummer, or a 9-digit organisasjonsnummer when the\n recipient is an organisation. Only required if the TFR config said so." }, "exchange": { "type": "string" }, "selfCustody": { "type": "boolean" } } }, "ListBitcoinAccountsResponse": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "$ref": "#/components/schemas/BitcoinAccount" } }, "totalBtc": { "type": "number", "description": "The total BTC balance of all accounts.", "format": "double" }, "totalNok": { "type": "number", "description": "The total NOK value of the BTC of all accounts,\n at the time of the request.", "format": "double" } } }, "ListTaxTransactionsResponse": { "type": "object", "properties": { "transactions": { "type": "array", "items": { "$ref": "#/components/schemas/TaxTransaction" } }, "hasMore": { "type": "boolean", "description": "True if there are more transactions available after the last one returned." }, "nextAfter": { "type": "string", "description": "Cursor for the next page: pass this as 'after' in the next request.", "format": "date-time" }, "nextAfterId": { "type": "string", "description": "Tiebreaker for the cursor: pass this as 'after_id' in the next request." } } }, "NewLightningInvoiceRequest": { "type": "object", "properties": { "accountId": { "type": "string", "description": "if empty, the default account is used." }, "currency": { "enum": [ "CURRENCY_BTC", "CURRENCY_NOK" ], "type": "string", "description": "The currency the invoice is denominated in. Once created, the invoice\n is for a specific amount of bitcoin.", "format": "enum" }, "amount": { "type": "number", "description": "The amount of the invoice, in the requested currency. Setting to 0\n creates an invoice where any amount is accepted.", "format": "double" }, "publicDescription": { "type": "string", "description": "Public description of the invoice. Shown to both the creator and the\n recipient of the invoice. This is the so-called \"memo\" field of the\n Lightning invoice." }, "internalDescription": { "type": "string", "description": "Free-form text description of the invoice. Can be used to correlate with\n your own systems. Only shown to the creator of this invoice, within the\n Bare Bitcoin systems." } } }, "NewLightningInvoiceResponse": { "type": "object", "properties": { "depositDestinationId": { "type": "string" }, "invoice": { "type": "string" } } }, "NewOrderRequest": { "type": "object", "properties": { "type": { "enum": [ "ORDER_TYPE_MARKET", "ORDER_TYPE_LIMIT" ], "type": "string", "format": "enum" }, "direction": { "enum": [ "DIRECTION_BUY", "DIRECTION_SELL" ], "type": "string", "format": "enum" }, "amount": { "type": "number", "description": "Amount to spend. Must be positive. When buying, this is the amount in NOK.\n When selling, this is the amount in BTC.", "format": "double" }, "accountId": { "type": "string", "description": "The bitcoin account to use for this order. Empty for default account." }, "description": { "type": "string", "description": "Free-form text description of the order. Can be used to correlate with\n your own systems." }, "price": { "type": "number", "description": "The price to buy or sell at. Only used for limit orders.", "format": "double" } } }, "NewOrderResponse": { "type": "object", "properties": { "orderId": { "type": "string", "description": "ID of the created order." }, "tradeId": { "type": "string", "description": "If this was a market order, the order resulted in a trade. Empty if not\n market order." } } }, "OpenOrdersResponse": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/components/schemas/Order" } } } }, "Order": { "type": "object", "properties": { "orderId": { "type": "string" }, "type": { "enum": [ "ORDER_TYPE_MARKET", "ORDER_TYPE_LIMIT" ], "type": "string", "format": "enum" }, "direction": { "enum": [ "DIRECTION_BUY", "DIRECTION_SELL" ], "type": "string", "format": "enum" }, "amount": { "type": "number", "format": "double" }, "createdAt": { "type": "string", "format": "date-time" } } }, "PriceResponse": { "type": "object", "properties": { "price": { "type": "number", "description": "The mid price.", "format": "double" }, "bid": { "type": "number", "description": "Current bid price, without fees.", "format": "double" }, "ask": { "type": "number", "description": "Current ask price, without fees.", "format": "double" }, "timestamp": { "type": "string", "description": "The time the price was fetched.", "format": "date-time" }, "card": { "allOf": [ { "$ref": "#/components/schemas/UserPrice" } ], "description": "Effective price, when paying with card." }, "bank": { "allOf": [ { "$ref": "#/components/schemas/UserPrice" } ], "description": "Effective price, when paying with bank transfer." } } }, "SendBitcoinRequest": { "type": "object", "properties": { "destination": { "type": "string", "description": "The bitcoin destination to send funds to.\n Supported formats:\n - Bitcoin address (bech32, legacy-segwit, legacy)\n - Lightning invoice (bolt11)\n - Lightning address\n - Lightning LNURL" }, "amountBtc": { "type": "number", "description": "The amount to send.\n This field is required for all destinations except Lightning invoices.\n If the destination is a Lightning invoice, the amount is derived from the\n invoice.", "format": "double" }, "accountId": { "type": "string", "description": "The ID of the account to send from. If empty, the default account is used." }, "isPayment": { "type": "boolean", "description": "Marks the transaction as a payment. This has consequences for how the\n transaction is exported for tax purposes. It has no effect on the\n bitcoin transaction itself." }, "description": { "type": "string", "description": "Free-form text description of the withdrawal. Can be used to correlate with\n your own systems." }, "tfrInfo": { "allOf": [ { "$ref": "#/components/schemas/Info" } ], "description": "The recipient of this transaction, per EU's travel rule. Required for all\n withdrawals to new destinations." } } }, "SendBitcoinResponse": { "type": "object", "properties": { "withdrawalId": { "type": "string", "description": "The ID of the initiated withdrawal." }, "network": { "enum": [ "NETWORK_BITCOIN", "NETWORK_LIGHTNING" ], "type": "string", "format": "enum" }, "status": { "enum": [ "WITHDRAWAL_STATUS_PENDING", "WITHDRAWAL_STATUS_COMPLETED", "WITHDRAWAL_STATUS_FAILED" ], "type": "string", "description": "The status of the withdrawal. The withdrawal might immediately succeed,\n if sending to another user of the Bare Bitcoin platform.", "format": "enum" } } }, "TaxAccountBalance": { "type": "object", "properties": { "id": { "example": "acc_01HQZX3V9KJ4M2P8R6T0W5Y7BC", "type": "string" }, "name": { "example": "Sparekonto", "type": "string" }, "balanceBtc": { "example": "1.89975850", "type": "string", "description": "Stringified decimal number with 8 decimal places: the BTC balance of the\n account." }, "deleteTime": { "example": "2025-11-14T09:03:11Z", "type": "string", "description": "When this account was deleted. Empty if the account is not deleted. Only\n ever set when the request asked for deleted accounts.", "format": "date-time" } } }, "TaxTransaction": { "type": "object", "properties": { "id": { "example": "tr_01HVXHG9PMDKR3YQV4Z8W5T2BN", "type": "string" }, "accountId": { "example": "acc_01HQZX3V9KJ4M2P8R6T0W5Y7BC", "type": "string", "description": "The bitcoin account the transaction belongs to. Empty for fiat deposits\n and fiat withdrawals, which are not tied to an account." }, "type": { "enum": [ "TAX_TRANSACTION_TYPE_BTC_BUY", "TAX_TRANSACTION_TYPE_BTC_SELL", "TAX_TRANSACTION_TYPE_BTC_WITHDRAWAL", "TAX_TRANSACTION_TYPE_BTC_DEPOSIT", "TAX_TRANSACTION_TYPE_BTC_BONUS", "TAX_TRANSACTION_TYPE_FIAT_DEPOSIT", "TAX_TRANSACTION_TYPE_FIAT_WITHDRAWAL" ], "type": "string", "format": "enum" }, "subType": { "example": "market", "enum": [ "", "market", "limit", "manual", "onchain", "lightning", "internal", "lightning-payment-request", "lightning-address", "bank", "card" ], "type": "string", "description": "Sub-type of the transaction. Which values apply depends on the type:\n trades carry the order type, bitcoin transfers the network, fiat deposits\n the payment method. Empty when the transaction has no sub-type." }, "createTime": { "example": "2024-02-01T10:22:36Z", "type": "string", "format": "date-time" }, "finalizeTime": { "example": "2024-02-01T10:41:05Z", "type": "string", "description": "Unset while the transaction is still pending, e.g. a bitcoin deposit\n that is not yet confirmed.", "format": "date-time" }, "inAmount": { "example": "0.1", "type": "string", "description": "Stringified decimal number" }, "inCurrency": { "example": "BTC", "type": "string" }, "outAmount": { "example": "65000", "type": "string", "description": "Stringified decimal number" }, "outCurrency": { "example": "NOK", "type": "string" }, "feeAmount": { "example": "975", "type": "string", "description": "Stringified decimal number. When the fee is zero, fee_currency may be\n empty." }, "feeCurrency": { "example": "NOK", "type": "string" }, "rateMarket": { "example": "650000", "type": "string", "description": "Stringified decimal number: the market rate in NOK per BTC at the time of\n the transaction." }, "isPayment": { "type": "boolean", "description": "Whether the transaction was a payment to a third party, as declared by\n the user. Only ever set for bitcoin withdrawals." }, "paymentInfo": { "example": "f4184fc596403b9d638783cf57adfe4c75c605f6356fbc91338530e9831e9e16:bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4", "type": "string", "description": "For bitcoin transfers: \":\". For bank\n fiat transfers: the counterparty bank account number. Empty for card\n deposits, trades and bonuses." }, "note": { "example": "Første kjøp", "type": "string", "description": "Free-form user-supplied description." }, "usdnok": { "example": "10.45", "type": "string", "description": "Stringified decimal number: the USD/NOK exchange rate at the time of the\n transaction, when known." }, "runningBalanceBtc": { "example": "1.8997585", "type": "string", "description": "Stringified decimal number: the user's total BTC balance across all\n accounts after this transaction." } } }, "UserPrice": { "type": "object", "properties": { "buy": { "type": "number", "format": "double" }, "sell": { "type": "number", "format": "double" } }, "description": "The prices a user can expect to pay for a given amount of BTCNOK,\n with a given payment method." }, "VolumeHistoricResponse": { "type": "object", "properties": { "dailyVolume": { "type": "array", "items": { "$ref": "#/components/schemas/VolumeHistoricResponse_DailyVolume" } }, "shareOfTotalVolume": { "type": "object", "additionalProperties": { "type": "number", "format": "double" }, "description": "Each market's share of the total volume for the period in question." } } }, "VolumeHistoricResponse_DailyVolume": { "type": "object", "properties": { "date": { "type": "string", "description": "YYYY-MM-DD" }, "stats": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/VolumeHistoricResponse_MarketStats" }, "description": "Each market's volume for the day." } } }, "VolumeHistoricResponse_MarketStats": { "type": "object", "properties": { "name": { "type": "string" }, "color": { "type": "string" }, "volumeNok": { "type": "number", "format": "double" }, "volumeBtc": { "type": "number", "format": "double" }, "shareOfTotalVolume": { "type": "number", "description": "Share of the total volume for the day in question.", "format": "double" } } }, "VolumeResponse": { "type": "object", "properties": { "daily": { "$ref": "#/components/schemas/VolumeStats" }, "monthly": { "$ref": "#/components/schemas/VolumeStats" }, "yearly": { "$ref": "#/components/schemas/VolumeStats" }, "last24h": { "$ref": "#/components/schemas/VolumeStats" } } }, "VolumeStats": { "type": "object", "properties": { "amountNok": { "type": "number", "format": "double" }, "amountBtc": { "type": "number", "format": "double" }, "buyPercentage": { "type": "number", "format": "double" }, "numberOfTrades": { "type": "integer", "format": "int32" } } } }, "securitySchemes": { "apiKey": { "type": "apiKey", "description": "Public part of your API key. Starts with `bb/public/`.", "name": "x-bb-api-key", "in": "header" }, "apiNonce": { "type": "apiKey", "description": "Nonce value. Used to ensure correct ordering of all API requests, as well as prevent attackers from being able to replay old requests. Can be set to any value, but needs to increase for each request. Recommendation is to use the current Unix timestamp in milliseconds.", "name": "x-bb-api-nonce", "in": "header" }, "apiHmac": { "type": "apiKey", "description": "HMAC authentication for the API request, constructed using the corresponding secret value from your API key.", "name": "x-bb-api-hmac", "in": "header" }, "oauth2": { "type": "oauth2", "description": "OAuth2 access token obtained through the authorization code flow. Only available on a subset of endpoints. The required scope is listed per operation.", "flows": { "authorizationCode": { "authorizationUrl": "https://api.bb.no/oauth2/v0/authorize", "tokenUrl": "https://api.bb.no/oauth2/v0/token", "refreshUrl": "https://api.bb.no/oauth2/v0/token", "scopes": { "api:accounts:bitcoin:read": "See balance and names of your bitcoin accounts", "api:trades:read": "See executed trades", "api:tax:transactions:read": "Read transactions relevant for tax calculation" } } } } } }, "security": [ { "apiKey": [] } ], "tags": [ { "name": "BitcoinTransferService", "description": "Transfer bitcoin in and out of the platform. Fetch information about past\n bitcoin transfers." }, { "name": "PublicService", "description": "Public endpoints that don't require authentication" }, { "name": "TaxService" }, { "name": "TradingService", "description": "Execute and cancel orders. Fetch information about past orders." }, { "name": "UserService", "description": "Fetch information the authenticated user and its bitcoin accounts." } ] }