List investments

curl --request GET \
  --url https://api.myladder.africa/partner/v1/investments \
  --header 'X-Ladder-Key: <api-key>' \
  --header 'X-Ladder-Signature: <api-key>' \
  --header 'X-Ladder-Timestamp: <api-key>'

import requests

url = "https://api.myladder.africa/partner/v1/investments"

headers = {
    "X-Ladder-Key": "<api-key>",
    "X-Ladder-Timestamp": "<api-key>",
    "X-Ladder-Signature": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Ladder-Key': '<api-key>',
    'X-Ladder-Timestamp': '<api-key>',
    'X-Ladder-Signature': '<api-key>'
  }
};

fetch('https://api.myladder.africa/partner/v1/investments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.myladder.africa/partner/v1/investments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Ladder-Key: <api-key>",
    "X-Ladder-Signature: <api-key>",
    "X-Ladder-Timestamp: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.myladder.africa/partner/v1/investments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Ladder-Key", "<api-key>")
	req.Header.Add("X-Ladder-Timestamp", "<api-key>")
	req.Header.Add("X-Ladder-Signature", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.myladder.africa/partner/v1/investments")
  .header("X-Ladder-Key", "<api-key>")
  .header("X-Ladder-Timestamp", "<api-key>")
  .header("X-Ladder-Signature", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.myladder.africa/partner/v1/investments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Ladder-Key"] = '<api-key>'
request["X-Ladder-Timestamp"] = '<api-key>'
request["X-Ladder-Signature"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "category": "<string>",
      "provider": "<string>",
      "country": "GH",
      "currency": "GHS",
      "price": "<string>",
      "bid_price": "<string>",
      "minimum_investment": "<string>",
      "expected_return_rate": "<string>",
      "duration": "60 days",
      "payout_type": "regular earnings on investments",
      "risk_profile": "<string>",
      "start_date": "2023-12-25",
      "close_date": "2023-12-25",
      "maturity_date": "2023-12-25",
      "status": "pending",
      "is_open": "<string>",
      "allocation_remaining": "<string>",
      "terms_url": "<string>",
      "image_url": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "count": 123
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

GET

partner

investments

List investments

curl --request GET \
  --url https://api.myladder.africa/partner/v1/investments \
  --header 'X-Ladder-Key: <api-key>' \
  --header 'X-Ladder-Signature: <api-key>' \
  --header 'X-Ladder-Timestamp: <api-key>'

import requests

url = "https://api.myladder.africa/partner/v1/investments"

headers = {
    "X-Ladder-Key": "<api-key>",
    "X-Ladder-Timestamp": "<api-key>",
    "X-Ladder-Signature": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Ladder-Key': '<api-key>',
    'X-Ladder-Timestamp': '<api-key>',
    'X-Ladder-Signature': '<api-key>'
  }
};

fetch('https://api.myladder.africa/partner/v1/investments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.myladder.africa/partner/v1/investments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Ladder-Key: <api-key>",
    "X-Ladder-Signature: <api-key>",
    "X-Ladder-Timestamp: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.myladder.africa/partner/v1/investments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Ladder-Key", "<api-key>")
	req.Header.Add("X-Ladder-Timestamp", "<api-key>")
	req.Header.Add("X-Ladder-Signature", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.myladder.africa/partner/v1/investments")
  .header("X-Ladder-Key", "<api-key>")
  .header("X-Ladder-Timestamp", "<api-key>")
  .header("X-Ladder-Signature", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.myladder.africa/partner/v1/investments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Ladder-Key"] = '<api-key>'
request["X-Ladder-Timestamp"] = '<api-key>'
request["X-Ladder-Signature"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "name": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "category": "<string>",
      "provider": "<string>",
      "country": "GH",
      "currency": "GHS",
      "price": "<string>",
      "bid_price": "<string>",
      "minimum_investment": "<string>",
      "expected_return_rate": "<string>",
      "duration": "60 days",
      "payout_type": "regular earnings on investments",
      "risk_profile": "<string>",
      "start_date": "2023-12-25",
      "close_date": "2023-12-25",
      "maturity_date": "2023-12-25",
      "status": "pending",
      "is_open": "<string>",
      "allocation_remaining": "<string>",
      "terms_url": "<string>",
      "image_url": "<string>"
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "count": 123
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  }
}

Authorizations

X-Ladder-Key

string

header

required

Your key id: pk_test_… (sandbox) or pk_live_… (live).

X-Ladder-Timestamp

string

header

required

Unix seconds, as a string; must be within 5 minutes of server time.

X-Ladder-Signature

string

header

required

Lower-case hex HMAC-SHA512 over timestamp, method, path+query and the SHA-256 of the body. See Authentication.

Query Parameters

limit

integer

Page size, 1–200 (default 50).

offset

integer

Rows to skip (default 0).

currency

string

NGN, GHS or USD

country

string

NG or GH

provider

string

Underlying provider

Response

data

object[]

required

Show child attributes

pagination

object

required

Show child attributes

Organisation

KYB

Wallets and funding

Direct-debit mandates

Investments

Market data

Orders

Holdings

Webhooks

Sandbox

List investments

Authorizations

Query Parameters

Response