Skip to main content
GET
Get account by address

Authorizations

X-API-KEY
string
header
required

Authorization method required to allow user to access the api endpoints.

Path Parameters

id
string
required

Response

200 - application/json
id
string
required

Stable account id. Matches account_id on workspace balance responses for joins.

Example:

"bje5mmbqxjvwjaf7oxwpyxntxdyspzZyt4vwennw5rug"

name
string
required
Example:

"Treasury wallet"

type
enum<string>
required
Available options:
eoa,
multisig,
contract,
custodian,
exchange,
bank,
defi
Example:

"eoa"

provider
string
required
Example:

"ledger, kraken, wallet, ..."

groups
object[]
required
Example:
status
enum<string>
required
Available options:
active,
updating
Example:

"active"

balances
object[]
required
network
string
Example:

"solana"

address
string
Example:

"BJE5MMbqXjVwjAF7oxwPYXnTXDyspzZyt4vwenNw5ruG"

balances_usd
string | null

Total USD value across all of the account balances. null when no asset has a known price.

Example:

"1234.56"

balances_updated_at
string
Example:

"2024-01-01T00:00:00.000Z"

details
object
notes
string
Example:

"Primary treasury wallet"

role
string
Example:

"Treasury"

last_synced_at
object | null

When a transaction-sync run last succeeded for this account, or null if none ever has. Always present on persisted account responses; omitted on connection-preview stubs that have never been imported. Sync is only triggered manually via POST /v2/accounts/transfers/sync (one job per account).

Example:

"2026-01-01T00:00:00.000Z"

sync_unavailable_reason
enum<string> | null

Why the most recent transaction sync failed, when the cause is permanent for this account rather than a transient error worth retrying. Classified from ops-only last_sync_error; never the raw text.

provider_region_unsupported: the provider does not serve transaction history for this account's country with the credential it was given. Always present on persisted account responses; omitted on preview stubs.

Available options:
provider_region_unsupported
Example:

"provider_region_unsupported"

sync_status
enum<string> | null

Outcome of the most recent sync run for this account, or null before the first one. failed leaves last_synced_at at the last genuinely successful run. Always present on persisted account responses; omitted on preview stubs.

Available options:
running,
succeeded,
failed
Example:

"succeeded"

Last modified on August 20, 2026