GET: Current Ratings

Ingrid

https://api.bitsighttech.com/ratings/v1/current-ratings

Get your active Current Ratings, which provides a 24-hr snapshot of a company’s rating.

Vendor Risk Assessment Data Service (VRADS)

Parameters

See query parameters for details on the limit (default: ↻ 100) and offset (default: ↻ 100) parameters.

Example Request

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

Example Response

{
  "links":{
    "next":"https://api.bitsighttech.com/ratings/v1/current-ratings?limit=100&offset=100",
    "previous":null
  },
  "count":123,
  "summaries":{
    "rating_as_of":"2023-10-04"
  },
  "results":[
    […]
    {
      "guid":"9ecd7b7e-42b4-4d32-99e8-1b65e59b0774",
      "name":"Frontstore, Inc.",
      "rating":690,
      "rating_category":"intermediate"
    }
  ]
}

Response Attributes

Field			Description
links Object			Navigation for multiple pages of results. See pagination.
	next String		The URL for navigating to the next page of results.
	previous String		The URL for navigating to the previous page of results.
count Integer			The number of entities.
summaries Object			When the rating was calculated.
	rating_as_of String [`YYYY-MM-DD`]		When the rating was calculated.
results Array			The ratings of entities in your portfolio.
	Object		An entity.
		guid String [`entity_guid`]	The unique identifier of this entity in your portfolio.
		name String	The name of this entity.
		rating Integer	The current Bitsight Security Rating of this entity.
		rating_category String	The rating category.

Response Codes

200 – Okay: Everything worked as expected.
401 – Unauthorized: No valid API token was provided.
403 – Permission Denied: You do not have permission to access this resource.
404 – Not Found: The specified resource could not be found.
default: Unexpected error.

August 26, 2024: Defined Current Ratings license.
October 5, 2023: Published.