Démarrer

Utiliser avec un LLM

Toute la documentation existe en Markdown, le format que les assistants IA et les coding agents (Claude, ChatGPT, Claude Code, Cursor, Codex…) lisent le mieux. Donnez-la-leur : ils écrivent votre intégration à partir de l’API actuelle, pas de mémoire.

Sur chaque page

En haut de chaque page de la documentation :

Copier la page copie la page en Markdown, prête à coller dans une conversation ;
Markdown ouvre la version Markdown de la page ;
Ouvrir dans Claude et Ouvrir dans ChatGPT démarrent une conversation qui lit la page : posez vos questions directement.

llms.txt

Deux fichiers à la racine du site suivent la convention llms.txt :

Fichier	Contenu	Quand l’utiliser
`/llms.txt`	Index : chaque page avec un résumé d’une ligne et le lien vers sa version Markdown, plus les références de l’API lisibles par une machine	Laisser l’agent choisir les pages dont il a besoin
`/llms-full.txt`	Toute la documentation en anglais dans un seul fichier, pages des indicateurs comprises	Tout charger d’un coup dans le contexte

/llms.txt est en anglais, la langue que les agents attendent ; les pages françaises y sont listées dans la section Optional.

Pages Markdown

Ajoutez .md à l’adresse de n’importe quelle page de la documentation pour obtenir sa version Markdown :

BASH

curl https://fathomcharts.com/docs/demarrage-rapide.md

Les agents qui envoient Accept: text/markdown (Claude Code, Cursor…) reçoivent directement le Markdown à l’adresse habituelle :

BASH

curl -H "Accept: text/markdown" https://fathomcharts.com/docs/demarrage-rapide

Les pages anglaises fonctionnent de la même façon : /en/docs/quickstart.md. Les liens entre pages Markdown pointent vers des pages Markdown : un agent peut les suivre.

Références lisibles par une machine

En plus de la documentation, l’API se décrit elle-même :

GET https://api.fathomcharts.com/v1/indicators, sans authentification : chaque indicateur avec les JSON Schemas de ses paramètres et de ses données (voir Indicateurs) ;
GET https://api.fathomcharts.com/v1/instruments, avec une clé API : les instruments et leur tick size (voir Instruments) ;
GET https://api.fathomcharts.com/v1/offers, sans authentification : les offres et leurs limites (voir Limites) ;
https://api.fathomcharts.com/docs/json, sans authentification : la description OpenAPI 3.1 de l’API REST.

Instructions pour votre coding agent

Collez ce bloc dans le fichier AGENTS.md de votre projet (lu par Codex, Cursor et la plupart des agents) ou dans CLAUDE.md (Claude Code). Il est en anglais, comme /llms.txt :

## Fathom Charts API

- Before writing code against the Fathom Charts API, read the documentation index https://fathomcharts.com/llms.txt and the Markdown pages it links to. Do not rely on memory.
- Indicator parameters and data shapes: the JSON Schemas of GET https://api.fathomcharts.com/v1/indicators.
- Use the TypeScript SDK `@fathom-charts/sdk` for real-time streams and history pagination.
- The API key comes from the `FATHOM_CHARTS_API_KEY` environment variable, server-side only: never in code that runs in a browser.

Bon à savoir

Les pages Markdown sont générées depuis la même source que les pages HTML, à chaque mise en ligne : elles disent toujours la même chose.
Ne collez jamais une clé API dans une conversation avec un assistant : donnez-lui plutôt le nom de la variable d’environnement (voir Authentification).