plaid2.model.holdings_override module

class plaid2.model.holdings_override.HoldingsOverride(*, institution_price_as_of: Optional[str] = None, cost_basis: Optional[float] = None, security: SecurityOverride, currency: str, quantity: float, institution_price: float)[source]

Bases: BaseModel

cost_basis: Optional[float]

The average original value of the holding. Multiple cost basis values for the same security purchased at different prices are not supported.

currency: str

Either a valid iso_currency_code or unofficial_currency_code

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]

//wikipedia.org/wiki/ISO_8601) date.

Type

The date at which institution_price was current. Must be formatted as an [ISO 8601](https

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) HoldingsOverride[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) HoldingsOverride[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.

security: SecurityOverride

Specify the security associated with the holding or investment transaction. When inputting custom security data to the Sandbox, Plaid will perform post-data-retrieval normalization and enrichment. These processes may cause the data returned by the Sandbox to be slightly different from the data you input. An ISO-4217 currency code and a security identifier (ticker_symbol, cusip, isin, or sedol) are required.