API Documentation
Build on ZivanaKrib
RESTful APIs for property listings, payments, user management, and more. Integrate ZivanaKrib into your own applications.
Quick Start
1. Get API Key
Sign up and generate your API key from the developer dashboard.
2. Make Requests
Send authenticated requests to our REST endpoints using any HTTP client.
3. Build & Ship
Integrate property data, payments, and user management into your app.
Example RequestcURL
curl -X GET "https://api.zivanakrib.com/v1/properties?city=Lagos&limit=10" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json"
API Endpoints
Base URL: https://api.zivanakrib.com/v1
GET
/api/v1/propertiesList all verified properties with filters for location, price, and type.GET
/api/v1/properties/:idGet detailed information about a specific property listing.POST
/api/v1/propertiesCreate a new property listing (requires landlord authentication).POST
/api/v1/auth/registerRegister a new user account (tenant, landlord, or agent).POST
/api/v1/auth/loginAuthenticate and receive an access token.GET
/api/v1/users/meGet the authenticated user's profile information.POST
/api/v1/payments/escrowInitiate an escrow payment for a property transaction.PUT
/api/v1/properties/:idUpdate an existing property listing.DELETE
/api/v1/properties/:idRemove a property listing (owner only).Authentication
All API requests require a Bearer token in the Authorization header. Obtain your token by calling the /auth/login endpoint.
Rate limits: 100 requests per minute for free plans, 1,000 requests per minute for paid plans.