REST APIJSONv1

API CoinClarity

Accedez aux donnees des marches financiers africains via notre API REST gratuite et ouverte.

URL de base :https://api.coinclarity.org/api/v1

Pas d'authentification

La plupart des endpoints sont ouverts

100 req/min

Limite de debit par adresse IP

17 bourses africaines

BRVM, NGX, JSE, NSE, GSE et plus

Entreprises

Donnees des entreprises cotees, cours et fondamentaux.

Marche

Indices de marche, performance sectorielle et top movers.

Marches africains

Bourses africaines, statistiques et donnees multi-marches.

Actualites

Articles d'actualites financieres avec filtres et analyse de sentiment.

Screener

Filtrage avance d'actions avec criteres multiples.

Chat IA

Assistant IA financier avec contexte RAG des marches africains.

Commencer

Integrez les donnees CoinClarity en 3 etapes simples.

Choisissez un endpoint

Parcourez la documentation ci-dessus pour trouver les donnees dont vous avez besoin.

Envoyez une requete

Utilisez fetch, axios ou curl pour appeler l'API. Pas de cle API requise.

Utilisez les donnees

Les reponses sont au format JSON avec pagination et metadonnees.

Exemple JavaScript

javascript

// Recuperer les entreprises de la BRVM
const response = await fetch(
  'https://api.coinclarity.org/api/v1/companies?market=brvm&limit=10'
);
const { data, meta } = await response.json();

console.log(`${meta.total} entreprises trouvees`);
data.forEach(company => {
  console.log(`${company.ticker}: ${company.latestPrice} XOF (${company.priceChangePercent > 0 ? '+' : ''}${company.priceChangePercent?.toFixed(2)}%)`);
});

Exemple TypeScript

typescript

// Avec TypeScript et types
interface Company {
  ticker: string;
  name: string;
  latestPrice: number | null;
  priceChangePercent: number | null;
}

interface APIResponse<T> {
  success: boolean;
  data: T;
  meta: {
    page: number;
    limit: number;
    total: number;
    totalPages: number;
  };
}

async function getCompanies(market = 'brvm'): Promise<Company[]> {
  const res = await fetch(
    `https://api.coinclarity.org/api/v1/companies?market=${market}&limit=20`
  );
  const json: APIResponse<Company[]> = await res.json();
  return json.data;
}

// Utilisation
const companies = await getCompanies('brvm');

Limites de debit

Pour garantir la qualite du service, des limites de debit sont appliquees.

Endpoints generaux : 100 requetes par minute par IP
Endpoints chat IA : 20 requetes par minute par IP
Reponse 429 (Too Many Requests) en cas de depassement

Questions frequentes

Reponses aux questions les plus courantes sur l'API.

Ai-je besoin d'une cle API ?

Non, la plupart des endpoints sont ouverts et ne necessitent pas d'authentification. Seuls certains endpoints d'administration et de watchlist necessitent une session authentifiee.

Quel est le format des reponses ?

Toutes les reponses sont au format JSON avec un champ 'success' (boolean), un champ 'data' contenant les resultats, et optionnellement un champ 'meta' avec les informations de pagination.

Quelles bourses sont couvertes ?

L'API couvre 17 bourses africaines dont la BRVM, NGX (Nigeria), JSE (Afrique du Sud), NSE (Kenya), GSE (Ghana), BSE (Botswana), et plus. Utilisez l'endpoint /markets pour la liste complete.

A quelle frequence les donnees sont-elles mises a jour ?

Les cours sont mis a jour quotidiennement apres la cloture des marches. Les actualites sont ingerees en continu depuis plusieurs sources africaines et internationales.

Y a-t-il une limite sur le nombre de resultats ?

Oui, la pagination est limitee a 100 resultats par page maximum. Utilisez les parametres 'page' et 'limit' pour naviguer dans les resultats.

Puis-je utiliser l'API dans une application commerciale ?

Les donnees sont fournies a titre informatif. Pour un usage commercial intensif, contactez-nous pour discuter des conditions d'utilisation et des limites de debit adaptees.

Besoin de plus d'informations ?

Consultez la documentation interactive Swagger ou contactez-nous.

Swagger UI Nous contacter

// Recuperer les entreprises de la BRVM const response = await fetch( 'https://api.coinclarity.org/api/v1/companies?market=brvm&limit=10' ); const { data, meta } = await response.json(); console.log(`${meta.total} entreprises trouvees`); data.forEach(company => { console.log(`${company.ticker}: ${company.latestPrice} XOF (${company.priceChangePercent > 0 ? '+' : ''}${company.priceChangePercent?.toFixed(2)}%)`); });

// Avec TypeScript et types interface Company { ticker: string; name: string; latestPrice: number | null; priceChangePercent: number | null; } interface APIResponse<T> { success: boolean; data: T; meta: { page: number; limit: number; total: number; totalPages: number; }; } async function getCompanies(market = 'brvm'): Promise<Company[]> { const res = await fetch( `https://api.coinclarity.org/api/v1/companies?market=${market}&limit=20` ); const json: APIResponse<Company[]> = await res.json(); return json.data; } // Utilisation const companies = await getCompanies('brvm');