instrument
Retrieve market coverage or detailed analytics for any financial instrument. Filter by asset class or status, or search by symbol for performance metrics and risk profile.
Instructions
The instrument catalog, or one instrument's dossier.
Without symbol: the catalog of covered markets - name, venue, asset
class, status - filterable by asset_class (equity, crypto,
index, commodity) or status. Use for "which markets do you
cover?", "list your crypto instruments".
With symbol: the dossier - identity (name, venue, currency, sector)
plus stats, the analytics summary: buy-and-hold facts (cagr,
ann_vol, max_dd, time_underwater_pct) and the six-axis character
fingerprint (radar, with verdict). stats is null for freshly added
instruments. Case-insensitive: AAPL finds AAPL.US; a venue-suffixed
id (RY.TO) pins one listing. Use for "what do you know about AAPL?",
"how volatile is BTC?".
For strategies backtested on the instrument, use leaderboard with the
same symbol.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | ||
| offset | No | ||
| status | No | ||
| symbol | No | ||
| asset_class | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||