Account Information

Account information related to account Id /portfolio/accounts or /portfolio/subaccounts must be called prior to this endpoint.

get/portfolio/{accountId}/meta

Request

Base URL
http://localhost:5000/v1/api
URL
http://localhost:5000/v1/api/portfolio/{accountId}/meta
Auth
none declared

Path parameters

accountIdstring required

account id

Response

An object

idstring

The account identification value

accountIdstring

The account number

accountVanstring

The accountAlias

accountTitlestring

Title of the account

displayName'accountTitle' | 'accountVan' | 'accountId'

Whichever value is not null in this priority

accountAliasstring

User customizable account alias. Refer to Configure Account Alias for details.

accountStatusnumber

When the account was opened in unix time.

currency'AUD' | 'GBP' | 'CAD' | 'CNH' | 'CZK' | 'DKK' | 'EUR' | 'HKD' | 'HUF' | 'INR' | 'ILS' | 'JPY' | 'MXN' | 'NOK' | 'NZD' | 'PLN' | 'RUB' | 'SGD' | 'SEK' | 'CHF' | 'USD'

Base currency of the account.

type'INDIVIDUAL' | 'JOINT' | 'ORG' | 'TRUST' | 'DEMO'

Account Type

tradingTypestring

UNI - Deprecated property

faclientboolean

If an account is a sub-account to a Financial Advisor.

clearingStatus'O' | 'P' | 'N' | 'A' | 'R' | 'C'

Status of the Account

O = Open
P or N = Pending
A = Abandoned
R = Rejected
C = Closed

covestorboolean

Is a Covestor Account

descstring

Formatted "accountId - accountAlias"

Example response

[
  {
    "accountId": "U12345678 for Individual Live Accounts, DU12345678 for Individual Paper Accounts"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.