Skip to content
Structured Products

List Structured Products

Returns the structured products on sale that the Client can buy, such as FCN and SAN, filtered by the given conditions. Each item includes the coupon, strike and knock-out levels, tenor, and underlyings. Call it when the Client opens the product list or changes filters. You can use the codes in underlying to query quote changes for the product card.

When the Client taps a product, call GET /v2/wms/product/detail with its counter_id.

POSThttps://api.lbkrs.com/v1/wms/product/list

Request body application/json

filtersarray<object>required

Filter conditions. Pass an empty array for no filtering. Include only dimensions that have selected values

Child attributes
keystringrequired

Filter dimension key from filters[].key of GET /v1/wms/product/info

valuesarray<object>required

Selected values in the dimension

Child attributes
valuestringrequired

Selected filter value

titlestring

Display name of the filter value. Optional

Responses

HTTP 200The request succeeded. The response body contains the result of the “List Structured Products” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
productsarray<object>

Products. Empty when no product matches

Child attributes
counter_idstring

Structured product code used to query details and place orders

idea_idstring

Product idea ID

instrument_namestring

Product name

subject_titlestring

Product display title. Show instrument_name when empty

product_typestring

Product type, such as FCN or SAN

currencystring

Product currency

coupon_ratestring

Coupon rate

coupon_2_ratestring

Second-stage conditional coupon rate. Empty when the product has no tiered coupon

strike_levelstring

Strike level, as a percentage of the initial price

ko_levelstring

Knock-out level, as a percentage of the initial price

tenor_numberstring

Tenor value. Show it with tenor_unit

tenor_unitstring

Tenor unit

underlyingarray<string>

Underlying security codes. Use them to query quote changes. Codes starting with TN are non-public underlyings, such as treasuries, and have no security detail page

keywordsarray<object>

Key elements shown on the product card

Child attributes
keystring

Element key that identifies the element type. underlying_name is the underlying name and can link to the security detail. underlying_counter_id is for association only and is not displayed

titlestring

Element label

contentstring

Element display value

linkstring

Link associated with the element. May be empty

link_typestring

Link type:

  • pdf - Open link as a PDF file
  • direct - Open link directly
Whale Docs