Describe an instrument
describe_assetRead-onlyIdempotent
What one instrument is and how it has done, in aggregate.
An equity, ETF, fund or bond, by id from ``find_assets``. Returns return,
annualised return, volatility and maximum drawdown over the standard windows,
the six factor tilts against the universe and a few company fundamentals, all in
the client's currency including the exchange rate. No prices or raw data.
A section that does not apply (factor tilts for a fund, a 3Y window for a recent
listing) comes back absent with the reason; absent means unknown, not zero. It
describes the instrument and makes no recommendation. Several instruments at
once, such as a screen's companies, are one ``describe_assets`` call.
The card charts the return since the first price, against a comparison the
client picks. The points stay out of the result unless ``series_in_context``
asks for them.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"asset_id": "<asset_id>"
},
"name": "describe_asset"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| asset_id | Yes | ||
| series_in_context | No |