likidodefi/riskstate-docs

O que riskstate-docs faz?

API de risco pré-negociação para cripto — governança de exposição BTC/USD e ETH/USD. Consciente de spot, perpétuos e DeFi. Mais de 30 sinais, mecanismo de política de 5 níveis.

Visão Geral

A skill riskstate-docs fornece endpoints REST para verificação de risco antes de executar ordens em mercados de criptomoedas. Ela processa sinais de mercado em tempo real e aplica políticas configuráveis para classificar o risco de transações.

Principais Características

• 30+ sinais de risco: volatilidade, liquidez, spread, profundidade de livro de ordens, financiamento de perpétuos, correlação, exposição DeFi, etc.
• Mecanismo de política de 5 níveis:
  • low (baixo): risco aceitável, ordem permitida.
  • medium (médio): alerta, ordem permitida com monitoramento.
  • high (alto): ordem permitida apenas com confirmação explícita.
  • critical (crítico): ordem bloqueada automaticamente.
  • extreme (extremo): bloqueio total, requer intervenção manual.
• Suporte a múltiplos instrumentos: BTC/USD, ETH/USD, e pares relacionados (spot, perpétuos, pools DeFi).
• API REST simples: integração fácil com agentes de IA via chamadas HTTP.

Como Usar

Endpoints

1. Consultar risco de uma ordem

POST /risk/check

Exemplo de corpo da requisição:

{
  "asset": "BTC",
  "side": "buy",
  "size": 1.5,
  "market": "spot",
  "reference_price": 65000
}

Resposta:

{
  "risk_level": "high",
  "signals": [
    {
      "name": "volatility_24h",
      "value": 0.15,
      "threshold": 0.10,
      "status": "triggered"
    },
    {
      "name": "liquidity_spread",
      "value": 0.02,
      "threshold": 0.05,
      "status": "ok"
    }
  ],
  "policy_action": "require_confirmation"
}

2. Listar sinais disponíveis

GET /signals

Retorna a lista completa de sinais configurados para o par ativo.

3. Configurar política

PUT /policy

Atenção: Requer autenticação. Permite ajustar limites de risco dinamicamente.

Plataformas Suportadas

• Spot: exchanges centralizadas (CEX) como Binance, Coinbase, Kraken.
• Perpétuos (perps): mercados de futuros perpétuos (dYdX, Bybit, OKX).
• DeFi: pools de liquidez em Uniswap, Curve, Balancer, Compound.

Variáveis de Ambiente

Variável	Descrição	Obrigatória
RISKSTATE_API_KEY	Chave de API para autenticação	Sim
RISKSTATE_ENDPOINT	URL base da API (ex: https://api.riskstate.io)	Sim
RISKSTATE_POLICY	Nível de política padrão (low, medium, high, critical, extreme)	Não

Exemplo de Uso com Agente de IA

import requests

# Configuração
api_key = "sua_chave_aqui"
endpoint = "https://api.riskstate.io"

# Verificar risco de ordem
order = {
    "asset": "ETH",
    "side": "sell",
    "size": 10.0,
    "market": "perp"
}

response = requests.post(
    f"{endpoint}/risk/check",
    json=order,
    headers={"Authorization": f"Bearer {api_key}"}
)

if response.status_code == 200:
    data = response.json()
    if data["risk_level"] == "low":
        print("Risco baixo. Executar ordem.")
    elif data["risk_level"] == "high":
        print("Risco alto. Solicitar confirmação.")
    else:
        print("Ordem bloqueada.")

Contribuição

Consulte o repositório em likidodefi/riskstate-docs para relatar problemas ou enviar PRs.

Licença

MIT