Recursos

API reference

Integrá Orkasa
con tu stack.

REST API completa, webhooks en tiempo real, OAuth 2.0 para portales. Versionado semántico, rate limit generoso, contratos estables.

Autenticación

Generá API keys desde Configuración → API. Cada key tiene scopes (read, write, admin) y un brokerage_id asociado.

curl https://api.orkasa.io/v1/properties \
  -H "Authorization: Bearer ork_live_xxxxxxxxxxxxx" \
  -H "Content-Type: application/json"

Endpoints

  • GET/v1/properties
    Listar propiedades del brokerage. Soporta filtros por status, type, precio.
  • POST/v1/properties
    Crear una nueva propiedad. Devuelve la URL pública para carga de imágenes.
  • GET/v1/properties/{id}
    Obtener una propiedad por ID con todos sus campos e imágenes.
  • PATCH/v1/properties/{id}
    Actualizar una propiedad parcialmente.
  • POST/v1/properties/{id}/publish
    Disparar publicación a portales seleccionados con adapter spec.
  • GET/v1/leads
    Listar leads con scoring, status y agente asignado.
  • POST/v1/leads
    Crear lead (uso típico: integración con tu sitio web).
  • PATCH/v1/leads/{id}
    Mover entre estados del kanban, cambiar asignación.
  • POST/v1/ai/listing-review
    Disparar review de listing con Claude Opus 4.7. Devuelve 3 variantes + análisis de fotos.
  • POST/v1/ai/photo-enhance
    Mejorar foto con Gemini 2.5 Flash Image. Devuelve URL del resultado.
  • GET/v1/integrations
    Estado de cada integración (portal/social) del brokerage.

Webhooks

Eventos firmados con HMAC-SHA256 vía header X-Orkasa-Signature. Reintentos exponenciales con cap a 24h. Idempotencia vía event_id.

  • property.created

    Nueva propiedad creada.

  • property.updated

    Propiedad modificada (incluye campo cambiado).

  • property.published

    Propiedad publicada en un portal específico.

  • property.unpublished

    Propiedad despublicada o eliminada de un portal.

  • lead.created

    Nuevo lead capturado (incluye source).

  • lead.qualified

    Lead pasó a calificado.

  • lead.assigned

    Lead reasignado a otro agente.

  • compliance.kyc_required

    Lead requiere KYC para avanzar.

  • compliance.match_alert

    Match positivo en lista de sanciones.

Rate limits y SLA

Solo / Team

300 req/min

Brokerage

3,000 req/min

Uptime

99.9% (Brokerage SLA)

¿Vas a integrar?

Pedí acceso anticipado a la beta. SDKs en TypeScript y Python.

Solicitar acceso →
API reference — Orkasa · Orkasa