Documentation

Integrate the best Ethiopian data API in minutes.

Secure Fast REST

Getting Started

Welcome to Guramayle API. Our RESTful API provides comprehensive access to Ethiopian banking details, holidays, and full 5-tier geographic administrative divisions.

Base URL
https://guramayle.bayainnovation.com/api/v1
Quick Steps
  • Register at Guramayle Dashboard
  • Subscribe to a plan (Free trial available)
  • Copy your X-API-Key from the overview page
  • Start making requests using the endpoints below

Authentication

The API uses custom headers for authentication. Secure your API key and never share it publicly.

curl -H "X-API-Key: YOUR_SECRET_KEY" \
     https://guramayle.bayainnovation.com/api/v1/banks
Security Tip: Use environment variables to store your API keys. Avoid hardcoding them in your source files.

Rate Limiting

Request limits depend on your active subscription. You can check your remaining limits in each response header.

Header Description
X-RateLimit-Limit Maximum requests allowed in the monthly window
X-RateLimit-Remaining Requests remaining in the current window
X-RateLimit-Reset Timestamp when the limit will reset

API Endpoints

Banks

GET /banks

Get verified details for all Ethiopian commercial and private banks, including SWIFT codes, branch counts, and logos.

Parameters
Key Type Description
search string Search by bank name or description
page int Page number (default: 1)
Response Preview
{
  "success": true,
  "data": [
    {
      "name": "Commercial Bank of Ethiopia",
      "swift_code": "CBETETAA",
      "branch_count": 1900,
      "logo": "https://.../cbe.png"
    }
  ]
}
All geographic endpoints (Regions, Cities, Towns, Woredas, Streets) follow the same hierarchical structure and support search and pagination.

Error Handling

Standard HTTP status codes are used to indicate the success or failure of an API request.

401

Unauthorized Key

429

Limit Reached

404

Not Found