Operator API · v1

Consent-bound integration, documented end to end.

Use the machine contract, fixed privacy allowlist and operational guides below. API access requires an environment-specific BOT client certificate; the sandbox contains synthetic data only.

Download OpenAPI 3.1.1 Download AsyncAPI

AI implementation promptsCopy safe prompts for your integration backend Operator guideRead the canonical guide Sandbox, review, and productionRead the canonical guide Field catalogue and privacy allowlistRead the canonical guide Consent and revocationRead the canonical guide mTLS certificatesRead the canonical guide Webhook setup and operationsRead the canonical guide Versioning and deprecationRead the canonical guide

From idea to production

One visible path, with an explicit final activation.

Register securely.Verify your email, create a passkey, and store the one-time recovery codes.
Accept the current terms.The standard API license is non-commercial. Ads and every other monetization require a separate written agreement; mixed-source output needs item-level BOT attribution.
Describe the integration.Add purpose, public policies, logo, linking URL, scopes, and the required BOT credit.
Build in the sandbox.Use an environment-specific certificate and only synthetic orders, histories, revocations, vehicles, and statistics.
Submit for review.BOT reviews the exact profile and scopes. Material changes create a new review version.
Activate deliberately.After approval, the owner uses the prominent production activation button; approval alone never releases data.
Operate and delete safely.Poll with cursors and ETags, process tombstones immediately, and acknowledge deletion.

Follow the complete operator guide Create an operator account

Required BOT credit

Copy this into your public footer. The script renders an accessible badge with the original BOT app logo and the wording “Data provided by Boring Order Tracker with user consent”. It sets no cookies, contains no analytics, and makes no background requests other than loading this versioned script and the BOT logo.

<footer>
  <span data-bot-attribution data-bot-theme="auto"></span>
  <script src="https://integration.boringordertracker.com/assets/bot-data-credit-v1.js" referrerpolicy="no-referrer" defer></script>
</footer>

Set data-bot-theme to auto, light, or dark. Keep referrerpolicy="no-referrer" so the partner page URL is not sent with the asset request. If you omit the placeholder, place the script directly in the footer and the badge is inserted beside it. Loading the script more than once is safe and does not duplicate a rendered badge.

Mixed-source output still needs point-of-display attribution. This footer badge is the required site-wide credit, but it does not replace labelling every BOT-derived record, table value, map point, chart value, or export directly where that item is displayed. A footer alone is not enough.

Reference implementations

curl PHP Node.js Python

Production access requires manual BOT approval and a separate owner activation. A sandbox certificate can never access production data.

Consent-bound integration, documented end to end.

One visible path, with an explicit final activation.

Add the versioned, tracker-free footer badge.

Reference implementations