Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
What a partner can buy, and how to read price, minimum, open state and allocation.
GET /investments lists every investment open to partners, filterable by currency, country and provider.
{
"id": "8788a2e2-c071-4a05-8dac-adb40627926a",
"name": "ARM NGN Mutual Fund",
"category": "Fixed Interest",
"provider": "GetEquity",
"country": "NG",
"currency": "NGN",
"price": "10000.00",
"bid_price": "10000.00",
"minimum_investment": "10000.00",
"expected_return_rate": "20.50",
"duration": "12",
"payout_type": "Quarterly",
"risk_profile": "medium",
"maturity_date": "2026-11-09",
"status": "available",
"is_open": true,
"allocation_remaining": null,
"terms_url": null
}
| field | meaning |
|---|---|
price | the ask: what a buy pays per unit |
bid_price | what a sell receives per unit when known; null means Ladder settles sells at the value paid |
minimum_investment | orders below it are refused with amount_below_minimum |
is_open | start and close dates and status folded together; closed investments refuse orders with investment_closed |
allocation_remaining | when not null, how much of this investment is still available to partners; live orders above it are refused with allocation_exceeded |
terms_url | the prospectus or terms document, when the issuer provides one |
investment_id you order with.