API Documentation & Support

Quick Start

Get up and running with the WealthGuard API in under 5 minutes. All requests require authentication via API key.

Base URL: https://api.wealthguard.com/v2

Sandbox Environment

All requests in this documentation default to the sandbox environment. Use your test API keys to experiment without affecting live data.

h3>1. Obtain Your API Key

Log in to your WealthGuard Developer Dashboard and navigate to Settings → API Keys. Generate a new secret key and store it securely. Never expose keys in client-side code.

2. Make Your First Request

Include your API key in the Authorization header. Here's a simple GET request to fetch account balances:

cURL

curl -X GET "https://api.wealthguard.com/v2/accounts" \
  -H "Authorization: Bearer sk_test_51Mz..." \
  -H "Content-Type: application/json"

3. Parse the Response

JSON Response

{
  "status": "success",
  "data": {
    "total_accounts": 3,
    "accounts": [
      {
        "id": "acc_8f7k2m9p",
        "name": "Primary Checking",
        "balance": 12450.50,
        "currency": "USD",
        "type": "checking"
      }
    ]
  },
  "meta": {
    "request_id": "req_9x8c7v6b",
    "rate_limit_remaining": 997
  }
}

Authentication

WealthGuard uses Bearer token authentication. All API requests must include your secret key in the Authorization header. Keys are scoped to specific environments and have configurable permissions.

Security Notice

Never embed API keys in frontend code, public repositories, or client-side JavaScript. Always use server-to-server authentication or secure environment variables.

Header Format

// Always use Bearer prefix
Authorization: Bearer sk_live_your_secret_key_here

API Endpoints

Our API follows RESTful conventions and returns JSON responses. All endpoints are versioned and support pagination, filtering, and field selection.

GET /accounts

List all linked accounts

Returns a paginated list of financial accounts linked to the authenticated user. Supports filtering by account type, institution, and status.

Parameter	Type	Description
`limit`	integer	Max results per page (default: 20, max: 100)
`type`	string	Filter by account type: checking, savings, credit, investment
`status`	string	active, pending, error, closed

POST /accounts

Link new account

Initiates the secure account linking flow using Plaid/Finicity integration. Returns a session token for frontend authentication.

GET /transactions

Retrieve transaction history

Fetches categorized transactions with merchant data, amounts, dates, and reconciliation status.

Parameter	Type	Description
`account_id`	string	Filter by specific account
`date_from`	string	ISO 8601 start date Required
`date_to`	string	ISO 8601 end date Required
`category`	string	Filter by ML-predicted category

PUT /transactions/{id}

Update transaction metadata

Modify category, notes, or budget allocation for a specific transaction. Useful for user corrections and custom tagging.

GET /portfolios/overview

Get portfolio summary

Returns aggregated net worth, asset allocation breakdown, performance metrics, and risk scoring.

Rate Limits & Pricing

Request Limits

Free Tier1,000 / hour

Pro Tier10,000 / hour

EnterpriseCustom / unthrottled

Webhook Delivery99.9% SLA

Response Headers

X-RateLimit-Limit10000

X-RateLimit-Remaining8432

X-RateLimit-Reset1698765432

X-Request-Idreq_9x8c7v6b

429 Too Many Requests

When rate limited, the API returns HTTP 429 with a Retry-After header. Implement exponential backoff to avoid service disruption.

Error Codes

400 Bad Request

Invalid parameters, malformed JSON, or missing required fields. Check request schema.

401 Unauthorized

Missing or invalid API key. Verify token scope and environment match.

403 Forbidden

Key lacks required permissions or account is suspended. Contact support.

404 Not Found

Resource ID doesn't exist or access restricted. Verify IDs and ownership.

422 Unprocessable

Business logic validation failed (e.g., insufficient funds, invalid date range).

500 Internal Server

Unexpected platform error. Includes error_id in response for tracking.

Official SDKs

Accelerate development with our officially maintained client libraries. All SDKs include automatic retries, pagination helpers, and type definitions.

Installation

# Python
pip install wealthguard

# Node.js
npm install @wealthguard/js

# Java (Maven)
com.wealthguard
wealthguard-java
2.4.1

Developer Support

Documentation

Comprehensive guides, interactive playground, and migration tutorials.

Read Docs

GitHub & Issues

Report bugs, request features, and browse community examples.

Open Issue

Technical Support

Direct email support for Pro & Enterprise developers. Avg response: 4hrs.

API Status & Uptime

Real-time system status: All Systems Operational. Historical uptime: 99.98% (Last 30 days)

Integrate with the Financial Intelligence API