{"items":[{"type":"link","fsPath":"index.md","metadata":{"type":"markdown"},"label":"Bare Bitcoin public API","link":"/","routeSlug":"/","relativePathFromDirectory":"index.md"},{"type":"group","label":"api","items":[{"type":"link","label":"Bare Bitcoin API","link":"/api/openapi","routeSlug":"/api/openapi"},{"type":"group","label":"BitcoinTransferService","link":"/api/openapi/bitcointransferservice","routeSlug":"/api/openapi/bitcointransferservice","items":[{"label":"Fetch bitcoin deposit destinations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/bitcointransferservice/bitcointransferservice_depositdestinations","routeSlug":"/api/openapi/bitcointransferservice/bitcointransferservice_depositdestinations","metadata":{"seo":{"title":"Fetch bitcoin deposit destinations","description":"Fetches bitcoin deposit destinations. These destinations are always valid, and can be used for receiving arbitrary amounts. Onchain addresses are refreshed every time a deposit is made, but all prior generated addresses are still valid."}},"httpPath":"/v1/deposit-destinations/bitcoin"},{"label":"Create a new Lightning invoice","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/bitcointransferservice/bitcointransferservice_newlightninginvoice","routeSlug":"/api/openapi/bitcointransferservice/bitcointransferservice_newlightninginvoice","metadata":{"seo":{"title":"Create a new Lightning invoice","description":"Creates a new BOLT11 Lightning invoice. Lightning invoices are requests to receive a specific amount of bitcoin within a set amount of time. If you don't a specific amount, consider using the destinations returned from /v1/deposit-destinations/bitcoin."}},"httpPath":"/v1/deposit-destinations/bitcoin/invoice"},{"label":"Fetch a Lightning invoice","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/bitcointransferservice/bitcointransferservice_getlightninginvoice","routeSlug":"/api/openapi/bitcointransferservice/bitcointransferservice_getlightninginvoice","metadata":{"seo":{"title":"Fetch a Lightning invoice","description":"Fetches a Lightning invoice."}},"httpPath":"/v1/deposit-destinations/bitcoin/invoice/{id}"},{"label":"Initiate withdrawal","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/bitcointransferservice/bitcointransferservice_sendbitcoin","routeSlug":"/api/openapi/bitcointransferservice/bitcointransferservice_sendbitcoin","metadata":{"seo":{"title":"Initiate withdrawal","description":"Initiates a bitcoin withdrawal. The transaction is not completed until it is confirmed by the network it is sent onto. A success response from this endpoint means the transaction was successfully initiated, but does not guarantee completion."}},"httpPath":"/v1/withdrawals/bitcoin"},{"label":"Fetch withdrawal","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/bitcointransferservice/bitcointransferservice_getbitcoinwithdrawal","routeSlug":"/api/openapi/bitcointransferservice/bitcointransferservice_getbitcoinwithdrawal","metadata":{"seo":{"title":"Fetch withdrawal","description":"Fetches a bitcoin withdrawal."}},"httpPath":"/v1/withdrawals/bitcoin/{withdrawalId}"}]},{"type":"group","label":"PublicService","link":"/api/openapi/publicservice","routeSlug":"/api/openapi/publicservice","items":[{"label":"Fetch BTCNOK","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/publicservice/publicservice_price","routeSlug":"/api/openapi/publicservice/publicservice_price","metadata":{"seo":{"title":"Fetch BTCNOK","description":"Fetches the current BTCNOK price."}},"httpPath":"/v1/price/nok"},{"label":"Fetch volume statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/publicservice/publicservice_volume","routeSlug":"/api/openapi/publicservice/publicservice_volume","metadata":{"seo":{"title":"Fetch volume statistics","description":"Returns statistics about the volume of BTCNOK trades."}},"httpPath":"/v1/volume"},{"label":"Fetch historic volume statistics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/publicservice/publicservice_volumehistoric","routeSlug":"/api/openapi/publicservice/publicservice_volumehistoric","metadata":{"seo":{"title":"Fetch historic volume statistics","description":"Fetch historic volume statistics"}},"httpPath":"/v1/volume/historic"}]},{"type":"group","label":"TaxService","link":"/api/openapi/taxservice","routeSlug":"/api/openapi/taxservice","items":[{"label":"Fetch balances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/taxservice/taxservice_gettaxbalance","routeSlug":"/api/openapi/taxservice/taxservice_gettaxbalance","metadata":{"seo":{"title":"Fetch balances","description":"Fetches the user's current balances: the NOK balance, and the balance of each bitcoin account."}},"httpPath":"/v1/tax/balance"},{"label":"List tax transactions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/taxservice/taxservice_listtaxtransactions","routeSlug":"/api/openapi/taxservice/taxservice_listtaxtransactions","metadata":{"seo":{"title":"List tax transactions","description":"Lists tax-relevant transactions done by the user within the Bare Bitcoin platform. Note that this does NOT include any of the third party transactions imported into the platform tax calculator."}},"httpPath":"/v1/tax/transactions"}]},{"type":"group","label":"TradingService","link":"/api/openapi/tradingservice","routeSlug":"/api/openapi/tradingservice","items":[{"label":"Fetch open orders","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/tradingservice/tradingservice_openorders","routeSlug":"/api/openapi/tradingservice/tradingservice_openorders","metadata":{"seo":{"title":"Fetch open orders","description":"Fetches all open orders for the user. Open orders are orders that are not yet filled, and can be cancelled."}},"httpPath":"/v1/orders"},{"label":"Place a new order","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/tradingservice/tradingservice_neworder","routeSlug":"/api/openapi/tradingservice/tradingservice_neworder","metadata":{"seo":{"title":"Place a new order","description":"Places a new order. If the endpoint returns with a 200 status, the order is successfully placed. If you're creating a market order, a trade is also created, and its ID is included in the response."}},"httpPath":"/v1/orders"},{"label":"Cancel an order","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/tradingservice/tradingservice_cancelorder","routeSlug":"/api/openapi/tradingservice/tradingservice_cancelorder","metadata":{"seo":{"title":"Cancel an order","description":"Cancel a pending order. If the order is already filled, an error will be returned. It is not possible to cancel market orders."}},"httpPath":"/v1/orders/{orderId}"}]},{"type":"group","label":"UserService","link":"/api/openapi/userservice","routeSlug":"/api/openapi/userservice","items":[{"label":"Revoke consent for a specific OAuth2 application","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/userservice/userservice_revokeconsent","routeSlug":"/api/openapi/userservice/userservice_revokeconsent","metadata":{"seo":{"title":"Revoke consent for a specific OAuth2 application","description":"This endpoint can be called with any valid OAuth2-obtained token"}},"httpPath":"/v1/user/applications/consent/{clientId}"},{"label":"Fetch bitcoin accounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/userservice/userservice_listbitcoinaccounts","routeSlug":"/api/openapi/userservice/userservice_listbitcoinaccounts","metadata":{"seo":{"title":"Fetch bitcoin accounts","description":"Lists the bitcoin accounts for the user. Each bitcoin account has a separate balance. Every bitcoin transaction (withdrawal, deposit, trade, bonus payout) affects the balance of exactly one bitcoin account."}},"httpPath":"/v1/user/bitcoin-accounts"},{"label":"Fetch user fiat information","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/api/openapi/userservice/userservice_getfiataccount","routeSlug":"/api/openapi/userservice/userservice_getfiataccount","metadata":{"seo":{"title":"Fetch user fiat information","description":"Fetches the fiat account. The fiat account for a user holds their NOK balance. Every user has exactly one fiat account. Other sub-accounts for a user only pertains to bitcoin holdings."}},"httpPath":"/v1/user/fiat-account"}]}]},{"type":"link","fsPath":"oauth.md","metadata":{"type":"markdown"},"label":"OAuth2","link":"/oauth","routeSlug":"/oauth","relativePathFromDirectory":"oauth.md"}]}