Aller au contenu principal

Spécification OpenAPI & Collections API

OpenAPI 3.0

La spécification OpenAPI 3.0 complète est disponible en téléchargement. Vous pouvez l'utiliser avec des outils comme Swagger UI, Redocly, ou tout outil compatible OpenAPI.

Télécharger openapi.yaml

Utilisation avec Swagger UI

Vous pouvez consulter la spécification de façon interactive à l'aide de l'éditeur Swagger en ligne :

  1. Accédez à editor.swagger.io
  2. Cliquez sur File > Import URL ou collez le contenu du fichier YAML

Utilisation avec Redocly

npx @redocly/cli preview-docs openapi.yaml

Collection Postman / Insomnia

Une collection préconfigurée avec tous les endpoints API est disponible pour importation dans Postman ou Insomnia.

Télécharger prediction-market-api.postman_collection.json

Importation dans Postman

  1. Ouvrez Postman
  2. Cliquez sur Import (en haut à gauche)
  3. Sélectionnez le fichier JSON téléchargé
  4. La collection apparaîtra avec tous les endpoints organisés par catégorie

Importation dans Insomnia

  1. Ouvrez Insomnia
  2. Cliquez sur Import depuis le tableau de bord ou File > Import
  3. Sélectionnez le fichier JSON téléchargé
  4. Toutes les requêtes seront importées

Variables de la collection

Après l'importation, mettez à jour ces variables avec vos valeurs :

VariableDescriptionValeur par défaut
baseUrlURL de base de l'APIhttps://polymarket.sandbox.playbatman.com
apiKeyVotre clé API opérateuryour-api-key
marketIdRenseignée automatiquement lors de la création d'un marché
outcomeIdRenseignée automatiquement lors de la création d'un marché
orderIdRenseignée automatiquement lors du placement d'un ordre
categoryIdÀ définir manuellement après la création d'une catégorie

Variables renseignées automatiquement

La collection inclut des scripts de test qui définissent automatiquement les variables :

  • Create Market définit marketId et outcomeId à partir de la réponse
  • Place Order définit orderId à partir de la réponse

Cela vous permet d'exécuter des requêtes en séquence sans copier manuellement les identifiants.

Organisation des requêtes

La collection est organisée en dossiers correspondant aux sections de l'API :

DossierRequêtes
HealthHealth Check, Ready Check
CategoriesCreate, List, Get
MarketsCreate, List, Get, Update, Open, Suspend, Resume, Close, Resolve, Cancel
OrdersPlace (Limit Buy, Limit Sell, Market Buy), Get, List, List by Player, Cancel
PositionsGet All, Get by Market
TradesList All, List by Market
Market DataOrder Book, Market Prices, Outcome Price
StatsOverview
SettlementsSettle, Status, Retry, Get All, Get by Market