Skip to main content

Accounts

Table of Contents

Description

Financial meaning

Accounts represent storage locations for financial assets or cash. They define where securities, cash, or other financial holdings are kept, ensuring legal ownership, custody, and safekeeping.

Platform abstraction

An Account in the Finmars platform defines a place where assets or cash are held. It carries properties like type, name, and purpose (e.g., depository, provisional account).
Accounts are essential for linking transactions, managing cash, tracking positions, and generating reports.

Accounts are used in:

  • Connecting holdings to the correct location

  • Verifying asset values across accounts

  • Supporting regulatory and internal reporting

Examples

User Code Type  Short Name Name Public Name Notes
129900RGLDPQ3DT2T5H1 Default Account Type SCVA Securities Vault Alpha SECALPHAZZXXX Depository for Securities

  • User code: a unique identifier of the account within the system.

  • Type: classification of the account (e.g., default, provisional, etc.).

  • Short name: a brief label for quick reference of the account.

  • Name: the full name of the account for user clarity.

  • Public name: the name displayed externally or used in reporting.

  • Notes: additional information about the purpose or specifics of the account.

Cookbook

CRUD

Operations within platform.

Use Cases

What for it's used.

F.A.Q.

API documentation

Back to top