Index Objects
Returns the requested Index object describing the index and its performance. The index object includes up to 100 leading stocks within the index. It also includes information to place the index in the hierarchy; an array of sub-indcies and the parent index where appropriate.
Properties
| Name | Code | Type | Description |
|---|---|---|---|
| ID | id | number | The index ID |
| Name | name | string | The title of the index |
| Code | code | string | A unique string used as an ID for the index |
| Title | title | ||
| Image | tw_profile_image | string | The URL to the Twitter profile image of the top stock |
| Background | tw_background_image | string | The URL to the Twitter background image of the top stock |
| Value | value | float | The average value of the top 100 stocks in the index |
| Movement | movement | float | The average movement of the top 100 stocks in the index |
| Change | change | float | The average change of the top 100 stocks in the index |
| Parent | parent_index | index object | The parent index object |
| Charts | charts | array of chart objects or an emp | An array of chart objects ordered by timespan, starting with the smallest span |
| Stocks | stocks | array of stock objects or an emp | Up to 100 of the top performing stocks in the index |
| Sub Indices | sub_indices | array of index objects or an emp | An array of the sub indices |
| Full | full | boolean | Indicates if the index is to be dealt with as the complete data, a value of true is given when the index is accessed directly, and false is given when the index object is used within an array eg. sub_indices |
Objects
The Index object is present under the following endpoints