IBM Cloud API Docs

Introduction

The Instrument Analytics service supports the current computation of the theoretical or market calibrated valuation, and all relevant associated analytics, for investment securities such as equities, fixed income, and derivatives.

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 a small number of analytics for a single instrument

Get the values of any number of analytics for a given instrument. If no analytics are specified, the theoretical price will be computed. Use this for small number of analytics.

GET /api/v1/instrument/{id}

Request

Path Parameters

  • id
    Required*
    string

    instrument ID

Query Parameters

  • analytics
    string

    comma-separated list of analytics

  • curl --request GET --url 'https://fss-analytics.mybluemix.net/api/v1/instrument/{id}?analytics=string' -header 'accept: application/json' --header 'content-type: application/json' --header 'x-ibm-access-token: REPLACE_KEY_VALUE'

Response

Response Body

AnalyticsResponse

Status Code

  • 200

    Success. The results contains the instrument ID, scenario, and 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 a large number of analytics for a single instrument

Returns the value for all of the requested analytics for a given instrument. Use this call for a large number of analytics.

POST /api/v1/instrument/{id}

Request

Path Parameters

  • id
    Required*
    string

    instrument ID

Request Body

string[]

list of analytics

  • curl --request POST --url https://fss-analytics.mybluemix.net/api/v1/instrument/{id} --header 'accept: application/json' --header 'content-type: application/json' --header 'x-ibm-access-token: REPLACE_KEY_VALUE'

Response

Response Body

AnalyticsResponse

Status Code

  • 200

    Success. The results include an annary of analytics for the 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.

POST /api/v1/instruments

Request

Request Body

object

Specifies the parameters to use when computing analytics on securities

  • curl --request POST --url https://fss-analytics.mybluemix.net/api/v1/instruments --header 'accept: application/json' --header 'content-type: application/json' --header 'x-ibm-access-token: REPLACE_KEY_VALUE'

Response

Response Body

Resp2130760_root

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.