GET: Industries

Ingrid

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

Retrieve information about industries, along with their most recent ratings.

Parameters

expand

[Query] Additional rating details, including risk vector letter grades.

Value: [String] rating_details

show_all

[Query] Include industries that are independent from your portfolio.

Value: [Boolean] true = Show all industries.

add_sub_industries

[Query] Filter by sub-industries.

Value: [Boolean] true = Include sub-industries for each industry.

Example Request

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

Example Response

{
  "industries":[
    {
      "id":10,
      "rating":690,
      "href":"https://api.bitsighttech.com/ratings/v1/industries/Utilities",
      "name":"Utilities",
      "slug":"utilities"
    }
  ],
  "rating_date":"2020-01-19"
}

Response Attributes

Field			Description
industries Array			Industries in your portfolio.
	Object		An industry.
		id Integer	The identification number of this industry.
		rating Integer	The current average security rating of portfolio companies in this industry.
		href String [`URL`]	A detailed history of security ratings of this industry.
		name String	The name of this industry.
		slug String [`Slug`]	The slug name of this industry.
rating_date String [`YYYY‑MM‑DD`]			The most recent date for available industry ratings.

January 21, 2020: Published.