Metadata
Index groups
Returns a list of all index groups
query Parameters
languageA string that indicates the language in which to return the response. More information can be found here.
formatA string value that specifies what type of format to provide the response.
Headers
AuthorizationThe Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.
Index groups › Responses
OK
NameName of the index group.
IDNumeric id used to identify a group of related indices.
AscendingBit that describes the direction of the index value. When true, the poorest value is 0, best value is 10. When false, the poorest value is 10, best value is 0.
DescriptionA text value that provides detail about the index group.
Index metadata by group id
Returns indices and associated metadata that are defined in a specific group using group id.
path Parameters
groupIDA numerical value representing a group of related indices. More information can be found here.
query Parameters
languageA string that indicates the language in which to return the response. More information can be found here.
formatA string value that specifies what type of format to provide the response.
Headers
AuthorizationThe Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.
Index metadata by group id › Responses
OK
NameName of the index group.
IDNumeric id used to identify the specific index group.
AscendingBit that describes the direction of the index value. When true, the poorest value is 0, best value is 10. When false, the poorest value is 10, best value is 0.
DescriptionA text value that provides detail about the index group.
Index metadata
Returns all indices and associated metadata
query Parameters
languageA string that indicates the language in which to return the response. More information can be found here.
formatA string value that specifies what type of format to provide the response.
Headers
AuthorizationThe Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.
Index metadata › Responses
OK
NameName of the index group.
IDNumeric id used to identify the specific index group.
AscendingBit that describes the direction of the index value. When true, the poorest value is 0, best value is 10. When false, the poorest value is 10, best value is 0.
DescriptionA text value that provides detail about the index group.
Index metadata by index Id
Specify an index ID to get metadata for that index.
path Parameters
indexIDA numerical value used to identify a specific index. More information can be found here.
query Parameters
languageA string that indicates the language in which to return the response. More information can be found here.
formatA string value that specifies what type of format to provide the response.
Headers
AuthorizationThe Authorization header is used to authenticate using your API key. Format is Bearer YOUR_API_KEY.
Index metadata by index Id › Responses
OK
NameName of the index group.
IDNumeric id used to identify the specific index group.
AscendingBit that describes the direction of the index value. When true, the poorest value is 0, best value is 10. When false, the poorest value is 10, best value is 0.
DescriptionA text value that provides detail about the index group.