Reference Guide - Product feed

From SRP API Docs

Product feed

There are three main actions which can be performed on products. Actions can be performed only if user has privileges for the particular action. All users with a valid PublicApiKey and PrivateApiKey can retrieve products, but only users with an SRPUltraFeed license can insert, update or delete products.

Retrieving products

Simple way to retrieve products:

GET https://api.structuredretailproducts.com/v1/products/products

This will return 500 latest products in XML format.

In addition, product filters can be applied:

GET https://api.structuredretailproducts.com/v1/products?market=MK0012&style=continuous

This will return the most recent 500 latest continuous UK products.

Sample response:

<?xml version="1.0" encoding="UTF-8"?>
<products>
  <status code="0">OK</status>
  <list count="500" from="0" to="149" total="150">
    <product>
      <id>ID3674102</id>
      <name>FTSE Kickout Bond Issue 9</name>
      ...
    </product>
    <product>
      <id>ID3674099</id>
      <name>Protected Capital Plus Account 14</name>
      ...
    </product>
  </list>
</products>

<protect>

Inserting/updating products

Not implemented </protect>

<protect>

Deleting products

Not implemented </protect>

Ordering options

Products can be ordered by these parameters:

Parameter name Description
submitted Date added
launch Launch/strike date
offer_close Offer close date
maturity Maturity date

For how to use ordering please go here

Sample:

order=maturity&direction=asc

Return columns

StructuredRetailProducts.com API will return all fields the user can access. By default all user accessible fields will be returned.

Parameter name Description
include Includes only selected fields
exclude excludes selected fields from accessible fields

Request sample

include=id,name,provider-name

Note: empty fields will be returned as empty strings.

Please note: All fields are available to be retrieved, however it is recommended that calls are placed using only the required fields. This ensures speedier request processing and cleaner data sets.

Available fields

Available field names can be found by using response block definition in the Product properties section.

For top level properties the field name is the same as the element name. If the property belongs to an object, field name must be prefixed with the object element name using a single dash (-) as a separator.

For example Third party has such response:

Response

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

Available fields for it is :

  • thirdparty to return all fields of third party object
  • thirdparty-name to return the name of third party
  • thirdparty-code to return the code of third party

For example some fields names for Market:

  • market to return all fields of market object
  • market-country to return all fields of market country object
  • market-country-name to return the name of market country

<protect> TODO: add a method in API which will return user accessible fields list. E.g. /v1/user/product-fields </protect>