Each endpoint in the Bitsight API 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.
- Overview
- Client/Vendor Access Program
- Alerts
- Companies
- Company Relationships
- Company Requests
- Customers
- Current Ratings
- Defaults
- Exposed Credentials
- Folders
- Industries
- Insights
- News
- Peer Analytics
- Portfolio
- Rapid Underwriting Assessments
- Reports
- Risk Remediation Plan
- Subscriptions
- Territories
- Threats
- Tiers
- Users
Overview
/
Find out the resources available to you through the API (Companies, Industries, Alerts, Subscriptions).
Client/Vendor Access Program
Manage your collaboration efforts via the Client/Vendor Access Program.
Alerts
Returns alerts that are generated for all companies in your portfolio(s).
Client Access Links
Manage your registration forms for clients to register for collaborating via the Client/Vendor Access Program.
Companies
Get information about a company (including companies your organization and companies in your portfolio) and manage company information.
Company Relationships
Get the company relationship details of your organization.
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
Manage your Company API tokens.
Current Ratings
Current ratings of an entity or all portfolio entities.
Defaults
Get static Bitsight data, such as:
- Rating category ranges.
- Bitsight risk vectors.
- The Bitsight platform color schemes.
Exposed Credentials
View exposed credentials leaks and affected companies in your portfolio.
Folders
Create, edit, and delete your folders; add and remove vendors and insureds to and from those folders.
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
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
Get the most recent news on data breaches.
Peer Analytics
Peer Analytics is an analytics tool that provides an objective, data-driven comparison between companies and peer groups.
Portfolio
/portfolio
- Continuous Monitoring – Returns vulnerabilities, open ports, and botnet infections in your portfolio; and additional details about each portfolio company.
- National Cybersecurity – 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
Quickly get rating details for any mapped or unmapped company within 1 minute.
Reports
Download either of the following reports:
Risk Remediation Plan
/companies/{company_guid}/risk-remediation-plan
Generate, retrieve, and manage Risk Remediation Plans for a company. Plans identify and prioritize findings to improve risk vector grades toward an A.
Run a Risk Remediation Plan – Create a new base or custom plan run for a given risk vector.
Risk Remediation Plan Details by Risk Vector – Retrieve a completed plan in JSON or CSV format.
Scheduling a Risk Remediation Plan – Manage plan settings, selections, and scheduled runs.
Running a Risk Remediation Forecast – Generate forecast timelines projecting future grade improvements based on a plan.
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
Bitsight data for territories.
Threats
Threats include vulnerabilities and vulnerability groups.
Tiers
Configure your tiers and the companies within them.
Users
Retrieve a list of all Bitsight Security Ratings Platform user accounts in your organization.
- August 31, 2026: Added Risk Remediation Plan
- October 23, 2024: Added table of contents.
-
March 1, 2024: Added
/threats. -
February 12, 2024: Added
/client-access-links.
Comments
Please sign in to leave a comment.