Sign in

v1

latestOpenAPI 3.1.02026-07-13143194365.4 KB
account

Retrieve account metadata and cached balances

Get a snapshot of the authenticated account, including:

  • account_id: Grove account ID bound to the JWT.
  • tipping_address: The Grove-managed custodial wallet address (for sending tips).
  • earning_address: The user's canonical earning wallet (ERC-4337 Smart Account).
  • smart_account_address: Alias of the canonical earning Smart Account address.
  • network: The VM type for this account (e.g., "base-sepolia" for EVM).
  • metadata: Arbitrary key/value metadata (currently unvalidated).
  • balances: Cached balances across networks/tokens (no provider refresh).
  • referral_code: This account's shareable referral code (e.g., "GRV-ABC123").
  • referred_by_account_id: Account ID of who referred this user (if any).
  • referral_count: Number of accounts this user has referred.

Authentication: Authorization: Bearer <CLIENT_JWT>

Notes:

  • Balances are returned from the database cache by default.
  • Pass resync=true to trigger a background balance resync from on-chain.
  • Metadata structure is TBD; today it is returned as-is.
get/v1/account

Query parameters

resyncboolean

Force a fresh balance sync from on-chain. Use for onramp flows where balances may have changed externally.

Force a fresh balance sync from on-chain. Use for onramp flows where balances may have changed externally.

Headers

authorizationstring nullable

Bearer JWT issued by Grove that identifies the account.

Bearer JWT issued by Grove that identifies the account.

Response

Successful Response

account_idstring required
tipping_addressstring required
earning_addressstring nullable
eoa_owner_addressstring nullable
smart_account_addressstring nullable

ERC-4337 Smart Account address (the earning wallet)

external_linked_walletsstring[]

External linked wallet addresses (profile references, non-earning)

networkstring required
metadataobject nullable
handlestring nullable
referral_codestring required
referred_by_account_idstring nullable
referral_countinteger
onchain_addressstring required
embedded_wallet_addressstring nullable required
client_addressstring nullable required
earnings_addressstring nullable required