Logo

Properties required for Global Shortselling

To ensure 100% disclosure coverage in all 95 jurisdictions for all asset classes, all of the following properties are required.
It is possible you might 'get away' with less e.g. if you are NOT trading in Czech or Filipino companies you don't need to provide MarketCap. But obviously if you start trading there in the future you will need this data. Therefore we recommend trying to populate as much as possible
The only way to be sure you are providing enough data is to go into Rapptr results and ensure you have no Missing Data - see here.
Rapptr will fail validation if any of the properties marked with Required are missing. Rapptr will provide a default value for those properties marked with Defaulted.

For information on integrating via API, please see our GitHub repository. For all other information on Rapptr please see our Zendesk HelpCentre



Asset Properties

An asset is the specific position a portfolio has in an instrument. Instrument properties are independent of portfolio, whereas asset properties are specific to the portfolio

Property Name Applies To Description Data type Valid values & notes Rules Jurisdictions
AssetId required All Unique ID of the asset String(255) e.g. ISIN + Market for listed instruments, Alternative Instrument Identifier for OTCs.
Must be unique for every asset in the portfolio and consistent across NAV dates
All All
AssetName required All Name of the asset String(255) Used throughout Rapptr as the primary display name for the asset, so ensure this name is meaningful All All
ExecutionVenue ADR, Convertible, Equity, PreferredEquity, Rights, Warrant Market identification code (MIC) for the market that this position is traded and executed on. All shares of the position need to share this venue, otherwise split out the positions so they are venue-specific. String(255) ISO 10383 code (MIC). Leave this field blank if not able to source at the position level. 8 5
IsDeltaHedged Convertible, Warrant If a long convertible bond or warrant should be delta hedged by an offsetting short position in equity for Short selling in Japan Boolean Used in: Short selling in Japan. The default requirement for Short Selling Japan is to net short equities with long equities and separately net short convertibles with long convertibles. The rule has an exemption to this default that allows for netting of short equity positions with long convertible bond and warrant positions on a delta hedged basis. If you would like to take advantage of this delta hedge exemption you must set the asset property IsDeltaHedged = true and provide a delta value for long convertible bonds and warrants. 1 1
MarketValue All Market value of a position in portfolio currency Decimal If the market value can't be provided in portfolio currency, it should be provided in instrument currency (property MarketValueInInstrumentCurrency). For derivatives, this should represent the fair market value using the relevant/preferred pricing methodology. 3 2
MarketValueInInstrumentCurrency All Market value of a position in instrument currency Decimal Should only be provided if the market value can't be provided in portfolio currency (property MarketValue). For derivatives, this should represent the fair market value using the relevant/preferred pricing methodology. All All
Quantity required All Equities - Number of shares held
Bonds (including Convertibles) - Total nominal value divided by face value (the multiple of the face value making up the nominal of the position)
ETF - Number of units held
Derivatives - Number of contracts held
Decimal Short sale positions - Insert a negative quantity for positions resulting from short sale transactions.
Lending/Borrowing/Collateral (SFTType) - For any asset which does NOT have an SFTType set to 'Normal', insert only positive quantities.
CDS - For credit default swaps, use a negative quantity for protection buys (which is an effective short position) and a positive quantity for protection sells (which is an effective long position).
112 65
SFTType All Type of securities financing transaction (SFT) String(255) Valid values: Borrowed, CollateralGiven, CollateralTaken, Lent, Normal.
This property accounts for various kinds of transactions such as lending, borrowing, repos, reverse repos, while also allowing for general collateral taken and collateral given. See here for more details on populating
112 65

Instrument Properties

An instrument is the portfolio independent information

Property Name Applies To Description Data type Valid values & notes Rules Jurisdictions
AssetClass required All Asset class (e.g. Equity, Bond, CFD etc.) String(255) Valid values: ADR, Bond, CDS, CFD, Convertible, Equity, Future, Index, Option, PreferredEquity, Rights, StructuredProduct, Swap, Unit, Warrant.
To ignore this asset during checking, set to 'Ignore'
112 65
CallOrPut required Option, Warrant If an option / warrant is call or put String(255) Valid values: Call, Put. 112 65
ClassSharesOutstanding Equity, PreferredEquity, Unit Total amount of shares in circulation for this share class Decimal For Unit funds structured as ETFs this should reflect the number of units issued. 4 4
ClassSharesOutstandingListedOnKRX Equity, PreferredEquity Total amount of a class of shares in circulation on the KRX (XKOS, XKRX) Decimal This property is only required for the Korean short selling rules. While ClassSharesOutstandingListedOnKRX may be identical to ClassSharesOutstanding for many issuers, it is not always the case. For dual listed issuers, this property omits outstanding shares not listed on the KRX (KOSPI Stock Market or KOSDAQ Market). 2 1
ContractSize CFD, Future, Option, Warrant Contract size of a derivative. If relevant, this should be in instrument currency Decimal e.g. 1000 would mean every option represents 1000 of the underlying. 47 39
ConversionRatio ADR, Convertible, PreferredEquity, Rights Convertible: the number of equities one convertible converts into;
DR: the number of underlying shares represented in one DR;
Right: the number of underlying securities that one right gives entitlement to.
Preferred Equity: the number of common shares one convertible preference share converts into.
Decimal 47 39
CountryOfIncorporation Equity, PreferredEquity, Unit [Issuer Property] Equity and Preferred Equity - Country where the issuer is incorporated.
ETFs - Country where the collective investment scheme's (or other company structure's) legal personality is incorporated
String(255) Valid values: ISO 3166-1 Alpha 2 country codes. 8 6
CountryOfIssue Bond, Equity, PreferredEquity, Unit Country the stock was issued String(255) Valid values: ISO 3166-1 Alpha 2 country codes. 8 7
CountryOfRCAMTFs defaulted ADR, Bond, Convertible, Equity, PreferredEquity, Rights, Unit, Warrant Country of Relevant Competent Authority (RCA) for securities trading on MTFs in the European Economic Area (EEA). Rapptr automatically populates this property by looking up the relevant instrument's ISIN (or underlying ISIN) in FIRDS, published by ESMA. String(255) There is an option to fill in this property with the respective Relevant Competent Authority (represented as a country code) directly in the positions file, otherwise, Rapptr looks it up in the FIRDS list. 31 31
CountryOfRCAMTFsDRs defaulted ADR Country of Relevant Competent Authority (RCA) for depository receipts trading on MTFs in the European Economic Area (EEA). Rapptr automatically populates this property by looking up the relevant instrument's ISIN (or underlying ISIN) in FIRDS, published by ESMA.
Please note that this property is specific for the Dutch short selling equity rules. In light of AFM's clarification that they view depositary receipts (DRs) as equated with 'shares' (the underlying of the DR) since a DR is issued with the company's cooperation, the property looks at the ISIN of a DR to determine the relevant competent authority (RCA) for disclosure purposes.
String(255) There is an option to fill in this property with the respective Relevant Competent Authority (represented as a country code) directly in the positions file, otherwise, Rapptr looks it up in the FIRDS list. 1 1
CountryOfRCARegulatedMarkets defaulted ADR, Bond, Convertible, Equity, PreferredEquity, Rights, Unit, Warrant Country of Relevant Competent Authority (RCA) for securities trading on regulated markets in the European Economic Area (EEA). Rapptr automatically populates this property by looking up the relevant instrument's ISIN (or underlying ISIN) in FIRDS, published by ESMA. String(255) There is an option to fill in this property with the respective Relevant Competent Authority (represented as a country code) directly in the positions file. Otherwise, Rapptr looks it up in the FIRDS list. 31 31
CountryOfRCARegulatedMarketsDRs defaulted ADR Country of Relevant Competent Authority (RCA) for depository receipts trading on regulated markets in the European Economic Area (EEA). Rapptr automatically populates this property by looking up the relevant instrument's ISIN (or underlying ISIN) in FIRDS, published by ESMA.
Please note that this property is specific for the Dutch short selling equity rules. In light of AFM's clarification that they view depositary receipts (DRs) as equated with 'shares' (the underlying of the DR) since a DR is issued with the company's co-operation, the property looks at the ISIN of a DR to determine the relevant competent authority (RCA) for disclosure purposes.
String(255) There is an option to fill in this property with the respective Relevant Competent Authority (represented as a country code) directly in the positions file, otherwise, Rapptr looks it up in the FIRDS list. 1 1
Delta Convertible, Option, Warrant The Delta measures the degree to which the derivative is exposed to shifts in the price of the underlying asset (price sensitivity with relation to the underlying) Decimal Valid Values: 0 to 1 70 34
DurationAdjustment Bond Modified duration of a bond Decimal This is used for calculating the appropriate exposure for EU Sovereign Debt Short Selling Regulation. 34 30
FaceValue Bond, Convertible Denomination of a debt instrument at issuance Decimal 34 30
HomeMemberState_v2 defaulted ADR, Bond, Convertible, Equity, PreferredEquity, Rights, Unit, Warrant The EU country of the competent authority to which an issuer of the security is assigned or registered with respect to the EU Transparency Directive. This property provides the Home Member State for bonds, equities, units and preferred equities. For all other asset classes, the Home Member State of the underlying asset is returned. String(255) If not provided, Rapptr populates this property with the EEA country of the Relevant Competent Authority by looking up the relevant instrument's ISIN or underlying ISIN (also for depository receipts) in the FIRDS list. For more information see the Help Centre article on this topic. 1 1
InstrumentCurrency ADR, Bond, CDS, CFD, Convertible, Equity, Future, Index required, Option, PreferredEquity, Rights, StructuredProduct required, Swap, Unit, Warrant Currency the instrument is denominated in String(255) Valid values: ISO 4217 currency codes. 81 39
InstrumentId required All Identifier to link assets to instruments and instruments to Underlying instruments String(255) Must be unique for every instrument in one upload All All
InstrumentName required All Instrument name String(255) Used throughout Rapptr as the primary display name for the instrument, so ensure this name is meaningful All All
IsCashSettled CFD required, Future required, Option required, Swap required, Warrant If the derivative is cash settled (as opposed to requiring physical delivery) Boolean Most countries capture physically settled derivatives, many (but less) are interested in cash settled derivatives. 10 9
IsConvertiblePreferred PreferredEquity If the preferred equity has the option to be converted into ordinary shares. Boolean 4 2
IsCoveredConvertible Convertible This property defines whether a convertible bond references shares already in issue or shares to be issued by the issuer upon conversion of the bond. Should this information not be possible to provide, please use the value 'Undetermined'. This value is allowed because the IsCoveredConvertible property, when set to True without certain knowledge, may be conservative in one context (Major rules), but less conservative in another (EU short selling). String(255) Valid values: False, True, Undetermined. 32 31
IsCoveredWarrant Warrant If the warrant is covered Boolean 32 31
IsETF Unit If a unit fund is exchange traded Boolean 77 40
IsGovernmentBacked Bond If the bond is government backed or guaranteed. For shareholding disclosure, required only if shorting European Government debt. Boolean 34 30
ISIN ADR, Bond, CDS, CFD, Convertible, Equity, Future, Option, PreferredEquity, Swap, Unit, Warrant ISIN of the instrument String(255) Used to look-up Instrument in many lists such as EU Short Selling Exempt, short selling black & white lists, Takeover lists etc. 44 37
IsREIT Equity Set to TRUE if a share of a Real Estate Investment Trust (REIT) Boolean 1 1
IssuerId ADR, Bond, Convertible, Equity, PreferredEquity, Unit, Warrant Unique identifier for the issuer of the instrument String(255) Do not use the LEI for this as for the foreseeable future not all issuers have an LEI. For Unit funds structured as an ETF, this should identify the ETF itself. 112 65
IssuerName ADR, Bond, Convertible, Equity, PreferredEquity, Unit, Warrant [Issuer Property] Name of the issuer of the instrument String(255) For Unit funds structured as ETF, the IssuerName should be that of the ETFs itself.
For EU government bonds, insert the exact sovereign issuer name from ESMA's list of sovereign issuers.
For issuers that are disclosable under the nominal share capital rules in The Netherlands, insert the exact issuer name outlined by the Dutch AFM here if you want Rapptr to automatically populate the official value for TotalIssuedNominalCapital.
112 65
IsWhenIssued Equity, PreferredEquity If a security has been authorised but not yet issued. Boolean If set to TRUE, the securities have been authorised but not yet issued. For example, during a stock split where the securities are authorised but not issued until the corporate action is completed.
Set to FALSE if otherwise.
31 31
LocalTicker ADR, Equity, PreferredEquity, Unit The ticker or stock symbol which is an abbreviation used to uniquely identify traded shares of a stock on a particular stock market. String(255) This property is required for disclosure forms, and will allow the Singapore Short selling rule to run on only those SEDOLs traded on SGX-ST (i.e. in scope for disclosure.) If multiple SEDOLs are traded, a separate instrument should be provided in the positions file for the instruments traded on SGX-ST for which LocalTicker is being provided. 3 1
LotSize Equity, PreferredEquity, Unit Number of shares in each lot or trading unit Decimal Required for: Short selling in Japan 1 1
Market ADR, Bond, CDS, CFD, Convertible, Equity, Future, Option, PreferredEquity, Rights, Swap, Unit, Warrant Market identification code (MIC) for the primary market that this instrument is traded on. String(255) ISO 10383 code (MIC). Insert the MIC of the primary market that the instrument is traded on. Where the specific market segment is different to the Operating MIC, please use the specific market segment since the Operating MIC is the parent market venue only.
For instruments which are truly over-the-counter (OTC), use the value recommended by the ISO standard: XXXX
For instruments where the market is completely unknown, use the value: XMIC (which is not an ISO code but a suggested default value in such cases).
4 4
MarketsListedIn ADR, Bond, CDS, CFD, Convertible, Equity, Future, Option, PreferredEquity, Rights, Swap, Unit, Warrant List of all market identification codes (MICs) where the instrument is listed - should be a list of all markets that the instrument is listed on, and should include the primary market. List ISO 10383 code (MIC). Insert the MICs of all markets that the instrument is listed on (should include the primary market). Where the specific market segment is different to the Operating MIC, please use the specific market segment since the Operating MIC is the parent market venue only.
For instruments which are truly over-the-counter (OTC), use the value recommended by the ISO standard: XXXX
For instruments where the market is completely unknown, use the value: XMIC (which is not an ISO code but a suggested default value in such cases).
33 24
Notional CDS, Future, Option, Swap, Unit The reference value of the derivative/bond-fund instrument (in instrument currency) in terms of the underlying debt instruments. Applies to derivatives on bonds, derivatives on bond indices or holdings of sovereign bond funds. This may be the face value or a multiple of the face value of underlying debt. For bond funds or bond indices, this will be the sum of the individual bond constituent holding values (not market values), in a common currency. Decimal 34 30
Price All Price of the instrument in instrument currency. For bonds and convertibles, the price must be stated as a percentage of the face value of an individual bond (since this is the way bonds are quoted on the market). Decimal 47 39
TotalDebtOutstanding Bond, Convertible [Issuer Property] Total amount of debt outstanding of an issuer in instrument currency, for sovereign debt rules Decimal Only required if you can't match the sovereign issuer name used in Issuer to ESMA's list of sovereign issuers 34 30
TotalSharesInTreasury Equity, PreferredEquity [Issuer Property] Total amount of shares held in treasury by the issuer. Decimal 31 31
TotalSharesOutstanding Equity, PreferredEquity, Unit [Issuer Property] Total amount of shares in circulation for this issuer (all share classes) Decimal For Unit funds structured as ETFs this should reflect the number of units issued. 37 35

Properties valid for ALL AssetClasses

AssetClass, AssetId, AssetName, InstrumentCurrency, InstrumentId, InstrumentName, MarketValue, MarketValueInInstrumentCurrency, Price, Quantity, SFTType

Properties valid for each AssetClass

Asset classes which require exactly one underlying asset to pass validation are marked with one
Asset classes which can have multiple underlying assets are marked with multiple

Asset Class Valid Underlyings Properties
ADR required Equity, PreferredEquity ConversionRatio, CountryOfRCAMTFs, CountryOfRCAMTFsDRs, CountryOfRCARegulatedMarkets, CountryOfRCARegulatedMarketsDRs, ExecutionVenue, HomeMemberState_v2, ISIN, IssuerId, IssuerName, LocalTicker, Market, MarketsListedIn
Bond CountryOfIssue, CountryOfRCAMTFs, CountryOfRCARegulatedMarkets, DurationAdjustment, FaceValue, HomeMemberState_v2, IsGovernmentBacked, ISIN, IssuerId, IssuerName, Market, MarketsListedIn, TotalDebtOutstanding
CDS required Bond, Index, StructuredProduct ISIN, Market, MarketsListedIn, Notional
CFD required Bond, Convertible, Equity, Index, PreferredEquity, StructuredProduct ContractSize, IsCashSettled, ISIN, Market, MarketsListedIn
Convertible required Equity ConversionRatio, CountryOfRCAMTFs, CountryOfRCARegulatedMarkets, Delta, ExecutionVenue, FaceValue, HomeMemberState_v2, IsCoveredConvertible, IsDeltaHedged, ISIN, IssuerId, IssuerName, Market, MarketsListedIn, TotalDebtOutstanding
Equity ClassSharesOutstanding, ClassSharesOutstandingListedOnKRX, CountryOfIncorporation, CountryOfIssue, CountryOfRCAMTFs, CountryOfRCARegulatedMarkets, ExecutionVenue, HomeMemberState_v2, ISIN, IsREIT, IssuerId, IssuerName, IsWhenIssued, LocalTicker, LotSize, Market, MarketsListedIn, TotalSharesInTreasury, TotalSharesOutstanding
Future required Bond, Convertible, Equity, Index, PreferredEquity, StructuredProduct ContractSize, IsCashSettled, ISIN, Market, MarketsListedIn, Notional
Index multiple ADR, Bond, CDS, Convertible, Equity, PreferredEquity
Option required Bond, Convertible, Equity, Future, Index, PreferredEquity, StructuredProduct, Unit CallOrPut, ContractSize, Delta, IsCashSettled, ISIN, Market, MarketsListedIn, Notional
PreferredEquity Equity ClassSharesOutstanding, ClassSharesOutstandingListedOnKRX, ConversionRatio, CountryOfIncorporation, CountryOfIssue, CountryOfRCAMTFs, CountryOfRCARegulatedMarkets, ExecutionVenue, HomeMemberState_v2, IsConvertiblePreferred, ISIN, IssuerId, IssuerName, IsWhenIssued, LocalTicker, LotSize, Market, MarketsListedIn, TotalSharesInTreasury, TotalSharesOutstanding
Rights required Equity ConversionRatio, CountryOfRCAMTFs, CountryOfRCARegulatedMarkets, ExecutionVenue, HomeMemberState_v2, Market, MarketsListedIn
StructuredProduct multiple ADR, Bond, CDS, Convertible, Equity, Future, Index, Option, PreferredEquity, StructuredProduct, Unit
Swap required ADR, Bond, Convertible, Equity, Index, PreferredEquity, StructuredProduct IsCashSettled, ISIN, Market, MarketsListedIn, Notional
Unit multiple ADR, Bond, CDS, Convertible, Equity, Future, Option, PreferredEquity, StructuredProduct ClassSharesOutstanding, CountryOfIncorporation, CountryOfIssue, CountryOfRCAMTFs, CountryOfRCARegulatedMarkets, HomeMemberState_v2, IsETF, ISIN, IssuerId, IssuerName, LocalTicker, LotSize, Market, MarketsListedIn, Notional, TotalSharesOutstanding
Warrant required Equity CallOrPut, ContractSize, CountryOfRCAMTFs, CountryOfRCARegulatedMarkets, Delta, ExecutionVenue, HomeMemberState_v2, IsCashSettled, IsCoveredWarrant, IsDeltaHedged, ISIN, IssuerId, IssuerName, Market, MarketsListedIn

Portfolio & Entity Properties

A portfolio is the smallest unit that can hold assets (aka an account, fund etc.), an entity is a grouping of portfolios. The properties are generally set-up once and then only updated when changes occur. Portfolio properties can be entered directly into the Rapptr UI and do not need to be provided in an input file.

The following are required for the rules / Rapptr to function correctly

Property NameApplies ToDescriptionData typeValid values & notesRules Jurisdictions
PortfolioId required Both Unique identifier for the portfolio / entity String(255) This Id should NOT change over time (even during implementation). If it does a new portfolio / entity will be created. All All
PortfolioName required Both Name of the portfolio / entity String(255) All All
PortfolioCurrency required Both Base currency of the portfolio / currency entity should use for calculations String(255) Valid values: ISO 4217 currency codes. 3 2
PortfolioType required Both Portfolio: a container that holds assets (Accounts, Funds, Portfolios etc.);
Entity: an aggregation of portfolios (Management Company, Controlling Entity, etc.)
Umbrella: If a portfolio's direct parent is an umbrella and a portfolio level disclosure is required, Rapptr will trigger the disclosure on the parent umbrella, aggregating all portfolios underneath that specific umbrella
String(255) Valid values: Entity, Portfolio, Umbrella. Click here for more information on umbrellas All All
PortfolioCompany required Both If a Chinese wall, or similar, exists, you will be able to limit the visibility to specific areas of the business. String(255) More information is available here All All
DefaultParentId Both Identifier (PortfolioId) of the Entity that a portfolio or (sub)Entity aggregates to String(255) Must match a PortfolioId of an Entity in the file. This is used to define the aggregation structure. In this case, an aggregation structure named 'Default' is used. For Entities which are at the top of the tree, the DefaultParentId will be its own PortfolioId. For clients with multiple aggregation structures, additional columns named 'XParentId' can be added, where X is the name of the tree (e.g. Voting, Legal, Management). More information here All All
RuleFolders Portfolio Defines which rules run on the system. List Valid values all folders active in your system see bottom left panel in the rules page All All
LiquidationDate Both When the portfolio / entity was / will be liquidated Date All All
ShortSGReportingType Portfolio Indication of which Singapore Short Selling rules are evaluated for a portfolio based on certain attributes described in the regulation, or if another party (e.g. the underlying investor) has taken the disclosure obligation. String(255) Valid values: Exclude, NoThreshold, Threshold.
See this Help Centre article for the full meaning of each of these values and instructions on which selection to make.
3 1

Last generated: 2020-03-18 21:00:36 UTC