// QUICKSTART

register an account

No card. Free public sandbox — 100 calls/month (fair use).

curl -X POST http://localhost:3001/v1/account/register \
  -H 'content-type: application/json' \
  -d '{"email":"you@example.com"}'

// response includes api_key shown ONCE — save it

score a single address

Cached lookup against any address SybilShield has scored before.

curl http://localhost:3001/v1/score/0xa12b00000000000000000000000000000000c4d7 \
  -H "Authorization: Bearer $YOUR_KEY"

create a batch analysis

Submit 10K–1M addresses → scores + clusters + evidence.

curl -X POST http://localhost:3001/v1/analyses \
  -H "Authorization: Bearer $YOUR_KEY" \
  -H 'content-type: application/json' \
  -d '{"name":"first","chains":["ethereum"],"addresses":["0x...","0x..."]}'

// status: pending → ingesting → analyzing → scoring → complete

poll or use webhook

For longer analyses configure webhook URL at /dashboard/api-keys.

curl http://localhost:3001/v1/analyses/$ID \
  -H "Authorization: Bearer $YOUR_KEY"

fetch scored results

Paginated. Filter by label.

curl "http://localhost:3001/v1/analyses/$ID/results?label=sybil&limit=100" \
  -H "Authorization: Bearer $YOUR_KEY"

// or export full CSV: /v1/analyses/:id/results/export