Yara API Documentation
Welcome to the Yara API documentation. Yara provides a simple API for crypto-to-fiat conversions and cross-border payments.
What Can You Build?
With the Yara API, you can:
- Accept crypto payments - Receive USDC, USDT, BTC, ETH, SOL from users
- Send fiat payouts - Disburse NGN, GHS, USD, GBP, CAD, EUR to bank accounts
- Get exchange rates - Real-time crypto-to-fiat conversion rates
- Track transactions - Monitor deposits and payouts in real-time
API Features
- REST API - Simple HTTP endpoints at
/api/*
Available Endpoints
- Exchange rates — GET
/api/rates - Initiate payout — POST
/api/v1/payout?pair=usd_ngn - Get Payouts History — GET
/api/v1/payout/history?page=<page>&limit=<limit> - Get Payout by Reference — GET
/api/v1/payout?reference=<reference>&id=<id> - Account balance — GET
/api/v1/wallet?reference=<reference> - Get Wallet Address — GET
/api/v1/wallet?reference=<reference> - Generate wallet address — POST
/api/v1/wallet?reference=<reference>&addresstype=<type> - Widget — GET
/api/widget
Quick Example
Get exchange rates (no authentication required):
curl https://api.yara.cash/api/ratesResponse:
{
"data": {
"baseCurrency": "USD",
"buy": {
"BTC": 0.000009187604696338184,
"CAD": 1.2618052631578949,
"EUR": 0.8432196153846165,
"GBP": 0.672464210526316,
"NGN": 1615.1736107499999,
"SOL": 0.0054845080313296185,
"USD": 1.015,
"USDC": 1.015,
"USDT": 1.015
},
"sell": {
"BTC": 0.000009792981615552567,
"CAD": 1.2625641025641026,
"ETH": 0.00029997696155307444,
"EUR": 0.8595599999999993,
"GBP": 0.7019999999999998,
"GHS": 11.9,
"NGN": 1448.5411998,
"SOL": 0.006317458593719706,
"USD": 1,
"USDC": 1,
"USDT": 1
},
"expiresAt": 1762351070
},
"message": "success"
}Base URLs
- REST API:
https://api.yara.cash/
Authentication
Most endpoints require the x-yara-api-key header created in the Yara dashboard.
curl -X GET "https://api.yara.cash/api/v1/wallet" \
-H "x-yara-api-key: <secret-key>" \
-H "Content-Type: application/json"