Accounts

Accounts represent financial containers such as checking accounts, credit cards, brokerage accounts, loans, real estate, manual assets, and imported records.

Endpoints

Method	Path	Scope
`GET`	`/v1/accounts`	`accounts:read`
`GET`	`/v1/accounts/{accountId}`	`accounts:read`

List accounts

Use GET /v1/accounts to list accounts visible to the current API key.

Query parameters

Parameter	Description
`status`	Filter by account status.
`category`	Filter by account category, such as investment or credit.
`sourceType`	Filter by `PROVIDER`, `MANUAL`, or `IMPORT`.
`supportsTransactions`	Filter accounts that can return transactions.
`supportsHoldings`	Filter accounts that can return holdings.
`pageSize`	Number of records to return, up to 100.
`pageToken`	Cursor from the previous page.

Request

curl "https://api.tablewealth.com/v1/accounts?category=investment&pageSize=25" \
  -H "X-API-Key: $TABLEWEALTH_API_KEY"

const url = new URL('https://api.tablewealth.com/v1/accounts');
url.searchParams.set('category', 'investment');
url.searchParams.set('pageSize', '25');

const response = await fetch(url, {
  headers: {
    'X-API-Key': process.env.TABLEWEALTH_API_KEY!
  }
});

const body = await response.json();

import os
import requests

response = requests.get(
    "https://api.tablewealth.com/v1/accounts",
    headers={"X-API-Key": os.environ["TABLEWEALTH_API_KEY"]},
    params={"category": "investment", "pageSize": 25},
    timeout=30,
)
response.raise_for_status()
body = response.json()

Response fields

Key fields include id, sourceType, provider, status, category, name, institutionName, balances, supportsTransactions, and supportsHoldings.

Get account

Use GET /v1/accounts/{accountId} for details about one accessible account.

Request

curl "https://api.tablewealth.com/v1/accounts/acct_123" \
  -H "X-API-Key: $TABLEWEALTH_API_KEY"

const accountId = 'acct_123';
const response = await fetch(
  `https://api.tablewealth.com/v1/accounts/${accountId}`,
  {
    headers: {
      'X-API-Key': process.env.TABLEWEALTH_API_KEY!
    }
  }
);

const body = await response.json();

import os
import requests

account_id = "acct_123"
response = requests.get(
    f"https://api.tablewealth.com/v1/accounts/{account_id}",
    headers={"X-API-Key": os.environ["TABLEWEALTH_API_KEY"]},
    timeout=30,
)
response.raise_for_status()
body = response.json()

Response fields

Key fields include id, connectionId, name, officialName, institutionId, connectionStatus, ownershipPercentage, and createdAt.

Data semantics

All ids are Tablewealth ids unless a field is explicitly named external or provider.
sourceType can be PROVIDER, MANUAL, or IMPORT.
provider is only present for provider-backed records.

On this page