GET: Security Ratings History of an Industry – Bitsight Knowledge Base

https://api.bitsighttech.com/ratings/v1/industries/industry_slug

Get a 1-year security ratings history of a particular industry.

Parameters

Parameter Values

industry_slug

[Path] Identify the industry to query.

[String] Industry slug name. Use GET /v1/industries?add_sub_industries=true&show_all=true.

Example Request

Visiting the industry URI found in the Industries overview endpoint.

curl https://api.bitsighttech.com/ratings/v1/industries/technology -u api_token:

Example Response

The server returns an array of objects containing individual rating_date and rating subkeys, ordered by most recent to least recent.

{
  "name":"Technology",
  "ratings":[
    {
      "rating":700,
      "rating_date":"2024-01-07",
      "percentile_10":650,
      "percentile_90":780
    },
    […]
  ],
  "company_distribution":[
    {
      "min":250,
      "max":399,
      "percent":0.29
    },
    […]
  ]
}

Response Attributes

Field			Description
name String			The industry name.
ratings Array			The industry’s rating and percentile details on particular dates.
	Object		Details by date.
		rating Integer	The average security rating for the industry on this day.
		rating_date String [`YYYY-MM-DD`]	The date.
		percentile_10 Integer	Companies who are at the 10% among all ratings in the industry.
		percentile_90 Integer	Companies who are at the 90% among all ratings in the industry.
company_distribution Array			The distribution of companies in the Bitsight inventory from that industry.
	Object		The distribution of companies by rating range.
		min Integer	The minimum rating in this range.
		max Integer	The maximum rating in this range.
		percent Decimal	The percent of the total number of companies (including companies that are independent from your portfolio) and are in this rating range.

January 10, 2024: percentile_10 & percentile_90.
January 20, 2020: Published.

Parameters

Example Request

Example Response

Response Attributes

Related articles