shareco
Watch your first BOM

DOCS

API docs for watched BOM data.

A lightweight public reference for teams that want alerts and BOM risk state outside the ShareCo UI.

Read the technical writeup

Authentication

API keys are generated inside app settings. v1 uses bearer tokens for server-to-server reads and webhook registration.

Authorization: Bearer shc_live_...

BOM endpoints

Read BOMs and their normalized watch state.

  • GET /v1/boms - list BOMs
  • GET /v1/boms/:id - read one BOM

Part status endpoint

Fetch the current known risk state for one manufacturer part number.

GET /v1/parts/:mpn

{
  "mpn": "MCU-47B",
  "lifecycle": "nrnd",
  "last_checked_at": "2026-05-24T09:18:00Z"
}

Alert stream

Read recent lifecycle, stock, lead-time, and price-drift alerts.

  • GET /v1/alerts - list recent alerts
  • POST /v1/webhooks - register a webhook URL

Versioning

These v1 docs are hand-written. OpenAPI-backed docs ship after the private app API stabilizes.