Skip to content
Bkper
app.header.homeapp.header.docs

Overview

Bkper REST API (v5)

RESTful API for managing financial books, accounts, transactions, and balances in Bkper.

Base URL

https://api.bkper.app

All endpoints are under /v5/. For example:

  • GET https://api.bkper.app/v5/user — Get the authenticated user
  • GET https://api.bkper.app/v5/books — List books
  • GET https://api.bkper.app/v5/books/{bookId} — Get a specific book

Authentication

All requests require a Google OAuth2 access token with the email scope, sent as a Bearer token:

Authorization: Bearer <access_token>

Getting a token

The easiest way to authenticate is through the Bkper CLI, which manages the OAuth flow for you:

npm i -g bkper
bkper auth login  # Opens browser for Google sign-in
bkper book list   # You're connected

For programmatic access, use a client library that handles token management:

  • Node.js — bkper-js with the CLI’s getOAuthToken() for local scripts, or with @bkper/web-auth for browser apps
  • Google Apps Script — bkper-gs library, which uses Apps Script’s built-in OAuth

You can also set up your own OAuth2 client credentials in a Google Cloud project if you need full control over the authentication flow.

API Key (optional)

For dedicated quota and project-level usage tracking, you can pass an API key via the key query parameter. API keys are for quota management only — they do not replace OAuth2 authentication.

OpenAPI Specification

The machine-readable spec is available at https://bkper.com/docs/api/rest/openapi.json. Use it with Swagger UI, Postman, or any OpenAPI-compatible tool.

  • OpenAPI version: 2.0