- April 29, 2022: Added
/peer-analytics. - January 19, 2022: Added
/exposed-credentials. - October 15, 2021: Added
/territories.
Each endpoint returns objects and information related to the resource. See a summary overview of endpoints as used when appended to the API request URL https://api.bitsighttech.com/ratings below. Visit the associated articles for endpoint-specific information.
| Topic | Endpoint | Description |
|---|---|---|
| Overview |
/ |
Find out the resources available to you through the API (Companies, Industries, Alerts, Subscriptions). |
| Enable Access Program |
/access-requests |
Manage your collaboration efforts via the Enable Access Program. |
| Alerts |
/alerts |
Returns alerts that are generated for all companies in your portfolio(s). |
| Companies |
/companies |
Get information about a company (including companies your organization and companies in your portfolio) and manage company information. |
| Company Relationships |
/company-relationships |
Get the company relationship details of your organization. |
| Company Requests |
/company-requests |
Check the status of Bitsight Security Rating Report requests, check subscriptions for a company by domain, and modify subscriptions via the API. |
| Customers |
/customers |
Manage your Company API tokens. |
| Defaults |
/defaults |
Get static Bitsight data, such as:
|
| Exposed Credentials |
/exposed-credentials |
View exposed credentials leaks and affected companies in your portfolio. |
| WFH Findings |
/findings/wfh |
Use Work From Home (WFH) to get findings for a set of IP addresses. |
| Folders |
/folders |
Create, edit, and delete your folders; add and remove vendors and insureds to and from those folders. |
| Industries |
/industries |
Returns the industry rating for all industries that are categorized by Bitsight; get the last 12 months of ratings for a specific industry. |
| Insights |
/insights?company=GUID&start=YYYY-MM-DD&end=YYYY-MM-DD |
Retrieves the significant rating change data of a requested company. The information fetched by this endpoint includes the initial and final rating of a company over a certain range of time, the reason behind the rating change, and the percentile change of the company’s rating. |
| News |
/news |
Get the most recent news on data breaches. |
| Peer Analytics |
/peer-analytics |
Peer Analytics is an analytics tool that provides an objective, data-driven comparison between companies and peer groups. |
| Portfolio |
/portfolio |
Returns vulnerabilities, open ports, and botnet infections in your portfolio; and additional details about each portfolio company. |
| Portfolio for National Cybersecurity |
/portfolio |
Returns vulnerabilities, open ports, and botnet infections in your National Cybersecurity portfolio; geographical distribution of portfolio IP addresses; and additional details about each company in the portfolio. |
| Rapid Underwriting Assessments |
/fast-ratings |
Quickly get rating details for any mapped or unmapped company within 1 minute. |
| Reports |
/reports |
Get a single company’s Bitsight Security Rating Report (PDF). The report includes the information presented in the company’s Overview and Rating Details pages, statistics information, and remediation instructions for Compromised Systems events. |
| Subscriptions |
/subscriptions |
Get information about your current subscriptions, quota remaining.
Access control to most resources and functions will be limited to customer admins for Enterprise customers or all users for Insurance customers who have unlimited quotas. Bulk add companies to your portfolio using their website URLs or Bitsight GUIDs if you have them. |
| Territories |
/territories |
Bitsight data for territories. |
| Tiers |
/tiers |
Configure your tiers and the companies within them. |
| Users |
/users |
Retrieve a list of all Bitsight Security Ratings Platform user accounts in your organization. |