cripsy-binary-api 0.2.0

API moderna multibroker para opciones binarias (Rust, sync y async)
Documentation
# cripsy_binary_API

![cripsy_binary_API: cliente Rust para la API de IQ Option](https://raw.githubusercontent.com/ionixcorp/cripsy_binary_API/master/docs/assets/banner.svg)

[![Licencia: MIT](https://img.shields.io/badge/licencia-MIT-blue.svg)](LICENSE)
[![Rust 1.86+](https://img.shields.io/badge/rust-1.86%2B-orange.svg)](https://www.rust-lang.org)
[![Documentación](https://img.shields.io/badge/docs-GitHub%20Pages-blue.svg)](https://ionixcorp.github.io/cripsy_binary_API/)
[![CI](https://github.com/ionixcorp/cripsy_binary_API/actions/workflows/ci.yml/badge.svg)](https://github.com/ionixcorp/cripsy_binary_API/actions)
[![crates.io](https://img.shields.io/crates/v/cripsy-binary-api.svg)](https://crates.io/crates/cripsy-binary-api)
[![docs.rs](https://img.shields.io/docsrs/cripsy-binary-api.svg)](https://docs.rs/cripsy-binary-api)

Librería cliente en Rust para la API de IQ Option. Proporciona una interfaz para
la sesión, el catálogo de activos, las velas históricas, el stream de velas y
ticks, y el envío de órdenes clásicas, digitales y blitz. El mismo motor se
ofrece como núcleo `async` y como fachada bloqueante.

Los resultados de las operaciones se entregan como eventos. El último resultado
se lee de una caché local alimentada por esos eventos, sin consultar al bróker.

```rust
let broker = IqOptionBroker::nuevo(BrokerParams::IqOption(cfg)).await?;

let id = broker.buy_binary(BuyBinaryRequest {
    symbol: "EURUSD-OTC".into(),
    amount: 1.0,
    direction: Direction::Call,
    expiration_minutes: 1,
    option_type: OptionType::Binary,
}).await?;

// El cierre llega por el stream de eventos.
let mut eventos = broker.events().await?;
while let Some(evento) = eventos.next().await {
    if let Event::OrderClosed { id: cerrada, result } = evento {
        if cerrada == id {
            println!("orden {id}: {result:?}");
            break;
        }
    }
}
```

## 📌 Estado del proyecto

Versión `0.1.0`. Cada componente se probó mediante conexiones reales contra el
bróker (cuenta de práctica) el 8 de noviembre de 2026:

| Componente | Estado | Comprobación |
|---|---|---|
| Conexión y sesión | Probado contra el bróker | Login, perfil y balances |
| Catálogo de activos | Probado contra el bróker | 791 activos con metadatos |
| Velas históricas | Probado contra el bróker | 1 s – 1 día, descarga paginada |
| Stream de velas | Probado contra el bróker | Velas en vivo por suscripción |
| Ticks de precio | Probado contra el bróker | Stream nativo por activo |
| Órdenes clásicas | Probado contra el bróker | Resultado por evento y caché |
| Órdenes digitales | Probado contra el bróker | Cierre por evento |
| Órdenes blitz | Probado contra el bróker | Duraciones en segundos |
| Venta anticipada | Probado contra el bróker | Aceptada dentro de la ventana |
| Perfil de activo (GraphQL) | Probado contra el bróker | Nombre, ticker y variaciones |
| Historial de posiciones | Probado contra el bróker | PnL realizado y apalancamiento |
| Indicadores del bróker | Depende del activo | El bróker rechaza algunos activos |
| Canales de plataforma | Probado contra el bróker | Comisiones y live-deal |

Los detalles, límites y casos no soportados están en
[`docs/01_introduccion.es.md`](docs/01_introduccion.es.md).

## 🧩 Funcionalidades

La librería incluye las siguientes funcionalidades:

| | Área | Descripción |
|---|---|---|
| 🔐 | Sesión | Autenticación, WebSocket, perfil y balances (incluye saldo retenido y bonos); cambio entre cuenta de práctica y real en caliente |
| 📊 | Catálogo | Activos con payout, duraciones, importes mínimo y máximo, sector, proveedor de precio y horarios |
| 🕯️ | Velas históricas | Intervalos de 1 segundo a 1 día; consulta puntual por rango y descarga paginada con detección de huecos |
| ⚡ | Stream | Suscripción a velas por intervalo y recepción de ticks nativos del activo |
| 🎯 | Órdenes | Clásicas (turbo y binary), digitales v2, blitz v2 y venta anticipada (buyback) |
| 📈 | Resultados | Cierre tipado (`Win`, `Loss`, `Equal`) por evento, con caché consultable |
| 🧾 | Historial | Posiciones cerradas con PnL realizado, importe invertido y apalancamiento |
| 🌐 | Datos de plataforma | Perfil fundamental del activo, comisiones en vivo y operaciones de terceros |
| 🧠 | Señales del bróker | Humor de traders, activos populares e indicadores publicados por el bróker |
| 🔁 | Modos de consumo | `async`/`await` o `SyncBroker` bloqueante |
| 🔌 | Continuidad | Reconexión automática con reautenticación, replay de suscripciones y aviso por eventos |
| 🧩 | Multibróker | El trait `Broker` y un registro de adaptadores separan el dominio del transporte |

### Datos disponibles a través de la API

Además de las operaciones, la interfaz permite leer metadatos que el bróker
publica en su inicializador: ventana de venta anticipada, margen previo al
cierre, proveedor del precio, decimales, rollovers de blitz, comisiones y
operaciones de otros usuarios del instrumento.

## 🔌 Continuidad de la conexión

La librería mantiene la sesión por sí misma. **No hace falta que implementes un
sistema anticaída encima**: si el WebSocket se interrumpe, la sesión
reautentica, restaura perfil, balances y catálogo, reproduce todas las
suscripciones y vuelve a despachar.

Lo que el consumidor debe saber:

- **Aviso por eventos**: `Event::Disconnected { motivo }` al perder la conexión
y `Event::Reconnected { intentos, downtime_ms }` al recuperarla. No hay que
reiniciar el bróker ni volver a suscribirse.
- **Mientras no hay socket**: las llamadas devuelven `BrokerError::NotConnected`
en lugar de encolarse. En opciones binarias, diferir una orden 30 segundos
cambia el mercado y el resultado.
- **Órdenes en vuelo**: se descartan con error y no se reenvían. Un cierre
ocurrido durante la caída se recupera al reconectar recorriendo el historial de
posiciones, hasta 10 páginas de 100.
- **Streams**: los que ya tenías siguen siendo válidos y se reanudan solos.
- **Cola acotada**: `TransportConfig::cola_salida` limita lo pendiente de
enviar; si se llena, el productor espera en vez de crecer en memoria.
- **Backoff**: `backoff_base_ms` … `backoff_max_ms`. Un rechazo de credenciales
no se reintenta, para no bloquear la cuenta.

Lo que **no** debe hacer el consumidor: reconectar por su cuenta, repetir el
login ante un error de red, o resuscribir streams tras `Reconnected`. El diseño,
los límites y la personalización están en
[`docs/09_reconexion/01_reconexion.es.md`](docs/09_reconexion/01_reconexion.es.md).

## 📦 Instalación

Desde crates.io:

```powershell
cargo add cripsy-binary-api
```

O en `Cargo.toml`:

```toml
[dependencies]
cripsy-binary-api = "0.2"
```

Instalación desde el repositorio (para desarrollo o para probar `master`):

```powershell
git clone https://github.com/ionixcorp/cripsy_binary_API.git
cd cripsy_binary_API
.\installation\install.ps1        # guiado, con aprobación en cada paso
```

Compilación manual:

```powershell
cargo build --release                                            # async (por defecto)
cargo build --release --no-default-features --features blocking  # sync
```

Las credenciales se leen del entorno. `.env` está ignorado por git:

```dotenv
IQOPTION_EMAIL = "tu-correo@ejemplo.com"
IQOPTION_PASSWORD = "tu-contrasena"
```

## ✅ Verificación

Los scripts incluidos ejecutan comprobaciones reales contra el bróker. Leen
`.env`, usan la cuenta de práctica y no requieren configuración adicional:

```powershell
.\scripts\conectar.ps1        # sesión, balance, catálogo, velas y stream
.\scripts\balance.ps1         # balance, tipo de cuenta y balance_id
.\scripts\operar.ps1          # orden de 1 USD en demo y cierre por evento
.\scripts\verificar_todo.ps1  # recorre todas las capacidades documentadas
```

`verificar_todo.ps1` informa `[OK]`, `[FALLO]` o `[AVISO]` por capacidad y
termina con código 1 si algo falla. `-SoloLectura` omite el envío de órdenes.

Resultado de la última ejecución (cuenta de práctica, 9 de noviembre de 2026):
34 comprobaciones correctas, 0 fallos, 1 aviso — el bróker no publica
indicadores para el activo consultado.

## 🧭 Uso

```powershell
cargo run --example ejemplo_lectura      # async: sesión, catálogo, velas, stream
cargo run --example ejemplo_sincrono     # fachada bloqueante
cargo run --example ejemplo_orden_demo   # orden en demo y cierre por evento
cargo run --example verificar_todo       # verificación integral
```

## 📚 Documentación

- En línea: <https://ionixcorp.github.io/cripsy_binary_API/>
- En el repositorio: [`docs/`]docs/ (Markdown, fuente de verdad)

| Documento | Contenido |
|---|---|
| [Introducción]docs/01_introduccion.es.md | Alcance, estado de cada componente y qué no hace |
| [Sesión y cuentas]docs/02_account/01_sesion_cuentas.es.md | Conexión, cuentas y balances |
| [Históricos]docs/03_candle_and_stream/01_historicos.es.md | Límites por intervalo y descarga masiva |
| [Stream y ticks]docs/03_candle_and_stream/02_stream_ticks.es.md | Suscripciones y densidad de ticks |
| [Fachada síncrona]docs/03_candle_and_stream/03_fachada_sincrona.es.md | Consumo bloqueante |
| [Digital]docs/04_digital/01_digital.es.md · [Binary]docs/05_binary/01_binary.es.md · [Blitz]docs/06_blitz/01_blitz.es.md | Tipos de orden |
| [Herramientas]docs/07_herramientas/01_herramientas.es.md | Instalación, scripts y adaptadores |
| [Indicadores]docs/08_indicadores/01_indicadores.es.md | Canal de indicadores del bróker |
| [Reconexión]docs/09_reconexion/01_reconexion.es.md | Continuidad: qué resuelve la API y qué debe hacer el consumidor |

Para generar la documentación navegable en local:

```powershell
.\scripts\build_docs.ps1 -Lang es    # genera docs/site/es/index.html
```

- **VS Code:** instala la extensión **Live Server** (Go Live) y pulsa *Go Live*
  sobre `index.html` o `docs/site/es/index.html`.
- **Manual:** abre `docs/site/es/index.html` con doble clic. Funciona sin
  servidor (`file://`): la navegación es por hash y no usa `fetch`.

## 🗂️ Estructura

```
src/domain/      modelo puro: activos, velas, órdenes, posiciones, eventos
src/broker/      trait Broker, configuración, adaptadores y fachada sync
src/transport/   HTTP/WebSocket, reintentos con backoff y router request_id
examples/        uso real y generador de documentación
docs/            guía de usuario (Markdown, fuente de verdad)
scripts/         compuerta de calidad, documentación y verificadores
installation/    instalación guiada y verificación de entorno
```

## 🗺️ Hoja de ruta

El trait `Broker` y el registro de adaptadores permiten incorporar nuevos
brókers sin modificar el dominio ni el transporte. En próximas versiones se
prevé añadir adaptadores para otros brókers, entre ellos **Deriv**, **Quotex** y
otros; el orden y el alcance dependerán de la disponibilidad de sus interfaces
documentadas y de las pruebas correspondientes. No hay fechas comprometidas.

Las propuestas y discusiones se atienden en los issues del repositorio.

## 🧪 Calidad

```powershell
.\scripts\verify.ps1   # fmt + clippy -D warnings + 68 tests + build blocking + docs
```

La compuerta es la misma que se ejecuta en Windows y en Linux. Los tests no
acceden a la red ni requieren credenciales.

## 🛡️ Seguridad

- Las credenciales se reciben por entorno; el repositorio no contiene secretos.
- La verificación de certificados TLS está activa por defecto (`verify_tls`).
- Los ejemplos y scripts usan cuenta de práctica; operar con cuenta real exige
  elegir `AccountSelection::Real` de forma explícita.

## ⚖️ Alcance y limitaciones

La librería traduce el protocolo del bróker a tipos de dominio y expone los
datos que el bróker entrega. No calcula indicadores técnicos, no gestiona
riesgo ni ejecuta estrategias.

El alcance de la garantía cubre el uso del trait `Broker` y de los canales
descritos en `docs/`. Queda fuera del alcance hablar directamente con el
WebSocket, usar canales no documentados, interpretar importes sin la traducción
del adaptador o modificar el crate en local. Algunos datos dependen de lo que
el bróker decida publicar en cada momento; cuando no los publica, la API
devuelve el error del bróker sin sustituirlo por valores estimados.

Limitaciones conocidas de la versión actual:

- **Reconexión automática con backoff.** Si el WebSocket cae, la sesión se
  reautentica, restaura perfil, catálogo y suscripciones, y lo comunica por
  `Event::Disconnected` / `Event::Reconnected`. Mientras no hay socket, las
  llamadas devuelven `BrokerError::NotConnected`; las órdenes en vuelo no se
  reenvían.
- **`get_operation_result` no consulta al bróker.** Lee la caché de eventos;
  sin el stream activo una orden puede permanecer en `Pending`.
- **`get_payout` devuelve el payout del catálogo.** El parámetro de expiración
  no cambia la consulta; los cambios en vivo llegan por `Event::PayoutChanged`.
- **Sin baja explícita de suscripciones.** Al soltar el `CandleStream`, la
  suscripción se retira en el siguiente despacho de velas.
- **Pérdida de eventos.** Si el consumidor se atrasa más que el buffer (1024),
  recibe `Event::EventsLost { count }` y el stream continúa.

```rust
use cripsy_binary_api::{mensaje_consumidor, revisar_config};

println!("{}", mensaje_consumidor());
for aviso in &revisar_config(&cfg).advertencias {
    eprintln!("aviso de uso: {aviso}");
}
```

## 🧱 Base conceptual

El diseño se apoya en el conocimiento público del protocolo que la comunidad
documentó, en particular en la API original de IQ Option publicada en GitHub.
Este proyecto es una implementación desde cero: no incluye código de aquella ni
la usa como dependencia.

Proyecto independiente: no está afiliado, patrocinado ni respaldado por
IQ Option. La licencia MIT cubre el código de este repositorio, no las marcas ni
los protocolos de terceros.

## ❤️ Apoyar el proyecto

El proyecto es gratuito y se mantiene sin patrocinadores. Si te resulta útil y
quieres contribuir a sostenerlo, puedes enviar una donación por Binance Pay.
Es totalmente opcional: no desbloquea funciones, no cambia la prioridad de los
issues y no condiciona el soporte.

<img src="https://raw.githubusercontent.com/ionixcorp/cripsy_binary_API/master/docs/assets/donacion-binance.png" alt="Código QR de Binance Pay para donaciones" width="220">

**Alias de Binance Pay:** `CripSy-AGKY`

Contribuir no pasa solo por el dinero: un informe de error con pasos para
reproducirlo, una corrección en la documentación o un pull request ayudan
igual o más.

## ⚠️ Aviso

Este software no constituye asesoría financiera. Operar opciones binarias
implica riesgo de pérdida del capital y puede estar restringido por la
legislación de cada país o por los términos del bróker.

## 📄 Licencia

MIT — ver [`LICENSE`](LICENSE).