plaid2.model.holding module

class plaid2.model.holding.Holding(*, account_id: str, institution_price_as_of: Optional[str] = None, cost_basis: Optional[float] = None, unofficial_currency_code: Optional[str] = None, security_id: str, institution_price_datetime: Optional[str] = None, quantity: float, iso_currency_code: Optional[str] = None, institution_value: float, institution_price: float)[source]

Bases: BaseModel

account_id: str: The Plaid account_id associated with the holding.

cost_basis: Optional[float]: The original total value or the purchase price per share of the holding. This field is an aggregate on a per holding basis and dependent on the information provided by the institution.

dict(**kwargs: Any) → Dict[str, Any][source]: Return a dict representation of the object. Takes same keyword arguments as pydantic.BaseModel.dict

institution_price: float: The last price given by the institution for this security.

institution_price_as_of: Optional[str]: The date at which institution_price was current.

institution_price_datetime: Optional[str]

ssZ).

This field is returned for select financial institutions and comes as provided by the institution. It may contain default time values (such as 00:00:00).

Type: Date and time at which institution_price was current, in ISO 8601 format (YYYY-MM-DDTHH
Type: mm

institution_value: float: The value of the holding, as reported by the institution.

iso_currency_code: Optional[str]: The ISO-4217 currency code of the holding. 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

classmethod parse_obj(data: Any) → Holding[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) → Holding[source]: Parse a json string into the object. Takes same keyword arguments as pydantic.BaseModel.parse_raw

quantity: float: The total quantity of the asset held, as reported by the financial institution. If the security is an option, quantity will reflect the total number of options (typically the number of contracts multiplied by 100), not the number of contracts.

security_id: str: The Plaid security_id associated with the holding.

unofficial_currency_code: Optional[str]

The unofficial currency code associated with the holding. 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.