Reference Guide - Product filters Admin

From SRP API Docs

Product filters

<protect> Todo: remove tables from the list.

Suggestion: We could consider ";" as a separator instead of "," as "," is used as numbers separator. </protect>

To customize your product search results you can use filters.

Filters are a key/value pairs in the request url where the key is the filter name and the value is the filter value.

Free value filters

Free value filters allow you to do an exact search by selected property. If filter allows multiple values then they must be comma (",") separated.

Available filters are:

Name Description Multi-value Type
id Unique product number yes string, 9 bytes, starting with ID prefix. E.g. ID0024721
name Product name no string
isin ISIN code yes string
wkn WKN code yes string
cusip CUSIP code yes string
commision Sales Commission no string

Predefined value filters

Predefined value filters allow you to do an exact search by selected property where the value is equal to selected from predefined values.

All predefined values are specified in Product properties section.

Predefined value filters can have single or multiple values. Multiple values must be comma (",") separated.

Filter format:

?filter1Name=filter1Value&filter2Name=filter2Value1,filter2Value2

Available predefined value filters are:

Name Description Multi-value Possible values
flow Specify the type of products yes, max 2 flow/not_flow/leverage
live Specify if a product is live or has expired no yes/no
provider Specify which company is issuing the product yes, max 15 Providers
provider_group Specify which group the provider belongs to yes, max 10 Provider groups
thirdparty Provider third parties yes, max 15 Providers
bond_provider Product's bond providers yes, max 15 Providers
bp_public Display rule for Bond Provider no yes/no
market Markets the product is linked to yes, max 10 Markets
wrapper Wrapper yes, max 20 Wrappers
local_payoff Local Payoff yes, max 20 Payoffs
currency Currency yes, max 3 Currencies
volume_type When the volume sold is actual or estimate no actual/estimate
public Whether the volume for that product is public or not no yes/no
category Product Category yes, max 3 Categories
style Product Style no tranche/continuous
expiry_type Give the status of the expiry date, if it is an estimate or the actual one no actual/estimate
structure Product Structure (fund type). This field is continuous specific yes, max 10 Structure
type Product Type no growth/income/growth_and_income'
payoff Payoff yes, max 20 Payoffs
income Income Type no fixed/variable/mixed
capital_return_type Capital Return Actual or Estimate no actual/estimate
distribution_channel Distribution Channel yes, max 3 Distribution channels
counterparties Derivatives Counterparties yes, max 15 Derivative counterparties
dc_public Whether the Derivative Counterparty is public information or not no yes/no
rating Rating agencies yes, max 10 Rating Agencies
tax_status Tax Status yes, max 2 Tax statuses
exchange Exchange where the product is listed yes, max 5 Exchanges
du_interest whether the product is worth having on a single separate line on the daily update no yes/no
asset_class Asset class yes, max 5 Asset classes
wrapper_group Wrapper group yes, max 10 Wrapper groups
underlying Underlying yes, max 50 Underlyings

Range value filters

Range value filters allow you to search by selected property where the value is in selected the range.

There are 4 scenarios where range filters can be used. Syntax differs depending on filter selected, as below:

  • Range From-To - when both lower limit and upper limit are specified. Returns products where property value is equal or greater than lower_limit and property value is equal or less than upper_limit:
filter_name=lower_limit,upper_limit
  • Range From - when only lower limit is specified. Returns products where property value is equal or greater than lower_limit:
filter_name=lower_limit,null
  • Range To - when only upper limit is specified. Returns products where property value is equal or less than upper_limit:
filter_name=null,upper_limit
  • Range Exact - when lower limit is equal to upper limit. Returns products where property value is equal to exact_value:
filter_name=exact_value


Date filters

Date property filters are Range filters.

All dates must be in ISO 8610 format (YYYY-MM-DD).

Available date filters are:

Name Description
expiry Product expiry date
final_index Final Index Date
initial_strike Initial strike Date
knockout Date when a knockout can be expected
launch Continuous Product launch date
maturity Maturity Date
offer_close Offer Close date
offer_open Offer Open date
submitted Date the product has been aded

Sample date filters:

  • Products which expire in February 2012
expiry=2012-02-01,2012-02-29
  • Products which mature on 1st of February 2012 or later
maturity=2012-02-01,null
  • Products which mature on 1st of February 2012 or earlier
maturity=null,2012-02-01
  • Products which mature on 1st of February 2012
maturity=2012-02-01

Number range filters

Number range filters:

Name Description Type
barrier Barrier level float
capital_return Capital Return float
capital_return_an Annualised Capital Return float
headline_rate Headline Rate float
minimum_return Minimum Return, a percentage float
participation_rate Participation Rate float
strike_level Values of specific underlyings levels float
term Term in years float
volume The volume sold of that product float
volume_usd Volume Sold in US dollars float

Sample number filters:

  • Products with minimum return between 75 and 100 percents inclusive
minimum_return=75,100
  • Products with minimum return equal to 100 percents or greater
minimum_return=100,null
  • Products with minimum return equal to 50 percents or less
minimum_return=null,50
  • Products with minimum return equal to 100 percents
minimum_return=100

Aggregated filters

TODO: change section name and description Apart from standard filters, API accepts aggregated filters.

Available aggregated filters are:

Name Description Multi-value no
section Product section no string, current/continuous/leverage/flow/recent/maturing