Wallet REST API

Direct Access to Your Financial Data

Integrate your Wallet data with Excel, Power BI, custom applications, and automation tools using our secure REST API.

RESTful
JWT Auth
JSON
Wallet REST API
GET
https://api.budgetbakers.com
/internal/v1/get-records
Response:
{
"transactions": [
{
"id": "uuid",
"amount": 125.50,
"category": "Food",
"date": "2024-10-20"
}
]
}

Authentication

Getting Started:

    Example:

    Authorization: Bearer your_jwt_token_here

    API Endpoints

    GET
    /internal/v1/get-records

    Get Transactions

    Retrieve financial transactions with filtering and pagination support.

    Parameters:

    • min_amount - Minimum transaction amount (optional)
    • max_amount - Maximum transaction amount (optional)
    • date_from - Start date in ISO 8601 format (optional)
    • date_to - End date in ISO 8601 format (optional)
    • limit - Maximum results, default 30, max 300 (optional)
    • offset - Pagination offset, default 0 (optional)
    • sort_by - Sort fields with +/- prefix, e.g., '-record_date,+amount' (optional)

    Example Response:

    {
  "transactions": [
    {
      "id": "uuid",
      "note": "Transaction description",
      "payee": "Merchant name",
      "amount": 125.5,
      "currency": "USD",
      "record_date": "2024-10-20T14:30:00Z",
      "category": "Food & Dining",
      "record_state": "active"
    }
  ]
}
    GET
    /internal/v1/get-docs

    Get Documents

    Retrieve client documents by type (Account, Category, Budget, etc.).

    Parameters:

    • document_type - Single type, comma-separated types, or 'all' (required)
    • limit - Maximum results per type, default 30, max 200 (optional)
    • offset - Pagination offset, default 0 (optional)

    Document Types:

    Account - Bank accounts and cash accounts
    Category - Transaction categories
    Budget - Budget definitions
    StandingOrder - Recurring transactions
    Label - Transaction labels
    Goal - Savings goals
    Contact - Payee contacts
    RecordRule - Auto-categorization rules
    HashTag - Transaction hashtags
    MagicRule - Advanced automation rules

    Example Response:

    {
  "documents": [
    {
      "id": "uuid",
      "reserved_model_type": "Account",
      "data": {
        "name": "Checking Account",
        "balance": 5000
      }
    }
  ],
  "total": 5,
  "limit": 30,
  "offset": 0
}

    Integration Examples

    Excel Integration

    Use Power Query to import transactions directly into Excel for custom analysis and reporting.

    1. 1.Open Excel and go to Data > Get Data > From Web
    2. 2.Enter API URL with your query parameters
    3. 3.Add Authorization header with your JWT token
    4. 4.Transform and load data into your spreadsheet

    Power BI Dashboard

    Create real-time financial dashboards with automatic data refresh.

    1. 1.Use Web connector in Power BI
    2. 2.Configure authentication with Bearer token
    3. 3.Set up scheduled refresh
    4. 4.Build visualizations from your Wallet data

    Python Analysis

    Analyze your financial data programmatically with Python.

    import requests

headers = {'Authorization': 'Bearer YOUR_TOKEN'}
params = {
    'date_from': '2024-01-01T00:00:00Z',
    'date_to': '2024-12-31T23:59:59Z',
    'limit': 100
}

response = requests.get(
    'https://api.budgetbakers.com/internal/v1/get-records',
    headers=headers,
    params=params
)

transactions = response.json()['transactions']
for tx in transactions:
    print(f"{tx['record_date']}: {tx['payee']} - {tx['amount']} {tx['currency']}")

    Security Features

    JWT authentication with automatic expiration
    Row-Level Security - access only your own data
    HTTPS encryption for all API calls
    Rate limiting to prevent abuse
    Token revocation available in account settings

    Rate Limits

    API requests are subject to rate limiting to ensure service quality.

    100 requests per minute per user
    1000 requests per hour per user
    Response includes rate limit headers

    Ready to start building?

    Get your API token and start integrating Wallet data into your applications.

    Get StartedTry MCP Integration