The Borrower's Forum

Debt Intelligence Platform

API Documentation

Complete reference for The Borrower's Forum Platform API

Total Endpoints

190+

Countries

Live

World Bank Data

Secure

API Key Auth

Base URL

Production API endpoint

https://borrowers-forum.onrender.com

All API requests should be made to this base URL. The API is live and operational 24/7.

Authentication

API key required for protected endpoints

X-API-Key: your_api_key_here

Include your API key in the request header. Contact the administrator to obtain an API key.

API Endpoints

Countries API

Access country profiles and economic data

GET/api/v1/countries

List all countries with profiles

GET/api/v1/countries/:code

Get specific country by ISO code

Debt Calculator API

Calculate opportunity costs of debt relief

POST/api/v1/debt/calculate

Calculate healthcare, education, and climate equivalents

POST/api/v1/debt/calculate-live

Calculate using live World Bank data

POST/api/v1/debt/compare

Compare multiple relief scenarios

Precedents API

Search historical debt restructuring cases

GET/api/v1/precedents

Search with filters (country, year, creditor, treatment)

GET/api/v1/precedents/similar

AI-powered similarity matching (0-100 score)

GET/api/v1/precedents/stats

Get aggregated statistics by type

Live Data API

Real-time World Bank data integration

GET/api/v1/live/economic/:code

Live economic indicators (GDP, population, debt)

GET/api/v1/live/countries

List all 190+ supported countries

Example Request

Calculate debt relief impact for Ghana

# Calculate debt opportunity costs

curl -X POST \

"https://borrowers-forum.onrender.com/api/v1/debt/calculate" \

-H "Content-Type: application/json" \

-H "X-API-Key: your_api_key_here" \

-d '{

"country_code": "GHA",

"year": 2023,

"debt_amount_usd": 50000000

Full Documentation

Comprehensive API reference with all endpoints, parameters, and examples.

Data Sources

World Bank, IMF, and Paris Club official data sources.

Get API Key

Contact the administrator to request your secure API key.