Index groups
Returns a list of all index groups
query Parameters
languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usformatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
Namestring · minLength: 1 · requiredName of the index group.
IDinteger · int32 · requiredNumeric id used to identify a group of related indices.
AscendingbooleanBit 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.
Descriptionstring | nullA 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
groupIDstringA numerical value representing a group of related indices. More information can be found here.
Example: 1
query Parameters
languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usformatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
Namestring · minLength: 1 · requiredName of the index group.
IDinteger · int32 · requiredNumeric id used to identify the specific index group.
Ascendingboolean · requiredBit 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.
Descriptionstring · minLength: 1 · requiredA text value that provides detail about the index group.
Index metadata
Returns all indices and associated metadata
query Parameters
languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usformatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
Namestring · minLength: 1 · requiredName of the index group.
IDinteger · int32 · requiredNumeric id used to identify the specific index group.
Ascendingboolean · requiredBit 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.
Descriptionstring · minLength: 1 · requiredA 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
indexIDstringA numerical value used to identify a specific index. More information can be found here.
Example: 29
query Parameters
languagestringA string that indicates the language in which to return the response. More information can be found here.
Default: en-usformatstringA string value that specifies what type of format to provide the response.
Default: json
Headers
Authorizationstring · requiredThe
Authorizationheader is used to authenticate using your API key. Format isBearer YOUR_API_KEY.
Responses
OK
Namestring · minLength: 1 · requiredName of the index group.
IDinteger · int32 · requiredNumeric id used to identify the specific index group.
Ascendingboolean · requiredBit 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.
Descriptionstring · minLength: 1 · requiredA text value that provides detail about the index group.