Construisez avec Planetlium
Une API REST en lecture seule pour afficher les mondes, les parcelles, le marché, la bourse PLC et l'activité de la communauté dans vos sites, bots et tableaux de bord. Aucune écriture et aucun mouvement de ⬡ ou de PLC ne passent par l'API.
Mes clés
Connectez-vous pour créer une clé.
Authentification
Chaque requête envoie votre clé dans l'en-tête Authorization. Les clés commencent par plk_live_ (production) ou plk_test_ (bac à sable). Nous n'en conservons qu'une empreinte : une clé perdue ne peut pas être réaffichée, il faut en créer une nouvelle.
curl -H "Authorization: Bearer plk_live_xxxxxxxx_…" \
https://planetlium.com/api/v1/ping
Réponse type : {"data": {...}, "sandbox": false, "apiVersion": 1}. CORS est ouvert (*) sans cookies : ne publiez jamais une clé account dans du code exécuté par le navigateur de vos visiteurs.
Points d'accès
Temps réel (SSE)
GET /api/v1/stream?topics=activity,ticker envoie des événements activity (nouvelles actualités publiques) et ticker (prix PLC, portée market). Chaque connexion dure au plus quelques dizaines de secondes puis se referme ; EventSource se reconnecte seul et reprend grâce à Last-Event-ID. EventSource ne pouvant pas envoyer d'en-tête, la clé peut passer en paramètre api_key, uniquement sur ce flux. Utilisez de préférence une clé limitée à la portée public.
const es = new EventSource('https://planetlium.com/api/v1/stream?topics=activity&api_key=plk_test_…');
es.addEventListener('activity', (e) => console.log(JSON.parse(e.data).text));
Limites et erreurs
Chaque clé a une limite de requêtes par minute (60 par défaut, 20 en bac à sable), indiquée dans les en-têtes X-RateLimit-Limit et X-RateLimit-Remaining. Cinq clés actives au plus par compte. Les erreurs renvoient {"error": {"code", "message"}} :
API_KEY_MISSING / API_KEY_INVALID — clé absente, inconnue ou révoquéeAPI_SCOPE — portée manquanteRATE_LIMITED — attendez la fin de la minute (Retry-After)API_DISABLED — API momentanément ferméeBac à sable
Une clé plk_test_ renvoie les vraies données publiques, mais un compte fictif sur les points d'accès /me : idéal pour développer sans exposer vos données. Le champ sandbox: true l'indique dans chaque réponse.
En utilisant l'API, vous acceptez de respecter les CGU et la vie privée des membres. Les données de l'API n'ont aucune valeur contractuelle ; la valeur des parcelles et du PLC peut baisser.