EGNIMAX API

Introduction

The EGNIMAX API is organized around REST. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Authentication

The EGNIMAX API uses API keys to authenticate requests. You can view and manage your API keys in the API Dashboard.

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

curl https://api.egnimax.co.za/v1/finance/summary \
  -H "Authorization: Bearer egn_live_sk_1234567890abcdef"

const response = await fetch('https://api.egnimax.co.za/v1/finance/summary', {
  headers: {
    'Authorization': 'Bearer egn_live_sk_1234567890abcdef'
  }
});
const data = await response.json();

import requests

headers = {'Authorization': 'Bearer egn_live_sk_1234567890abcdef'}
response = requests.get('https://api.egnimax.co.za/v1/finance/summary', headers=headers)
data = response.json()

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.egnimax.co.za/v1/finance/summary');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'Authorization: Bearer egn_live_sk_1234567890abcdef'
]);
$response = curl_exec($ch);

Rate Limiting

The API is rate limited to prevent abuse. The current limits are:

Rate limit information is included in the response headers:

X-RateLimit-Limit: 10000
X-RateLimit-Remaining: 9523
X-RateLimit-Reset: 1609459200

Error Handling

EGNIMAX uses conventional HTTP response codes to indicate the success or failure of an API request.

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required parameter: user_id",
    "param": "user_id",
    "type": "validation_error"
  }
}

Get Finance Summary

Retrieves a summary of the user's financial status including total income, expenses, savings rate, and net worth.

Parameters

Example Request

curl https://api.egnimax.co.za/v1/finance/summary \
  -H "Authorization: Bearer egn_live_sk_1234567890abcdef" \
  -d date_from="2026-01-01" \
  -d date_to="2026-01-31"

Example Response

{
  "total_income": 3200.00,
  "total_expenses": 2100.50,
  "net_income": 1099.50,
  "savings_rate": 0.34,
  "currency": "ZAR",
  "period": {
    "from": "2026-01-01",
    "to": "2026-01-31"
  }
}