pub struct Security {Show 18 fields
pub close_price: Option<f64>,
pub close_price_as_of: Option<NaiveDate>,
pub cusip: Option<String>,
pub institution_id: Option<String>,
pub institution_security_id: Option<String>,
pub is_cash_equivalent: Option<bool>,
pub isin: Option<String>,
pub iso_currency_code: Option<String>,
pub market_identifier_code: Option<String>,
pub name: Option<String>,
pub option_contract: Option<OptionContract>,
pub proxy_security_id: Option<String>,
pub security_id: String,
pub sedol: Option<String>,
pub ticker_symbol: Option<String>,
pub type_: Option<String>,
pub unofficial_currency_code: Option<String>,
pub update_datetime: Option<DateTime<Utc>>,
}
Expand description
Contains details about a security
Fields§
§close_price: Option<f64>
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, refer to update_datetime
with the time when the price was last updated.
close_price_as_of: Option<NaiveDate>
Date for which close_price
is accurate. Always null
if close_price
is null
.
cusip: Option<String>
9-character CUSIP, an identifier assigned to North American securities. A verified CUSIP Global Services license is required to receive this data. This field will be null by default for new customers, and null for existing customers starting March 12, 2024. If you would like access to this field, please start the verification process here.
institution_id: Option<String>
If institution_security_id
is present, this field indicates the Plaid institution_id
of the institution to whom the identifier belongs.
institution_security_id: Option<String>
An identifier given to the security by the institution
is_cash_equivalent: Option<bool>
Indicates that a security is a highly liquid asset and can be treated like cash.
isin: Option<String>
12-character ISIN, a globally unique securities identifier. A verified CUSIP Global Services license is required to receive this data. This field will be null by default for new customers, and null for existing customers starting March 12, 2024. If you would like access to this field, please start the verification process here.
iso_currency_code: Option<String>
The ISO-4217 currency code of the price given. Always null
if unofficial_currency_code
is non-null
.
market_identifier_code: Option<String>
The ISO-10383 Market Identifier Code of the exchange or market in which the security is being traded.
name: Option<String>
A descriptive name for the security, suitable for display.
option_contract: Option<OptionContract>
Details about the option security.
For the Sandbox environment, this data is currently only available if the item is using a custom configuration object, and the ticker
field of the custom security follows the OCC Option Symbol standard with no spaces.
proxy_security_id: Option<String>
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: String
A unique, Plaid-specific identifier for the security, used to associate securities with holdings. Like all Plaid identifiers, the security_id
is case sensitive. The security_id
may change if inherent details of the security change due to a corporate action, for example, in the event of a ticker symbol change or CUSIP change.
sedol: Option<String>
7-character SEDOL, an identifier assigned to securities in the UK.
ticker_symbol: Option<String>
The security’s trading symbol for publicly traded securities, and otherwise a short identifier if available.
type_: Option<String>
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: Option<String>
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 for a full listing of supported iso_currency_code
s.
update_datetime: Option<DateTime<Utc>>
Date and time at which close_price
is accurate, in ISO 8601 format (YYYY-MM-DDTHH:mm:ssZ). Always null
if close_price
is null
.