Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Fetch rates before initiating a retail transaction. Direct FX publishes a rate board; the Pan-African Ramp issues a priced quote you must pass into the transaction.
| Direct FX | Pan-African Ramp | |
|---|---|---|
| Endpoint | GET /transactions/v2/rate_quote | GET /transactions/v2/direct_ramp/rate_quote |
| Returns | Current rates for all supported pairs | A single priced quote with an id |
| Validity | Read at any time, not reserved | 120 seconds |
| Needed to transact? | No | Yes — quoteId is required |
GET /transactions/v2/rate_quote
| Parameter | Type | Required | Description |
|---|---|---|---|
trx_type | string | ✓ | Direction: onramp or offramp |
const options = {
method: 'GET',
headers: {
accept: 'application/json',
'ngnc-sec-key': 'YOUR_SECRET_KEY'
}
};
fetch('https://api.linkio.world/transactions/v2/rate_quote?trx_type=onramp', options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import requests
url = "https://api.linkio.world/transactions/v2/rate_quote"
params = {"trx_type": "onramp"}
headers = {
"accept": "application/json",
"ngnc-sec-key": "YOUR_SECRET_KEY"
}
response = requests.get(url, params=params, headers=headers)
print(response.text)
NGNUSDC is the naira a user pays for one USDC.{
"NGNUSDC": 1587.9,
"USDUSDC": 1.0095
}
USDCNGN is the naira a user receives for one USDC.{
"USDCNGN": 1572.4,
"USDCUSD": 0.9905
}
NGNUSDC, off-ramp is USDCNGN. Read the direction from the key, not the position.GET /transactions/v2/direct_ramp/rate_quote
quoteId is required by the deposit and withdrawal calls.| Parameter | Type | Required | Description |
|---|---|---|---|
asset | string | ✓ | Fiat side of the pair: NGN, GHS, KES, SLE, ZAR, UGX, ZMW, XAF |
stables | string | ✓ | Stablecoin side, e.g. USDC |
amount | string | ✓ | Amount in the source asset for this direction |
trx_type | string | ✓ | Direction: onramp or offramp |
payment_method | string | ✓ | Rail to settle on — see Fiat payment methods |
customer_id | string | Links the quote to a registered customer |
const params = new URLSearchParams({
asset: 'NGN',
stables: 'USDC',
amount: '100000',
trx_type: 'onramp',
payment_method: 'bank_transfer'
});
const options = {
method: 'GET',
headers: {
accept: 'application/json',
'ngnc-sec-key': 'YOUR_SECRET_KEY'
}
};
fetch(`https://api.linkio.world/transactions/v2/direct_ramp/rate_quote?${params}`, options)
.then(response => response.json())
.then(response => console.log(response))
.catch(err => console.error(err));
import requests
url = "https://api.linkio.world/transactions/v2/direct_ramp/rate_quote"
params = {
"asset": "NGN",
"stables": "USDC",
"amount": "100000",
"trx_type": "onramp",
"payment_method": "bank_transfer"
}
headers = {
"accept": "application/json",
"ngnc-sec-key": "YOUR_SECRET_KEY"
}
response = requests.get(url, params=params, headers=headers)
print(response.text)
200 OK{
"status": "Success",
"message": "Rate retrieved",
"data": {
"quoteId": "VHlwZXM6OkNhc2hyYW1wOjpBUEk6OlJhbXBRdW90ZS0yOTJmNjA3ZC0xMzBiLTRjMjctOGVlMy05OGE4Njg0NDVhNjg=",
"trx_type": "onramp",
"amount": "100000",
"rate": "1365.300",
"payoutAmount": "73.24",
"validity": "120 seconds",
"date": "2026-10-03 15:12"
}
}
quoteId is a long base64 string, not a UUID — pass it through unchanged. rate and payoutAmount come back as strings, so parse them before doing arithmetic.quoteId.