Integrate Orkasa
with your stack.

Generate API keys from Settings → API. Each key has scopes (read, write, admin) and an associated brokerage_id.

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

• GET/v1/properties
  List brokerage properties. Supports filters by status, type, price.
• POST/v1/properties
  Create a new property. Returns the public URL for image uploads.
• GET/v1/properties/{id}
  Get a property by ID with all its fields and images.
• PATCH/v1/properties/{id}
  Update a property partially.
• POST/v1/properties/{id}/publish
  Trigger publication to selected portals with adapter spec.
• GET/v1/leads
  List leads with scoring, status and assigned agent.
• POST/v1/leads
  Create a lead (typical use: integration with your website).
• PATCH/v1/leads/{id}
  Move between kanban states, change assignment.
• POST/v1/ai/listing-review
  Trigger a listing review with Claude Opus 4.7. Returns 3 variants + photo analysis.
• POST/v1/ai/photo-enhance
  Enhance a photo with Gemini 2.5 Flash Image. Returns the result URL.
• GET/v1/integrations
  Status of each integration (portal/social) for the brokerage.

Events signed with HMAC-SHA256 via X-Orkasa-Signature header. Exponential retries capped at 24h. Idempotency via event_id.

• property.created

  New property created.

• property.updated

  Property modified (includes changed field).

• property.published

  Property published on a specific portal.

• property.unpublished

  Property unpublished or removed from a portal.

• lead.created

  New lead captured (includes source).

• lead.qualified

  Lead moved to qualified.

• lead.assigned

  Lead reassigned to another agent.

• compliance.kyc_required

  Lead requires KYC to proceed.

• compliance.match_alert

  Positive match on a sanctions list.