Documentation

from settlerisk import SettleRiskClient

client = SettleRiskClient(
    key_id="vx_yourkey_123",
    secret="your-base64-secret",
)

# Get risk score for any market
score = client.get_risk_score("polymarket", "0xabc123")

print(f"Risk Score: {score['aggregate_risk_score']}/100")
print(f"Tier: {score['risk_tier']}")
print(f"P(Dispute): {score['p_dispute']:.1%}")
print(f"Drivers: {len(score['drivers'])}")
for d in score['drivers']:
    print(f"  - {d['driver_type']}: {d['points_contribution']} pts")

# Settlement delay estimate
delay = client.get_expected_delay("polymarket", "0xabc123")
print(f"Median delay: {delay['delay_distribution']['p50_hours']}h")
print(f"P90 delay: {delay['delay_distribution']['p90_hours']}h")

# Evaluate custom rules (no existing market needed)
result = client.evaluate_rules({
    "platform": "polymarket",
    "rules_text": "Resolves YES if BTC reaches $100,000 by Dec 31.",
    "resolution_sources": ["https://coingecko.com"],
})
print(f"Risk: {result['aggregate_risk_score']} ({result['risk_tier']})")

# Dispute-adjusted pricing
pricing = client.price({
    "platform": "polymarket",
    "platform_market_id": "0xabc123",
    "mid_price": 0.65,
    "position_side": "YES",
    "position_notional_usd": 10000,
    "annual_capital_cost_apr": 0.12,
})
print(f"Fair price:  {pricing['adjusted_fair_price']:.4f}")
print(f"Risk premium: {pricing['risk_premium']:.4f}")
print(f"Fair spread:  {pricing['fair_spread_bps']} bps")

# Batch — score up to 1,000 markets at once
batch = client.batch_risk_scores([
    {"platform": "polymarket", "platform_market_id": "0xabc"},
    {"platform": "kalshi", "platform_market_id": "KXBTC-26FEB12"},
])

from settlerisk import (
    SettleRiskClient,
    RateLimitError,
    NotFoundError,
    AuthenticationError,
)

client = SettleRiskClient(key_id="...", secret="...")

try:
    score = client.get_risk_score("polymarket", "0xabc")
except NotFoundError:
    print("Market not in SettleRisk database yet")
except RateLimitError as e:
    print(f"Rate limited. Retry after: {e.retry_after}s")
except AuthenticationError:
    print("Check your key_id and secret")

import { SettleRiskClient } from "settlerisk";

const client = new SettleRiskClient({
  keyId: "vx_yourkey_123",
  secret: "your-base64-secret",
});

// Get risk score for any market
const score = await client.getRiskScore("polymarket", "0xabc123");

console.log(`Risk Score: ${score.aggregate_risk_score}/100`);
console.log(`Tier: ${score.risk_tier}`);
console.log(`P(Dispute): ${(score.p_dispute * 100).toFixed(1)}%`);
console.log(`Drivers: ${score.drivers.length}`);
for (const d of score.drivers) {
  console.log(`  - ${d.driver_type}: ${d.points_contribution} pts`);
}

// Settlement delay estimate
const delay = await client.getExpectedDelay("polymarket", "0xabc123");
console.log(`Median delay: ${delay.delay_distribution.p50_hours}h`);
console.log(`P90 delay: ${delay.delay_distribution.p90_hours}h`);

// Evaluate custom rules (no existing market needed)
const result = await client.evaluateRules({
  platform: "polymarket",
  rules_text: "Resolves YES if BTC reaches $100,000 by Dec 31.",
  resolution_sources: ["https://coingecko.com"],
});
console.log(`Risk: ${result.aggregate_risk_score} (${result.risk_tier})`);

// Dispute-adjusted pricing
const pricing = await client.price({
  platform: "polymarket",
  platform_market_id: "0xabc123",
  mid_price: 0.65,
  position_side: "YES",
  position_notional_usd: 10000,
  annual_capital_cost_apr: 0.12,
});
console.log(`Fair price:  ${pricing.adjusted_fair_price.toFixed(4)}`);
console.log(`Risk premium: ${pricing.risk_premium.toFixed(4)}`);
console.log(`Fair spread:  ${pricing.fair_spread_bps} bps`);

// Batch — score up to 1,000 markets at once
const batch = await client.batchRiskScores([
  { platform: "polymarket", platform_market_id: "0xabc" },
  { platform: "kalshi", platform_market_id: "KXBTC-26FEB12" },
]);

import {
  SettleRiskClient,
  RateLimitError,
  NotFoundError,
  AuthenticationError,
} from "settlerisk";

const client = new SettleRiskClient({ keyId: "...", secret: "..." });

try {
  const score = await client.getRiskScore("polymarket", "0xabc");
} catch (err) {
  if (err instanceof NotFoundError) {
    console.log("Market not in SettleRisk database yet");
  } else if (err instanceof RateLimitError) {
    console.log(`Rate limited. Retry after: ${err.retryAfter}s`);
  } else if (err instanceof AuthenticationError) {
    console.log("Check your keyId and secret");
  }
}