Introduction

The Simulated Instrument Analytics service supports the 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.

Authentication

You authenticate to the API by using IAM. You can pass either a bearer token in an Authorization header or an apikey. Tokens support authenticated requests without embedding service credentials in every call. API keys use basic authentication. Learn more about IAM.

If you are using Simulated Instrument Analytics and you are also using Managed Financial Data as the data provider service, follow the steps that are described in Connecting to IBM Managed Financial Data API.

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

Compute mark-to-market for one or more instruments

Returns the values for the requested analytics for a given instrument.

GET /v2/mtm/{id-type}
Request

Path Parameters

  • ID Type

    Allowable values: [isin,sedol,ric]

Query Parameters

  • One or more instrument IDs. Separate IDs with commas.

  • Specify a three-letter currency code for reporting purposes.

Response

Status Code

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

  • The request requires you to specify the API key in the request. Please refer to the Getting Started page for Simulated Instrument Analytics and resubmit.

  • The API key wasn't recognized. Verify that your API key is correct and resubmit.

  • The requested resource could not be found. See the error for more details

  • The requested method is not allowed.

  • Unexpected error. Contact your Simulated Instrument Analytics administrator. See the error for more details

Example responses

Compute analytics for multiple instruments

Returns the value for the specified analytics for all of the specified instruments using a given scenario, for a specific date, and for specific time steps. If no analytics are specified, the theoretical price is returned.

POST /v2/simulate
Request

Query Parameters

  • Set to CSV, BIN, or JSON (default)

  • Specify a three-letter currency code for reporting purposes.

Form Parameters

  • Within an id-list structure, specify one or more pairs of id and type for each instrument that you want to simulate. type is one of ric, sedol, or isin. id is the ID of the instrument as it specified for the type.

  • Analytics

    Allowable values: [Price,Clean Price,Dirty Price,Value,Exposure,Yield,Profit and Loss,Return,Adjusted Duration,Effective Duration,Macaulay Duration,Monetary Duration,Convexity,Effective Convexity,Monetary Convexity,Implied Spread,Delta,Rho,Gamma,Theta,Vega]

  • The name of a predefined scenario set that is provided by IBM.

  • Specify days (triggers) using an array of numbers. Corresponds to a distinct point in time at which the problem is measured and computed. The value may be either 30 (in 30 days) or 0 (current time). If timestep is not specified, the default is 0.

  • Specify a date in YYYY-MM-DD format.

Response

Status Code

  • Success. Returns results for each valid instrument ID and the value for each specified analytic. Additional analytics specified in the request body are also returned in the result.

  • The request format is wrong.

  • The request is not authenticated.

  • The requested method is not allowed.

  • An internal error has occured.

Example responses