reference

The complete list of risk factor classifications used in the risk factors endpoint.

get/stocks/taxonomies/vX/risk-factors

Query parameters

taxonomynumber double

Version identifier (e.g., '1.0', '1.1') for the taxonomy Value must be a floating point number.

taxonomy.gtnumber double

Filter greater than the value. Value must be a floating point number.

taxonomy.gtenumber double

Filter greater than or equal to the value. Value must be a floating point number.

taxonomy.ltnumber double

Filter less than the value. Value must be a floating point number.

taxonomy.ltenumber double

Filter less than or equal to the value. Value must be a floating point number.

primary_categorystring

Top-level risk category

primary_category.any_ofstring

Filter equal to any of the values. Multiple values can be specified by using a comma separated list.

primary_category.gtstring

Filter greater than the value.

primary_category.gtestring

Filter greater than or equal to the value.

primary_category.ltstring

Filter less than the value.

primary_category.ltestring

Filter less than or equal to the value.

secondary_categorystring

Mid-level risk category

secondary_category.any_ofstring

Filter equal to any of the values. Multiple values can be specified by using a comma separated list.

secondary_category.gtstring

Filter greater than the value.

secondary_category.gtestring

Filter greater than or equal to the value.

secondary_category.ltstring

Filter less than the value.

secondary_category.ltestring

Filter less than or equal to the value.

tertiary_categorystring

Most specific risk classification

tertiary_category.any_ofstring

Filter equal to any of the values. Multiple values can be specified by using a comma separated list.

tertiary_category.gtstring

Filter greater than the value.

tertiary_category.gtestring

Filter greater than or equal to the value.

tertiary_category.ltstring

Filter less than the value.

tertiary_category.ltestring

Filter less than or equal to the value.

limitinteger

Limit the maximum number of results returned. Defaults to '200' if not specified. The maximum allowed limit is '1000'.

sortstring

A comma separated list of sort columns. For each column, append '.asc' or '.desc' to specify the sort direction. The sort column defaults to 'taxonomy' if not specified. The sort order defaults to 'desc' if not specified.

Response

A list of results.

next_urlstring

If present, this value can be used to fetch the next page.

request_idstring required

A request id assigned by the server.

status'OK' required

The status of this request's response.