Reference Guide - Product properties

From SRP API Docs

Revision as of 19:12, 9 October 2016 by Jonas (Talk | contribs) (Derivatives Counterparty)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Product properties

ID Number

The ID Number is the unique reference of the product in the SRP database <protect> Request

Filter name Multi-value Filter type Possible values
id yes, max 100 Free value 9 bytes string, starting with ID prefix. E.g. ID0024721

Request sample

id=ID0024721,ID0024722

</protect>

Response

Element name Multi-value Value type
id no string

XML response sample:

<id>ID0024721</id>

Product Name

The product name.

<protect> Request

Filter name Multi-value Filter type Possible values
name no Free value url encoded string

Request sample

name=Kapitalschutz

</protect>

Response

Element name Multi-value Value type
name no string

XML response sample:

<name>Kapitalschutz</name>

Product description

The product description

Response

Element name Multi-value Value type
description yes object
  language no string
  text no string

XML response sample:

<descriptions>
  <description>
    <language>English</language>
    <text><![CDATA[This is a growth product.</br> It is linked to...]]></text>
  </description>
</descriptions>

Because description text can be HTML code, it will come as CDATA section.

PDF Brochures

The product brochures

Response

Element name Multi-value Value type
brochure yes object
  country no string
  filename no string
  name no string

XML response sample:

<brochures>
  <brochure>
    <country>UK</country>
    <filename>Terms_2012.pds</filename>
    <name>Termssheet</name>
  </brochure>
</brochures>

ISIN Information

The ISIN Information is listed below:

Code ISIN International Securities Identification Numbers. The ISIN code is a 12-character alpha-numerical code that does not contain information characterising financial instruments but allows for uniform identification when trading or settling a security.

Volume Volume sold (in millions of the local currency) for that ISIN code.

<protect> Request

Filter name Multi-value Filter type Possible values
isin yes, max 50 Free value 12 bytes string

Request sample

isin=CH0148180588

</protect>

Response

Element name Multi-value Value type
isin yes object
  code no string
  wrapper yes object
    code no string
    name no string
  volume no float
  volume_type no string, actual/estimate

XML response sample:

<isins>
  <isin>
    <code>CH0148180588</code>
    <wrappers>
      <wrapper>
        <code>WP0035</code>
        <name>Warrants</name>
        <group>
          <code>WG002</code>
          <name>Deposit</name>
        </group>
      </wrapper>
    </wrappers>
    <volume>150.00</volume>
    <volume_type>actual</volume_type>
  </isin>
</isins>

WKN code

A unique-identifier code, mostly used in Germany as an alternate to the ISIN code

<protect> Request

Filter name Multi-value Filter type Possible values
wkn yes, max 50 Free value string

Request sample

wkn=CB6VBD

</protect>

Response

Element name Multi-value Value type
wkn no string

XML response sample:

<wkn>CB6VBD</wkn>

CUSIP

An US identification number assigned to each fund by the Committee on Uniform Security Identification Procedures.

<protect> Request

Filter name Multi-value Filter type Possible values
cusip yes, max 50 Free value string

Request sample

cusip=R21892AM7

</protect>

Response

Element name Multi-value Value type
cusip no string

XML response sample:

<cusip>R21892AM7</cusip>

Sales Commission

Sales Commission

<protect> Request

Filter name Multi-value Filter type Possible values
commision no Free value string

Request sample

commision=up%20to%204%25

</protect>

Response

Element name Multi-value Value type
commision no string

XML response sample:

<commision>up to 4%</commision>

Class

The database is split according to these product classes:

Leverage Products that provide leverage long or leverage short position in an underlying, usually including a stop-loss feature. These products are typically known as turbos.

Flow & Others products are Highly standardized structured products, usually issued in large numbers and on a regular basis. The following products are currently classified as flow products:

Germany Discount, Sprint, Bonus and other type of highly-standardized investment certificates, usually traded on the Stuttgart stock Exchange.

Switzerland Standardized investment certificates issued by providers primarily for the German market, but also distributed in Switzerland. Non-flow products will therefore mostly include the products only targeted at Swiss investors, as well as non-standardized German products also distributed in Switzerland.

Austria Standardized investment certificates issued by providers primarily for the German market, but also distributed in Austria. Non-flow products will therefore mostly include the products only targeted at Austrian investors, as well as non-standardized German products also distributed in Austria.

France Mainly Euronext-traded investment certificates, known locally as "Produits de Bourse".

Spain Callable-only or Putable-only products.

Italy Interest-rate products based on either callable, putable or floater features

Malaysia, Australia, Taiwan, Hong Kong, Singapore, Japan Monthly issuance of standardized products, usually FX-rate dual currency or interest-rate based products.

Non flow products are the ones which doesn't match previous rules

<protect> Request

Filter name Multi-value Filter type Possible values
class yes, max 2 Predefined value flow/non_flow/leverage

Request sample

class=flow,leverage

</protect>

Response

Element name Multi-value Value type
class no string, flow/non_flow/leverage

XML response sample:

<class>flow</class>

Live

Products which hasn't expired yet

<protect> Request

Filter name Multi-value Filter type Possible values
live no Predefined value yes/no

Request sample

live=yes

</protect>

Response

Element name Multi-value Value type
live no string, yes/no

XML response sample:

<live>yes</live>

Initial Charge

Initial charge

Response

Element name Multi-value Value type
initial_charge no string

XML response sample:

<initial_charge>Up to 5%</initial_charge>

Annualised Margin

Annualised Margin <protect> (flo_annualised_gross_margin) </protect>

Response

Element name Multi-value Value type
annualised_margin no float

XML response sample:

<annualised_margin>1</annualised_margin>

PV Gross Margin

PV Gross Margin <protect> (flo_pv_gross_margin) </protect>

Response

Element name Multi-value Value type
gross_margin no float

XML response sample:

<gross_margin>4.5</gross_margin>

Bonus Level

Bonus Level

Response

Element name Multi-value Value type
bonus_level no float

XML response sample:

<bonus_level>100</bonus_level>

Annual Management Charge

Annual Management Charge

Response

Element name Multi-value Value type
management_charge no string

XML response sample:

<management_charge>Up to 2%</management_charge>

Distributor

The company that distributes the product.

Request

Filter name Multi-value Filter type Possible values
provider yes, max 15 Predefined value Providers

Request sample

provider=PV25529

Response

Element name Multi-value Value type
provider no object
  code no string
  name no string

XML response sample:

<provider>
  <code>PV25529</code>
  <name>JPMorgan</name>
</provider>

Distributor Group

The parent company of the one that distributed the product.

Request

Filter name Multi-value Filter type Possible values
provider_group yes, max 10 Predefined value Provider groups

Request sample

provider_group=PG0052

Response

Element name Multi-value Value type
provider_group no object
  code no string
  name no string

XML response sample:

<provider_group>
  <code>PG0052</code>
  <name>Citi</name>
</provider_group>

Distributor Type

Type of the company which distributes the product.

Response

Element name Multi-value Value type
provider_type no object
  code no string
  name no string

XML response sample:

<provider_type>
  <code>PT0052</code>
  <name>Securities Company</name>
</provider_type>

Third Party Distributor

Any other company involved in the distribution of the product (e.g. insurance company or broker dealer)

Request

Filter name Multi-value Filter type Possible values
thirdparty yes, max 15 Predefined value Providers

Request sample

thirdparty=PV25529

Response

Element name Multi-value Value type
thirdparty yes object
  code no string
  name no string

XML response sample:

<thirdparties>
  <thirdparty>
    <code>PV25529</code>
    <name>JPMorgan</name>
  </thirdparty>
</thirdparties>

Bond Provider

The provider that issued the zero coupon bond used in structured the product.

<protect> Request

Filter name Multi-value Filter type Possible values
bond_provider yes, max 15 Predefined value Providers

Request sample

bond_provider=PV25529

</protect>

Response

Element name Multi-value Value type
bond_provider yes object
  code no string
  name no string

XML response sample:

<bond_providers>
  <bond_provider>
    <code>PV25529</code>
    <name>JPMorgan</name>
  </bond_provider>
</bond_providers>

Bond Provider Public

Display rule for Bond Providers

<protect> Request

Filter name Multi-value Filter type Possible values
bp_public no Predefined value yes/no

Request sample

bp_public=yes

</protect>

Response

Element name Multi-value Value type
bp_public no string, yes/no

XML response sample:

<bp_public>yes</bp_public>

Market

Country. Products within the StructuredRetailProducts.com database are classified under individual market (country) databases. In most cases, the database name represents the country or region where the particular products are distributed. The exception is the Private Banking database - groups non-retail products targeted at private banking and institutional markets. The Private Banking database is not split by market.

Please note - you will only be able to make calls for markets which are included in your API license, and you will only get public volumes.

Currency. Currency denomination is simply the currencies in which the initial investment is denominated. This can be any currency depending on the design of the product.

Volume. Volume consists of these properties:

   Amount - the volume amount a particular product was sold

   Date - date when a particular product was sold

   Currency - the currency in which the volume was sold for a particular product. This currency is always the same as the local currency of a given market.

Volume public. Whether the volume for that product is public or not

Volume type. When the volume sold is actual or estimate

Wrapper. Product market wrapper

Wrapper group. Product market wrapper group

Local Payoff. Product market payoff <protect> Request

Filter name Multi-value Filter type Possible values
currency yes Predefined value Currencies
local_payoff yes, max 20 Predefined value Payoffs Not implemented
market yes, max 10 Predefined value Markets
volume Number range float Not implemented
volume_public no Predefined value yes/no Not implemented
volume_type no Predefined value actual/estimate Not implemented
wrapper yes, max 20 Predefined value Wrappers
wrapper_group yes Predefined value Wrapper groups

Request sample

market=MK0012&local_payoff=PF0244&currency=EUR&volume=15.5,16.5&volume_public=yes&volume_type=actual&wrapper=WP0035&wrapper_group=WG002

</protect>

Response

Element name Multi-value Value type
market yes object
  country no object
    code no string
    name no string
  currency no string, DEPRECATED
  currency yes string
  email no string
  local_payoff yes object
    code no string
    name no string
  phone no string
  volume no object
    amount no float
    date no date
    currency no string
  volume_public no string
  volume_type no string
  website no string
  wrapper yes object
    code no string
    group yes object
      code no string
      name no string
    name no string

XML response sample:

<markets>
  <market>
    <country>
      <code>MK0012</code>
      <name>UK</name>
    </country>
    <currency>EUR</currency> <!-- DEPRECATED, please use 'currencies' instead -->
    <currencies>
      <currency>
        <name>EUR</name>
      </currency>
    </currencies>
    <email>info@structuredretailproducts.com</email>
    <local_payoffs>
      <local_payoff>
        <code>PF0244</code>
        <name>Guarantee Bond</name>
      </local_payoff>
    </local_payoffs>
    <phone>+440000000000</phone>
    <volume>
      <amount>15.9</amount>
      <date>2011-12-31</date>
      <currency>USD</currency>
    </volume>
    <volume_public>yes</volume_public>
    <volume_type>actual</volume_type>
    <website>www.structuredretailproducts.com</website>
    <wrappers>
      <wrapper>
        <code>WP0035</code>
        <name>Warrants</name>
        <group>
          <code>WG002</code>
          <name>Deposit</name>
        </group>
      </wrapper>
    </wrappers>
  </market>
</markets>

Category

This signifies whether a product is an Offshore, (Domestic) Retail, Institutional or Private Banking offering.

<protect> Request

Filter name Multi-value Filter type Possible values
category yes Predefined value Categories

Request sample

category=CT4

</protect>

Response

Element name Multi-value Value type
category yes object
  code no string
  name no string

XML response sample:

<categories>
  <category>
    <code>CT4</code>
    <name>Institutional</name>
  </category>
</categories>

Style

The database is split according to two product styles:

Tranche Customized structured products with a primary offer period, an initial strike date, a final index date, and a maturity date.

Continuous Customized structured products that are always available for investment, also known as open-ended products.

<protect> Request

Filter name Multi-value Filter type Possible values
style no Predefined value tranche/continuous

Request sample

style=continuous

</protect>

Response

Element name Multi-value Value type
style no string, tranche/continuous

XML response sample:

<style>continuous</style>

Expiry Type

Give the status of the expiry date, if it is an estimate or the actual one

<protect> Request

Filter name Multi-value Filter type Possible values
expiry_type no Predefined value actual/estimate

Request sample

expiry_type=estimate

</protect>

Response

Element name Multi-value Value type
expiry_type no string, actual/estimate

XML response sample:

<expiry_type>estimate</expiry_type>

Structure

The product structure is Continuous products specific property.

<protect> Request

Filter name Multi-value Filter type Possible values
structure yes Predefined value Structures

Request sample

structure=ST01

</protect>

Response

Element name Multi-value Value type
structure yes object
  code no string
  name no string

XML response sample:

<structures>
  <structure>
    <code>ST01</code>
    <name>Fund Structure</name>
  </structure>
</structures>

Type

The three product type definitions are shown below:

Growth A structured product typically providing a minimum fixed return at maturity plus a variable amount linked to one or more underlying equity market.

Growth and Income A growth type structured product offered together with an associated fixed or variable rate income product, typically a shorter term fixed rate deposit paying a high headline rate.

Income A structured product typically providing a high fixed income payment and a variable capital return at maturity linked to one or more underlying equity market.

<protect> Request

Filter name Multi-value Filter type Possible values
type no Predefined value growth/income/growth_and_income

Request sample

type=income

</protect>

Response

Element name Multi-value Value type
type no string, growth/income/growth_and_income

XML response sample:

<type>income</type>

Payoff Type

The payoff types are defined here: Payoffs

<protect> Request

Filter name Multi-value Filter type Possible values
payoff yes Predefined value Payoffs

Request sample

payoff=PF0262

</protect>

Response

Element name Multi-value Value type
payoff yes object
  code no string
  name no string

XML response sample:

<payoffs>
  <payoff>
    <code>PF0262</code>
    <name>Barrier</name>
  </payoff>
</payoffs>

Income Type

Income Type

Request

Filter name Multi-value Filter type Possible values
income no Predefined value fixed/variable/mixed

Request sample

income=fixed

Response

Element name Multi-value Value type
income no string, fixed/variable/mixed

XML response sample:

<income>fixed</income>

Capital Return Type

Capital return type (Actual or Estimate)

<protect> Request

Filter name Multi-value Filter type Possible values
capital_return_type no Predefined value actual/estimate

Request sample

capital_return_type=actual

</protect>

Response

Element name Multi-value Value type
capital_return_type no string, actual/estimate

XML response sample:

<capital_return_type>actual</capital_return_type>

Distribution Channel

The distribution channels through which the product is being offered. The available distribution channels are shown here: Distribution channels

<protect> Request

Filter name Multi-value Filter type Possible values
distribution_channel yes Predefined value Distribution channels

Request sample

distribution_channel=DS4

</protect>

Response

Element name Multi-value Value type
distribution_channel yes object
  code no string
  name no string

XML response sample:

<distribution_channels>
  <distribution_channel>
    <code>DS4</code>
    <name>Direct</name>
  </distribution_channel>
</distribution_channels>

Derivatives Manufacturer

Company involved in structuring the optionality

<protect> Request

Filter name Multi-value Filter type Possible values
counterparty yes Predefined value Derivative counterparties

Request sample

counterparty=DC0645

</protect>

Response

Element name Multi-value Value type
counterparty yes object
  code no string
  name no string

XML response sample:

<counterparties>
  <counterparty>
    <code>DC0645</code>
    <name>Citi</name>
  </counterparty>
</counterparty>

Derivatives Counterparty Public

Whether the Derivatives Counterparty is public information or not

<protect> Request

Filter name Multi-value Filter type Possible values
dc_public no Predefined value yes/no

Request sample

dc_public=yes

</protect>

Response

Element name Multi-value Value type
dc_public no string, yes/no

XML response sample:

<dc_public>yes</dc_public>

Rating Agencies

Rating agencies

<protect> Request

Filter name Multi-value Filter type Possible values
rating yes Predefined value Rating Agencies

Request sample

rating=RA02

</protect>

Response

Element name Multi-value Value type
rating yes object
  code no string
  name no string
  level no float

XML response sample:

<ratings>
  <rating>
    <code>RA02</code>
    <name>Moody's</name>
    <level>Aa1</level>
  </rating>
</ratings>

Tax Status

Tax Status

<protect> Request

Filter name Multi-value Filter type Possible values
tax_status yes Predefined value Tax statuses

Request sample

tax_status=TX001

</protect>

Response

Element name Multi-value Value type
tax_status yes object
  code no string
  name no string

XML response sample:

<tax_statuses>
  <tax_status>
    <code>TX001</code>
    <name>Capital Gains Tax</name>
  </tax_status>
</tax_statuses>

Exchange

Exchange where the product is listed

<protect> Request

Filter name Multi-value Filter type Possible values
exchange yes Predefined value Exchanges

Request sample

exchange=EX001

</protect>

Response

Element name Multi-value Value type
exchange yes object
  code no string
  name no string
  ticker no string

XML response sample:

<exchanges>
  <exchange>
    <code>EX001</code>
    <name>AMEX</name>
    <ticker>EFM</ticker>
  </exchange>
</exchanges>

<protect>

Daily Update Interest

Whether the product is worth having on a single separate line on the daily update

Request

Filter name Multi-value Filter type Possible values
du_interest no Predefined value yes/no

Request sample

du_interest=yes

Response

Element name Multi-value Value type
du_interest no string, yes/no

XML response sample:

<du_interest>yes</du_interest>

</protect>

Asset Class

The asset classes are defined here: Asset classes

<protect> Request

Filter name Multi-value Filter type Possible values
asset_class yes Predefined value Asset classes

Request sample

asset_class=AC10

</protect>

Response

Element name Multi-value Value type
asset_class yes object
  code no string
  name no string

XML response sample:

<asset_classes>
  <asset_class>
    <code>AC10</code>
    <name>Commodities</name>
  </asset_class>
</asset_classes>

Underlying

The underlying links are defined here: Underlyings

<protect> Request

Filter name Multi-value Filter type Possible values
underlying yes Predefined value Underlyings
strike_level no float Number range Not implemented

Request sample

underlying=UD00034

</protect>

Response

Element name Multi-value Value type
underlying yes object
  code no string
  name no string
  level no float
  isin (launch date:18th April 2016) no string
  sector code (launch date:18th April 2016) yes string
  sector name (launch date:18th April 2016) yes string
  instrument code (launch date:18th April 2016) yes string
  instrument name (launch date:18th April 2016) yes string

XML response sample:

<underlyings>
  <underlying>
    <code>UD00034</code>
    <name>Gold</name>
    <level>150.45</level>
    <isin>ExampleIsinCode</isin>
    <sector_code>UDST0001</sector_code>
    <sector_name>Country & Regional Indexes</sector_name>
    <instrument_code>UDIN0001</instrument_code>
    <instrument_name>Stocks</instrument_name>
  </underlying>
</underlyings>

Expiry Date

Product expiry date

<protect> Request

Filter name Filter type Possible values
expiry Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

expiry=2012-02-01

</protect>

Response

Element name Multi-value Value type
expiry no date

XML response sample:

<expiry>2012-02-01</expiry>

Final Index Date

The date when the final level of the equity index is recorded.

<protect> Request

Filter name Filter type Possible values
final_index Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

final_index=2012-01-01

</protect>

Response

Element name Multi-value Value type
final_index no date

XML response sample:

<final_index>2012-01-01</final_index>

Initial Strike Date

The date when the first fixing is taken for calculating the initial level of the underlying.

<protect> Request

Filter name Filter type Possible values
initial_strike Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

initial_strike=2012-01-15

</protect>

Response

Element name Multi-value Value type
initial_strike no date

XML response sample:

<initial_strike>2012-01-15</initial_strike>

Knockout

Knockout date

<protect> Request

Filter name Filter type Possible values
knockout Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

knockout=2012-01-15

</protect>

Response

Element name Multi-value Value type
knockout yes object
  date no date
  level no float
  payout no float

XML response sample:

<knockouts>
  <knockout>
    <date>2012-01-15</date>
    <level>10</level>
    <payout>109.45</payout>
  </knockout>
</knockout>

Launch Date

Input the date when the product was first available for investment (Continuous products).

<protect> Request

Filter name Filter type Possible values
launch Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

launch=2012-01-15

</protect>

Response

Element name Multi-value Value type
launch no date

XML response sample:

<launch>2012-01-15</launch>

Maturity Date

The date when the product matures.

<protect> Request

Filter name Filter type Possible values
maturity Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

maturity=2012-01-15

</protect>

Response

Element name Multi-value Value type
maturity no date

XML response sample:

<maturity>2012-01-15</maturity>

Offer Close Date

The date when the offer closes for investment.

<protect> Request

Filter name Filter type Possible values
offer_close Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

offer_close=2015-01-15

</protect>

Response

Element name Multi-value Value type
offer_close no date

XML response sample:

<offer_close>2015-01-15</offer_close>

Offer Open Date

The date when the offer opens for investment.

<protect> Request

Filter name Filter type Possible values
offer_open Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

offer_open=2012-01-15

</protect>

Response

Element name Multi-value Value type
offer_open no date

XML response sample:

<offer_open>2012-01-15</offer_open>

Date Added

Date the product has been added,

<protect> Request

Filter name Filter type Possible values
submitted Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

submitted=2012-01-15

</protect>

Response

Element name Multi-value Value type
submitted no date

XML response sample:

<submitted>2012-01-15</submitted>

Date Updated

Date the product has been updated,

<protect> Request

Filter name Filter type Possible values
updated Date range ISO 8610 format date (YYYY-MM-DD)

Request sample

updated=2013-05-01,2013-05-02

</protect>

Response

Element name Multi-value Value type
updated no datetime (YYYY-MM-DD hh:mm:ss according to ISO 8610)

XML response sample:

<updated>2013-05-01 10:15:00</updated>

Barrier Level

Barrier level

<protect> Request

Filter name Filter type Possible values
barrier Number range float

Request sample

barrier=10.5

</protect>

Response

Element name Multi-value Value type
barrier yes float

XML response sample:

<barriers>
  <barrier>10.5</barrier>
</barriers>

Capital Return

Capital return

<protect> Request

Filter name Filter type Possible values
capital_return Number range float

Request sample

capital_return=10.5,11.5

</protect>

Response

Element name Multi-value Value type
capital_return no float

XML response sample:

<capital_return>10.8</capital_return>

Annualized Capital Return

Annualized Capital Return

<protect> Request

Filter name Filter type Possible values
capital_return_an Number range float

Request sample

capital_return_an=10.5,12

</protect>

Response

Element name Multi-value Value type
capital_return_an no float

XML response sample:

<capital_return_an>11.5</capital_return_an>

Headline Rate

Headline Rate

<protect> Request

Filter name Filter type Possible values
headline_rate Number range float

Request sample

headline_rate=10.5,11.55

</protect>

Response

Element name Multi-value Value type
headline_rate no float

XML response sample:

<headline_rate>11.5</headline_rate>

Minimum Return

Minimum return in percents

<protect> Request

Filter name Filter type Possible values
minimum_return Number range float

Request sample

minimum_return=50,100

</protect>

Response

Element name Multi-value Value type
minimum_return no positive float number

XML response sample:

<minimum_return>75</minimum_return>

Participation Rate

Participation Rate

<protect> Request

Filter name Filter type Possible values
participation_rate Number range float

Request sample

participation_rate=100,150.5

</protect>

Response

Element name Multi-value Value type
participation_rate no float

XML response sample:

<participation_rate>140.5</participation_rate>

Term

The length of investment of the product, in years.

<protect> Request

Filter name Filter type Possible values
term Number range float

Request sample

term=4.5,5.5

</protect>

Response

Element name Multi-value Value type
term no float

XML response sample:

<term>4</term>

Volume Sold USD

Volume Sold in US dollars

<protect> Request

Filter name Filter type Possible values
volume_usd Number range float

Request sample

volume_usd=20.1,20.9

</protect>

Response

Element name Multi-value Value type
volume_usd no float
volume_usd_public no string, yes/no
volume_usd_type no string, actual/estimate

XML response sample:

<volume_usd>20.5</volume_usd>
<volume_usd_public>yes</volume_usd_public>
<volume_usd_type>actual</volume_usd_type>

Exercise

Exercise

Response

Element name Multi-value Value type
exercise yes object
  date no date
  payout no float
  type no string, call/put

XML response sample:

<exercises>
  <exercise>
    <date>2012-01-15</date>
    <payout>109.45</payout>
    <type>call</type>
  </exercise>
</exercises>

Digital Coupon

The digital coupon captures the coupon amount for digital products in all situations. It is a non-negative percentage value.

Response

Element name Multi-value Value type
digital_coupon yes object
  level no float

XML response sample:

<digital_coupons>
  <digital_coupon>
    <level>10</level>
  </digital_coupon>
</digital_coupons>

Fixed Coupon

The fixed coupon captures the amount of fixed coupon offered by a product before its maturity. We can have fixed coupon 1 to denote the first period coupon, fixed coupon 2 for the second period and so on.

Response

Element name Multi-value Value type
fixed_coupon yes object
  level no float

XML response sample:

<fixed_coupons>
  <fixed_coupon>
    <level>10</level>
  </fixed_coupon>
</fixed_coupons>

Coupon Strike

The coupon strike records the strike level that triggers the payment of a digital coupon. It is a non-negative percentage value. <protect> This information is linked to the payoff type 'digital' only. </protect>

Response

Element name Multi-value Value type
coupon_strike yes object
  level no float

XML response sample:

<coupon_strikes>
  <coupon_strike>
    <level>10</level>
  </coupon_strike>
</coupon_strikes>

KnockIn trigger frequency

For products having a protected tracker payoff types (or knock-in options), we state how often such trigger level is being observed during the investment. It can either take the value of "continuously" or "at discrete intervals"

Response

Element name Multi-value Value type
knockin_frequency no string 'continuously' / 'at discrete intervals'

XML response sample:

<knockin_frequency>4</knockin_frequency>

Final Rebate

The products final rebate amount

Response

Element name Multi-value Value type
final_rebate no float

XML response sample:

<final_rebate>0</final_rebate>

Estimated Intial Value

The products estimated initial value amount

Response

Element name Multi-value Value type
flo_est_initial_value no float

XML response sample:

<flo_est_initial_value>0</flo_est_initial_value>