Quickstart Guide

Five steps from signup to your first production-grade risk assessment.

1. Create an Account

2. Get Your API Key

A sandbox key is auto-generated. Find it under Portal → Developers → API Keys. Rotate at any time.

export EOSYN_API_KEY="sk_sandbox_5a1b..."

3. Make Your First Call

Install the Python SDK and call the risk endpoint.

pip install eosyn

import eosyn, os
client = eosyn.Client(api_key=os.environ["EOSYN_API_KEY"])
result = client.risk.get(lat=51.5074, lng=-0.1278, peril="flood")
print(result.risk_score, result.confidence)

4. Understand the Response

Every response carries a confidence score, model version, and provenance for audit.

{
  "risk_score": 0.72,          // 0.0 - 1.0
  "confidence": 0.942,          // model confidence
  "peril": "flood",
  "model_version": "flood-v2.3.1",
  "provenance": {
    "sources": ["sentinel-1", "sentinel-2", "elevation-eu-dem"],
    "as_of": "2026-07-01T00:00:00Z"
  }
}

5. Go Live

Ready to move from sandbox to production? Contact us to enable production keys, sign a Data Processing Agreement, and configure rate limits.

Request production access →

pip install eosyn import eosyn, os client = eosyn.Client(api_key=os.environ["EOSYN_API_KEY"]) result = client.risk.get(lat=51.5074, lng=-0.1278, peril="flood") print(result.risk_score, result.confidence)

4. Understand the Response

Every response carries a confidence score, model version, and provenance for audit.

{
  "risk_score": 0.72,          // 0.0 - 1.0
  "confidence": 0.942,          // model confidence
  "peril": "flood",
  "model_version": "flood-v2.3.1",
  "provenance": {
    "sources": ["sentinel-1", "sentinel-2", "elevation-eu-dem"],
    "as_of": "2026-07-01T00:00:00Z"
  }
}