Skip to content

Reference data

Directory, procedures, datasets, public holidays, operators, banks: paginated lists and records.

Try it from this page

The "Try" button calls the API from your browser. Without a key, the call counts against the anonymous quota (100 calls per day and per IP address); with a key in the Authorization field, the quota rises to 1,000. The key stays in your browser. Get a key
GET
/v1/adresses/geocoder

Query Parameters

texte*string
Length1 <= length <= 300

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/adresses/geocoder?texte=En+face+de+la+pharmacie%2C+M%C3%A9dina%2C+Dakar"
{  "alternatives": [    {      "contexte": "Dakar Plateau, Dakar, Dakar",      "coordonnees": {        "lat": 0.1,        "lon": 0.1,        "precision": "region"      },      "id": "string",      "level": "region",      "name": "string",      "name_source": "string",      "parent_id": "string",      "population_2023": 0    }  ],  "ambigu": true,  "avertissements": [    "string"  ],  "lat": 0,  "lieu": {    "contexte": "Dakar Plateau, Dakar, Dakar",    "coordonnees": {      "lat": 0.1,      "lon": 0.1,      "precision": "region"    },    "id": "string",    "level": "region",    "name": "string",    "name_source": "string",    "parent_id": "string",    "population_2023": 0  },  "lon": 0,  "precision": "string",  "relation": "string",  "repere": "string",  "sources": [    {      "licence": "string",      "official": true,      "title": "string",      "url": "string"    }  ],  "texte": "string"}
GET
/v1/adresses/normaliser

Query Parameters

texte*string
Length1 <= length <= 300

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/adresses/normaliser?texte=En+face+de+la+pharmacie%2C+M%C3%A9dina%2C+Dakar"
{  "alternatives": [    {      "contexte": "Dakar Plateau, Dakar, Dakar",      "coordonnees": {        "lat": 0.1,        "lon": 0.1,        "precision": "region"      },      "id": "string",      "level": "region",      "name": "string",      "name_source": "string",      "parent_id": "string",      "population_2023": 0    }  ],  "ambigu": true,  "lieu": {    "contexte": "Dakar Plateau, Dakar, Dakar",    "coordonnees": {      "lat": 0.1,      "lon": 0.1,      "precision": "region"    },    "id": "string",    "level": "region",    "name": "string",    "name_source": "string",    "parent_id": "string",    "population_2023": 0  },  "lieu_id": "string",  "lieux_reconnus": [    {      "candidats": 0,      "texte": "string"    }  ],  "limites": "string",  "relation": "string",  "repere": "pharmacie Guigon",  "texte": "string"}
GET
/v1/adresses/suggestions

Query Parameters

q*string
Length2 <= length <= 100
limit?integer
Formatint64
Range1 <= value <= 20
Default10

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/adresses/suggestions?q=thies"
{  "data": [    {      "contexte": "Dakar Plateau, Dakar, Dakar",      "coordonnees": {        "lat": 0.1,        "lon": 0.1,        "precision": "region"      },      "id": "string",      "level": "region",      "name": "string",      "name_source": "string",      "parent_id": "string",      "population_2023": 0    }  ],  "sources": [    {      "licence": "string",      "official": true,      "title": "string",      "url": "string"    }  ]}
GET
/v1/annuaire

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default20
q?string

Full-text search, ignoring accents and case.

Length1 <= length
category?string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/annuaire"
{  "data": [    null  ],  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}
GET
/v1/annuaire/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/annuaire/string"
null

Banks

GET
/v1/banques

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default20
q?string

Full-text search, ignoring accents and case.

Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/banques"
{  "data": [    {      "bank_code": "K 0010 A",      "id": "k0010a",      "name": "string",      "sources": [        {          "lang": "fr",          "official": true,          "title": "string",          "url": "http://example.com",          "verifiedOn": "2019-08-24"        }      ],      "website": "http://example.com"    }  ],  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}

Banks: one entry

GET
/v1/banques/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/banques/string"
{  "bank_code": "K 0010 A",  "id": "k0010a",  "name": "string",  "sources": [    {      "lang": "fr",      "official": true,      "title": "string",      "url": "http://example.com",      "verifiedOn": "2019-08-24"    }  ],  "website": "http://example.com"}

Directory categories

GET
/v1/categories

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default20
q?string

Full-text search, ignoring accents and case.

Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/categories"
{  "data": [    null  ],  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}
GET
/v1/categories/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/categories/string"
null
DELETE
/v1/compte

Authorization

session
better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

curl -X DELETE "https://example.com/v1/compte" \  -H "Content-Type: application/json" \  -d '{}'
Empty
GET
/v1/compte/export

Authorization

session
better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/compte/export"
{  "property1": null,  "property2": null}
GET
/v1/demandes

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/demandes"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "details": "string",      "id": "string",      "kind": "api",      "note": "string",      "status": "ouverte",      "title": "string",      "voted": true,      "votes": 0    }  ]}
POST
/v1/demandes

Authorization

session
better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/demandes" \  -H "Content-Type: application/json" \  -d '{    "kind": "api",    "title": "string"  }'
{  "created_at": "2019-08-24T14:15:22Z",  "details": "string",  "id": "string",  "kind": "api",  "note": "string",  "status": "ouverte",  "title": "string",  "voted": true,  "votes": 0}
DELETE
/v1/demandes/{id}/vote

Authorization

session
better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Response Body

application/json

application/json

curl -X DELETE "https://example.com/v1/demandes/string/vote"
{  "created_at": "2019-08-24T14:15:22Z",  "details": "string",  "id": "string",  "kind": "api",  "note": "string",  "status": "ouverte",  "title": "string",  "voted": true,  "votes": 0}
PUT
/v1/demandes/{id}/vote

Authorization

session
better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

id*string

Response Body

application/json

application/json

curl -X PUT "https://example.com/v1/demandes/string/vote"
{  "created_at": "2019-08-24T14:15:22Z",  "details": "string",  "id": "string",  "kind": "api",  "note": "string",  "status": "ouverte",  "title": "string",  "voted": true,  "votes": 0}

Regulatory procedures

GET
/v1/demarches

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default20
q?string

Full-text search, ignoring accents and case.

Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/demarches"
{  "data": [    null  ],  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}
GET
/v1/demarches/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/demarches/string"
null
GET
/v1/invitations/{token}

Path Parameters

token*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/invitations/string"
{  "email_masked": "f***@example.test",  "expires_at": "2019-08-24T14:15:22Z",  "project_name": "string",  "role": "admin",  "status": "pending"}
POST
/v1/invitations/{token}/accepter

Authorization

session
better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Path Parameters

token*string

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/invitations/string/accepter"
{  "project_id": "string",  "role": "admin"}
GET
/v1/jeux

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default20
q?string

Full-text search, ignoring accents and case.

Length1 <= length
status?string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/jeux"
{  "data": [    null  ],  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}
GET
/v1/jeux/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/jeux/string"
null
GET
/v1/jours-feries

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default20
q?string

Full-text search, ignoring accents and case.

Length1 <= length
type?string
date_status?string
year?string
Match^\d{4}$

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/jours-feries"
{  "data": [    {      "date": "2019-08-24",      "date_status": "confirmee",      "id": "2026-nouvel-an",      "name": {        "en": "New Year's Day",        "fr": "Jour de l'an"      },      "sources": [        {          "lang": "fr",          "official": true,          "title": "string",          "url": "http://example.com",          "verifiedOn": "2019-08-24"        }      ],      "type": "civile"    }  ],  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}
GET
/v1/jours-feries/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/jours-feries/string"
{  "date": "2019-08-24",  "date_status": "confirmee",  "id": "2026-nouvel-an",  "name": {    "en": "New Year's Day",    "fr": "Jour de l'an"  },  "sources": [    {      "lang": "fr",      "official": true,      "title": "string",      "url": "http://example.com",      "verifiedOn": "2019-08-24"    }  ],  "type": "civile"}

Hub modules

GET
/v1/modules

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default20
q?string

Full-text search, ignoring accents and case.

Length1 <= length
status?string
form?string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/modules"
{  "data": [    null  ],  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}

Hub modules: one entry

GET
/v1/modules/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/modules/string"
null
GET
/v1/operateurs

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default20
q?string

Full-text search, ignoring accents and case.

Length1 <= length
operator?string
type?string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/operateurs"
{  "data": [    {      "id": "30",      "operator": "Expresso Sénégal",      "prefix": "30",      "sources": [        {          "lang": "fr",          "official": true,          "title": "string",          "url": "http://example.com",          "verifiedOn": "2019-08-24"        }      ],      "type": "fixe"    }  ],  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}
GET
/v1/operateurs/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/operateurs/string"
{  "id": "30",  "operator": "Expresso Sénégal",  "prefix": "30",  "sources": [    {      "lang": "fr",      "official": true,      "title": "string",      "url": "http://example.com",      "verifiedOn": "2019-08-24"    }  ],  "type": "fixe"}

Mes projets (20 au plus)

GET
/v1/projets

Authorization

session
better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/projets"
{  "data": [    {      "created_at": "2019-08-24T14:15:22Z",      "id": "string",      "name": "string",      "slug": "string"    }  ],  "limit": 0}
POST
/v1/projets

Authorization

session
better-auth.session_token<token>

Session ouverte à la connexion au tableau de bord.

In: cookie

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/v1/projets" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'
{  "created_at": "2019-08-24T14:15:22Z",  "id": "string",  "name": "string",  "slug": "string"}
GET
/v1/secteurs

Query Parameters

page?integer
Formatint64
Range1 <= value
Default1
per_page?integer
Formatint64
Range1 <= value <= 100
Default20
q?string

Full-text search, ignoring accents and case.

Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/secteurs"
{  "data": [    null  ],  "pagination": {    "page": 0,    "per_page": 0,    "total": 0,    "total_pages": 0  }}
GET
/v1/secteurs/{id}

Path Parameters

id*string

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/secteurs/string"
null
GET
/v1/telechargements

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/telechargements"
{  "data": [    {      "jeu": "banques",      "ouvertures": 0,      "telechargements": 0    }  ]}
POST
/v1/telechargements/{jeu}

Path Parameters

jeu*string

Identifiant du jeu (catalogue /v1/jeux).

Query Parameters

type?string
Default"telechargement"

Value in

  • "telechargement"
  • "ouverture"

Response Body

application/json

curl -X POST "https://example.com/v1/telechargements/banques"
Empty
GET
/v1/webhook-event-types

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/webhook-event-types"
[  {    "label_en": "string",    "label_fr": "string",    "product": "payments",    "type": "string"  }]