Getting Started

Welcome to the Oolel Maps API. This guide walks you through creating your account, obtaining an API key, and making your first request.

Overview

Oolel Maps provides a RESTful API for geocoding, search, navigation, and address management across West Africa. All endpoints return JSON and support French, Arabic, and English via the language parameter.

Base URL

https://api.oolel.com
1

Create your account

Head to the registration page and create a free developer account. You will need to provide your name, email address, and optionally your company name.

2

Generate an API key

After logging in, navigate to the API Keys section of your dashboard. Click "Create New Key" and give it a descriptive name (e.g. "Production" or "Development"). Copy and store your key securely — you will not be able to see it again after creation.

3

Make your first request

Use your API key in the Authorization header with a Bearer prefix. Here is a simple forward geocoding request:

cURLbash
curl -X GET "https://api.oolel.com/geocoding/forward?q=Tevragh+Zeina+Nouakchott" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authentication

All API requests must include your API key in the Authorization header:

Header Formattext
Authorization: Bearer YOUR_API_KEY

Requests without a valid API key will receive a 401 Unauthorized response.

Rate Limits

The free tier includes 10,000 requests per month. Rate limits are applied per API key with a maximum of 100 requests per minute. The following headers are included in every response:

Rate Limit Headerstext
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 97
X-RateLimit-Reset: 1709683200

Error Handling

The API uses standard HTTP status codes. Error responses include a JSON body with a descriptive message:

Error Responsejson
{
  "statusCode": 400,
  "message": "Query parameter 'q' is required",
  "error": "Bad Request"
}
Status CodeDescription
200Request succeeded
400Bad request (missing or invalid parameters)
401Unauthorized (missing or invalid API key)
429Rate limit exceeded
500Internal server error

Language Support

Most endpoints accept a language query parameter to control the response language. Supported values:

fr

French (default)

ar

Arabic

en

English