brin
get started

Quickstart

Start scoring context with brin in under a minute

brin has two interfaces: a REST API available today, and a CLI coming soon.

##API

No auth, no signup. A single GET request returns a score and verdict.

Bash
# npm package
curl https://api.brin.sh/npm/express
 
# PyPI package
curl https://api.brin.sh/pypi/requests
 
# Domain
curl https://api.brin.sh/domain/example.com

Response:

JSON
{
  "score": 85,
  "verdict": "safe",
  "confidence": "high"
}

##CLI

Bash
npm install -g brin
Bash
brin check npm/express
JSON
{
  "score": 85,
  "verdict": "safe",
  "confidence": "high"
}

##If the artifact isn't in the database

brin returns a preliminary score immediately and queues a full scan in the background. Pass a webhook URL to be notified when it completes:

Bash
curl "https://api.brin.sh/npm/some-package?webhook=https://your-server.com/callback"

##Next steps