Predictive Market Scenarios

Preview

Predictive Market Scenarios

+ Day(s) remaining in the trial

Overview

The Predictive Market Scenarios service generates a predictive financial market scenario based on a change to a specified risk factor. This analysis is most commonly used to generate an alternate state of market conditions that can be used as input parameters to financial pricing models. For example, you can use this service to determine how interest rates, FX rates, and equity prices may react to a 5% decline in the price of oil. This scenario can then be applied to an investment portfolio using the financial models contained within the Simulated Instrument Analytics service.

Security

Keys

Pick a key to use with this API. Make sure you are logged in with your IBM id for your keys to be populated in the dropdown below. By selecting a key, it will be pre-filled for each endpoint in the Documentation section that can be used with the built-in testing. If you want to change which key to use for a particular endpoint, you can do so at the endpoint in the Documentation section.
You can manage your API keys in the <MyAPIs> section. API keys authenticate you to your subscription, so make sure to keep them secret. Do not share the X-IBM-Client-Secret portion of any API key in publicly accessible places such as GitHub, or client-side code.



Manage your keys
 

Global Parameters

This section contains global variables, which apply to all of the endpoint definitions of this API. You can use this section to set these variables once, and have the values pre-filled for every endpoint in the Documentation section. The values set can be used with the built-in testing. You can always override the value in the endpoint definition of the Documentation section.
Global variables

Documentation

Predictive Market Scenarios:

Generate a scenario

Generate a scenario
Generate a scenario
This operation generates a scenario file in CSV format based on a given risk factor and the change to that factor. Use this operation to create a scenario to be applied to an investment portfolio using the Simulated Instrument Analytics service.

POST   /api/v1/scenario/generate_predictive

			{hostname}/api/v1/scenario/generate_predictive
		
Keys
Global variables

hostname

BASEURL , required

Request code
								
HttpResponse<String> response = Unirest.post("https://ibm.com//api/v1/scenario/generate_predictive") .header("accept", "text/csv") .header("content-type", "application/json") .header("x-ibm-access-token", "REPLACE_KEY_VALUE") .asString();
Request model

risk_factor

STRING , optional

ID of the risk factor

shock

DOUBLE , optional

Ratio of the new to old values of the risk factor

Request example
[{
  "risk_factor": "undefined",
  "shock": undefined
}]
Response model

200

Successful operation. Returns the generated scenario CSV file.

Body

object , optional

400

Invalid request format.

Body

object , optional

401

Request not authenticated.

Body

object , optional

405

Requested method not allowed.

Body

object , optional

500

An internal error has occured.

Body

object , optional

Response example

200

Successful operation. Returns the generated scenario CSV file.

								{
  "" : object
}
							

400

Invalid request format.

								{
  "" : object
}
							

401

Request not authenticated.

								{
  "" : object
}
							

405

Requested method not allowed.

								{
  "" : object
}
							

500

An internal error has occured.

								{
  "" : object
}
							

Loading content...

Resources