IBM Cloud API Docs

Introduction

The Simulated Historical Instrument Analytics service supports the historical computation of the theoretical or market calibrated valuation, and all relevant associated analytics, for investment securities such as equities, fixed income, and derivatives over an alternate set of market conditions.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 response always indicates success. A 400 type response is some sort of failure, and a 500 type response usually indicates an internal system error.

Methods

Get analytics for a single instrument

Returns the values of a list of analytics for an instrument at a given date with a given scenario. If no analytics are specified, the theoretical price will be returned.

POST /api/v1/scenario/historical/instrument/{id}

Request

Custom Headers

  • EncType
    Required*
    string

    set the value to be multipart/form-data

Path Parameters

  • id
    Required*
    string

    instrument ID

Query Parameters

  • date
    Required*
    string

    date used to compute the instrument value

  • curl --request POST --url 'https://fss-analytics.mybluemix.net/api/v1/scenario/historical/instrument/{id}?date=string' --header 'accept: application/json' --header 'content-type: multipart/form-data' --header 'enctype: string' --header 'x-ibm-access-token: REPLACE_KEY_VALUE'

Response

Response Body

AnalyticsResponse

Status Code

  • 200

    Success. The results include an array of analytics for a given instrument.

  • 400

    The request format is wrong.

  • 401

    The request is not authenticated.

  • 405

    The requested method is not allowed.

  • 500

    An internal error has occured.

No Sample Response

This method does not specify any sample responses.

Get analytics for multiple instruments

Returns the value for the specified analytics for all of the specified instruments on a given date. If no analytics are specified, the theoretical price is returned.

POST /api/v1/scenario/historical/instruments

Request

Custom Headers

  • EncType
    Required*
    string

    Set the value to multipart/form-data because the endpoint requires a file to be uploaded.

Query Parameters

  • date
    Required*
    string

    Date used to compute the instruments' values

  • curl --request POST --url 'https://fss-analytics.mybluemix.net/api/v1/scenario/historical/instruments?date=string' --header 'accept: application/json' --header 'content-type: multipart/form-data' --header 'enctype: string' --header 'x-ibm-access-token: REPLACE_KEY_VALUE'

Response

Response Body

AnalyticsResponse

Status Code

  • 200

    Success. Returns an array of results for each valid instrument ID and the value for each specified analytic.

  • 400

    The request format is wrong.

  • 401

    The request is not authenticated.

  • 405

    The requested method is not allowed.

  • 500

    An internal error has occured.

No Sample Response

This method does not specify any sample responses.