plaid2.model.security module
- class plaid2.model.security.Security(*, cusip: Optional[str] = None, name: Optional[str] = None, institution_security_id: Optional[str] = None, type: Optional[str] = None, close_price_as_of: Optional[str] = None, unofficial_currency_code: Optional[str] = None, sedol: Optional[str] = None, institution_id: Optional[str] = None, security_id: str, ticker_symbol: Optional[str] = None, close_price: Optional[float] = None, proxy_security_id: Optional[str] = None, update_datetime: Optional[str] = None, isin: Optional[str] = None, iso_currency_code: Optional[str] = None, is_cash_equivalent: Optional[bool] = None)[source]
Bases:
BaseModel- close_price: Optional[float]
Price of the security at the close of the previous trading session. Null for non-public securities.
If the security is a foreign currency this field will be updated daily and will be priced in USD.
If the security is a cryptocurrency, this field will be updated multiple times a day. As crypto prices can fluctuate quickly and data may become stale sooner than other asset classes, please refer to update_datetime with the time when the price was last updated.
- close_price_as_of: Optional[str]
Date for which close_price is accurate. Always null if close_price is null.
- cusip: Optional[str]
9-character CUSIP, an identifier assigned to North American securities.
- dict(**kwargs: Any) Dict[str, Any][source]
Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict
- institution_id: Optional[str]
If institution_security_id is present, this field indicates the Plaid institution_id of the institution to whom the identifier belongs.
- institution_security_id: Optional[str]
An identifier given to the security by the institution
- is_cash_equivalent: Optional[bool]
Indicates that a security is a highly liquid asset and can be treated like cash.
- isin: Optional[str]
12-character ISIN, a globally unique securities identifier.
- iso_currency_code: Optional[str]
The ISO-4217 currency code of the price given. Always null if unofficial_currency_code is non-null.
- json(**kwargs: Any) str[source]
Return a json string representation of the object. Takes same keyword arguments as pydantic.BaseModel.json
- name_: Optional[str]
A descriptive name for the security, suitable for display.
- classmethod parse_obj(data: Any) Security[source]
Parse a dict into the object. Takes same keyword arguments as pydantic.BaseModel.parse_obj
- classmethod parse_raw(b: Union[bytes, str], **kwargs: Any) Security[source]
Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw
- proxy_security_id: Optional[str]
In certain cases, Plaid will provide the ID of another security whose performance resembles this security, typically when the original security has low volume, or when a private security can be modeled with a publicly traded security.
- security_id: str
A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the security_id is case sensitive.
- sedol: Optional[str]
7-character SEDOL, an identifier assigned to securities in the UK.
- ticker_symbol: Optional[str]
The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.
- type: Optional[str]
The security type of the holding. Valid security types are:
cash: Cash, currency, and money market funds
cryptocurrency: Digital or virtual currencies
derivative: Options, warrants, and other derivative instruments
equity: Domestic and foreign equities
etf: Multi-asset exchange-traded investment funds
fixed income: Bonds and certificates of deposit (CDs)
loan: Loans and loan receivables
mutual fund: Open- and closed-end vehicles pooling funds of multiple investors
other: Unknown or other investment types
- unofficial_currency_code: Optional[str]
The unofficial currency code associated with the security. Always null if iso_currency_code is non-null. Unofficial currency codes are used for currencies that do not have official ISO currency codes, such as cryptocurrencies and the currencies of certain countries.
See the [currency code schema](https://plaid.com/docs/api/accounts#currency-code-schema) for a full listing of supported `iso_currency_code`s.
- update_datetime: Optional[str]
ssZ). Always null if close_price is null.
- Type
Date and time at which close_price is accurate, in ISO 8601 format (YYYY-MM-DDTHH
- Type
mm