API and SDK Terms
These terms add to the Terms of Service for anyone who uses the BreachSpider API, the breachspider Python SDK, the BreachSpider MCP server (the breachspider-mcp package or the hosted connector) or the embeddable widget.
1. The client software
The Python SDK and the MCP server package are published under the MIT License, which governs the code itself. Using them to call BreachSpider is governed by these terms, because the code is a client for the service.
2. Keys and access
- API keys belong to an organization and are created and revoked by its members from a signed-in session. Keep them out of source code, logs, tickets and shared screens. Revoke a key as soon as you think it has been exposed.
- Give keys an expiry where you can (30, 90 or 365 days). Expired and revoked keys are refused.
- Trial keys are read-only and end with the trial. Partner keys are limited to the endpoints in the partner agreement.
- Connected apps (hosted MCP) act for the person who approved them and can be disconnected from Integrations at any time.
3. Limits
Each key has request limits and an allowance that depend on the plan; current usage is reported in response headers and in Settings. Calls over a limit are refused with a retry hint. Do not spread traffic over several keys or accounts to avoid limits. Large inventories go through batch jobs, not loops of single calls.
4. What you send
- Send device facts: vendor, product, version, part number and a neutral asset id such as
PLC-01. - Do not send host names, IP or MAC addresses, serial numbers, email addresses, user names or site names. The device check endpoints refuse device fields that contain an IP or MAC address, email address, serial number or user name, and the MCP server also refuses host names and site names; the field is named and the value is never echoed or stored.
- The stateless device check and Windows check endpoints do not save the devices or hosts you send. Batch jobs keep their inputs and results for 30 days (or the period set for the key) so you can collect the results.
5. Versioning and changes
The API follows the BreachSpider versioning and breaking-change policy: everything under /api/v1/ is stable; new fields, objects, warning codes and enum values can appear at any time, so clients must ignore unknown fields and tolerate new values; a breaking change gets a new version and notice before the old one is retired.
6. Using the results
- You may use API results inside your organization, and inside products you build for your own customers if your agreement allows it.
- Keep the citations: when you show a finding to someone else, keep its source and advisory link and its assessment (for example "needs review" or "partial coverage"). Never present an empty, unresolved or partial result as meaning a device has no vulnerabilities.
- Do not store results to build a copy of the BreachSpider catalog, or redistribute the catalog, findings or lifecycle data in bulk, without a written agreement.
- Do not imply that BreachSpider endorses your product, or use the BreachSpider name or logo beyond saying truthfully that your product uses BreachSpider data, without our written permission.
7. The widget
A site that embeds the BreachSpider widget must keep the widget's attribution and source links visible and must not change what it says about a result. Device checks made through the widget count against the partner's key.
8. Security
Report vulnerabilities in the API, SDK, MCP server or widget under the disclosure policy. Do not load-test or scan the API.
9. Suspension and ending
We may throttle or suspend a key that breaks these terms or puts the service at risk, and tell the key's organization. You may stop using the API at any time; revoke your keys when you do.
