Volume 24h—Positions ouvertes—Liquidations 24h$1.36BLong/Short 24h—Dominance BTC—Dominance ETH—
App
Langue ▾
€ EUR ▾
/api/meta/openapi
GETDisponible

Document OpenAPI

Description OpenAPI 3.0 de l'API publique, générée à partir du catalogue et des tableaux de champs déduits de réponses réelles.

GET/api/meta/openapi

Requête

Cet endpoint n'accepte aucun paramètre.

Exemple de requête

curl -s "https://www.coinboss.com/api/meta/openapi"

Champs de la réponse

Le tableau des champs est généré à partir de réponses réelles : il liste donc exactement ce que renvoie l'endpoint. Les chemins utilisent a[] pour les éléments d'un tableau et {*} pour les objets indexés par un nom dynamique, comme une crypto ou une plateforme.

ChampTypeUnitéDescription
openapistring—Version de la spécification OpenAPI de ce document.
infoobject—Titre, version et description de l'API.
info.titlestring—Titre de l'API.
info.versionstring—Version de l'API.
info.descriptionstring—Brève description de l'API et de ses conventions.
serversarray—URL de base de l'API.
servers[]object—Une entrée de serveur.
servers[].urlstring—URL de base à placer devant chaque chemin.
tagsarray—Catégories d'endpoints.
tags[]object—Une catégorie.
tags[].namestring—Nom.
tags[].descriptionstring—Description de la catégorie.
pathsobject—Endpoints, indexés par chemin. clés dynamiques: /api/coin-heatmap,/api/coins/all,/api/coins/search,/api/currency/ex-table,/api/currency/flows,/api/currency/list
paths.{*}object—Opérations disponibles sur un chemin.
paths.{*}.getobject—L'opération GET.
paths.{*}.get.operationIdstring—Identifiant de l'endpoint, le même que dans le catalogue.
paths.{*}.get.summarystring—Bloc de synthèse.
paths.{*}.get.descriptionstring—Ce que renvoie l'endpoint, avec des notes sur la couverture et les limites.
paths.{*}.get.tagsarray—Catégories de l'endpoint.
paths.{*}.get.tags[]string—Identifiant de la catégorie.
paths.{*}.get.x-declared-statusstring—Disponibilité déclarée : `available`, `partial` ou `unavailable`.
paths.{*}.get.x-cache-ttl-secondsnumbersDurée de vie du cache côté serveur de l'endpoint. peut être absent
paths.{*}.get.parametersarray—Paramètres de la requête. vide dans les échantillons ayant servi à générer ce tableau
paths.{*}.get.parameters[]object—Un paramètre.
paths.{*}.get.parameters[].namestring—Nom.
paths.{*}.get.parameters[].instring—Emplacement du paramètre : `query` ou `path`.
paths.{*}.get.parameters[].requiredboolean—`true` lorsque le paramètre doit être envoyé.
paths.{*}.get.parameters[].descriptionstring—Signification du paramètre.
paths.{*}.get.parameters[].schemaobject—JSON Schema de la valeur du paramètre (type, valeur par défaut, enum, minimum, maximum).
paths.{*}.get.parameters[].examplestring—Exemple de valeur. peut être absent
paths.{*}.get.responsesobject—Réponses indexées par statut HTTP ; la réponse 200 porte le JSON Schema généré à partir de réponses réelles.
componentsobject—Schémas partagés, dont le corps d'erreur utilisé par tous les endpoints.

Généré à partir de 1 réponses réelles (2026-11-11 23:03 UTC).

Exemple de réponse

/api/meta/openapi · Réponse réelle (capture : 2026-11-13 03:59:28 UTC). Les tableaux et dictionnaires longs sont abrégés pour l'affichage : tags comptait 21 éléments; paths comptait 298 éléments; paths.{*}.get.responses comptait 5 éléments; paths.{*}.get.parameters comptait 3 éléments; components.schemas.Error.properties.code.enum comptait 9 éléments.

  • {
    • "openapi": "3.0.3",
    • "info": {
      • "title": "CoinBoss API",
      • "version": "v1 (2026.11.12)",
      • "description": "Public market-data API of CoinBoss. Generated from the endpoint catalog and from field tables inferred from real responses."
      },
    • "servers": [
      • { … 1 }
      ],
    • "tags": [
      • { … 2 },
      • { … 2 }
      ],
    • "paths": {
      • "/api/coin-heatmap": { … 1 },
      • "/api/coins/all": { … 1 }
      },
    • "components": {
      • "schemas": { … 1 },
      • "securitySchemes": { … 1 }
      }
    }

Détails

Authentification
Aucune. Endpoint public.
Limite de requêtes
1200 requêtes par minute et par IP
Cache serveur
5m
Micro-cache en périphérie
10s
Horodatages
Millisecondes depuis l'epoch Unix (UTC), sauf indication contraire dans la description du champ
Format de réponse
json
Stabilité
Stable
Disponible depuis
2026-11-11

Statut en direct

DisponibleVérifié : 2026-11-13 03:59:28 UTCHTTP 20037 msSchéma conforme

Disponibilité, 30 derniers jours

100 % des 408 contrôles réussis

Erreurs

Les appels en échec ont la même structure sur tous les endpoints. La liste complète figure sur la page des erreurs. Erreurs et limites de requêtes →

CodeHTTPSignificationQue faire
INVALID_PARAM400Un paramètre requis est manquant ou une valeur n'est pas acceptée. `param` indique le nom du paramètre lorsqu'il est connu.Ne réessayez pas à l'identique ; corrigez la requête.
UNAUTHORIZED401L'en-tête `CB-API-KEY` a été envoyé, mais la clé est inconnue ou révoquée. Les données publiques ne nécessitent aucune clé — supprimez l'en-tête ou utilisez une clé valide.Ne réessayez pas à l'identique.
FORBIDDEN403La route ne fait pas partie de l'API publique (interne ou réservée aux comptes).Ne réessayez pas.
NOT_FOUND404Route inconnue, ou la crypto / la plateforme / le fonds demandé n'existe pas.Ne réessayez pas ; vérifiez le chemin et les identifiants dans le catalogue.
RATE_LIMITED429Plus de requêtes que la limite par minute. `Retry-After` indique le nombre de secondes à attendre.Attendez la durée indiquée par `Retry-After`, puis réessayez avec backoff.
INTERNAL500Erreur serveur inattendue. Le message est volontairement générique ; citez `request_id` lorsque vous la signalez.Réessayez une fois après quelques secondes ; si l'erreur persiste, signalez-la avec l'ID de requête.
UPSTREAM_FAILED503La source de données derrière cet endpoint n'a pas répondu à temps. Aucun chiffre périmé ni de substitution n'est renvoyé à sa place.Réessayez avec backoff ; consultez la page de statut.
UNAVAILABLE501 / 503Le jeu de données n'est temporairement pas prêt (préchauffage du cache) ou l'endpoint n'a pas encore de source publique licite.Réessayez plus tard ; le catalogue signale les endpoints indisponibles par conception.
REQUEST_FAILED200Certains endpoints plus anciens répondent HTTP 200 avec `success: false`. Vérifiez toujours `success`, et pas seulement le statut HTTP.Dépend du message ; à traiter comme une requête en échec.

Essayer

GET/api/meta/openapiDisponible
Paramètres

Aucun paramètre.

URL de la requêtehttps://www.coinboss.com/api/meta/openapi
Choisissez un endpoint et cliquez sur « Envoyer la requête ». La réponse, les en-têtes et le temps de réponse s'afficheront ici.