Get started

SDKs & samples

The Partner API is small enough that a hand-rolled HTTP client is the right choice for most teams — no SDK lock-in. Two official thin wrappers (Python + Go) handle retries, exponential backoff, and signature verification if you'd rather not.

Official SDKs

Python
qorbom
pip install qorbom Source on GitHub
Go
github.com/qortrace/qorbom-go
go get github.com/qortrace/qorbom-go Source on GitHub
Community SDKs. Node, Ruby, Rust, and PHP libraries are maintained by the community. They aren't audited by QorBOM — review the source before depending on them.

First call with the SDK

import os
from qorbom import Client

q = Client(api_key=os.environ["QORBOM_KEY"])

# Submit + wait (handles polling for you, default timeout 90s)
scan = q.scans.create_and_wait(
    repo_url="https://github.com/octocat/Hello-World"
)

print(scan.score, scan.findings_total)

# CycloneDX BOM as a dict
bom = q.scans.bom(scan.id, format="cyclonedx")
print(bom["bomFormat"], bom["specVersion"])

Or just plain HTTP

Every endpoint is a single request. See Quickstart for curl, Python (requests), Node (axios), and Go (net/http) recipes without any SDK dependency.

Postman collection

A pre-built Postman 2.1 collection is available on the interactive API reference page — click Export → Postman. The collection includes a sandbox environment with all required headers + a working example for every endpoint.

Step 1 of 4

Navigate by section

The left rail groups every page in the QorBOM Partner API docs. Click any link to jump straight there — Quickstart, Authentication, Webhooks, and more.