// Developer experience · Headless capableAPI v3.8.4

API-first. Built for engineers who demand deterministic pipelines.

Every action BrokerOS performs is available via our standard REST endpoints and Webhook event streams. Trigger autonomous tendering, extract parsed load JSON, or query carrier reliability scores programmatically.

Transport
REST + Webhooks
Specification
OpenAPI 3.1
Webhook signing
HMAC-SHA256
Rate limit
5,000 req / min
// Quickstart

From raw request to committed load

The ingest endpoint is the front door. Post whatever your customer sent; BrokerOS returns the structured load, how confident it is, the lane benchmark, and where the order landed in your TMS.

  1. 1

    Authenticate

    Requests are scoped to your brokerage's workspace, so one tenant can never read another's loads.

  2. 2

    Post the request

    Send the unstructured payload to the ingest endpoint over TLS 1.3.

  3. 3

    Read the response

    Use the confidence score to decide whether to auto-route the load or hold it for a rep's review.

POST /v1/loads/ingest.json
200 OK · 18ms
{
  "id": "LD-20481",
  "status": "PARSED_CONFIRMED",
  "confidence_score": 0.987,
  "lane": {
    "origin": "Montreal, QC",
    "destination": "Chicago, IL",
    "mileage": 848.2
  },
  "equipment": {
    "type": "53' Flatbed",
    "tarp": true,
    "weight_lbs": 44500
  },
  "pricing": {
    "shipper_target_rate": "$3,450.00",
    "dat_index_benchmark": "$3,412.50",
    "currency": "USD"
  },
  "tms_sync": {
    "target": "MCLEOD_LOADMASTER",
    "remote_order_id": "ORD-991823",
    "state": "COMMITTED"
  }
}
// Core resources

What you can drive headlessly

The same operations your brokers perform in the BrokerOS workspace, exposed for your own systems and automations.

  • POST

    Ingest a load

    Send an unstructured request — an email body, a PDF rate con, a pasted message — and receive a structured, validated load with a confidence score and TMS sync state.

  • POST

    Trigger a tender

    Start autonomous waterfall tendering for a structured load, using the tier rules and margin floors configured in your workspace.

  • GET

    Read parsed load JSON

    Fetch any load as JSON, including the lane, equipment, pricing benchmark, and the audit trail linking each field to its source text.

  • GET

    Query carrier reliability

    Pull the carrier scorecard — on-time performance, fallback rate, claim frequency — to drive your own routing or reporting.

// Webhook event stream

State changes, pushed to you

Representative events. Each delivery is signed with HMAC-SHA256 so your endpoint can verify it came from BrokerOS.

load.parsed
A new request was structured and validated
load.needs_review
A required field is missing or below confidence threshold
tender.bid_received
A carrier replied to an active tender
tender.awarded
A broker awarded the load and the rate con was issued
tracking.geofence
A truck entered or left a pickup, delivery or checkpoint geofence
tracking.exception
Predicted ETA slipped past the appointment window
// Platform guarantees

Built for production workloads

  • HMAC-SHA256 Signatures

    Every incoming webhook payload is cryptographically signed, preventing replay attacks and payload tampering. Verify the signature against your endpoint secret before trusting a payload.

  • Swagger / OpenAPI 3.1

    Machine-readable OpenAPI specs let you generate client SDKs in Go, TypeScript, Python, and C#, or import the collection straight into your API client.

  • 5,000 req / min Rate Limit

    High-throughput token buckets engineered for high-volume brokerage dispatch and batch ingest workloads.

  • Event streams, not polling

    Subscribe to load, tender and tracking events and let BrokerOS push state changes to you as they happen.

Headless & API-first

Build on BrokerOS.

Tell us what you want to connect and we'll walk your engineers through the spec.

  • ✓ OpenAPI 3.1 spec
  • ✓ Signed webhooks
  • ✓ 5,000 req / min