Packages

GET/packages/search?q={query}

Search the public package database by name or keyword.

curl "https://binshieldapi-production.up.railway.app/packages/search?q=bcrypt"

GET/packages/{ecosystem}/{name}

Retrieve full analysis for a specific package.

curl "https://binshieldapi-production.up.railway.app/packages/npm/bcrypt"

GET/packages/{ecosystem}/{name}/versions/{version}

Retrieve analysis for a specific version of a package.

curl "https://binshieldapi-production.up.railway.app/packages/npm/bcrypt/versions/6.0.0"

GET/packages/{ecosystem}/{name}/versions/{version}/sbom

Export a CycloneDX 1.5 SBOM for a specific package version.

curl "https://binshieldapi-production.up.railway.app/packages/npm/bcrypt/versions/6.0.0/sbom"

GET/packages/browse

Browse all surfaced packages with pagination and filters.

curl "https://binshieldapi-production.up.railway.app/packages/browse?limit=20&offset=0"

Scans

POST/scans

Submit a new binary scan. Returns a scan ID for polling.

curl -X POST "https://binshieldapi-production.up.railway.app/scans" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BINSHIELD_API_KEY" \
  -d '{"ecosystem":"npm","package":"bcrypt","version":"6.0.0"}'

GET/scans/{scanId}

Poll scan status and results. Status progresses: queued -> processing -> complete.

curl "https://binshieldapi-production.up.railway.app/scans/scan_abc123" \
  -H "Authorization: Bearer $BINSHIELD_API_KEY"

GET/scans/{scanId}/report

Retrieve the full structured report for a completed scan.

curl "https://binshieldapi-production.up.railway.app/scans/scan_abc123/report" \
  -H "Authorization: Bearer $BINSHIELD_API_KEY"

Organizations

GET/orgs/me

Retrieve the authenticated organization profile and usage summary.

curl "https://binshieldapi-production.up.railway.app/orgs/me" \
  -H "Authorization: Bearer $BINSHIELD_API_KEY"

GET/orgs/me/api-keys

List API keys for the authenticated organization.

curl "https://binshieldapi-production.up.railway.app/orgs/me/api-keys" \
  -H "Authorization: Bearer $BINSHIELD_API_KEY"

POST/orgs/me/watchlists

Add a package to the organization watchlist for version-change alerts.

curl -X POST "https://binshieldapi-production.up.railway.app/orgs/me/watchlists" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $BINSHIELD_API_KEY" \
  -d '{"ecosystem":"npm","package":"sharp"}'

Billing

GET/billing/usage

Current billing period usage, scan counts, and plan limits.

curl "https://binshieldapi-production.up.railway.app/billing/usage" \
  -H "Authorization: Bearer $BINSHIELD_API_KEY"

POST/billing/portal

Generate a Stripe customer portal link for plan management.

curl -X POST "https://binshieldapi-production.up.railway.app/billing/portal" \
  -H "Authorization: Bearer $BINSHIELD_API_KEY"

API Reference