KaribuKaribuData
Request access

API Reference

REST · JSON · versioned at /api/v1. The full interactive reference below is generated from our OpenAPI 3.1 spec — the source of truth.

Get a sandbox keyDownload OpenAPI 3.1 spec

Authentication

Send your key as a bearer token. Sandbox keys answer synthetic data on the same schema.

curl https://karibuhome.world/api/v1/index?city=Nairobi \
  -H "Authorization: Bearer kapi_<keyId>_<secret>"

Endpoints

  • GET/api/v1/indexscope: market:read

    Karibu Index time series by area × type × sale/rent.

  • GET/api/v1/market/compsscope: market:read

    Median price & KES/sqm comps from verified listings.

  • GET/api/v1/properties/{upi}scope: listings:read

    Canonical property record + attribute provenance.

  • GET/api/partner/listingsscope: listings:read

    Published market inventory (paginated).

  • GET/api/partner/marketscope: market:read

    Source registry + inventory aggregates.

  • GET/api/partner/customersscope: customers:read

    De-identified customer aggregates. No PII.

  • GET/api/partner/me

    Identify the calling key (env, tier, scopes).