Market overview and indices
fp_indicesRetrieve Tehran and Farabourse market summaries and rank up to 70 market and industry indices by return period, with optional name filtering.
Instructions
Show the Tehran and Farabourse market summary and rank the 65 market and industry indices by return.
Use for "how is the bourse today", "which industries are up this year", "what is the total index". Each index has an ins_code: pass it to fp_index_history for its daily values. The first block is the market overview.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Indices to return. | |
| query | No | Part of an index name, Persian, e.g. 'شاخص کل', 'بانک', 'خودرو', 'فلزات'. | |
| sort_by | No | Ranking column; returns are percent over that period. | daily |