Instrument Analytics

Preview

Instrument Analytics

+ Day(s) remaining in the trial

Overview

Leverage IBM Algorithmics' sophisticated financial models to price and compute analytics on securities.

Getting started

Where Do I Find A List Of Instruments?

To get the analytics for a given instrument, choose from this [list of instruments.](http://public.dhe.ibm.com/software/analytics/solutions/en/fintech/Sample_Instrument_Universe.xlsx)

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
 

Documentation

Instrument Analytics:

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}

			https://ibm.com/api/v1/instrument/{id}
		
Keys
Path and Query parameters

id

URL , required

instrument ID

Request code
								
HttpResponse<String> response = Unirest.post("https://ibm.com//api/v1/instrument/{id_string}") .header("accept", "application/json") .header("x-ibm-access-token", "REPLACE_KEY_VALUE") .body("{\"analytics\":[null]}") .asString();
Request model

analytics

ARRAY , optional

list of analytics

Request example
{
  "analytics": []
}
Response model

200

Success. The results include an annary of analytics for the instrument.

Body

instrument

STRING , optional

ID of the instrument.

scenario

STRING , optional

Name of the scenario.

values [Value]

ARRAY , optional

The list of values that the instrument has taken.

date

STRING , optional

The fixed point in time, formatted as "%Y/%m/%d".

value

STRING , optional

The value of a specific analytic, such as the price.

400

The request format is wrong.

Body

error

STRING , optional

Error message

401

The request is not authenticated.

Body

error

STRING , optional

Error message

405

The requested method is not allowed.

Body

error

STRING , optional

Error message

500

An internal error has occured.

Body

error

STRING , optional

Error message

Response example

200

Success. The results include an annary of analytics for the instrument.

								[{
  "instrument" : string,
  "scenario" : string,
  "values" : [{
    "date" : string,
    "value" : string
  }]
}]
							

400

The request format is wrong.

								{
  "error" : string
}
							

401

The request is not authenticated.

								{
  "error" : string
}
							

405

The requested method is not allowed.

								{
  "error" : string
}
							

500

An internal error has occured.

								{
  "error" : string
}
							
Get analytics for multiple instruments
Returns the value for the specified analytics for all of the specified instruments.

POST   /api/v1/instruments

			https://ibm.com/api/v1/instruments
		
Keys
Request code
								
HttpResponse<String> response = Unirest.post("https://ibm.com//api/v1/instruments") .header("accept", "application/json") .header("content-type", "application/json") .header("x-ibm-access-token", "REPLACE_KEY_VALUE") .body("{\"analytics\":[null],\"instruments\":[null]}") .asString();
Request model

compute_request

OBJECT , optional

Specifies the parameters to use when computing analytics on securities

instruments

ARRAY , required

Array of instrument IDs, up to a maximum of 500 IDs.

analytics

ARRAY , optional

Array of analytics. If this parameter is not set, the theoretical price will be used.

Request example
[{
  "compute_request": {
    "instruments": [],
    "analytics": []
  }
}]
Response model

200

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

Body

instrument

STRING , optional

ID of the instrument.

scenario

STRING , optional

Name of the scenario.

values

ARRAY , optional

The list of values that the instrument has taken.

date

STRING , optional

The fixed point in time, formatted as '%Y/%m/%d'.

value

STRING , optional

The value of a specific analytic, such as the price.

400

The request format is wrong.

Body

error

STRING , optional

Error message

401

The request is not authenticated.

Body

error

STRING , optional

Error message

405

The requested method is not allowed.

Body

error

STRING , optional

Error message

500

An internal error has occured.

Body

error

STRING , optional

Error message

Response example

200

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

								{
  "instrument" : string,
  "scenario" : string,
  "values" : [{
    "date" : string,
    "value" : string
  }]
}
							

400

The request format is wrong.

								{
  "error" : string
}
							

401

The request is not authenticated.

								{
  "error" : string
}
							

405

The requested method is not allowed.

								{
  "error" : string
}
							

500

An internal error has occured.

								{
  "error" : string
}
							
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}

			https://ibm.com/api/v1/instrument/{id}
		
Keys
Path and Query parameters

analytics

STRING , optional

comma-separated list of analytics

id

URL , required

instrument ID

Request code
								
HttpResponse<String> response = Unirest.get("https://ibm.com//api/v1/instrument/{id_string}?analytics=string") .header("accept", "application/json") .header("content-type", "application/json") .header("x-ibm-access-token", "REPLACE_KEY_VALUE") .asString();
Response model

200

Success. The results contains the instrument ID, scenario, and an array of analytics for a given instrument.

Body

instrument

STRING , optional

ID of the instrument.

scenario

STRING , optional

Name of the scenario.

values [Value]

ARRAY , optional

The list of values that the instrument has taken.

date

STRING , optional

The fixed point in time, formatted as "%Y/%m/%d".

value

STRING , optional

The value of a specific analytic, such as the price.

400

The request format is wrong.

Body

error

STRING , optional

Error message

401

The request is not authenticated.

Body

error

STRING , optional

Error message

405

The requested method is not allowed.

Body

error

STRING , optional

Error message

500

An internal error has occured.

Body

error

STRING , optional

Error message

Response example

200

Success. The results contains the instrument ID, scenario, and an array of analytics for a given instrument.

								[{
  "instrument" : string,
  "scenario" : string,
  "values" : [{
    "date" : string,
    "value" : string
  }]
}]
							

400

The request format is wrong.

								{
  "error" : string
}
							

401

The request is not authenticated.

								{
  "error" : string
}
							

405

The requested method is not allowed.

								{
  "error" : string
}
							

500

An internal error has occured.

								{
  "error" : string
}
							

Loading content...

Resources